| 1 |
Notes on how Doxygen documentation generation works within the VXL framework. |
| 2 |
|
| 3 |
----- |
| 4 |
Usage |
| 5 |
----- |
| 6 |
In package directory CMakeList.txt, use doxygen_add_package(...) to describe the package. |
| 7 |
|
| 8 |
e.g.: |
| 9 |
doxygen_add_package(contrib/mul |
| 10 |
"Manchester University Libraries" |
| 11 |
) |
| 12 |
|
| 13 |
In each library director CMakeLists.txt, use doxygen_add_library(...) to describe the library |
| 14 |
e.g.: |
| 15 |
doxygen_add_library(contrib/gel/mrc/vpgl |
| 16 |
DEPENDS core/vcsl core/vgl core/vnl core/vbl |
| 17 |
PACKAGE contrib/gel |
| 18 |
DESCRIPTION "Photogrammetry Library" |
| 19 |
) |
| 20 |
|
| 21 |
------------ |
| 22 |
How it works |
| 23 |
------------ |
| 24 |
doxygen_add_package and doxygen_add_library are defined in config/cmake/doxygen.cmake |
| 25 |
|
| 26 |
doxygen_add_library: |
| 27 |
- Creates a file ${CMAKE_BINARY_DIR}/doxy/output/doxyfile.${libname}, a copy of config/cmake/doxyfile.in |
| 28 |
- Appends information about library to ${CMAKE_BINARY_DIR}/doxygen_configuration.cmake |
| 29 |
|
| 30 |
|
| 31 |
To build documentation, use command: |
| 32 |
make build_doxygen_doc |
| 33 |
|
| 34 |
This is defined in doxygen.cmake |
| 35 |
It invokes "cmake -P ${DOXYGEN_SCRIPT_DIR}doxygen_makeall.cmake ..." |
| 36 |
|
| 37 |
doxygen_makeall.cmake |
| 38 |
--------------------- |
| 39 |
1) Loads in configuration from doxygen_configuration.cmake |
| 40 |
2) Processes each book |
| 41 |
3) Processes each library (in ${DOXYGEN_LIBRARY_LIST}) |
| 42 |
4) Creates a directory ${DOXYGEN_OUTPUT_DIR}/html/${library}/html |
| 43 |
5) Runs doxygen using the parameter file ${CMAKE_BINARY_DIR}/doxy/output/doxyfile.${libname} |
| 44 |
6) Creates a global index, which expects data for each library to be in somewhere like: |
| 45 |
obj/doxy/html/core/vnl/html/index.html |