Skip to content

nrfx documentation

Bartosz Gentkowski edited this page Feb 6, 2018 · 2 revisions

Project documentation

Documentation for the nrfx project can be found in doc/html. It has been generated in the release zip file or you can generate it yourself using the scripts located in doc directory.

Generating documentation

To generate documentation for the latest source files, you must install doxygen. You can open the console and type doxygen to check whether it is properly installed before using scripts from the doc directory.

To generate documentation in the native Windows environment, run the generate_html_doc.bat file. For Linux and Mac operating systems, use generate_html_doc.sh.