| Xiaoming Shi | 73dfa20 | 2020-03-12 11:31:35 -0700 | [diff] [blame] | 1 | Doxygen |
| 2 | ======= |
| 3 | |
| 4 | To generate all the documentation run the following |
| 5 | from this directory: |
| 6 | |
| 7 | doxygen Doxyfile |
| 8 | |
| 9 | The resulting output goes to |
| 10 | |
| 11 | /tmp/doxygen |
| 12 | |
| 13 | To view those file locally in your browser run: |
| 14 | |
| 15 | cd /tmp/doxygen/html; python -m SimpleHTTPServer 8000 |
| 16 | |
| 17 | and visit |
| 18 | |
| 19 | http://localhost:8000 |
| 20 | |
| 21 | If you want to have the documentation regenerated on every save then |
| 22 | you can install `entr` and run the following from this directory: |
| 23 | |
| 24 | find ../../include/ ../../src/ . | entr doxygen ./Doxyfile |
| 25 | |
| 26 | Install |
| 27 | ------- |
| 28 | |
| 29 | For a linux desktop you can install the doxygen tool via: |
| 30 | |
| 31 | sudo apt install doxygen |
