mirror of
https://github.com/mudita/MuditaOS.git
synced 2026-04-19 06:30:46 -04:00
065a70fbd0
Fixes multiple documents with broken links. Removes HTML anchors and updates each ToC with a proper link.
2.7 KiB
2.7 KiB
MuditaOS Documentation
This folder contains the documentation of the MuditaOS.
How to generate documentation using Doxygen
Fully detailed documentation can be built locally using Doxygen.
You can build code documentation with the following command:
make doc
If you prefer to build documentation always with all target instead, configure cmake
with BUILD_DOC_WITH_ALL option set to ON, e.g.:
cmake -DBUILD_DOC_WITH_ALL=ON . build/
Documentation is generated in the doc/html subdirectory of the build directory. To view it open index.html using a web browser, e.g.:
firefox build/doc/html/index.html
Table of contents
-
Getting Started Guides
-
Developer Guides
- Coding Guidelines
- System architecture
- Modules
- Services
- Tools
-
Changelog