summaryrefslogtreecommitdiffstats
path: root/hl
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-09-10 12:40:27 (GMT)
committerGitHub <noreply@github.com>2021-09-10 12:40:27 (GMT)
commitb58f8540ac3c416e1d833aad243a0df35ec4a616 (patch)
treefb160575a2cc88c8341f9115c3f66a9286e00d7c /hl
parent8e06298ecfde5eb647b39cfe0dab70005f092199 (diff)
downloadhdf5-b58f8540ac3c416e1d833aad243a0df35ec4a616.zip
hdf5-b58f8540ac3c416e1d833aad243a0df35ec4a616.tar.gz
hdf5-b58f8540ac3c416e1d833aad243a0df35ec4a616.tar.bz2
Fix various warnings and issues in doxygen doc generation (#994)
* Fix various warnings and issues in doxygen doc generation * Add new file to list
Diffstat (limited to 'hl')
-rw-r--r--hl/src/CMakeLists.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/hl/src/CMakeLists.txt b/hl/src/CMakeLists.txt
index 7678de8..a97d6fa 100644
--- a/hl/src/CMakeLists.txt
+++ b/hl/src/CMakeLists.txt
@@ -169,3 +169,32 @@ if (NOT WIN32 AND NOT MINGW)
COMPONENT hllibraries
)
endif ()
+
+#-----------------------------------------------------------------------------
+# Option to build documentation
+#-----------------------------------------------------------------------------
+if (DOXYGEN_FOUND)
+# This cmake function requires that the non-default doxyfile settings are provided with set (DOXYGEN_xxx) commands
+# In addition the doxyfile aliases @INCLUDE option is not supported and would need to be provided in a set (DOXYGEN_ALIASES) command.
+# doxygen_add_docs (hdf5lib_doc
+## ${HL_SOURCES} ${HL_HEADERS} ${HDF5_DOXYGEN_DIR}/dox
+# ${DOXYGEN_INPUT_DIRECTORY}
+# ALL
+# WORKING_DIRECTORY ${HDF5_HL_SRC_DIR}
+# COMMENT "Generating HDF5 HL library Source Documentation"
+# )
+
+# This custom target and doxygen/configure work together
+ # Replace variables inside @@ with the current values
+ add_custom_target (hdf5hllib_doc ALL
+ COMMAND ${DOXYGEN_EXECUTABLE} ${HDF5_BINARY_DIR}/Doxyfile
+ WORKING_DIRECTORY ${HDF5_HL_SRC_DIR}
+ COMMENT "Generating HDF5 HL library Source API documentation with Doxygen"
+ VERBATIM )
+
+ if (NOT TARGET doxygen)
+ add_custom_target (doxygen)
+ endif ()
+
+ add_dependencies (doxygen hdf5hllib_doc)
+endif ()