Vector35 / Vector35/binaryninja-api
InstructionTextToken docs in markdown, not doxygen
Open
Nobody has claimed this yet.
Effort: Trivial
Impact: Low
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
https://api.binary.ninja/cpp/struct_binary_ninja_1_1_instruction_text_token.html
Should also double check the other C++ docs for markdown style syntax to see if there are others (spoiler: there most certainly is)
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 linked InstructionTextToken C++ documentation page and compare its syntax with the project's expected Markdown style. Then inspect the other C++ documentation for similar Markdown-versus-Doxygen issues; done means the identified documentation uses the intended style and related instances are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100