C++ Documentation Improvements

Aperta
#3,393 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cpp
Ambito
documentation

Direzione di ricerca

Start with the C++ API documentation for the unchecked classes: BinaryView, Function, LowLevelILInstruction, MediumLevelILFunction, MediumLevelILInstruction, HighLevelILFunction, and HighLevelILInstruction. Locate their declarations and existing documentation patterns, then document the remaining classes and mark each completed item in the issue checklist.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Effort: Medium Impact: Medium

All major classes in C++ need to be documented

  • Architecture
  • BinaryView
  • Function
  • BinaryViewType
  • BinaryReader
  • BinaryWriter
  • Type
  • BasicBlock
  • AnalysisContext
  • Workflow
  • PluginCommand
  • Platform
  • Structure
  • Settings
  • EnumerationBuilder
  • FileMetadata
  • Symbol
  • Logging functions
  • LogRegistry
  • Demangling functions
  • Report functions
  • Interactions functions
  • TemporaryFile
  • TagType
  • FlowGraphNode / Flowgraph
  • SecretsProvider
  • WebsocketProvider
  • DownloadInstance
  • TypePrinter
  • DataRenderer/DataRendererContainer
  • InstructionTextToken
  • Segment
  • Section
  • LowLevelILFunction
  • LowLevelILInstruction
  • MediumLevelILFunction
  • MediumLevelILInstruction
  • HighLevelILFunction
  • HighLevelILInstruction
Lingua principale
C++
Stelle
1.3k
Fork
298
Merge medio
5g 5h
PR unite (30g)
19

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Vector35/binaryninja-api

Tutte le issue di Vector35/binaryninja-api

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.