mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-09 23:34:20 +00:00
Code Activity
JUCE/doxygen
History
Tom Poole 5a5a8fc293 Updated the README for generating offline Doxygen docs
2019-06-27 16:56:20 +01:00
..
Doxyfile Fixed some Doxygen parsing errors 2018-10-25 10:18:20 +01:00
make.bat Updated the README for generating offline Doxygen docs 2019-06-27 16:56:20 +01:00
Makefile Updated the README for generating offline Doxygen docs 2019-06-27 16:56:20 +01:00
process_source_files.py Updated the README for generating offline Doxygen docs 2019-06-27 16:56:20 +01:00
README.txt Updated the README for generating offline Doxygen docs 2019-06-27 16:56:20 +01:00

README.txt 

The JUCE API Reference
======================

From here, you can generate an offline HTML version of the JUCE API Reference.

Dependencies
------------

- doxygen
- python
- graphviz (to generate inheritance diagrams)

Make sure that all the dependencies can be found on your PATH.

Building
--------

- cd into this directory on the command line
- run `make`

Doxygen will create a new subfolder "doc". Open doc/index.html in your browser
to access the generated HTML documentation.