TradingApp/Doxyfile at main · MartinSch77/TradingApp · 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
# Doxygen configuration for TradingApp (doxygen 1.9.8). HTML output with
# PlantUML architecture diagrams and the specification/traceability pages.
# Build the docs:   tools/make_docs.sh   →  docs/html/index.html

PROJECT_NAME           = "TradingApp"
PROJECT_BRIEF          = "eToro trading app with a consolidated, costed decision system"
PROJECT_NUMBER         = 1.0.0
OUTPUT_DIRECTORY       = docs
GENERATE_HTML          = YES
HTML_OUTPUT            = html
GENERATE_LATEX         = NO

INPUT                  = src docs/mainpage.md docs/architecture.md \
                         docs/requirements.md docs/design.md docs/test_spec.md \
                         docs/verification.md docs/vmodel.md docs/tools.md \
                         docs/platforms.md docs/windows.md tests README.md \
                         CONTRIBUTING.md SECURITY.md
FILE_PATTERNS          = *.h *.cpp *.md
RECURSIVE              = YES
USE_MDFILE_AS_MAINPAGE = docs/mainpage.md
EXCLUDE_PATTERNS       = */build*/*

# Heading anchors the GitHub way ("### Packaging (desktop)" -> packaging-desktop),
# so an intra-document [text](#anchor) link resolves both on github.com and in
# the generated HTML. Without this doxygen names sections autotoc_mdNN and every
# such link becomes an "unable to resolve reference for \ref" warning. Page-level
# @ref targets (@ref windows, @ref architecture, ...) come from the file name and
# are unaffected. Needs doxygen >= 1.10; older versions ignore the tag with a
# warning and simply keep the old behaviour.
MARKDOWN_ID_STYLE      = GITHUB

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
SOURCE_BROWSER         = YES
GENERATE_TREEVIEW      = YES
QUIET                  = YES
WARN_IF_UNDOCUMENTED   = NO

# Traceability tags used in the test sources; rendered as labelled paragraphs
# and machine-read by tools/trace_report.py.
ALIASES                = "tstid=\par Test case ID:^^" \
                         "verifies=\par Verifies requirement:^^" \
                         "design=\par Design element:^^" \
                         "satisfies=\par Satisfies:^^"

# Diagrams: PlantUML for the architecture pages, Graphviz for code graphs.
PLANTUML_JAR_PATH      = tools/third-party/plantuml.jar
HAVE_DOT               = YES
DOT_IMAGE_FORMAT       = svg
DOT_GRAPH_MAX_NODES    = 70
INTERACTIVE_SVG        = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = NO

# Qt specifics so the parser copes with the macros.
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = Q_OBJECT= "Q_DECLARE_METATYPE(x)=" QT_FORWARD_DECLARE_CLASS(x)= \
                         "signals=public" "slots="

# The generated traceability matrix is shipped alongside the HTML docs; the
# main page links to it. (Regenerate with tools/trace_report.py first.)
HTML_EXTRA_FILES       = docs/traceability.html