From 6dbb689c9d0d9947eb1a16c00278db40a51c117e Mon Sep 17 00:00:00 2001 From: ralfulrich <ralf.ulrich@kit.edu> Date: Fri, 10 Aug 2018 14:24:26 +0200 Subject: [PATCH] also support .dox files --- Documentation/Doxygen/Doxyfile.in | 6 ++++-- ThirdParty/ThirdParty.dox | 28 ++++++++++++++++++++++++++++ corsika.dox | 8 ++++++++ 3 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 ThirdParty/ThirdParty.dox create mode 100644 corsika.dox diff --git a/Documentation/Doxygen/Doxyfile.in b/Documentation/Doxygen/Doxyfile.in index 400b6f2e0..3083700bd 100644 --- a/Documentation/Doxygen/Doxyfile.in +++ b/Documentation/Doxygen/Doxyfile.in @@ -1,12 +1,14 @@ -PROJECT_NAME = CORSIKA8 +PROJECT_NAME = CORSIKA +PROJECT_NUMBER = 8.0.0 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../.. +EXCLUDE_PATTERN = "*/ThirdParty/*/*" GENERATE_HTML = YES GENERATE_LATEX = NO -FILE_PATTERNS = *.cc *.h +FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.dox RECURSIVE = YES SOURCE_BROWSER = YES diff --git a/ThirdParty/ThirdParty.dox b/ThirdParty/ThirdParty.dox new file mode 100644 index 000000000..956b180f5 --- /dev/null +++ b/ThirdParty/ThirdParty.dox @@ -0,0 +1,28 @@ +/** +@page ThirdParty +@tableofcontents + +In the directory ThirdParty we provide simple dependencies. This +minimizes the need to install additional software for the user. Note +the individual copyrights and licences here! + + +@section PhysUnits + +The PhysUnits library is an external dependency included here just for +convenience: + +Original source code from: https://github.com/martinmoene/PhysUnits-CT-Cpp11#references + +Licence: BSL-1.0 (https://github.com/martinmoene/PhysUnits-CT-Cpp11/blob/master/LICENSE_1_0.txt) + +References: https://github.com/martinmoene/PhysUnits-CT-Cpp11#references + + +@section catch2 + +The catch2 unit testing library is from: https://github.com/catchorg/Catch2 +Licence: BSL-1.0 (https://github.com/martinmoene/PhysUnits-CT-Cpp11/blob/master/LICENSE_1_0.txt) +References: https://github.com/catchorg/Catch2 + +*/ diff --git a/corsika.dox b/corsika.dox new file mode 100644 index 000000000..9416fcf60 --- /dev/null +++ b/corsika.dox @@ -0,0 +1,8 @@ +/** +@mainpage CORSIKA air shower simulations + +Source code documentation and reference guide for the CORSIKA8 +software framework for air shower simulations. + + +*/ -- GitLab