b2/Doxyfile at develop · bertiniteam/b2 · 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
# Doxyfile for Bertini 2 -- C++ API reference.
# Only non-default settings are listed; everything else uses Doxygen defaults.

PROJECT_NAME           = "Bertini 2"
PROJECT_BRIEF          = "Numerical algebraic geometry library (C++ core)"
PROJECT_NUMBER         =
OUTPUT_DIRECTORY       = build/docs/cpp
HTML_OUTPUT            = .

INPUT                  = core/include README.md
RECURSIVE              = YES
USE_MDFILE_AS_MAINPAGE = README.md

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO

JAVADOC_AUTOBRIEF      = YES
QT_AUTOBRIEF           = YES
MULTILINE_CPP_IS_BRIEF = NO
INLINE_INHERITED_MEMB  = YES

GENERATE_HTML          = YES
GENERATE_LATEX         = NO
GENERATE_TREEVIEW      = YES
DISABLE_INDEX          = NO
FULL_SIDEBAR           = NO
HTML_COLORSTYLE        = LIGHT

# doxygen-awesome-css is fetched in CI and these paths are wired up there.
HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css \
                         doxygen-awesome-css/doxygen-awesome-sidebar-only.css
HTML_EXTRA_FILES       = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
                         doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
                         doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
                         doxygen-awesome-css/doxygen-awesome-interactive-toc.js

HAVE_DOT               = YES
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
COLLABORATION_GRAPH    = YES
CLASS_GRAPH            = YES

QUIET                  = YES
WARN_IF_UNDOCUMENTED   = NO
WARN_NO_PARAMDOC       = NO

# Don't error on a few patterns common in template-heavy code.
ALIASES                =
PREDEFINED             = BMP_EXPRESSION_TEMPLATES \
                         BERTINI_HAVE_EIGEN

EXCLUDE_PATTERNS       = */test/* \
                         */tests/* \
                         */build/* \
                         */bld/* \
                         */dist/* \
                         */wheelhouse/*

GENERATE_TODOLIST      = NO
GENERATE_TESTLIST      = NO
SHOW_USED_FILES        = NO