9
3

Readme.txt 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. This directory contains source for the documentation. It is also the
  2. build target for doxygen output.
  3. Directory Layout
  4. . (Docs root)
  5. High level content and format files. (E.g. css, header, footer.)
  6. ./Conceptual
  7. Conceptual (non-api) documentation such as overviews, how-to's, etc.
  8. The main index page content is also in this directory.
  9. ./Extern
  10. API documentation that is located outside the source files.
  11. When the API documentation gets too big or complex for the header
  12. and source files, it goes in this directory.
  13. ./Images
  14. Images related to the documentation.
  15. ./html
  16. The target for the Doxygen build. (Created during the build process.)
  17. Miscellany
  18. One of the requirements for the API documentation is that it
  19. has the minimum possible impact on the declarations in the
  20. header files. So, in general, the header file declarations only
  21. contain summary documentation. The detail documentation
  22. is placed as follows:
  23. 1. If an element is defined in a cpp file, then place
  24. the detail documentation in the source file.
  25. 2. If an element does not have an associated cpp file, then
  26. place the detail documentation at the end of the header file.
  27. 3. If there is a lot of detail documentation cluttering up
  28. the end of a header file, then the content is moved to
  29. a separate file in the Extern directory.
  30. Building the Documentation
  31. 1. Download and install the appropriate Doxygen version. (See the first
  32. line in the Doxyfile for the current version.)
  33. 2. Run "doxygen" in the project root directory. (The location of the Doxyfile.)
  34. No arguments are required.
  35. The generated html files will be located in the /Docs/html directory.
  36. If you want to "version" the documentation, you can set the PROJECT_NUMBER
  37. setting in the Doxyfile. E.g. PROJECT_NUMBER = "(2014-04-23)". The project
  38. number will be added to the header of the documentation.
  39. E.g. "Recast Navigation (2014-04-23)"