lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-08-04 09:42:08 +03:00
Code Activity

cmake: Update doxygen module.

Browse Source
This commit is contained in:
Andreas Schneider
2014-04-09 11:21:29 +02:00
parent 8fe36e3d07
commit d75573e665
1 changed files with 104 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
cmake/Modules/UseDoxygen.cmake
View File

@@ -2,10 +2,18 @@
# #
# Adds a doxygen target that runs doxygen to generate the html # Adds a doxygen target that runs doxygen to generate the html
# and optionally the LaTeX API documentation. # and optionally the LaTeX API documentation.
# The doxygen target is added to the doc target as dependency. # The doxygen target is added to the doc target as a dependency.
# i.e.: the API documentation is built with: # i.e.: the API documentation is built with:
# make doc # make doc
# #
# USAGE: GLOBAL INSTALL
#
# Install it with:
# cmake ./ && sudo make install
# Add the following to the CMakeLists.txt of your project:
# include(UseDoxygen OPTIONAL)
# Optionally copy Doxyfile.in in the directory of CMakeLists.txt and edit it.
#
# USAGE: INCLUDE IN PROJECT # USAGE: INCLUDE IN PROJECT
# #
# set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}) # set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
@@ -13,88 +21,124 @@
# Add the Doxyfile.in and UseDoxygen.cmake files to the projects source directory. # Add the Doxyfile.in and UseDoxygen.cmake files to the projects source directory.
# #
# #
# CONFIGURATION
#
# To configure Doxygen you can edit Doxyfile.in and set some variables in cmake.
# Variables you may define are: # Variables you may define are:
# DOXYFILE_OUTPUT_DIR - Path where the Doxygen output is stored. Defaults to "doc". # DOXYFILE_SOURCE_DIR - Path where the Doxygen input files are.
# # Defaults to the current source directory.
# DOXYFILE_LATEX_DIR - Directory where the Doxygen LaTeX output is stored. Defaults to "latex". # DOXYFILE_EXTRA_SOURCES - Additional source diretories/files for Doxygen to scan.
# # The Paths should be in double quotes and separated by space. e.g.:
# DOXYFILE_HTML_DIR - Directory where the Doxygen html output is stored. Defaults to "html". # "${CMAKE_CURRENT_BINARY_DIR}/foo.c" "${CMAKE_CURRENT_BINARY_DIR}/bar/"
#
# DOXYFILE_OUTPUT_DIR - Path where the Doxygen output is stored.
# Defaults to "${CMAKE_CURRENT_BINARY_DIR}/doc".
#
# DOXYFILE_LATEX - ON/OFF; Set to "ON" if you want the LaTeX documentation
# to be built.
# DOXYFILE_LATEX_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
# the Doxygen LaTeX output is stored. Defaults to "latex".
#
# DOXYFILE_HTML_DIR - Directory relative to DOXYFILE_OUTPUT_DIR where
# the Doxygen html output is stored. Defaults to "html".
# #
# #
# Copyright (c) 2009-2010 Tobias Rautenkranz <tobias@rautenkranz.ch> # Copyright (c) 2009, 2010, 2011 Tobias Rautenkranz <tobias@rautenkranz.ch>
# Copyright (c) 2010 Andreas Schneider <asn@cryptomilk.org>
# #
# Redistribution and use is allowed according to the terms of the New # Redistribution and use is allowed according to the terms of the New
# BSD license. # BSD license.
# For details see the accompanying COPYING-CMAKE-SCRIPTS file. # For details see the accompanying COPYING-CMAKE-SCRIPTS file.
# #
macro(usedoxygen_set_default name value) macro(usedoxygen_set_default name value type docstring)
if(NOT DEFINED "${name}") if(NOT DEFINED "${name}")
set("${name}" "${value}") set("${name}" "${value}" CACHE "${type}" "${docstring}")
endif() endif()
endmacro() endmacro()
find_package(Doxygen) find_package(Doxygen)
if(DOXYGEN_FOUND) if(DOXYGEN_FOUND)
find_file(DOXYFILE_IN find_file(DOXYFILE_IN "Doxyfile.in"
NAMES PATHS "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_ROOT}/Modules/"
doxy.config.in NO_DEFAULT_PATH
PATHS DOC "Path to the doxygen configuration template file")
${CMAKE_CURRENT_SOURCE_DIR} set(DOXYFILE "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
${CMAKE_ROOT}/Modules/ include(FindPackageHandleStandardArgs)
NO_DEFAULT_PATH) find_package_handle_standard_args(DOXYFILE_IN DEFAULT_MSG "DOXYFILE_IN")
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(DOXYFILE_IN DEFAULT_MSG "DOXYFILE_IN")
endif() endif()
if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND) if(DOXYGEN_FOUND AND DOXYFILE_IN_FOUND)
add_custom_target(doxygen ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxy.config) usedoxygen_set_default(DOXYFILE_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doc"
PATH "Doxygen output directory")
usedoxygen_set_default(DOXYFILE_HTML_DIR "html"
STRING "Doxygen HTML output directory")
usedoxygen_set_default(DOXYFILE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}"
PATH "Input files source directory")
usedoxygen_set_default(DOXYFILE_EXTRA_SOURCE_DIRS ""
STRING "Additional source files/directories separated by space")
set(DOXYFILE_SOURCE_DIRS "\"${DOXYFILE_SOURCE_DIR}\" ${DOXYFILE_EXTRA_SOURCES}")
usedoxygen_set_default(DOXYFILE_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}") usedoxygen_set_default(DOXYFILE_LATEX YES BOOL "Generate LaTeX API documentation" OFF)
usedoxygen_set_default(DOXYFILE_HTML_DIR "html") usedoxygen_set_default(DOXYFILE_LATEX_DIR "latex" STRING "LaTex output directory")
set_property(DIRECTORY APPEND PROPERTY mark_as_advanced(DOXYFILE_OUTPUT_DIR DOXYFILE_HTML_DIR DOXYFILE_LATEX_DIR
ADDITIONAL_MAKE_CLEAN_FILES "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_HTML_DIR}") DOXYFILE_SOURCE_DIR DOXYFILE_EXTRA_SOURCE_DIRS DOXYFILE_IN)
set(DOXYFILE_LATEX FALSE)
set(DOXYFILE_PDFLATEX FALSE)
set(DOXYFILE_DOT FALSE)
#find_package(LATEX) set_property(DIRECTORY
#if(LATEX_COMPILER AND MAKEINDEX_COMPILER) APPEND PROPERTY
# set(DOXYFILE_LATEX TRUE) ADDITIONAL_MAKE_CLEAN_FILES
# usedoxygen_set_default(DOXYFILE_LATEX_DIR "latex") "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_HTML_DIR}")
#
# set_property(DIRECTORY APPEND PROPERTY
# ADDITIONAL_MAKE_CLEAN_FILES
# "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
#
# if(PDFLATEX_COMPILER)
# set(DOXYFILE_PDFLATEX TRUE)
# endif()
# if(DOXYGEN_DOT_EXECUTABLE)
# set(DOXYFILE_DOT TRUE)
# endif()
#
# add_custom_command(TARGET doxygen
# POST_BUILD
# COMMAND ${CMAKE_MAKE_PROGRAM}
# WORKING_DIRECTORY "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
#endif()
configure_file(${DOXYFILE_IN} ${CMAKE_CURRENT_BINARY_DIR}/doxy.config ESCAPE_QUOTES IMMEDIATE @ONLY) add_custom_target(doxygen
if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/doxy.trac.in) COMMAND "${DOXYGEN_EXECUTABLE}"
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxy.trac.in ${CMAKE_CURRENT_BINARY_DIR}/doxy.trac ESCAPE_QUOTES IMMEDIATE @ONLY) "${DOXYFILE}"
add_custom_target(doxygen-trac ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxy.trac) COMMENT "Writing documentation to ${DOXYFILE_OUTPUT_DIR}..."
endif() WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
get_target_property(DOC_TARGET doc TYPE) set(DOXYFILE_DOT "NO")
if(NOT DOC_TARGET) if(DOXYGEN_DOT_EXECUTABLE)
add_custom_target(doc) set(DOXYFILE_DOT "YES")
endif() endif()
add_dependencies(doc doxygen) ## LaTeX
set(DOXYFILE_PDFLATEX "NO")
set_property(DIRECTORY APPEND PROPERTY
ADDITIONAL_MAKE_CLEAN_FILES
"${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
if(DOXYFILE_LATEX STREQUAL "ON")
set(DOXYFILE_GENERATE_LATEX "YES")
find_package(LATEX)
find_program(DOXYFILE_MAKE make)
mark_as_advanced(DOXYFILE_MAKE)
if(LATEX_COMPILER AND MAKEINDEX_COMPILER AND DOXYFILE_MAKE)
if(PDFLATEX_COMPILER)
set(DOXYFILE_PDFLATEX "YES")
endif()
add_custom_command(TARGET doxygen
POST_BUILD
COMMAND "${DOXYFILE_MAKE}"
COMMENT "Running LaTeX for Doxygen documentation in ${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}..."
WORKING_DIRECTORY "${DOXYFILE_OUTPUT_DIR}/${DOXYFILE_LATEX_DIR}")
else()
set(DOXYGEN_LATEX "NO")
endif()
else()
set(DOXYFILE_GENERATE_LATEX "NO")
endif()
configure_file("${DOXYFILE_IN}" "${DOXYFILE}" @ONLY)
get_target_property(DOC_TARGET doc TYPE)
if(NOT DOC_TARGET)
add_custom_target(doc)
endif()
add_dependencies(doc doxygen)
endif() endif()