third_party/exiv2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CMake: control doc generation with a new CMake option

Browse Source
This commit is contained in:
Luis Diaz Mas 2018-06-06 19:53:02 +02:00 committed by Luis Díaz Más
parent 211a7a3edd
commit 71638014a3
3 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CMakeLists.txt
View File

@ -49,6 +49,7 @@ option( EXIV2_BUILD_SAMPLES "Build sample applications"
option( EXIV2_BUILD_PO "Build translations files" OFF )
option( EXIV2_BUILD_EXIV2_COMMAND "Build exiv2 command-line executable" ON )
option( EXIV2_BUILD_UNIT_TESTS "Build unit tests" OFF )
option( EXIV2_BUILD_DOC "Add 'doc' target to generate documentation" OFF )
# Only intended to be used by Exiv2 developers/contributors
option( EXIV2_TEAM_EXTRA_WARNINGS "Add more sanity checks using compiler flags" OFF )
@ -88,7 +89,12 @@ endif()
include(config/findDependencies.cmake REQUIRED)
include(config/compilerFlags.cmake REQUIRED)
include(config/generateConfigFile.cmake REQUIRED)
include(config/generateDoc.cmake REQUIRED)
if (EXIV2_BUILD_DOC)
include(config/generateDoc.cmake REQUIRED)
generate_documentation("${PROJECT_SOURCE_DIR}/config/Doxyfile.in")
endif()
include_directories(${CMAKE_BINARY_DIR}) # Make the exv_conf.h file visible for the full project

12
config/generateDoc.cmake
View File

@ -4,6 +4,8 @@
# target "doc" allows building the documentation with doxygen/dot on WIN32, Linux and Mac
#
find_package(Doxygen REQUIRED dot)
macro(generate_documentation DOX_CONFIG_FILE)
if(NOT EXISTS "${DOX_CONFIG_FILE}")
message(FATAL_ERROR "Configuration file for doxygen not found")
@ -23,13 +25,3 @@ macro(generate_documentation DOX_CONFIG_FILE)
set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES doc)
endmacro()
find_package(Doxygen)
if(DOXYGEN_FOUND AND DOXYGEN_DOT_EXECUTABLE)
message(STATUS "Doxygen and dot found. Adding 'doc' target for generating the documentation")
generate_documentation("${PROJECT_SOURCE_DIR}/config/Doxyfile.in")
else()
message(STATUS "doxygen or dot not found. Both commands are needed for the adding the 'doc' target")
endif()

2
config/printSummary.cmake
View File

@ -62,7 +62,7 @@ OptionOutput( "Building exiv2 command: " EXIV2_BUILD_EXIV2_COMMAND
OptionOutput( "Building samples: " EXIV2_BUILD_SAMPLES )
OptionOutput( "Building PO files: " EXIV2_BUILD_PO )
OptionOutput( "Building unit tests: " EXIV2_BUILD_UNIT_TESTS )
OptionOutput( "Doxygen doc: " DOXYGEN_FOUND AND DOXYGEN_DOT_EXECUTABLE )
OptionOutput( "Building doc: " EXIV2_BUILD_DOC )
OptionOutput( "Using ccache: " BUILD_WITH_CCACHE )