diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2021-09-10 12:41:53 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-10 12:41:53 (GMT) |
| commit | b30a44973e97c56bf7772cdbf767b98f84122397 (patch) | |
| tree | 7119bde4cf6155222f932f68bcefb1a69d72c178 /hl/src | |
| parent | d41c8049b68bb18dc2dd3b15e73571c170e7a102 (diff) | |
| download | hdf5-b30a44973e97c56bf7772cdbf767b98f84122397.zip hdf5-b30a44973e97c56bf7772cdbf767b98f84122397.tar.gz hdf5-b30a44973e97c56bf7772cdbf767b98f84122397.tar.bz2 | |
Merge Fix various warnings and issues in doxygen doc generation #994 (#996)
Diffstat (limited to 'hl/src')
| -rw-r--r-- | hl/src/CMakeLists.txt | 29 |
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 () |