Debian Codegraph @

addon/doxycommentview/README.md

raw
1 # Viewer for the content of a Doxygen style comment block
2
3 ## Contents
4
5 The directory contains an index.html page and a python3 helper script.
6 The script can be used to start a local web server that can do life rendering of
7 the content of a doxygen comment block.
8
9 Similar to e.g. https://markdownlivepreview.com/ but using doxygen as render engine.
10
11 ## To prepare the server
12
13 Place a doxygen.css in the same directory as the doxycommentview.py script.
14
15 This file can be generated running
16
17 doxygen -w html /tmp/header.html /tmp/footer.html doxygen.css path/to/Doxyfile
18
19 or, alternatively, copied from an existing HTML output directory generated by doxygen.
20
21 ## To run the server invoke:
22
23 python3 doxycommentview.py --doxyfile /path/to/Doxyfile
24
25 The relevant settings, such as alias definitions, will be taken from the Doxyfile.
26
27 If desired you can set the port for the webserver using `--port` and
28 point to the location of the doxygen binary using `--doxygen`
29
30 Once the server is started, point your browser to the index page
31
32 firefox http://localhost:8000/index.html
33
34 You should see a panel to enter text on the left hand side and the output
35 rendered by doxygen on the right hand side of the page.
36
37 You can copy and paste the contents of this README.md file to test it quickly.
38