[doc] Build doxygen documentation with CMake

coin-or · Nov 26, 2024 · a02023b · a02023b
1 parent a241053
commit a02023b
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 10 deletions.
diff --git a/ADOL-C/CMakeLists.txt b/ADOL-C/CMakeLists.txt
@@ -1,2 +1,3 @@
 add_subdirectory(include)
 add_subdirectory(src)
+add_subdirectory(doc)
diff --git a/ADOL-C/doc/CMakeLists.txt b/ADOL-C/doc/CMakeLists.txt
@@ -0,0 +1 @@
+add_subdirectory(doxygen)
diff --git a/ADOL-C/doc/doxygen/CMakeLists.txt b/ADOL-C/doc/doxygen/CMakeLists.txt
@@ -0,0 +1,15 @@
+find_package(Doxygen)
+
+if(DOXYGEN_FOUND)
+
+  set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+  set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+  configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+  add_custom_target(doxygen
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating class documentation using Doxygen"
+        VERBATIM)
+
+endif()
diff --git a/ADOL-C/doc/doxygen/Doxyfile → ADOL-C/doc/doxygen/Doxyfile.in b/ADOL-C/doc/doxygen/Doxyfile → ADOL-C/doc/doxygen/Doxyfile.in
@@ -68,7 +68,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -591,7 +591,7 @@ HIDE_UNDOC_MEMBERS     = NO
 # if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
 # declarations. If set to NO, these declarations will be included in the
@@ -943,9 +943,9 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../include/adolc/ \
-                         Mainpage.md \
-                         Topics.md
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../include/adolc/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/Mainpage.md \
+                         @CMAKE_CURRENT_SOURCE_DIR@/Topics.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/ADOL-C/doc/doxygen/Mainpage.md b/ADOL-C/doc/doxygen/Mainpage.md
@@ -20,16 +20,19 @@ featuring e.g.
 
 ### Class documentation
 
-The library contains a class documentation which can be build using [doxygen].
-You can build the documentation using
+The library contains a class documentation generated by using [doxygen].
+In order to generate it, it is required that the `doxygen` program
+is available and found by CMake. After the project was configured using
+CMake and if doxygen was found, the documentation can
+be build by calling
 ```shell
-doxygen Doxyfile
+make doxygen
 ```
-from within thd `doc/` subdirectory.
+from within the build directory. The entry page of the documentation is located
+in `ADOL-C/doc/doxygen/html/index.html` within the build directory.
 For an overview of the contained features and submodules
 you can e.g. refer to the [Topics](topics.html) section of the doxygen documentation.
 
-@todo Add support for building the class documentation with cmake.
 
 ### Manual