Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
OpenVolumeMesh
OpenVolumeMesh
Commits
a66dba8e
Commit
a66dba8e
authored
Sep 02, 2019
by
Martin Heistermann
Browse files
doxygen with standard cmake
parent
703f83f4
Changes
3
Hide whitespace changes
Inline
Side-by-side
CMakeLists.txt
View file @
a66dba8e
...
...
@@ -8,7 +8,7 @@ project (OpenVolumeMesh
HOMEPAGE_URL https://openvolumemesh.org/
)
list
(
APPEND CMAKE_MODULE_PATH
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/cmake"
)
#
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
if
(
${
CMAKE_SOURCE_DIR
}
STREQUAL
${
CMAKE_CURRENT_SOURCE_DIR
}
)
set
(
OVM_STANDALONE_BUILD TRUE
)
...
...
@@ -49,4 +49,4 @@ endif()
#export(PACKAGE OpenVolumeMesh)
list
(
REMOVE_AT CMAKE_MODULE_PATH -1
)
#
list(REMOVE_AT CMAKE_MODULE_PATH -1)
cmake/ACGDoxygen.cmake
deleted
100644 → 0
View file @
703f83f4
# -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 hast 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
if
(
NOT DOXYGEN_FOUND
)
FIND_PACKAGE
(
Doxygen
)
endif
()
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 inetraction 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
)
IF
(
EXISTS
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/doxy.config.in"
)
MESSAGE
(
STATUS
"configured
${
CMAKE_CURRENT_SOURCE_DIR
}
/doxy.config.in -->
${
CMAKE_CURRENT_BINARY_DIR
}
/doxy.config"
)
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
"configured
${
CMAKE_CMAKE_MODULE_PATH
}
/doxy.config.in -->
${
CMAKE_CURRENT_BINARY_DIR
}
/doxy.config"
)
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
(
doc
${
DOXYGEN_EXECUTABLE
}
${
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
)
documentation/CMakeLists.txt
View file @
a66dba8e
...
...
@@ -6,13 +6,30 @@ if (DOXYGEN_FOUND)
set
(
DOXYGEN_IMAGE_PATH
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/images"
)
set
(
DOXYGEN_WARN_IF_UNDOCUMENTED
"FALSE"
)
set
(
DOXYGEN_CITE_BIB_FILES
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/references.bib"
)
set
(
DOXYGEN_STRIP_FROM_PATH
"
${
CMAKE_CURRENT_SOURCE_DIR
}
"
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/../src"
)
set
(
DOXYGEN_STRIP_FROM_INC_PATH
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/../src"
)
set
(
DOXYGEN_FILE_PATTERNS
"*.cc"
"*.hh"
"*.docu"
)
set
(
DOXYGEN_EXAMPLE_PATH
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/examples"
)
set
(
DOXYGEN_EXAMPLE_PATTERNS
"*.cc"
"*.hh"
"*.txt"
".ovm"
)
set
(
DOXYGEN_ENABLED_SECTIONS
"OPENVOLUMEMESH_INTERNAL_DOC"
)
set
(
DOXYGEN_GENERATE_TREEVIEW
"YES"
)
set
(
DOXYGEN_USE_MATHJAX
"YES"
)
#set(DOXYGEN_EXTRA_PACKAGS "amsmath" "amsfonts" "amssymb" "biblatex")
set
(
DOXYGEN_EXCLUDE
# "${CMAKE_BINARY_DIR}"
# "${CMAKE_CURRENT_SOURCE_DIR}/../examples"
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/../src/Unittests"
)
if
(
${
ACG_PROJECT_DATADIR
}
)
set
(
DOXYGEN_OUTPUT_DIRECTORY
"
${
CMAKE_BINARY_DIR
}
/Build/
${
ACG_PROJECT_DATADIR
}
/Doc
/html
"
)
set
(
DOXYGEN_OUTPUT_DIRECTORY
"
${
CMAKE_BINARY_DIR
}
/Build/
${
ACG_PROJECT_DATADIR
}
/Doc"
)
else
()
set
(
DOXYGEN_OUTPUT_DIRECTORY
"
${
CMAKE_BINARY_DIR
}
/Build/share/doc/OpenVolumeMesh"
)
endif
()
doxygen_add_docs
(
${
TARGET_NAME
}
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/.."
)
doxygen_add_docs
(
${
TARGET_NAME
}
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/"
"
${
CMAKE_CURRENT_SOURCE_DIR
}
/../src"
)
endif
()
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
