thead_admin 6aab0fd6f1 Linux_SDK_V0.9.5 | 1 year ago | |
---|---|---|
.. | ||
mainpage | 1 year ago | |
Doxyfile | 1 year ago | |
ProdDoxyfile | 1 year ago | |
README.md | 1 year ago | |
customdoxygen.css | 1 year ago | |
footer.html | 1 year ago | |
logo.png | 1 year ago |
To generate all the documentation run the following from this directory:
doxygen Doxyfile
The resulting output goes to
/tmp/doxygen
To view those file locally in your browser run:
cd /tmp/doxygen/html; python -m SimpleHTTPServer 8000
and visit
http://localhost:8000
If you want to have the documentation regenerated on every save then
you can install entr
and run the following from this directory:
find ../../include/ ../../src/ . | entr doxygen ./Doxyfile
For a linux desktop you can install the doxygen tool via:
sudo apt install doxygen