From 5a5a8fc293b9c75f2f50a070edbd6bcb28a30362 Mon Sep 17 00:00:00 2001 From: Tom Poole Date: Thu, 27 Jun 2019 16:56:20 +0100 Subject: [PATCH] Updated the README for generating offline Doxygen docs --- doxygen/Makefile | 1 - doxygen/README.txt | 25 +++++++++++++++++++------ doxygen/make.bat | 2 ++ doxygen/process_source_files.py | 5 +++++ 4 files changed, 26 insertions(+), 7 deletions(-) create mode 100644 doxygen/make.bat diff --git a/doxygen/Makefile b/doxygen/Makefile index 5b17c37169..d4f5d3eb65 100644 --- a/doxygen/Makefile +++ b/doxygen/Makefile @@ -8,7 +8,6 @@ doc/index.html: build/juce_modules.dox Doxyfile doxygen build/juce_modules.dox: process_source_files.py $(SOURCE_FILES) - rm -rf build python $< ../modules build clean: diff --git a/doxygen/README.txt b/doxygen/README.txt index 60a1511d35..ec537aec9a 100644 --- a/doxygen/README.txt +++ b/doxygen/README.txt @@ -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. -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 diff --git a/doxygen/make.bat b/doxygen/make.bat new file mode 100644 index 0000000000..1239654be2 --- /dev/null +++ b/doxygen/make.bat @@ -0,0 +1,2 @@ +python process_source_files.py ..\modules build +doxygen diff --git a/doxygen/process_source_files.py b/doxygen/process_source_files.py index 4ada4eb6d4..376c97db2b 100644 --- a/doxygen/process_source_files.py +++ b/doxygen/process_source_files.py @@ -75,6 +75,11 @@ if __name__ == "__main__": "subdirectories") args = parser.parse_args() + try: + shutil.rmtree(args.dest_dir) + except FileNotFoundError: + pass + # Get the list of JUCE modules to include. if args.subdirs: juce_modules = args.subdirs.split(",")