diff options
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/documentation.md | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index 3f357273..85d232dd 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -24,7 +24,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li echo API documentation available in build/html ## Changing -Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) in C++ and C, and [restructured text blocks](http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder. +Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.doxygen.nl/manual/docblocks.html) in C++ and C, and [restructured text blocks](http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder. ???+ Info "Tip" When updating user documentation, the `mkdocs serve` feature is particularly helpful. @@ -34,5 +34,4 @@ Changing documentation for the API itself is fairly straight forward. Use [doxyg [mkdocs]: http://www.mkdocs.org/ [breathe]: https://github.com/michaeljones/breathe [sphinx]: http://www.sphinx-doc.org/en/stable/index.html -[doxygen]: http://www.stack.nl/~dimitri/doxygen/ -[doxblocks]: doxygen +[doxygen]: https://www.doxygen.nl |