History

Leon Scroggins III 1ff07066f9 Remove more references to "master" Bug: chromium:1101491 Bug: b/161896447 Switch to more inclusive language, like "main", or remove where simply unnecessary. Change-Id: I36ef6ec631eb991f54f42b98887333f07c0984c2 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/306060 Commit-Queue: Leon Scroggins <scroggo@google.com> Reviewed-by: Mike Klein <mtklein@google.com> Reviewed-by: Kevin Lubick <kjlubick@google.com>		2020-07-28 13:06:07 +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	Remove more references to "master"	2020-07-28 13:06:07 +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