tree: 3ae6bf50252072a5d4c0e24c5fbd110013e63497 [path history] [tgz]
  1. Doxyfile
  2. ProdDoxyfile
  3. README.md
  4. customdoxygen.css
  5. footer.html
  6. logo.png
  7. mainpage/
tools/doxygen/README.md

Doxygen

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

Install

For a linux desktop you can install the doxygen tool via:

sudo apt install doxygen