OpenImpala/Doxyfile at master · BASE-Laboratory/OpenImpala · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Doxyfile for OpenImpala
# Auto-generated documentation: class hierarchy, dependency graphs, API reference

#---------------------------------------------------------------------------
# Project
#---------------------------------------------------------------------------
PROJECT_NAME           = "OpenImpala"
PROJECT_BRIEF          = "Image-based parallel transport property solver"
PROJECT_NUMBER         = ""
OUTPUT_DIRECTORY       = docs/doxygen
CREATE_SUBDIRS         = NO

#---------------------------------------------------------------------------
# Input
#---------------------------------------------------------------------------
INPUT                  = src/ docs/mainpage.md
FILE_PATTERNS          = *.H *.h *.hpp *.cpp *.cc
RECURSIVE              = YES
EXCLUDE_PATTERNS       = */build/* */external/*
USE_MDFILE_AS_MAINPAGE = docs/mainpage.md

#---------------------------------------------------------------------------
# Parsing
#---------------------------------------------------------------------------
EXTENSION_MAPPING      = H=C++ F90=Fortran
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = YES

#---------------------------------------------------------------------------
# Build
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
PREDEFINED             = __cplusplus \
                         AMREX_SPACEDIM=3 \
                         BL_LANG_CC
EXPAND_ONLY_PREDEF     = NO
SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
# Warnings
#---------------------------------------------------------------------------
WARN_IF_UNDOCUMENTED   = YES
WARN_NO_PARAMDOC       = NO
WARN_AS_ERROR          = NO

#---------------------------------------------------------------------------
# HTML Output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_COLORSTYLE        = LIGHT
SEARCHENGINE           = YES
GENERATE_TREEVIEW      = YES
DISABLE_INDEX          = NO
FULL_SIDEBAR           = NO

#---------------------------------------------------------------------------
# Other Output (disabled)
#---------------------------------------------------------------------------
GENERATE_LATEX         = NO
GENERATE_RTF           = NO
GENERATE_MAN           = NO
GENERATE_XML           = YES
XML_OUTPUT             = xml

#---------------------------------------------------------------------------
# Graphs (requires Graphviz dot)
#---------------------------------------------------------------------------
HAVE_DOT               = YES
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
DIRECTORY_GRAPH        = YES
DOT_GRAPH_MAX_NODES    = 100
MAX_DOT_GRAPH_DEPTH    = 0

#---------------------------------------------------------------------------
# Namespace
#---------------------------------------------------------------------------
HIDE_UNDOC_RELATIONS   = NO
SHOW_INCLUDE_FILES     = YES
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES