diff --git a/documentation/SphinxDoxfile b/documentation/SphinxDoxfile new file mode 100644 index 0000000000000000000000000000000000000000..92ec04c866826a94d2ba1a2548215047d67329a3 --- /dev/null +++ b/documentation/SphinxDoxfile @@ -0,0 +1,49 @@ +PROJECT_NAME = CORSIKA 8 +PROJECT_NUMBER = 0.0.0 +PROJECT_BRIEF = "The framework to simulate particle cascades for astroparticle physics" + +GENERATE_HTML = YES +GENERATE_LATEX = YES +GENERATE_XML = YES + +OUTPUT_DIRECTORY = /home/augalves/Development/Release/CORSIKA/corsika_proj/documentation/ +INPUT = /home/augalves/Development/Release/CORSIKA/corsika/corsika /home/augalves/Development/Release/CORSIKA/corsika/src /home/augalves/Development/Release/CORSIKA/corsika_proj/corsika +EXCLUDE_PATTERNS = *.inl +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = /home/augalves/Development/Release/CORSIKA/corsika + +FILE_PATTERNS = *.cpp *.hpp *.dox *.md *.inc +EXTENSION_MAPPING = inc=C++ +RECURSIVE = YES + +SOURCE_BROWSER = YES +# INLINE_SOURCES +GENERATE_TREEVIEW = YES + +CLASS_DIAGRAMS = NO +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +UML_LOOK = NO +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +GENERATE_LEGEND = YES + +USE_MATHJAX = YES +MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols + +#JAVADOC_BANNER = YES +JAVADOC_AUTOBRIEF = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = YES +MULTILINE_CPP_IS_BRIEF = YES +MARKDOWN_SUPPORT = YES +BUILTIN_STL_SUPPORT = YES + +#CLANG_ASSISTED_PARSING = YES +#CLANG_DATABASE_PATH = /home/augalves/Development/Release/CORSIKA/corsika_proj/documentation/ +#CLANG_OPTIONS = "-std=c++17" + +SEARCHENGINE = YES