/usr/share/vxl/cmake/doxygen.cmake is in libvxl1-dev 1.14.0-14.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | option(BUILD_DOCUMENTATION
"Build doxygen-based code documentation." OFF)
# Dummy stubs to avoid BUILD_DOCUMENTATION ocnditionals around calls.
function(doxygen_add_book)
endfunction(doxygen_add_book)
function(doxygen_add_package)
endfunction(doxygen_add_package)
function(doxygen_add_library)
endfunction(doxygen_add_library)
if(BUILD_DOCUMENTATION)
#-------------------------------------------------------------------
# helper functions
#-------------------------------------------------------------------
# doxygen_add_book(<package> <description>)
#
# - package : package or site (e.g., core, contrib/mul, etc.)
# - description : comment describing the package
#
# Example usage:
#
# doxygen_add_package(contrib/mul
# "Manchester University Libraries overview documentation"
# )
function(doxygen_add_book _book _description)
if(TEXI2HTML_EXECUTABLE)
string(REPLACE / _ bookname ${_book})
file(APPEND "${CMAKE_BINARY_DIR}/doxygen_configuration.cmake"
"set(DOXYGEN_BOOK_LIST \${DOXYGEN_BOOK_LIST} ${_book})\n"
"set(DOXYGEN_${bookname}_BOOK_DESCRIPTION\n"
" \"${_description}\")\n"
)
endif()
endfunction(doxygen_add_book)
# doxygen_add_package(<package> <description>)
#
# - package : package or site (e.g., core, contrib/mul, etc.)
# - description : comment describing the package
#
# Example usage:
#
# doxygen_add_package(contrib/mul
# "Manchester University Libraries"
# )
function(doxygen_add_package _package _description)
string(REPLACE / _ packname ${_package})
file(APPEND "${CMAKE_BINARY_DIR}/doxygen_configuration.cmake"
"set(DOXYGEN_PACKAGE_LIST \${DOXYGEN_PACKAGE_LIST} ${_package})\n"
"set(DOXYGEN_${packname}_DESCRIPTION \"${_description}\")\n"
)
endfunction(doxygen_add_package)
# doxygen_add_library(<lib>
# [DEPENDS <dep1> <dep2> ...]
# [PACKAGE <package>]
# [DESCRIPTION <description>]
# )
#
# - lib : name of library
# - package : package to which it belongs
# - depN : dependencies of this lib
# - description : comment describing the library
#
# Example usage:
#
# doxygen_add_library(contrib/gel/mrc/vpgl
# DEPENDS core/vcsl core/vgl core/vnl core/vbl
# PACKAGE contrib/gel
# DESCRIPTION "Photogrammetry Library"
# )
function(doxygen_add_library _library)
# parse arguments
set(DEPENDS)
set(PACKAGE)
set(DESCRIPTION)
set(active_option)
set(options_list PACKAGE DEPENDS DESCRIPTION)
foreach(arg ${ARGN})
list(FIND options_list ${arg} result)
if(result EQUAL -1)
set(${active_option} ${${active_option}} ${arg})
if(NOT "${active_option}" STREQUAL "DEPENDS")
set(active_option)
endif()
else()
set(active_option ${arg})
endif()
endforeach()
if(NOT PACKAGE)
set(PACKAGE other)
endif()
# start work
set(library ${_library})
string(REPLACE / _ libname ${library})
string(REPLACE / _ packname ${PACKAGE})
get_filename_component(prefix ${library} NAME)
set(prefix ${prefix}_)
# NOTE: tagfiles will be resolved in doxygen_makeall.cmake
set(tagfiles @tagfiles@)
configure_file(
"${DOXYGEN_SCRIPT_DIR}/doxyfile.in"
"${CMAKE_BINARY_DIR}/doxy/output/doxyfile.${libname}"
@ONLY
)
file(APPEND "${CMAKE_BINARY_DIR}/doxygen_configuration.cmake"
"set(DOXYGEN_LIBRARY_LIST\n"
" \${DOXYGEN_LIBRARY_LIST} ${library})\n"
"set(DOXYGEN_${libname}_DEPS \"${DEPENDS}\")\n"
"set(DOXYGEN_${libname}_DESCRIPTION \"${DESCRIPTION}\")\n"
"set(DOXYGEN_${packname}_LIBRARY_LIST\n"
" \${DOXYGEN_${packname}_LIBRARY_LIST} ${library})\n"
)
endfunction(doxygen_add_library)
#-------------------------------------------------------------------
# find packages needed
#-------------------------------------------------------------------
find_package(Doxygen REQUIRED)
find_package(Perl REQUIRED)
find_program(TEXI2HTML_EXECUTABLE texi2html)
if(NOT TEXI2HTML_EXECUTABLE)
message(WARNING "Texi2html not found; no books will be built.")
endif()
find_package(Subversion QUIET)
find_program(PSTOPNM_EXECUTABLE pstopnm)
find_program(PNMTOPNG_EXECUTABLE pnmtopng)
if(PSTOPNM_EXECUTABLE AND PNMTOPNG_EXECUTABLE)
set(NetPBM_FOUND TRUE)
else()
find_package(ImageMagick QUIET COMPONENTS convert)
endif()
#-------------------------------------------------------------------
#
#-------------------------------------------------------------------
# FIXME: Should others be cached?: DOXYGEN_STYLESHEET.
set(DOXYGEN_OUTPUT_DIR "${CMAKE_BINARY_DIR}/doxy"
CACHE PATH "Path to your doxygen output."
)
set(DOXYGEN_INDEX_FILE index.html
CACHE STRING "Name of your multi-lib global index."
)
set(DOXYGEN_MERGE_DOCS_WITH ""
CACHE STRING "Merge documentation to existing index."
)
get_filename_component(DOXYGEN_SCRIPT_DIR
"${CMAKE_CURRENT_LIST_FILE}" PATH
)
set(DOXYGEN_SOURCE_DIR "${CMAKE_SOURCE_DIR}")
set(DOXYGEN_INPUT_FILTER "${DOXYGEN_SCRIPT_DIR}/vxl_doxy.pl")
set(DOXYGEN_STYLESHEET) # FIXME: This is not really used so far...
if(DOXYGEN_DOT_FOUND)
option(DOXYGEN_USE_GRAPHVIZ
"Use graphviz to generate class diagrams" ON)
if(DOXYGEN_USE_GRAPHVIZ)
set(DOXYGEN_USE_DOT YES)
else(DOXYGEN_USE_GRAPHVIZ)
set(DOXYGEN_USE_DOT NO)
endif(DOXYGEN_USE_GRAPHVIZ)
endif(DOXYGEN_DOT_FOUND)
# make configuration loadable when running build_doxygen_doc target
file(WRITE "${CMAKE_BINARY_DIR}/doxygen_configuration.cmake"
"# Doxygen configuration variables for:\n"
"# ${DOXYGEN_SCRIPT_DIR}/doxygen_makeall.cmake\n"
"# *** This is a auto-generated file. DO NOT edit! ***\n"
"\n"
"set(Subversion_FOUND ${Subversion_FOUND})\n"
"set(Subversion_SVN_EXECUTABLE ${Subversion_SVN_EXECUTABLE})\n"
"\n"
"set(PERL_EXECUTABLE ${PERL_EXECUTABLE})\n"
"set(TEXI2HTML_EXECUTABLE ${TEXI2HTML_EXECUTABLE})\n"
"set(NetPBM_FOUND ${NetPBM_FOUND})\n"
"set(PSTOPNM_EXECUTABLE ${PSTOPNM_EXECUTABLE})\n"
"set(PNMTOPNG_EXECUTABLE ${PNMTOPNG_EXECUTABLE})\n"
"set(ImageMagick_FOUND ${ImageMagick_FOUND})\n"
"set(ImageMagick_convert_EXECUTABLE ${ImageMagick_convert_EXECUTABLE})\n"
"\n"
"set(DOXYGEN_EXECUTABLE ${DOXYGEN_EXECUTABLE})\n"
"set(DOXYGEN_OUTPUT_DIR ${DOXYGEN_OUTPUT_DIR})\n"
"set(DOXYGEN_INDEX_FILE ${DOXYGEN_INDEX_FILE})\n"
"set(DOXYGEN_MERGE_DOCS_WITH ${DOXYGEN_MERGE_DOCS_WITH})\n"
"set(DOXYGEN_SCRIPT_DIR ${DOXYGEN_SCRIPT_DIR})\n"
"set(DOXYGEN_SOURCE_DIR ${DOXYGEN_SOURCE_DIR})\n"
"set(DOXYGEN_LIBRARY_LIST)\n"
"set(DOXYGEN_BOOK_LIST)\n"
"\n"
#"set( ${})\n"
)
# prepare header for use by doxygen
set(title "\$title")
configure_file(
"${DOXYGEN_SCRIPT_DIR}/doxy_header.html"
"${CMAKE_BINARY_DIR}/doxy/output/doxy_header.html"
)
#-------------------------------------------------------------------
#
#-------------------------------------------------------------------
if(CMAKE_MINIMUM_REQUIRED_VERSION GREATER 2.6.3)
message(FATAL_ERROR
"config/cmake/doxygen/doxygen.cmake can now use SOURCES option"
"in add_custome_target command; un-comment the hidden code and"
"remove this conditional statement."
)
endif(CMAKE_MINIMUM_REQUIRED_VERSION GREATER 2.6.3)
add_custom_target(build_doxygen_doc
${CMAKE_COMMAND} -P "${DOXYGEN_SCRIPT_DIR}/doxygen_makeall.cmake"
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
COMMENT "Build Doxygen Documentation"
VERBATIM
#SOURCES
# "${DOXYGEN_SCRIPT_DIR}/doxygen.cmake"
# "${DOXYGEN_SCRIPT_DIR}/doxygen_makeall.cmake"
# "${DOXYGEN_SCRIPT_DIR}/doxyfile.in"
# "${DOXYGEN_SCRIPT_DIR}/doxy_header.html"
# "${DOXYGEN_SCRIPT_DIR}/vxl_doxy.pl"
# "${CMAKE_BINARY_DIR}/doxygen_configuration.cmake"
# "${CMAKE_BINARY_DIR}/doxygen_last_build_rev.cmake"
)
endif(BUILD_DOCUMENTATION)
|