• Home
Name
Date
Size
#Lines
LOC

..--

mainpage/12-May-2024-2519

DoxyfileD12-May-2024106.5 KiB2,5051,949

ProdDoxyfileD12-May-2024149 63

README.mdD12-May-2024613 3218

customdoxygen.cssD12-May-20243 KiB183144

footer.htmlD12-May-2024809 2517

logo.pngD12-May-20247.2 KiB

README.md

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
32