History

Joe Gregorio 6094ed698d Include svg module in Doxygen generated output. Bug: skia:11108 Change-Id: I2c676d674ede2455f35a69d7063b042f8409aea5 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/350617 Auto-Submit: Joe Gregorio <jcgregorio@google.com> Reviewed-by: Florin Malita <fmalita@chromium.org> Commit-Queue: Joe Gregorio <jcgregorio@google.com>		2021-01-06 16:40:09 +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	Get doxygen working again.	2019-03-08 16:06:03 +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; 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