AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
57b7a792bb
skia2/tools/doxygen
History
Joe Gregorio ca9e2a4288 api.skia.org - Don't document private. 
Bug: skia:
Change-Id: I4522267f6b553b999a3df47994e2bef1fb54d118
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/199723
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-03-11 15:52:21 +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 api.skia.org - Don't document private. 2019-03-11 15:52:21 +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

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