132 lines
5.6 KiB
CMake
132 lines
5.6 KiB
CMake
# (c) 2014 Copyright ownCloud GmbH
|
|
# Redistribution and use is allowed according to the terms of the BSD license.
|
|
# For details see the accompanying COPYING* file.
|
|
|
|
# -helper macro to add a "doc" target with CMake build system.
|
|
# and configure doxy.config.in to doxy.config
|
|
#
|
|
# target "doc" allows building the documentation with doxygen/dot on WIN32 and Linux
|
|
# Creates .chm windows help file if MS HTML help workshop
|
|
# (available from http://msdn.microsoft.com/workshop/author/htmlhelp)
|
|
# is installed with its DLLs in PATH.
|
|
#
|
|
#
|
|
# Please note, that the tools, e.g.:
|
|
# doxygen, dot, latex, dvips, makeindex, gswin32, etc.
|
|
# must be in path.
|
|
#
|
|
# Note about Visual Studio Projects:
|
|
# MSVS has its own path environment which may differ from the shell.
|
|
# See "Menu Tools/Options/Projects/VC++ Directories" in VS 7.1
|
|
#
|
|
# author Jan Woetzel 2004-2006
|
|
# www.mip.informatik.uni-kiel.de/~jw
|
|
|
|
|
|
FIND_PACKAGE(Doxygen)
|
|
|
|
IF (DOXYGEN_FOUND)
|
|
|
|
# click+jump in Emacs and Visual Studio (for doxy.config) (jw)
|
|
IF (CMAKE_BUILD_TOOL MATCHES "(msdev|devenv)")
|
|
SET(DOXY_WARN_FORMAT "\"$file($line) : $text \"")
|
|
ELSE (CMAKE_BUILD_TOOL MATCHES "(msdev|devenv)")
|
|
SET(DOXY_WARN_FORMAT "\"$file:$line: $text \"")
|
|
ENDIF (CMAKE_BUILD_TOOL MATCHES "(msdev|devenv)")
|
|
|
|
# we need latex for doxygen because of the formulas
|
|
FIND_PACKAGE(LATEX)
|
|
IF (NOT LATEX_COMPILER)
|
|
MESSAGE(STATUS "latex command LATEX_COMPILER not found but usually required. You will probably get warnings and user interaction on doxy run.")
|
|
ENDIF (NOT LATEX_COMPILER)
|
|
IF (NOT MAKEINDEX_COMPILER)
|
|
MESSAGE(STATUS "makeindex command MAKEINDEX_COMPILER not found but usually required.")
|
|
ENDIF (NOT MAKEINDEX_COMPILER)
|
|
IF (NOT DVIPS_CONVERTER)
|
|
MESSAGE(STATUS "dvips command DVIPS_CONVERTER not found but usually required.")
|
|
ENDIF (NOT DVIPS_CONVERTER)
|
|
FIND_PROGRAM(DOXYGEN_DOT_EXECUTABLE_PATH NAMES dot)
|
|
IF (DOXYGEN_DOT_EXECUTABLE_PATH)
|
|
SET(DOXYGEN_DOT_FOUND "YES")
|
|
ENDIF (DOXYGEN_DOT_EXECUTABLE_PATH)
|
|
|
|
IF (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in")
|
|
MESSAGE(STATUS "Generate ${CMAKE_CURRENT_BINARY_DIR}/doxy.config from doxy.config.in")
|
|
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/doxy.config
|
|
@ONLY )
|
|
# use (configured) doxy.config from (out of place) BUILD tree:
|
|
SET(DOXY_CONFIG "${CMAKE_CURRENT_BINARY_DIR}/doxy.config")
|
|
ELSE (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in")
|
|
# use static hand-edited doxy.config from SOURCE tree:
|
|
SET(DOXY_CONFIG "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config")
|
|
IF (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config")
|
|
MESSAGE(STATUS "WARNING: using existing ${CMAKE_CURRENT_SOURCE_DIR}/doxy.config instead of configuring from doxy.config.in file.")
|
|
ELSE (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config")
|
|
IF (EXISTS "${CMAKE_MODULE_PATH}/doxy.config.in")
|
|
# using template doxy.config.in
|
|
MESSAGE(STATUS "Generate ${CMAKE_CURRENT_BINARY_DIR}/doxy.config from doxy.config.in")
|
|
CONFIGURE_FILE(${CMAKE_MODULE_PATH}/doxy.config.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/doxy.config
|
|
@ONLY )
|
|
SET(DOXY_CONFIG "${CMAKE_CURRENT_BINARY_DIR}/doxy.config")
|
|
ELSE (EXISTS "${CMAKE_MODULE_PATH}/doxy.config.in")
|
|
# failed completely...
|
|
MESSAGE(SEND_ERROR "Please create ${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in (or doxy.config as fallback)")
|
|
ENDIF(EXISTS "${CMAKE_MODULE_PATH}/doxy.config.in")
|
|
|
|
ENDIF(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config")
|
|
ENDIF(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in")
|
|
|
|
ADD_CUSTOM_TARGET(csync_doc ${DOXYGEN_EXECUTABLE} ${DOXY_CONFIG} DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/doxy.config)
|
|
|
|
# create a windows help .chm file using hhc.exe
|
|
# HTMLHelp DLL must be in path!
|
|
# fallback: use hhw.exe interactively
|
|
IF (WIN32)
|
|
FIND_PACKAGE(HTMLHelp)
|
|
IF (HTML_HELP_COMPILER)
|
|
SET (TMP "${CMAKE_CURRENT_BINARY_DIR}\\doc\\html\\index.hhp")
|
|
STRING(REGEX REPLACE "[/]" "\\\\" HHP_FILE ${TMP} )
|
|
# MESSAGE(SEND_ERROR "DBG HHP_FILE=${HHP_FILE}")
|
|
ADD_CUSTOM_TARGET(winhelp ${HTML_HELP_COMPILER} ${HHP_FILE})
|
|
ADD_DEPENDENCIES (winhelp doc)
|
|
|
|
IF (NOT TARGET_DOC_SKIP_INSTALL)
|
|
# install windows help?
|
|
# determine useful name for output file
|
|
# should be project and version unique to allow installing
|
|
# multiple projects into one global directory
|
|
IF (EXISTS "${PROJECT_BINARY_DIR}/doc/html/index.chm")
|
|
IF (PROJECT_NAME)
|
|
SET(OUT "${PROJECT_NAME}")
|
|
ELSE (PROJECT_NAME)
|
|
SET(OUT "Documentation") # default
|
|
ENDIF(PROJECT_NAME)
|
|
IF (${PROJECT_NAME}_VERSION_MAJOR)
|
|
SET(OUT "${OUT}-${${PROJECT_NAME}_VERSION_MAJOR}")
|
|
IF (${PROJECT_NAME}_VERSION_MINOR)
|
|
SET(OUT "${OUT}.${${PROJECT_NAME}_VERSION_MINOR}")
|
|
IF (${PROJECT_NAME}_VERSION_PATCH)
|
|
SET(OUT "${OUT}.${${PROJECT_NAME}_VERSION_PATCH}")
|
|
ENDIF(${PROJECT_NAME}_VERSION_PATCH)
|
|
ENDIF(${PROJECT_NAME}_VERSION_MINOR)
|
|
ENDIF(${PROJECT_NAME}_VERSION_MAJOR)
|
|
# keep suffix
|
|
SET(OUT "${OUT}.chm")
|
|
|
|
#MESSAGE("DBG ${PROJECT_BINARY_DIR}/doc/html/index.chm \n${OUT}")
|
|
# create target used by install and package commands
|
|
INSTALL(FILES "${PROJECT_BINARY_DIR}/doc/html/index.chm"
|
|
DESTINATION "doc"
|
|
RENAME "${OUT}"
|
|
)
|
|
ENDIF(EXISTS "${PROJECT_BINARY_DIR}/doc/html/index.chm")
|
|
ENDIF(NOT TARGET_DOC_SKIP_INSTALL)
|
|
|
|
ENDIF(HTML_HELP_COMPILER)
|
|
# MESSAGE(SEND_ERROR "HTML_HELP_COMPILER=${HTML_HELP_COMPILER}")
|
|
ENDIF (WIN32)
|
|
ENDIF(DOXYGEN_FOUND)
|
|
|