IAP GITLAB

Skip to content
Snippets Groups Projects
Commit 73a301df authored by ralfulrich's avatar ralfulrich
Browse files

basic doc setup

parent 8af85bbf
No related branches found
No related tags found
No related merge requests found
...@@ -221,6 +221,7 @@ target_link_libraries ( ...@@ -221,6 +221,7 @@ target_link_libraries (
) )
# those are needed, since some headers (namely GeneratedParticleProperties.inc) are produced by python script from ParticleData.xml # those are needed, since some headers (namely GeneratedParticleProperties.inc) are produced by python script from ParticleData.xml
add_subdirectory (src) add_subdirectory (src)
add_subdirectory (documentation)
# #
# #
#+++++++++++++++++++++++++++++ #+++++++++++++++++++++++++++++
......
find_package (Doxygen OPTIONAL_COMPONENTS dot mscgen dia)
if (DOXYGEN_FOUND)
if (NOT DOXYGEN_DOT_EXECUTABLE)
message (FATAL_ERROR "Found doxygen but not 'dot' command, please install graphviz or set DOXYGEN_DOT_EXECUTABLE")
endif()
set (DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set (DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
set (DOXYGEN_GENERATE_HTML YES)
set (DOXYGEN_GENERATE_MAN YES)
configure_file (${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
message ("Start doxygen with \"make doxygen\"")
# note the option ALL which allows to build the docs together with the application
add_custom_target (doxygen # ALL
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
VERBATIM)
add_custom_command(TARGET doxygen POST_BUILD
COMMAND cd ${CMAKE_CURRENT_BINARY_DIR}/latex; pdflatex refman.tex
)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc OPTIONAL)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf DESTINATION share/doc OPTIONAL)
else (DOXYGEN_FOUND)
message ("Doxygen need to be installed to generate the doxygen documentation")
endif (DOXYGEN_FOUND)
ePROJECT_NAME = CORSIKA 8 PROJECT_NAME = CORSIKA 8
PROJECT_NUMBER = 0.0.0 PROJECT_NUMBER = 0.0.0
GENERATE_HTML = YES GENERATE_HTML = YES
...@@ -6,12 +6,12 @@ GENERATE_LATEX = YES ...@@ -6,12 +6,12 @@ GENERATE_LATEX = YES
GENERATE_XML = YES GENERATE_XML = YES
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/ OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/
INPUT = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@/Framework INPUT = @PROJECT_SOURCE_DIR@/corsika @PROJECT_SOURCE_DIR@/src
EXCLUDE_PATTERNS = */ThirdParty/*/* */build*/corsika/* EXCLUDE_PATTERNS = *.inl
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@
FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.hpp *.dox *.inc *.md FILE_PATTERNS = *.cpp *.hpp *.dox *.md
EXTENSION_MAPPING = inc=C++ EXTENSION_MAPPING = inc=C++
RECURSIVE = YES RECURSIVE = YES
......
Subproject commit c228d89b485ed0fa0822c64d5f12e53e32d2915d Subproject commit c17fc68bd35612e1b610ce2b43e84e91577b8a86
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment