-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathDoxyfile
More file actions
227 lines (184 loc) · 5.17 KB
/
Doxyfile
File metadata and controls
227 lines (184 loc) · 5.17 KB
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# Doxyfile for ProXPL Project
# Generated documentation will be in build/docs/
PROJECT_NAME = ProXPL
PROJECT_NUMBER = 1.1.0
PROJECT_BRIEF = "A Modern Programming Language Compiler"
PROJECT_LOGO =
OUTPUT_DIRECTORY = ./docs
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = YES
# Input settings
INPUT = src include
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c *.h
RECURSIVE = YES
# Exclude patterns
EXCLUDE_PATTERNS = */test/* */tests/*
EXCLUDE_SYMBOLS = _*
# Source browsing
SOURCE_BROWSER = YES
VERBATIM_HEADERS = NO
STRIP_CODE_COMMENTS = NO
# HTML output
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_THEME = doxygen
HTML_THEME_PATH =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET =
# LaTeX output (documentation as PDF)
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
# Other output formats
GENERATE_RTF = NO
GENERATE_MAN = YES
GENERATE_XML = NO
GENERATE_DOCBOOK = NO
# Documentation extraction
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_PACKAGE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
# Relationships
INTERNAL_DOCS = NO
FORCE_LOCAL_RANGES = NO
SHOW_INCLUDE_FILES = YES
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = NO
# Source code documentation
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# Dependency graphs
CLASS_DIAGRAMS = YES
HAVE_DOT = YES
DOT_NUM_THREADS = 4
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
DOT_GRAPH_MAX_NODES = 50
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
# Search engine
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
# Preprocessing
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH = ./include
PREDEFINED = DOXYGEN
# Code generation
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
# Documentation style
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
STRICT_PROTO_MATCHING = NO
GENERATE_QUIET = NO
# Output documentation
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_LACKED = NO
WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO
# Markdown support
USE_MDFILE_AS_MAINPAGE = README.md
MARKDOWN_SUPPORT = YES
AUTOLINK_SUPPORT = YES
# Sort
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
SORT_MEMBERS_CTORS_1ST = NO
# Configuration options
LAYOUT_FILE =
# Comment style
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE= NO
SHOW_INCLUDE_FILES = YES
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = NO
SHOW_GROUPED_MEMB_INC = NO
# Max initialization snippet
MAX_INITIALIZERS = 30
# Per-page footer
HTML_DYNAMIC_SECTIONS = YES
HTML_INDEX_NUM_ENTRIES = 100
# Section depth
TOC_EXPAND = NO
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
USE_MATHJAX = YES
MATHJAX_VERSION = MathJax_2
# Collaborator graphs
COLLABORATION_GRAPH = YES
# Include graphs
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
# Call graphs
CALL_GRAPH = NO
CALLER_GRAPH = NO
# Alias configuration
ALIASES =
# User-defined markdown extensions
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
# Cite bibliofile
CITE_BIBLY_FILES =
# Qt assistant format
QHG_LOCATION =
# Eclipse help
ECLIPSE_HELP_PLUGIN =
# Install prefix
INSTALL_PREFIX =
# Repeat brief in detailed docs
REPEAT_BRIEF = YES
# Abbreviate member names in brief descriptions
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# Always hide main page in tree view
SHOW_MAINPAGE_IN_TREE = YES
# BRIEF member descriptions on separate line
BRIEF_MEMBER_DESC = YES
# Multi-line brief descriptions treated as paragraph
BRIEF_MEMBER_DESC_ONLY = NO
# Member definitions and prototypes
ALWAYS_DETAILED_SEC = NO
# Inline docs for defines
INLINE_SIMPLE_STRUCTS = NO
# Typedef before struct
TYPEDEF_HIDES_STRUCT = NO
# Search documentation engine
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =