History

Ravi Mistry 6f217e0f8d Make OUTPUT_DIRECTORY in ProdDoxyfile configurable Bug: skia:9514 Change-Id: I628c2a59302e22c8d4c0973def0a3a11f7f882b7 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/260817 Reviewed-by: Joe Gregorio <jcgregorio@google.com> Commit-Queue: Ravi Mistry <rmistry@google.com>		2019-12-18 16:46:25 +00:00
..
mainpage
customdoxygen.css
Doxyfile	Docs: include/docs with doxygen	2019-10-18 20:38:37 +00:00
footer.html
logo.png
ProdDoxyfile	Make OUTPUT_DIRECTORY in ProdDoxyfile configurable	2019-12-18 16:46:25 +00:00
README.md

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