pestpp/Doxyfile at develop · jtwhite79/pestpp · 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
# Doxyfile for PEST++
# Doxygen generates XML consumed by Breathe/Sphinx for ReadTheDocs.

PROJECT_NAME           = "PEST++"
PROJECT_NUMBER         = 5
PROJECT_BRIEF          = "Parameter ESTimation tool ++ - uncertainty analysis and data assimilation"

OUTPUT_DIRECTORY       = docs/_doxygen

# Input source directories (project code only, not third-party Eigen)
INPUT                  = src/libs/common \
                         src/libs/pestpp_common \
                         src/libs/run_managers \
                         src/programs/gsa \
                         src/programs/pest++ \
                         src/programs/pestpp-da \
                         src/programs/pestpp-ies \
                         src/programs/pestpp-mou \
                         src/programs/pestpp-opt \
                         src/programs/pestpp-sqp \
                         src/programs/sweep

RECURSIVE              = YES
FILE_PATTERNS          = *.cpp *.h

# Exclude third-party libraries
EXCLUDE                = src/libs/Eigen \
                         src/libs/mio \
                         src/libs/propack

EXCLUDE_PATTERNS       = */Eigen/* */mio/* */propack/*

# Extract everything — even undocumented items
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = YES

# Doxygen output: XML only (consumed by Breathe)
GENERATE_HTML          = NO
GENERATE_LATEX         = NO
GENERATE_XML           = YES
XML_OUTPUT             = xml
XML_PROGRAMLISTING     = NO

# Enable Doxygen to follow #include chains
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO

# Source browsing
SOURCE_BROWSER         = NO
INLINE_SOURCES         = NO

# Warnings
WARN_IF_UNDOCUMENTED   = NO
QUIET                  = YES