diff --git a/Documentation/Doxygen/CMakeLists.txt b/Documentation/Doxygen/CMakeLists.txt index c045db8fd696f3bffd8cccb2ceddeef4ce7063ce..c12d7f7869a6856f2a97589e7752a9d00b12124a 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 3083700bd447f1fbc0968c856846f4868544f668..e94e892677be0d29ed58c405848006624fb29f07 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 9416fcf60d97b199e6381bcb6defc58cad71c99a..cf0e6d393182618ba93c65a99eec5dd0781debe5 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. */