1
This directory contains source for the documentation. It is also the
2
build target for doxygen output.
8
High level content and format files. (E.g. css, header, footer.)
12
Conceptual (non-api) documentation such as overviews, how-to's, etc.
13
The main index page content is also in this directory.
17
API documentation that is located outside the source files.
19
When the API documentation gets too big or complex for the header
20
and source files, it goes in this directory.
24
Images related to the documentation.
28
The target for the Doxygen build. (Created during the build process.)
32
One of the requirements for the API documentation is that it
33
has the minimum possible impact on the declarations in the
34
header files. So, in general, the header file declarations only
35
contain summary documentation. The detail documentation
38
1. If an element is defined in a cpp file, then place
39
the detail documentation in the source file.
40
2. If an element does not have an associated cpp file, then
41
place the detail documentation at the end of the header file.
42
3. If there is a lot of detail documentation cluttering up
43
the end of a header file, then the content is moved to
44
a separate file in the Extern directory.
46
Building the Documentation
48
1. Download and install the appropriate Doxygen version. (See the first
49
line in the Doxyfile for the current version.)
50
2. Run "doxygen" in the project root directory. (The location of the Doxyfile.)
51
No arguments are required.
53
The generated html files will be located in the /Docs/html directory.
55
If you want to "version" the documentation, you can set the PROJECT_NUMBER
56
setting in the Doxyfile. E.g. PROJECT_NUMBER = "(2014-04-23)". The project
57
number will be added to the header of the documentation.
58
E.g. "Recast Navigation (2014-04-23)"
added
removed
trunk/Tools/Dependencies/RecastNavigation/Docs/Readme.txt
