C++ Documentation Improvements

Abierto
#3,393 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
cpp

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
C++
Estrellas
1.3k
Forks
298
Merge medio
5 d 5 h
PR fusionados (30 d)
19

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Vector35/binaryninja-api

Todos los issues de Vector35/binaryninja-api

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.