25bd5d8adb
subrepo: subdir: "deps/juce" merged: "b13f9084e" upstream: origin: "https://github.com/essej/JUCE.git" branch: "sono6good" commit: "b13f9084e" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" |
||
|---|---|---|
| .. | ||
| doxygen | ||
| Accessibility.md | ||
| CMake API.md | ||
| JUCE Module Format.md | ||
| Linux Dependencies.md | ||
| README.md | ||
JUCE Documentation
This directory contains files documenting the JUCE Module Format, and the JUCE CMake API.
The JUCE modules themselves can be found in the modules subdirectory of the
JUCE repository.
CMake example projects are located in the examples/CMake directory.
The JUCE API itself is documented inline, but HTML docs can be generated from
the source code using the doxygen tool. These HTML docs can be found
online, or you can generate a local copy
which can be used without an internet connection. For instructions on generating
offline docs, see below.
Generating Offline HTML Documentation
Dependencies
- doxygen
- python
- make
- graphviz (to generate inheritance diagrams)
Make sure that all the dependencies can be found on your PATH.
Building
- cd into the
doxygendirectory on the command line - run
make
Doxygen will create a new subdirectory "doc". Open doc/index.html in your browser to access the generated HTML documentation.