From 5aaed4d58db4756ca885146ff6b4c8341e9d2848 Mon Sep 17 00:00:00 2001 From: ralfulrich <ralf.ulrich@kit.edu> Date: Tue, 29 Jan 2019 13:53:50 +0100 Subject: [PATCH] doxygen --- COAST/README.md | 11 +++++++++-- Documentation/Doxygen/Doxyfile.in | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/COAST/README.md b/COAST/README.md index 215d5f10c..634854a19 100644 --- a/COAST/README.md +++ b/COAST/README.md @@ -1,7 +1,14 @@ +# COAST interface {#COASTinterface} + +With the COAST interface of CORSIKA 8 you can write a CORSIKA 8 +"process" class and link it to CORSIKA 7. This can be very powerful to +benchmark new CORSIKA 8 physics code in the context of "old" CORSIKA 7 +simulations. + This is based on corsika7/trunk/coast/CoastOptions/example with an -additional interface to CORSIKA8. +additional interface to CORSIKA 8. -This is an example for a "COAST user library" using CORSIKA8 +We provide a step-by-step example for a "COAST user library" using CORSIKA 8 technology. It explains the steps, how to use the COAST_USER_LIB option of CORSIKA together with CORSIKA8/COAST diff --git a/Documentation/Doxygen/Doxyfile.in b/Documentation/Doxygen/Doxyfile.in index 47bcf61eb..4606124de 100644 --- a/Documentation/Doxygen/Doxyfile.in +++ b/Documentation/Doxygen/Doxyfile.in @@ -8,7 +8,7 @@ EXCLUDE_PATTERNS = */ThirdParty/*/* GENERATE_HTML = YES GENERATE_LATEX = YES -FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.dox *.inc +FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.dox *.inc *.md EXTENSION_MAPPING = inc=C++ RECURSIVE = YES -- GitLab