From a139b7a1c660438668f180dbf67b2096c814ae12 Mon Sep 17 00:00:00 2001
From: ralfulrich <ralf.ulrich@kit.edu>
Date: Tue, 21 Aug 2018 10:11:58 +0200
Subject: [PATCH] added pdf documentation
---
Documentation/Doxygen/CMakeLists.txt | 5 +++++
Documentation/Doxygen/Doxyfile.in | 2 +-
corsika.dox | 15 ++++++++++++---
3 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/Documentation/Doxygen/CMakeLists.txt b/Documentation/Doxygen/CMakeLists.txt
index c045db8fd..c12d7f786 100644
--- a/Documentation/Doxygen/CMakeLists.txt
+++ b/Documentation/Doxygen/CMakeLists.txt
@@ -16,7 +16,12 @@ if (DOXYGEN_FOUND)
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)
diff --git a/Documentation/Doxygen/Doxyfile.in b/Documentation/Doxygen/Doxyfile.in
index 3083700bd..e94e89267 100644
--- a/Documentation/Doxygen/Doxyfile.in
+++ b/Documentation/Doxygen/Doxyfile.in
@@ -6,7 +6,7 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../..
EXCLUDE_PATTERN = "*/ThirdParty/*/*"
GENERATE_HTML = YES
-GENERATE_LATEX = NO
+GENERATE_LATEX = YES
FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.dox
RECURSIVE = YES
diff --git a/corsika.dox b/corsika.dox
index 9416fcf60..cf0e6d393 100644
--- a/corsika.dox
+++ b/corsika.dox
@@ -1,8 +1,17 @@
/**
-@mainpage CORSIKA air shower simulations
+@mainpage CORSIKA air shower simulations framework
-Source code documentation and reference guide for the CORSIKA8
-software framework for air shower simulations.
+Documentation and reference guide for the CORSIKA8 software framework
+for air shower simulations. CORSIKA is the most comprehensive
+framework for air shower simulations. CORSIKA is characterized by
+simulating particle cascades in astrophysical environments. The impact
+of stochastic and continuous processes on the cascade development is
+simulated. To boost computational efficiency different techniques are
+provided, like thinning or cascade equations.
+The software makes extensive use of static design patterns and
+compiler optimization. Thus, the most fundamental configuration
+decision of the user must be performed at compile time. At runtime
+only spcific parameters can still be changed.
*/
--
GitLab