C++ Documentation Improvements

オープン
#3,393 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
cpp
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
C++
スター
1.3k
フォーク
298
平均マージ
5日 5時間
マージ済み PR（30日）
19

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Vector35/binaryninja-api のほかの issue

Vector35/binaryninja-api の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。