blob: f70b975127f7c6089af66ea0c815aade231aacdc (
plain)
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
|
# General configuration
PROJECT_NAME = fbgl
PROJECT_NUMBER = 0.1.0
PROJECT_BRIEF = "Documentation for the fbgl library"
OUTPUT_DIRECTORY = docs
CREATE_SUBDIRS = YES
OPTIMIZE_OUTPUT_FOR_C = YES
GENERATE_HTML = YES
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
GENERATE_XML = NO
# Input sources
INPUT = fbgl.h README.md
FILE_PATTERNS = *.h README.md
RECURSIVE = NO
EXCLUDE_PATTERNS = test/*
# Markdown support
USE_MDFILE_AS_MAINPAGE = README.md
MARKDOWN_SUPPORT = YES
# Extract documentation
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
# Source browsing
SOURCE_BROWSER = YES
INLINE_SOURCES = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
# Documentation styling for m.css
HTML_OUTPUT = html
HTML_EXTRA_STYLESHEET =
"mcss/css/m-dark.compiled.css" \
"mcss/css/m-documentation.compiled.css"
HTML_HEADER = "header.html"
HTML_FOOTER = "footer.html"
HTML_STYLESHEET =
HTML_DYNAMIC_SECTIONS = YES
GENERATE_TREEVIEW = YES
# Warnings
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
# Extra configurations
ALIASES = "note=\par\textbf{Note:}"
ALIASES += "todo=\par\textbf{TODO:}"
ALIASES += "bug=\par\textbf{Bug:}"
EXCLUDE_SYMBOLS = "*Test*"
# Graph and diagram support
HAVE_DOT = YES
DOT_GRAPH_MAX_NODES = 50
DOT_TRANSPARENT = YES
DOT_IMAGE_FORMAT = svg
CALL_GRAPH = YES
CALLER_GRAPH = YES
CLASS_DIAGRAMS = YES
DOT_MULTI_TARGETS = YES
|
