From c93b11eafde4f656dd30c05bba80db1dd63c81db Mon Sep 17 00:00:00 2001 From: Stephen Pratt Date: Wed, 23 Apr 2014 12:24:22 -0600 Subject: [PATCH] Add Doc Build Info To ReadMe File Adds some information on building the documentation to the documentation ReadMe file. --- Docs/Readme.txt | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/Docs/Readme.txt b/Docs/Readme.txt index a32f12b..be153b9 100644 --- a/Docs/Readme.txt +++ b/Docs/Readme.txt @@ -23,6 +23,10 @@ Directory Layout Images related to the documentation. +./html + + The target for the Doxygen build. (Created during the build process.) + Miscellany One of the requirements for the API documentation is that it @@ -38,5 +42,23 @@ is placed as follows: 3. If there is a lot of detail documentation cluttering up the end of a header file, then the content is moved to a separate file in the Extern directory. + +Building the Documentation + +1. Download and install the appropriate Doxygen version. (See the first + line in the Doxyfile for the current version.) +2. Run "doxygen" in the project root directory. (The location of the Doxyfile.) + No arguments are required. + +The generated html files will be located in the /Docs/html directory. + +If you want to "version" the documentation, you can set the PROJECT_NUMBER +setting in the Doxyfile. E.g. PROJECT_NUMBER = "(2014-04-23)". The project +number will be added to the header of the documentation. +E.g. "Recast Navigation (2014-04-23)" + + + +