This repository has been archived by the owner on Jun 17, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
added OMSI doxygen generation #107
Open
AlexBayer1991
wants to merge
1
commit into
OpenModelica:master
Choose a base branch
from
AlexBayer1991:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# This script will build the doxygen based documentation for the omsi 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(OmsiRuntimeDoc.config.in | ||
${PROJECT_BINARY_DIR}/OmsiRuntimeDoc.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}/OmsiRuntimeDoc.config | ||
WORKING_DIRECTORY ${TARGET_PATH} | ||
COMMENT "Generating API documentation with Doxygen" VERBATIM | ||
) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file in OMCompiler is called
SimulationRuntime/OMSI/
. Maybe using the same names is better.