Skip to content

Commit

Permalink
- doxygen template added to documentation
Browse files Browse the repository at this point in the history
- cpp-runtime documentation added
- .gitignore-file added
  • Loading branch information
Marcus Walther committed Aug 6, 2015
1 parent 826515e commit 2fe3abf
Show file tree
Hide file tree
Showing 8 changed files with 3,984 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
SimulationRuntime/cpp/CMakeFiles
SimulationRuntime/cpp/Doc
52 changes: 52 additions & 0 deletions SimulationRuntime/cpp/CMakeLists.txt
@@ -0,0 +1,52 @@
# This script will build the doxygen based documentation for the c++ simulation runtime
#
# The following variables are used to modify the configuration file of doxygen.
#
# TEMPLATE_ROOT_DIR the root folder for all html and css files that define the layout and style
# IMAGE_ROOT_DIR path to the root folder containing the images
# SOURCE_ROOT_DIR path to the folder of the simulation runtime code
# ADDITIONAL_DOC_ROOT_DIR path to the folder containing additional doxygen files
#
# The behaviour can be influenced by passing arguments to CMAKE
# if write output should be handled in parallel -DSOURCE_ROOT=PATH
# if ScoreP should be used for performance analysis -DTARGET_PATH=PATH
#

CMAKE_MINIMUM_REQUIRED (VERSION 2.8.6)
PROJECT(CppSolverInterface)
set(CMAKE_VERBOSE_MAKEFILE ON)
LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/CMake")

MESSAGE(STATUS "CMake version ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}")

FIND_PACKAGE(Doxygen)

IF(NOT(SOURCE_ROOT))
MESSAGE(FATAL_ERROR "Please specify the root directory of the c++ sources.")
ENDIF(NOT(SOURCE_ROOT))
SET(SOURCE_ROOT_DIR ${SOURCE_ROOT})

IF(NOT(TARGET_PATH))
MESSAGE(STATUS "Target path was not set, so the current binary dir is used.")
SET(TARGET_PATH ${CMAKE_CURRENT_BINARY_DIR})
ENDIF(NOT(TARGET_PATH))

SET(TEMPLATE_ROOT_DIR "../../doxygen")
SET(IMAGE_ROOT_DIR "./Images")
SET(ADDITIONAL_DOC_ROOT_DIR "./")

if (NOT DOXYGEN_FOUND)
message(FATAL_ERROR "Doxygen is needed to build the documentation. Please install it correctly")
endif()
MESSAGE(STATUS "Build the documentation with Doxygen")
#-- Configure the Template Doxyfile for our specific project
configure_file(CppRuntimeDoc.config.in
${PROJECT_BINARY_DIR}/CppRuntimeDoc.config @ONLY IMMEDIATE)
#-- Add a custom target to run Doxygen when ever the project is built
add_custom_target (Docs ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/CppRuntimeDoc.config
WORKING_DIRECTORY ${TARGET_PATH}
COMMENT "Generating API documentation with Doxygen" VERBATIM
)
# IF you do NOT want the documentation to be generated EVERY time you build the project
# then leave out the 'ALL' keyword from the above command.

0 comments on commit 2fe3abf

Please sign in to comment.