-
Notifications
You must be signed in to change notification settings - Fork 4
/
documentation.cmake
97 lines (85 loc) · 3.74 KB
/
documentation.cmake
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
################################################################################
#
# T|N.U.N. Build documentation utilities
#
# Copyright (c) 2016. Domagoj saric. All rights reserved.
#
################################################################################
################################################################################
# add_documentation()
#
# Supported configuration variables ('global parameters') and their mappings to
# Doxygen options:
# PSI_DOC_PROJECT_LABEL -> PROJECT_NAME
# PSI_DOC_PROJECT_VERSION -> PROJECT_NUMBER
# PSI_DOC_PROJECT_DESCRIPTION -> PROJECT_BRIEF
# PSI_DOC_PROJECT_LOGO -> PROJECT_LOGO
# PSI_DOC_STAGE_PATH -> OUTPUT_DIRECTORY
# PSI_DOC_HIDE_SCOPE_NAMES -> HIDE_SCOPE_NAMES
# PSI_DOC_ENABLED_SECTIONS -> ENABLED_SECTIONS
# PSI_DOC_SHOW_NAMESPACES -> SHOW_NAMESPACES
# PSI_DOC_SOURCES -> INPUT
# PSI_DOC_SOURCES_TO_EXCLUDE -> EXCLUDE
# PSI_DOC_EXAMPLE_PATH -> EXAMPLE_PATH
# PSI_DOC_FILTER_PATTERNS -> FILTER_PATTERNS
# PSI_DOC_CLANG_ASSISTED_PARSING -> CLANG_ASSISTED_PARSING
# PSI_DOC_EXTRA_DEFINES -> PREDEFINED
################################################################################
set( PSI_dir "${CMAKE_CURRENT_LIST_DIR}" )
macro( PSI_internal_cmake2doxy_boolean boolean )
string( REPLACE "OFF" "NO" ${boolean} ${${boolean}} )
string( REPLACE "ON" "YES" ${boolean} ${${boolean}} )
endmacro()
function( PSI_add_documentation )
# https://cmake.org/pipermail/cmake/2011-January/042313.html
find_package( Doxygen )
if ( NOT DOXYGEN_FOUND )
message( WARNING "Unable to find Doxygen" )
return()
endif()
if ( NOT DEFINED PSI_DOC_STAGE_PATH )
set( PSI_DOC_STAGE_PATH "${PROJECT_BINARY_DIR}/doc" )
endif()
option( PSI_DOC_CLANG_ASSISTED_PARSING "Use Clang for parsing sources when generating the documentation (more accurate but slower)" NO )
if ( PSI_DOC_CLANG_ASSISTED_PARSING )
set( PSI_DOXYGEN_CLANG_OPTIONS "-fms-extensions -fdelayed-template-parsing -fmsc-version=1900 -Wno-ignored-attributes -Wno-multichar -D\"BOOST_PP_CONFIG_FLAGS()\"=1 -DDOXYGEN_ONLY" )
endif()
option( PSI_DOC_SHOW_NAMESPACES YES )
option( PSI_DOC_HIDE_SCOPE_NAMES NO )
# Convert CMake list to a Doxygen-friendly "\ + newline" separated list.
string( REPLACE ";" " \\\n\t" PSI_DOC_SOURCES "${PSI_DOC_SOURCES}" )
PSI_internal_cmake2doxy_boolean( PSI_DOC_SHOW_NAMESPACES )
PSI_internal_cmake2doxy_boolean( PSI_DOC_HIDE_SCOPE_NAMES )
PSI_internal_cmake2doxy_boolean( PSI_DOC_CLANG_ASSISTED_PARSING )
configure_file(
"${PSI_dir}/doxyfile.in"
"${PROJECT_BINARY_DIR}/doxyfile"
)
# Implementation note:
# First remove the intermediate documentation directory to
# ensure clean documentation generation (w/o leftovers from a
# previous build).
# (27.01.2014.) (Domagoj Saric)
add_custom_target( Documentation
COMMAND "${CMAKE_COMMAND}" -E remove_directory "${PSI_DOC_STAGE_PATH}"
COMMAND "${CMAKE_COMMAND}" -E make_directory "${PSI_DOC_STAGE_PATH}/html"
COMMAND "${DOXYGEN_EXECUTABLE}" "${PROJECT_BINARY_DIR}/doxyfile"
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}/../doc"
COMMENT "Doxygen documentation"
SOURCES "${PROJECT_BINARY_DIR}/doxyfile"
#"${PSI_DOC_SOURCES}"
)
set_property( TARGET Documentation PROPERTY EXCLUDE_FROM_ALL false )
install(
DIRECTORY "${PSI_DOC_STAGE_PATH}"
DESTINATION "./"
COMPONENT Documentation
CONFIGURATIONS ${install_configs}
)
install(
FILES "${PSI_dir}/documentation.html"
DESTINATION "./doc"
COMPONENT Documentation
CONFIGURATIONS ${install_configs}
)
endfunction()