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
|
find_package(Doxygen REQUIRED)
option(ITK_WRAP_DOC_MAN "Generate unix manual pages." ON)
###############################################################################
# store the current dir, so it can be reused later
set(ITK_WRAP_DOC_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}" CACHE INTERNAL "doc source dir")
set(ITK_WRAP_DOC_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}" CACHE INTERNAL "doc binary dir")
###############################################################################
# the var to store the file produced by doxygen
set(ITK_WRAP_DOC_DOXYGEN_INSTALLED_PAGES "" CACHE INTERNAL "man pages produced by doxygen and already installed")
###############################################################################
macro(itk_wrap_module_DOC library_name)
set(ITK_WRAP_DOC_DOXYGEN_HEADERS ) # doxygen headers to process in this lib
set(ITK_WRAP_DOC_DOXYGEN_PAGES ) # pages produced by doxygen in this lib
set(ITK_WRAP_DOC_DOXYGEN_XML_FILES ) # xml files produced by doxygen in this lib
set(ITK_WRAP_DOC_DOCSTRING_FILES ) # swig docstring files produced by doxygen in this lib
endmacro()
###############################################################################
macro(itk_wrap_named_class_DOC class swig_name)
if("${WRAPPER_WRAP_METHOD}" STREQUAL "ENUM")
# doc is not generated in the same way for enum. Just ignore it
set(ITK_WRAP_DOC_GENERATE_DOXY2SWIG_INPUT OFF)
else()
set(ITK_WRAP_DOC_GENERATE_DOXY2SWIG_INPUT OFF)
get_directory_property(dirs INCLUDE_DIRECTORIES)
set(paths )
foreach(dir ${dirs})
list(APPEND paths "${dir}/${swig_name}.h")
endforeach()
file(GLOB doc_path ${paths})
if(doc_path AND "${class}" MATCHES "^itk::")
# store the header
list(APPEND ITK_WRAP_DOC_DOXYGEN_HEADERS "${doc_path}")
# and the produced file
string(REPLACE "::" "_" base_name "${class}")
set(page "${CMAKE_CURRENT_BINARY_DIR}/Doc/man3/${base_name}.3")
set(ITK_WRAP_DOC_DOXYGEN_PAGES "${ITK_WRAP_DOC_DOXYGEN_PAGES};${page}")
# and in install the manpage, if requested, and if not yet installed from another dir
if(ITK_WRAP_DOC_MAN AND NOT "${ITK_WRAP_DOC_DOXYGEN_INSTALLED_PAGES}" MATCHES "(^|;)${base_name}\\.3(;|$)")
WRAP_ITK_INSTALL(/Doc/man3 "${page}")
set(ITK_WRAP_DOC_DOXYGEN_INSTALLED_PAGES ${ITK_WRAP_DOC_DOXYGEN_INSTALLED_PAGES} "${base_name}.3" CACHE INTERNAL "man pages produced by doxygen and already installed")
endif()
# some simple computations to find the xml file produced for this class
string(REGEX REPLACE "([A-Z])" "\\1" xmlname ${class})
string(REGEX REPLACE ":" "_1" xmlname ${xmlname})
string(TOLOWER ${xmlname} xmlname)
list(APPEND ITK_WRAP_DOC_DOXYGEN_XML_FILES "${ITK_BINARY_DIR}/Utilities/Doxygen/xml/class${xmlname}.xml")
# the doxy2swig input
set(ITK_WRAP_DOC_DOXY2SWIG_INPUT "${ITK_WRAP_DOC_DOXY2SWIG_INPUT}\n${ITK_BINARY_DIR}/Utilities/Doxygen/xml/class${xmlname}.xml\t${class}")
set(ITK_WRAP_DOC_GENERATE_DOXY2SWIG_INPUT ON)
endif()
endif()
endmacro()
macro(itk_wrap_one_type_DOC wrap_method wrap_class swig_name template_params)
if(ITK_WRAP_DOC_GENERATE_DOXY2SWIG_INPUT)
set(ITK_WRAP_DOC_DOXY2SWIG_INPUT "${ITK_WRAP_DOC_DOXY2SWIG_INPUT}\t${swig_name}")
endif()
endmacro()
###############################################################################
macro(itk_end_wrap_module_DOC)
# create the target doc dir
set(library_doc_build_dir "${CMAKE_CURRENT_BINARY_DIR}/Doc") # Library documentation interface files building directory
# TODO: direct name of the library dir?
file(MAKE_DIRECTORY ${library_doc_build_dir})
# configure doxygen input file.
# be sure to not include a header several times
if("${ITK_WRAP_DOC_DOXYGEN_HEADERS}")
UNIQUE(headers "${ITK_WRAP_DOC_DOXYGEN_HEADERS}")
endif()
set(library_doxygen_config_file ${library_doc_build_dir}/doxygen.config)
set(ITK_WRAP_DOC_DOXYGEN_HEADERS_FORMATED)
foreach(header ${headers})
set(ITK_WRAP_DOC_DOXYGEN_HEADERS_FORMATED "${ITK_WRAP_DOC_DOXYGEN_HEADERS_FORMATED} \"${header}\"\\\n")
endforeach()
set(ITK_WRAP_DOC_GENERATE_MAN "NO")
if(ITK_WRAP_DOC_MAN)
set(ITK_WRAP_DOC_GENERATE_MAN "YES")
endif()
set(ITK_WRAP_DOC_LIBRARY_DIR "${library_doc_build_dir}")
configure_file("${ITK_WRAP_DOC_SOURCE_DIR}/doxygen.config.in"
"${library_doxygen_config_file}"
@ONLY)
# which files are produced?
set(outputs ${ITK_WRAP_DOC_DOXYGEN_XML_FILES})
if(ITK_WRAP_DOC_MAN)
list(APPEND outputs ${ITK_WRAP_DOC_DOXYGEN_PAGES})
endif()
# run doxygen
add_custom_command(
OUTPUT ${outputs} "${library_doc_build_dir}/xml/combine.xslt" # this file is always produced and avoid an error if ${outputs} is empty
COMMAND "${DOXYGEN_EXECUTABLE}" "${library_doxygen_config_file}"
# WORKING_DIRECTORY ${ITK_WRAP_DOC_BINARY_DIR}
DEPENDS ${ITK_WRAP_DOC_DOXYGEN_HEADERS} "${library_doxygen_config_file}"
COMMENT "-- Wrapping library ${WRAPPER_LIBRARY_NAME}: Constructing documentation xml structure."
)
add_custom_target(${WRAPPER_LIBRARY_NAME}Doxygen ALL DEPENDS ${outputs} ${ITK_WRAP_DOC_DOCSTRING_FILES})
endmacro()
macro(itk_wrap_submodule_DOC module)
set(ITK_WRAP_DOC_DOXY2SWIG_INPUT ) # the c++ name - swig names definitions
endmacro()
###############################################################################
# This macro is called once per module
# Global variable WRAPPER_MODULE_NAME can be used
# in the macro to current module name
#
macro(itk_end_wrap_submodule_DOC)
set(doxy2swig_config_file ${CMAKE_CURRENT_BINARY_DIR}/Doc/${WRAPPER_MODULE_NAME}.conf)
configure_file("${ITK_WRAP_DOC_SOURCE_DIR}/itk_doxy2swig.conf.in"
"${doxy2swig_config_file}"
@ONLY)
# run itk_doxy2swig
set(itk_doxy2swig_py "${ITK_WRAP_DOC_SOURCE_DIR}/itk_doxy2swig.py")
set(swig_doc_interface_file ${WRAPPER_MASTER_INDEX_OUTPUT_DIR}/${WRAPPER_MODULE_NAME}_doc.i)
add_custom_command(
OUTPUT ${swig_doc_interface_file}
COMMAND ${PYTHON_EXECUTABLE} ${itk_doxy2swig_py} ${doxy2swig_config_file} ${swig_doc_interface_file}
DEPENDS ${ITK_WRAP_DOC_DOXYGEN_XML_FILES} ${doxy2swig_config_file} ${itk_doxy2swig_py}
# COMMENT "-- Wrapping library ${WRAPPER_MODULE_NAME}: Generating swig interface for inline documentation."
)
list(APPEND ITK_WRAP_DOC_DOCSTRING_FILES ${swig_doc_interface_file})
endmacro()
|
