You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jianglk.darker
7ee447c011
|
4 months ago | |
|---|---|---|
| .. | ||
| mainpage | 4 months ago | |
| Doxyfile | 4 months ago | |
| ProdDoxyfile | 4 months ago | |
| README.md | 4 months ago | |
| customdoxygen.css | 4 months ago | |
| footer.html | 4 months ago | |
| logo.png | 4 months ago | |
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