mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
Updated the README for generating offline Doxygen docs
This commit is contained in:
parent
0239c0cb7e
commit
5a5a8fc293
4 changed files with 26 additions and 7 deletions
|
|
@ -8,7 +8,6 @@ doc/index.html: build/juce_modules.dox Doxyfile
|
||||||
doxygen
|
doxygen
|
||||||
|
|
||||||
build/juce_modules.dox: process_source_files.py $(SOURCE_FILES)
|
build/juce_modules.dox: process_source_files.py $(SOURCE_FILES)
|
||||||
rm -rf build
|
|
||||||
python $< ../modules build
|
python $< ../modules build
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,23 @@
|
||||||
# The JUCE API Reference
|
The JUCE API Reference
|
||||||
|
======================
|
||||||
|
|
||||||
From here, you can generate an offline HTML version of the JUCE API Reference.
|
From here, you can generate an offline HTML version of the JUCE API Reference.
|
||||||
|
|
||||||
How to:
|
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.
|
||||||
|
|
||||||
1. install doxygen
|
|
||||||
2. cd into this directory on the command line
|
|
||||||
3. run `make`
|
|
||||||
4. doxygen will create a new subfolder "doc" - open doc/index.html in your browser to access the generated HTML documentation
|
|
||||||
|
|
|
||||||
2
doxygen/make.bat
Normal file
2
doxygen/make.bat
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
python process_source_files.py ..\modules build
|
||||||
|
doxygen
|
||||||
|
|
@ -75,6 +75,11 @@ if __name__ == "__main__":
|
||||||
"subdirectories")
|
"subdirectories")
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
try:
|
||||||
|
shutil.rmtree(args.dest_dir)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
# Get the list of JUCE modules to include.
|
# Get the list of JUCE modules to include.
|
||||||
if args.subdirs:
|
if args.subdirs:
|
||||||
juce_modules = args.subdirs.split(",")
|
juce_modules = args.subdirs.split(",")
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue