-
Notifications
You must be signed in to change notification settings - Fork 0
/
DoxySfile
442 lines (435 loc) · 22.4 KB
/
DoxySfile
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# DoxySfile 1.1.5.0 ShortConfig -- Do not remove or edit this line please --
#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = CPAF
PROJECT_NUMBER =
INPUT = CBSIntroduction.page cpaf_mainpage.page example_cpaf_projects cpaf_libs
OUTPUT_DIRECTORY = ./build_cbs/CPAF-Documentation
GENERATE_DOXYS_HELP = YES
HTML_FILE_EXTENSION = .html
CUSTOM_DIR = ./common/DoxySCustom
SERVER_STATISTICS =
HTML_HELP_SERVER_PATH =
STRIP_CODE_COMMENTS = YES
#---------------------------------------------------------------------------
# Special options (rarely changed)
#---------------------------------------------------------------------------
DELETE_OUTPUT_DIRECTORY = YES
MS_DOT_NET_INTEGRATION = NO
MS_DOT_NET_INTEGRATION_PATH =
GENERATE_HTMLHELP1 = NO
GENERATE_STATISTICS = YES
USE_ONFOCUS_TO_LINKS = NO
#---------------------------------------------------------------------------
# Search page options
#---------------------------------------------------------------------------
CREATE_SEARCHPAGE = YES
SEARCH_BRIEF_DESCRIPTION = YES
SEARCH_FUNCTIONS = YES
SEARCH_VARIABLES = YES
SEARCH_TYPEDEFS_ETC = YES
AUTO_KEYWORD_LIMIT = 2
#---------------------------------------------------------------------------
# Specify what is included in the output
#---------------------------------------------------------------------------
CREATE_DOC_FOR_FILES = YES
CREATE_SOURCECODE_FOR_FILES = YES
CREATE_SOURCECODE_FOR_MEMBERS = YES
EXTRACT_PRIVATE = YES
EXTRACT_PROTECTED = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
HIDE_UNDOC_NAMESPACES = NO
HIDE_UNDOC_CLASSES = NO
HIDE_UNDOC_STRUCTS = NO
HIDE_UNDOC_UNIONS = NO
HIDE_UNDOC_FUNCTIONS = NO
HIDE_UNDOC_VARIABLES = NO
HIDE_UNDOC_ENUMS = NO
HIDE_UNDOC_ENUM_VALUES = NO
HIDE_UNDOC_TYPEDEFS = NO
HIDE_UNDOC_MACROS = NO
HIDE_UNDOC_DEFINES = YES
GENERATE_TODOLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST = YES
#---------------------------------------------------------------------------
# Customize how the documentation is generated
#---------------------------------------------------------------------------
MEMBER_SAME_FILE_RELATE_TO_CLASSES = YES
MEMBER_SAME_FILE_RELATE_TO_STRUCTS = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
INTERNAL_DOCS = NO
SHOW_KEYWORDS_SECTION = NO
TODO_DOCS = YES
INHERIT_DOCS = YES
HIDE_CLASS_METHODS_IN_OVERVIEW = NO
CONCATENATE_DECL_AND_DEFINITION_DOC = YES
#---------------------------------------------------------------------------
# Controlling the DocParser (wiki style parser)
#---------------------------------------------------------------------------
PAGE_DOCUMENTATION_MODE = NO
ENABLE_HARD_SOFT_LINE_BREAKS = YES
#---------------------------------------------------------------------------
# Options to control how the input is parsed
#---------------------------------------------------------------------------
HIDE_IN_BODY_DOCS = NO
TAB_SIZE = 4
ALIASES =
ENABLED_SECTIONS =
IGNORE_CLASS_PREFIX =
AUTO_BRIEF_ENDS_AT_FIRST_NEWLINE = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
MESSAGE_LEVEL_SCREEN = Messages Warnings
OUTPUT_PATTERNS_SCREEN = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile
OUTPUT_PREFIX_LEVEL_SCREEN = Warnings Errors
OUTPUT_PREFIX_PATTERNS_SCREEN =
MESSAGE_LEVEL_HTML_FILE = Messages Warnings Errors
OUTPUT_PATTERNS_HTML_FILE = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown
MESSAGE_SCREEN_LOGFILE =
QUIET = NO
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
IGNORE_FILE_NAME = DoxyS.ignore
FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.page *.dir *.dxd *.doc
RECURSIVE = YES
EXCLUDE = ./build_cbs/CPAF-Documentation
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
SIMPLE_REPLACE_FILTER =
#---------------------------------------------------------------------------
# Configuration options related to which tabs are shown
#---------------------------------------------------------------------------
DIR_TAB_SHOW_GLOBALS = YES
DIR_TAB_SHOW_GROUPS = YES
#---------------------------------------------------------------------------
# Options to control whether the various list displayed are alphabetized (sorted)
#---------------------------------------------------------------------------
SORT_GROUPS = YES
SORT_GROUP_MEMBERS = YES
#---------------------------------------------------------------------------
# Configuration options related to groups
#---------------------------------------------------------------------------
GROUP_DUMMY_PLACEHOLDER_OPTION = YES
#---------------------------------------------------------------------------
# Configuration options related to the HTML layout
#---------------------------------------------------------------------------
NAVIGATION_CHAR_LENGTH = 25
LIMIT_COMPACT_IN_OVERVIEW_TABLES = 100
COLS_IN_OVERVIEW_TABLES = 4
LIMIT_ALFA_INDEX_IN_OVERVIEW_TABLES = 200
COMPACT_CHAR_LENGTH = 25
INFO_ON_OVERVIEW_TABLES_NORMAL = YES
INFO_ON_OVERVIEW_TABLES_COMPACT = YES
INFO_ON_CODE_LINKS = YES
INCLUDE_BRIEF_IN_HEADER = YES
INCLUDE_BRIEF_IN_DESCRIPTION = YES
HIDE_TYPE_ON_DESCRIPTION = NO
EXPAND_COLLAPSE_SECTIONS = YES
EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY = YES
CENTER_ALIGN_IMAGES = NO
OPTIMIZE_OUTPUT_FOR_C = NO
SHOW_PATH_IN_HEADER = YES
FUNCTION_POINTER_NAME =
FUNCTION_POINTERS_NAME =
EXAMPLES_USE_TABS = YES
EXAMPLE_GROUP_USE_TABS = YES
CONTENT_FRAME_USE_SLIDER = YES
#---------------------------------------------------------------------------
# Configuration options related to Left Menu layout
#---------------------------------------------------------------------------
SHOW_LEFT_MENU = YES
SHOW_LEFT_MENU_MAINDIR = YES
SHOW_LEFT_MENU_SEARCH = YES
SHOW_LEFT_MENU_DIRECTORY = YES
SHOW_LEFT_MENU_DOC = YES
SHOW_LOGO = YES
LEFT_MENU_DIRECTORIES = YES
LEFT_MENU_PAGES = YES
LEFT_MENU_CLASSES = YES
LEFT_MENU_STRUCTS = YES
LEFT_MENU_FUNCTIONS = YES
LEFT_MENU_FUNCTION_POINTERS = YES
LEFT_MENU_MACROS = NO
LEFT_MENU_DEFINES = NO
LEFT_MENU_ATTRIBUTES = NO
LEFT_MENU_TYPES = NO
LEFT_MENU_UNITS = YES
LEFT_MENU_GROUPS = YES
LEFT_MENU_STATISTICS = YES
STATISTICS_LINK_ON_MAIN_PAGE = YES
LEFT_MENU_TREE_VIEW = YES
LEFT_MENU_TREE_DEFAULT_EXPANDED_LVL = 1
LEFT_MENU_TREE_EXPAND_ON_TEXT = NO
#---------------------------------------------------------------------------
# Configuration options related to left menu treeview
#---------------------------------------------------------------------------
TREE_VIEW_FOLDER_FOR_CLASSES = YES
TREE_VIEW_FOLDER_FOR_STRUCTS = YES
TREE_VIEW_FOLDER_FOR_UNITS = YES
TREE_VIEW_FOLDER_FOR_FUNCTIONS = YES
TREE_VIEW_FOLDER_FOR_FUNCTION_POINTERS = YES
TREE_VIEW_FOLDER_FOR_GROUPS = YES
TREE_VIEW_FOLDER_FOR_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to header and footer layout
#---------------------------------------------------------------------------
HIDE_HEADER_ON_DIRS_AND_PAGES = YES
HIDE_FOOTER_ON_DIRS_AND_PAGES = YES
HIDE_HEADER_ON_CLASS_AND_MEMBERS = NO
HIDE_FOOTER_ON_CLASS_AND_MEMBERS = NO
HIDE_HEADER_ON_UNITS = NO
HIDE_FOOTER_ON_UNITS = NO
HIDE_HEADER_ON_GROUPS = NO
HIDE_FOOTER_ON_GROUPS = NO
HIDE_HEADER_ON_EXAMPLES = NO
HIDE_FOOTER_ON_EXAMPLES = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH = ./cpaf_libs/include
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
ENABLE_DOT_GRAPHS = YES
DOT_PATH =
CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = YES
DIR_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DOT_IMAGE_FORMAT = png
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 0
CENTER_ALIGN_DOT_IMAGES = NO
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration options related to the latex formula tool
#---------------------------------------------------------------------------
HAVE_LATEX_AND_GS = NO
EXTRA_PACKAGES =
LATEX_BATCHMODE = NO
#---------------------------------------------------------------------------
# Language options
#---------------------------------------------------------------------------
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = YES
# - # DoxySfile 0.95c ShortConfig -- Do not remove or edit this line please --
# -
# - #---------------------------------------------------------------------------
# - # General configuration options
# - #---------------------------------------------------------------------------
# - PROJECT_NAME = CPAF
# - PROJECT_NUMBER =
# - INPUT = .
# - #INPUT = . CBSIntroduction.page cpaf_mainpage.page
# - OUTPUT_DIRECTORY = ./build_cbs/CPAF-Documentation
# - GENERATE_DOXYS_HELP = YES
# - HTML_FILE_EXTENSION = .html
# - CUSTOM_DIR = ./common/DoxySCustom
# - SERVER_STATISTICS =
# - HTML_HELP_SERVER_PATH =
# - STRIP_CODE_COMMENTS = YES
# - #---------------------------------------------------------------------------
# - # Special options (rarely changed)
# - #---------------------------------------------------------------------------
# - DELETE_OUTPUT_DIRECTORY = NO
# - MS_DOT_NET_INTEGRATION = NO
# - MS_DOT_NET_INTEGRATION_PATH =
# - GENERATE_HTMLHELP1 = NO
# - GENERATE_STATISTICS = YES
# - #---------------------------------------------------------------------------
# - # Search page options
# - #---------------------------------------------------------------------------
# - CREATE_SEARCHPAGE = YES
# - SEARCH_BRIEF_DESCRIPTION = YES
# - SEARCH_FUNCTIONS = YES
# - SEARCH_VARIABLES = YES
# - SEARCH_TYPEDEFS_ETC = YES
# - AUTO_KEYWORD_LIMIT = 2
# - #---------------------------------------------------------------------------
# - # Specify what is included in the output
# - #---------------------------------------------------------------------------
# - CREATE_DOC_FOR_FILES = YES
# - CREATE_SOURCECODE_FOR_FILES = NO
# - CREATE_SOURCECODE_FOR_MEMBERS = YES
# - EXTRACT_PRIVATE = YES
# - EXTRACT_PROTECTED = YES
# - EXTRACT_STATIC = YES
# - EXTRACT_LOCAL_CLASSES = YES
# - HIDE_UNDOC_NAMESPACES = NO
# - HIDE_UNDOC_CLASSES = NO
# - HIDE_UNDOC_STRUCTS = NO
# - HIDE_UNDOC_UNIONS = NO
# - HIDE_UNDOC_FUNCTIONS = NO
# - HIDE_UNDOC_VARIABLES = NO
# - HIDE_UNDOC_ENUMS = NO
# - HIDE_UNDOC_ENUM_VALUES = NO
# - HIDE_UNDOC_TYPEDEFS = NO
# - HIDE_UNDOC_MACROS = NO
# - HIDE_UNDOC_DEFINES = YES
# - GENERATE_TODOLIST = YES
# - GENERATE_BUGLIST = YES
# - GENERATE_DEPRECATEDLIST = YES
# - #---------------------------------------------------------------------------
# - # Customize how the documentation is generated
# - #---------------------------------------------------------------------------
# - MEMBER_SAME_FILE_RELATE_TO_CLASSES = YES
# - MEMBER_SAME_FILE_RELATE_TO_STRUCTS = NO
# - FULL_PATH_NAMES = NO
# - STRIP_FROM_PATH =
# - INTERNAL_DOCS = NO
# - TODO_DOCS = YES
# - INHERIT_DOCS = YES
# - HIDE_CLASS_METHODS_IN_OVERVIEW = NO
# - CONCATENATE_DECL_AND_DEFINITION_DOC = YES
# - #---------------------------------------------------------------------------
# - # Controlling the DocParser (wiki style parser)
# - #---------------------------------------------------------------------------
# - PAGE_DOCUMENTATION_MODE = NO
# - ENABLE_HARD_SOFT_LINE_BREAKS = YES
# - #---------------------------------------------------------------------------
# - # Options to control how the input is parsed
# - #---------------------------------------------------------------------------
# - HIDE_IN_BODY_DOCS = NO
# - TAB_SIZE = 4
# - ALIASES =
# - ENABLED_SECTIONS =
# - IGNORE_CLASS_PREFIX =
# - AUTO_BRIEF_ENDS_AT_FIRST_NEWLINE = YES
# - #---------------------------------------------------------------------------
# - # configuration options related to warning and progress messages
# - #---------------------------------------------------------------------------
# - MESSAGE_LEVEL_SCREEN = Messages Warnings
# - OUTPUT_PATTERNS_SCREEN = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile
# - OUTPUT_PREFIX_LEVEL_SCREEN = Warnings Errors
# - OUTPUT_PREFIX_PATTERNS_SCREEN =
# - MESSAGE_LEVEL_HTML_FILE = Messages Warnings Errors
# - OUTPUT_PATTERNS_HTML_FILE = Progress Preprocessor Scanner Generator Docparser Dot Definition Configfile Undocumented Unknown
# - MESSAGE_SCREEN_LOGFILE =
# - QUIET = NO
# - #---------------------------------------------------------------------------
# - # Configuration options related to the input files
# - #---------------------------------------------------------------------------
# - IGNORE_FILE_NAME = DoxyS.ignore
# - FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.page *.dir *.dxd *.doc
# - RECURSIVE = YES
# - EXCLUDE = ./build_cbs/CPAF-Documentation
# - EXCLUDE_SYMLINKS = NO
# - EXCLUDE_PATTERNS =
# - EXAMPLE_PATH =
# - IMAGE_PATH =
# - INPUT_FILTER =
# - FILTER_SOURCE_FILES = NO
# - #---------------------------------------------------------------------------
# - # Configuration options related to the HTML layout
# - #---------------------------------------------------------------------------
# - NAVIGATION_CHAR_LENGTH = 25
# - LIMIT_COMPACT_IN_OVERVIEW_TABLES = 100
# - COLS_IN_OVERVIEW_TABLES = 4
# - LIMIT_ALFA_INDEX_IN_OVERVIEW_TABLES = 200
# - COMPACT_CHAR_LENGTH = 25
# - INFO_ON_OVERVIEW_TABLES_NORMAL = YES
# - INFO_ON_OVERVIEW_TABLES_COMPACT = YES
# - INCLUDE_BRIEF_IN_HEADER = YES
# - INCLUDE_BRIEF_IN_DESCRIPTION = YES
# - HIDE_TYPE_ON_DESCRIPTION = NO
# - EXPAND_COLLAPSE_SECTIONS = YES
# - EXPAND_COLLAPSE_TABLE_SECTIONS_ONLY = YES
# - CENTER_ALIGN_IMAGES = NO
# - OPTIMIZE_OUTPUT_FOR_C = NO
# - #---------------------------------------------------------------------------
# - # Configuration options related to Left Menu layout
# - #---------------------------------------------------------------------------
# - SHOW_LEFT_MENU = YES
# - SHOW_LEFT_MENU_MAINDIR = YES
# - SHOW_LEFT_MENU_SEARCH = YES
# - SHOW_LEFT_MENU_DIRECTORY = YES
# - SHOW_LEFT_MENU_DOC = YES
# - SHOW_LOGO = YES
# - LEFT_MENU_DIRECTORIES = YES
# - LEFT_MENU_PAGES = YES
# - LEFT_MENU_CLASSES = YES
# - LEFT_MENU_STRUCTS = YES
# - LEFT_MENU_FUNCTIONS = NO
# - LEFT_MENU_MACROS = NO
# - LEFT_MENU_DEFINES = NO
# - LEFT_MENU_ATTRIBUTES = NO
# - LEFT_MENU_TYPES = NO
# - LEFT_MENU_UNITS = YES
# - LEFT_MENU_STATISTICS = YES
# - STATISTICS_LINK_ON_MAIN_PAGE = YES
# - #---------------------------------------------------------------------------
# - # Configuration options related to header and footer layout
# - #---------------------------------------------------------------------------
# - HIDE_HEADER_ON_DIRS_AND_PAGES = YES
# - HIDE_FOOTER_ON_DIRS_AND_PAGES = YES
# - HIDE_HEADER_ON_CLASS_AND_MEMBERS = NO
# - HIDE_FOOTER_ON_CLASS_AND_MEMBERS = NO
# - HIDE_HEADER_ON_UNITS = NO
# - HIDE_FOOTER_ON_UNITS = NO
# - #---------------------------------------------------------------------------
# - # Configuration options related to the preprocessor
# - #---------------------------------------------------------------------------
# - ENABLE_PREPROCESSING = YES
# - MACRO_EXPANSION = YES
# - EXPAND_ONLY_PREDEF = NO
# - SEARCH_INCLUDES = YES
# - INCLUDE_PATH = ./cpaf_libs/include
# - INCLUDE_FILE_PATTERNS =
# - PREDEFINED =
# - EXPAND_AS_DEFINED =
# - SKIP_FUNCTION_MACROS = YES
# - #---------------------------------------------------------------------------
# - # Configuration options related to the dot tool
# - #---------------------------------------------------------------------------
# - ENABLE_DOT_GRAPHS = YES
# - DOT_PATH =
# - CLASS_DIAGRAMS = YES
# - HIDE_UNDOC_RELATIONS = YES
# - CLASS_GRAPH = YES
# - COLLABORATION_GRAPH = YES
# - UML_LOOK = NO
# - TEMPLATE_RELATIONS = YES
# - INCLUDE_GRAPH = YES
# - INCLUDED_BY_GRAPH = YES
# - CALL_GRAPH = YES
# - DIR_GRAPH = YES
# - GRAPHICAL_HIERARCHY = YES
# - DOT_IMAGE_FORMAT = png
# - DOTFILE_DIRS =
# - MAX_DOT_GRAPH_WIDTH = 1024
# - MAX_DOT_GRAPH_HEIGHT = 1024
# - MAX_DOT_GRAPH_DEPTH = 0
# - CENTER_ALIGN_DOT_IMAGES = NO
# - DOT_CLEANUP = YES
# - #---------------------------------------------------------------------------
# - # Language options
# - #---------------------------------------------------------------------------
# - OUTPUT_LANGUAGE = English
# - USE_WINDOWS_ENCODING = YES