Commit 0337061a authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum
Browse files

[ADD] - doxygen doc for core now separate with install target.

parent 97bd672a
......@@ -7,6 +7,7 @@ syntax: glob
# switch to regexp syntax.
syntax: regexp
^doc/core/html
^doc/developer/html
^doc/developer/man
^doc/developer/doxyerror.log
......
......@@ -38,7 +38,7 @@ PROJECT_NUMBER = 1.1+
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = doc/developer/
OUTPUT_DIRECTORY = doc/core/
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
......@@ -519,7 +519,7 @@ FILE_VERSION_FILTER =
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE = doc/developer/doxygenLayout.xml
#LAYOUT_FILE = doc/developer/doxygenLayout.xml
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
......@@ -581,7 +581,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = src
INPUT = src/core
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
......@@ -612,10 +612,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = src/ext \
src/core/common/platformDependent/visualStudio/inttypes.h \
src/modules/lic/fibernavigator \
src/modules/lic/fantom
EXCLUDE = src/core/common/platformDependent/visualStudio/inttypes.h
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
......@@ -791,7 +788,7 @@ GENERATE_HTML = YES
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = htmlFull
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
......@@ -1167,7 +1164,7 @@ RTF_EXTENSIONS_FILE =
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = YES
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
......
......@@ -407,16 +407,6 @@ ADD_CUSTOM_TARGET( doc
VERBATIM
)
# NOTE: this full documentation also includes call/caller graphs, colaboration graphs and nicer inheritance graphs
# but needs "dot" from graphviz to render them.
ADD_CUSTOM_TARGET( fulldoc
COMMAND doxygen ${PROJECT_SOURCE_DIR}/../doc/developer/doxygenConfigFull
COMMAND chmod -R g+r ${PROJECT_SOURCE_DIR}/../doc/developer/htmlFull
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/..
COMMENT "Build verbose doxygen documentation"
VERBATIM
)
# ---------------------------------------------------------------------------------------------------------------------------------------------------
#
# Style
......@@ -464,6 +454,7 @@ ADD_CUSTOM_TARGET( list_install_tarets
COMMAND echo " * install_lib - install only libopenwalnut."
COMMAND echo " * install_modules - install only the compiled modules."
COMMAND echo " * install_dev - install the development headers for libopenwalnut."
COMMAND echo " * install_devdoc - install the development documentation for libopenwalnut."
COMMENT "List installation targets."
)
......@@ -491,6 +482,12 @@ ADD_CUSTOM_TARGET( install_dev
-DCOMPONENT=CORE_DEV
-P ${CMAKE_BINARY_DIR}/cmake_install.cmake
)
ADD_CUSTOM_TARGET( install_devdoc
${CMAKE_COMMAND}
-DCOMPONENT=CORE_DOC
-P ${CMAKE_BINARY_DIR}/cmake_install.cmake
DEPENDS core_devdoc
)
# ---------------------------------------------------------------------------------------------------------------------------------------------------
#
......
......@@ -76,6 +76,21 @@ SETUP_DEV_INSTALL( ${LibName} ${OW_LIBRARY_DIR_RELATIVE} TARGET_H_FILES "include
# Setup tests of this target
SETUP_TESTS( "${TARGET_TEST_FILES}" "${LibName}" "" )
# ---------------------------------------------------------------------------------------------------------------------------------------------------
# Doxygen Release documentation
# ---------------------------------------------------------------------------------------------------------------------------------------------------
# NOTE: this full documentation also includes call/caller graphs, colaboration graphs and nicer inheritance graphs
# but needs "dot" from graphviz to render them.
SET( DEVDOC_DIR "${PROJECT_SOURCE_DIR}/../doc/core/html" )
ADD_CUSTOM_TARGET( core_devdoc
COMMAND doxygen ${PROJECT_SOURCE_DIR}/../doc/core/doxygenConfig
COMMAND chmod -R g+r ${DEVDOC_DIR}
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/..
COMMENT "Build verbose doxygen documentation for core"
VERBATIM
)
# ---------------------------------------------------------------------------------------------------------------------------------------------------
# Copy local resources
# ---------------------------------------------------------------------------------------------------------------------------------------------------
......@@ -89,6 +104,12 @@ SETUP_RESOURCES( "core" "CORE" )
SET( OW_DOC_DIR_RELATIVE "share/doc/libopenwalnut1" )
SETUP_COMMON_DOC( ${OW_DOC_DIR_RELATIVE} "CORE" )
# Also add an install target for this
INSTALL( DIRECTORY ${DEVDOC_DIR}
DESTINATION ${OW_DOC_DIR_RELATIVE}
COMPONENT "CORE_DOC"
)
# ---------------------------------------------------------------------------------------------------------------------------------------------------
# Copy Shaders
# ---------------------------------------------------------------------------------------------------------------------------------------------------
......
......@@ -13,11 +13,14 @@ override_dh_auto_build:
# Invoke standard build mechanism.
#dh_auto_build
# Enable this if you have a multi-core machine. Compiles faster (of course costs more CPU)
# Enable this if you have a multi-core machine and are debugging the debian packages. Disable again for upload.
dh_auto_build -- -j10
# build the core api documentation too
dh_auto_build -- coredoc
override_dh_auto_configure:
# We turn of several build options here to reduce dependencies. Later, several modules are moved to an extra package which then uses cuda/opencl and stuff.
# NOTE: you can uncomment the last line for faster compilation/package debugging.
dh_auto_configure -- -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release \
-DOW_USE_CUDA=OFF\
-DOW_USE_OPENCL=OFF\
......@@ -25,7 +28,7 @@ override_dh_auto_configure:
-DOW_PACKAGE_BUILD=ON\
-DOW_PACKAGE_NOCOPY_LICENSE=ON\
-DOW_PACKAGE_NOLINK_OPENTHREADS=ON\
-DOW_MODULE_TOOLBOX_BASE=OFF -DOW_MODULE_TOOLBOX_EEG=OFF -DOW_MODULE_TOOLBOX_OTHERS=OFF -DOW_MODULE_TOOLBOX_IO=OFF -DOW_MODULE_TOOLBOX_IMAGEPROCESSING=OFF
# -DOW_MODULE_TOOLBOX_BASE=OFF -DOW_MODULE_TOOLBOX_EEG=OFF -DOW_MODULE_TOOLBOX_OTHERS=OFF -DOW_MODULE_TOOLBOX_IO=OFF -DOW_MODULE_TOOLBOX_IMAGEPROCESSING=OFF
override_dh_auto_install:
# libopenwalnut1
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment