History

Joe Gregorio 87496d3cc9 Fix doxygen README.md to use python3. Change-Id: Ie4ce9604f3c00f31a1f0117afeaa0ea6f30e9bd8 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/515719 Reviewed-by: Ravi Mistry <rmistry@google.com>		2022-03-04 14:21:35 +00:00
..
mainpage	Get doxygen working again.	2019-03-08 16:06:03 +00:00
customdoxygen.css	Get doxygen working again.	2019-03-08 16:06:03 +00:00
Doxyfile	Include svg module in Doxygen generated output.	2021-01-06 16:40:09 +00:00
footer.html	Get doxygen working again.	2019-03-08 16:06:03 +00:00
logo.png	Get doxygen working again.	2019-03-08 16:06:03 +00:00
ProdDoxyfile	Make OUTPUT_DIRECTORY in ProdDoxyfile configurable	2019-12-18 16:46:25 +00:00
README.md	Fix doxygen README.md to use python3.	2022-03-04 14:21:35 +00:00

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; python3 -m http.server 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