skia2/tools/doxygen/README.md
Joe Gregorio dd51aacdb1 Get doxygen working again.
This also enables MarkDeep for the comments, but I haven't added
any examples of that yet.

Screenshots:
  https://screenshot.googleplex.com/mUCgtAesDWt.png
  https://screenshot.googleplex.com/S1p4Dhpn6KW.png

Bug: skia:
Change-Id: I4f645ef1050d26c7a4660a1fc28a8d41f085f4f8
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/198241
Reviewed-by: Brian Osman <brianosman@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2019-03-08 16:06:03 +00:00

613 B

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