C++ Documentation Improvements

Offen
#3,393 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
cpp
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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
Vorherrschende Sprache
C++
Sterne
1.3k
Forks
298
Ø Merge
5 T. 5 Std.
Gemergte PRs (30 T.)
19

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Vector35/binaryninja-api

Alle Issues in Vector35/binaryninja-api

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.