Vector35 / Vector35/binaryninja-api
C++ Documentation Improvements
Open
Nobody has claimed this yet.
Effort: Medium
Impact: Medium
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100