History

Hal Canary 051f7d66e1 Docs: include/docs with doxygen Change-Id: Ic9e0040d12e92ba1fe91813ed1daaf83e28316d2 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/249536 Auto-Submit: Hal Canary <halcanary@google.com> Reviewed-by: Joe Gregorio <jcgregorio@google.com> Commit-Queue: Hal Canary <halcanary@google.com>		2019-10-18 20:38:37 +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	Docs: include/docs with doxygen	2019-10-18 20:38:37 +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	Get doxygen working again.	2019-03-08 16:06:03 +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