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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
#
# Build the documentation
#
include (${CMAKE_ROOT}/Modules/Documentation.cmake)
mark_as_advanced(BUILD_DOCUMENTATION)
if (BUILD_DOCUMENTATION)
# -------------------------------------------------------------
#
# Generate Doxygen configuration file in all configuration file
#
if( ${DOXYGEN_DOT_FOUND} )
set( ITK_HAVE_DOT "YES" )
else()
set( ITK_HAVE_DOT "NO" )
endif()
set( DOX_MODULE_LIST ${ITK_MODULES_ENABLED} )
foreach(itk-module ${DOX_MODULE_LIST})
if(${itk-module}_IS_TEST)
list( APPEND DOXYGEN_TEST_DIRS "\"${${itk-module}_SOURCE_DIR}\" \\\n ")
else()
if( EXISTS ${${itk-module}_SOURCE_DIR}/include )
list( APPEND DOXYGEN_INCLUDE_DIRS "\"${${itk-module}_SOURCE_DIR}/include\" \\\n")
endif()
endif()
endforeach()
list( APPEND DOXYGEN_TEST_DIRS "\"${ITK_SOURCE_DIR}/Examples\" \\\n")
list( APPEND DOXYGEN_TEST_DIRS "\"${ITK_SOURCE_DIR}\" \\\n")
list( APPEND DOXYGEN_TEST_DIRS " \"${ITK_SOURCE_DIR}/Modules/Remote\"\n")
# By definition DOXYGEN_TEST_DIRS can not be empty. In the worst case if
# BUILD_TESTING is turned OFF, there are at least 3 strings in
# DOXYGEN_TEST_DIRS: ${ITK_SOURCE_DIR}/Examples, ${ITK_SOURCE_DIR},
# and ${ITK_SOURCE_DIR}/Modules/Remote
string( REPLACE ";" " \\\\n" DOXYGEN_TEST_DIRS ${DOXYGEN_TEST_DIRS} )
list( LENGTH DOXYGEN_INCLUDE_DIRS _doxygen_include_dirs_size )
if( ${_doxygen_include_dirs_size} GREATER 0 )
# replace ";" in the string by space+backslash+newline
string( REPLACE ";" " \\\\n" DOXYGEN_INCLUDE_DIRS ${DOXYGEN_INCLUDE_DIRS} )
endif()
#
# Configure the script and the doxyfile, then add target
#
set( ITK_DOXYGEN_OUTPUT_DIR ${ITK_BINARY_DIR}/Utilities/Doxygen )
set( ITK_DOXYGEN_INPUT ${DOXYGEN_INCLUDE_DIRS} )
SET( ITK_DOXYGEN_DIAGRAMS YES )
option( ITK_DOXYGEN_HTML "Doxygen will generate HTML Output" ON )
option( ITK_DOXYGEN_DOCSET "Doxygen will generate additional index files for Xcode 3" OFF )
option( ITK_DOXYGEN_CHM "Doxygen will generate Microsoft HTML help" OFF )
option( ITK_DOXYGEN_QHP "Doxygen will generate Qt Compressed Help" OFF )
option( ITK_DOXYGEN_ECLIPSEHELP "Doxygen will generate Eclipse help plugin" OFF )
option( ITK_DOXYGEN_LATEX "Doxygen will generate LaTeX output" OFF )
option( ITK_DOXYGEN_RTF "Doxygen will generate RTF output optimized for Word 97" OFF )
option( ITK_DOXYGEN_XML "Doxygen will generate XML output" OFF )
mark_as_advanced( ITK_DOXYGEN_HTML
ITK_DOXYGEN_DOCSET
ITK_DOXYGEN_CHM
ITK_DOXYGEN_QHP
ITK_DOXYGEN_ECLIPSEHELP
ITK_DOXYGEN_LATEX
ITK_DOXYGEN_RTF
ITK_DOXYGEN_XML
)
set( ITK_DOXYGEN_OUTPUT
HTML
DOCSET
CHM
QHP
ECLIPSEHELP
LATEX
RTF
XML
)
foreach( var ${ITK_DOXYGEN_OUTPUT} )
if( ITK_DOXYGEN_${var} )
set( ITK_DOXYGEN_GEN_${var} "YES" )
else()
set( ITK_DOXYGEN_GEN_${var} "NO" )
endif()
endforeach()
find_package( Perl )
if( PERL_FOUND )
set( ITK_DOXYGEN_INPUT_FILTER
"${PERL_EXECUTABLE} ${ITK_BINARY_DIR}/Utilities/Doxygen/itkdoxygen.pl" )
configure_file(${ITK_SOURCE_DIR}/Utilities/Doxygen/itkdoxygen.pl.in
${ITK_BINARY_DIR}/Utilities/Doxygen/itkdoxygen.pl)
else()
set( ITK_DOXYGEN_INPUT_FILTER )
endif()
# When updating Doxygen versions, also re-run workbox-sw to regenerate the
# service worker pre-cache. Do this by running:
#
# npm install -g workbox-cli
# cd ITK-Doxygen-build
# make Documentation
# cd Utilites/Doxygen
# workbox inject:manifest
# cp ./html/serviceWorker.js ~/src/ITK/Utilies/Doxygen/
#
# If workbox has changed version, we also need to update workbox-sw.prod*.js
# referenced below
#file(COPY workbox-cli-config.js serviceWorker.js.in
# DESTINATION ${ITK_BINARY_DIR}/Utilities/Doxygen/)
configure_file(${ITK_SOURCE_DIR}/Utilities/Doxygen/doxygen.config.in
${ITK_BINARY_DIR}/Utilities/Doxygen/doxygen.config)
set( ITK_DOXYGEN_OUTPUT_DIR ${ITK_BINARY_DIR}/temp )
set( ITK_DOXYGEN_INPUT "\"INPUT_SINGLE_FILE\"" )
set( ITK_DOXYGEN_DIAGRAMS NO )
configure_file(${ITK_SOURCE_DIR}/Utilities/Doxygen/doxygen.config.in
${ITK_BINARY_DIR}/single-doxygen.config)
# -------------------------------------------------------------
find_package( LATEX )
if( NOT LATEX_COMPILER )
message( "Warning: LaTeX not found. Formulas will not be generated in documentation." )
endif()
# Custom command to generate a examples page which include all ITK examples
add_custom_command( OUTPUT "${ITK_BINARY_DIR}/Documentation/Doxygen/Examples.dox"
COMMAND ${CMAKE_COMMAND} -D "PROJECT_SOURCE_DIR:PATH=${ITK_SOURCE_DIR}"
-D "OUTPUT_FILE:PATH=${ITK_BINARY_DIR}/Documentation/Doxygen/Examples.dox"
-P "${ITK_SOURCE_DIR}/Utilities/Doxygen/GenerateExamplesDox.cmake"
WORKING_DIRECTORY "${ITK_SOURCE_DIR}/Examples"
DEPENDS "${ITK_SOURCE_DIR}/Examples" "${ITK_SOURCE_DIR}/Utilities/Doxygen/GenerateExamplesDox.cmake"
)
add_custom_target(Documentation ALL
COMMAND ${DOXYGEN_EXECUTABLE} ${ITK_BINARY_DIR}/Utilities/Doxygen/doxygen.config
MAIN_DEPENDENCY ${ITK_BINARY_DIR}/Utilities/Doxygen/doxygen.config
DEPENDS ${ITK_BINARY_DIR}/Utilities/Doxygen/itkdoxygen.pl
DEPENDS ${ITK_BINARY_DIR}/Documentation/Doxygen/Examples.dox
WORKING_DIRECTORY ${ITK_BINARY_DIR}/Utilities/Doxygen
)
# Somehow the logo image is not copied into the html folder.
# Here we ensure that the logo image ends up in the right directory
# where html pages could find it.
add_custom_command(TARGET Documentation
POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy
${ITK_SOURCE_DIR}/Documentation/Art/itkLogoSmall.jpg # logo
${ITK_DOXYGEN_OUTPUT_DIR}/html # output doxygen directory
)
message( STATUS
"To generate Doxygen's documentation, you need to build the Documentation target"
)
endif (BUILD_DOCUMENTATION)
|
