feedc0de/sdbus-cpp
1
0
Fork 0
forked from Kistler-Group/sdbus-cpp
Code Pull Requests Activity

Separate doxygen doc building from other docs

Browse Source
This commit is contained in:
Stanislav Angelovic
2019-04-25 13:34:33 +02:00
parent 882262bc2f
commit 824aaa711e
3 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CMakeLists.txt
View File

@ -138,7 +138,8 @@ endif()
# DOCUMENTATION # DOCUMENTATION
#---------------------------------- #----------------------------------
option(BUILD_DOC "Build doxygen documentation for sdbus-c++ API" ON) option(BUILD_DOC "Build documentation for sdbus-c++" ON)
option(BUILD_DOXYGEN_DOC "Build doxygen documentation for sdbus-c++ API" OFF)
if(BUILD_DOC) if(BUILD_DOC)
add_subdirectory("${CMAKE_SOURCE_DIR}/doc") add_subdirectory("${CMAKE_SOURCE_DIR}/doc")

6
README.md
View File

@ -26,7 +26,11 @@ $ sudo make install
* `BUILD_DOC` [boolean] * `BUILD_DOC` [boolean]
Option for building Doxygen documentation of sdbus-c++ API. If `BUILD_DOC` is enabled, the documentation must still be built explicitly through `make doc`. Default value: `ON`. Use `-DBUILD_DOC=OFF` to disable searching for Doxygen and building Doxygen documentation of sdbus-c++ API. Option for including sdbus-c++ documentation files and tutorials. Default value: `ON`. With this option turned on, you may also enable/disable the following option:
* `BUILD_DOXYGEN_DOC` [boolean]
Option for building Doxygen documentation of sdbus-c++ API. If enabled, the documentation must still be built explicitly through `make doc`. Default value: `OFF`. Use `-DBUILD_DOXYGEN_DOC=OFF` to disable searching for Doxygen and building Doxygen documentation of sdbus-c++ API.
* `BUILD_TESTS` [boolean] * `BUILD_TESTS` [boolean]

22
doc/CMakeLists.txt
View File

@ -2,18 +2,20 @@
find_package(Doxygen) find_package(Doxygen)
if(DOXYGEN_FOUND) if(BUILD_DOXYGEN_DOC)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(doc add_custom_target(doc
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen" COMMENT "Generating API documentation with Doxygen"
VERBATIM) VERBATIM)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR} OPTIONAL) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR} OPTIONAL)
else() else()
message(WARNING "Documentation enabled, but Doxygen cannot be found") message(WARNING "Documentation enabled, but Doxygen cannot be found")
endif()
endif() endif()
install(FILES sdbus-c++-class-diagram.png install(FILES sdbus-c++-class-diagram.png