|
79
|
1 # Doxyfile 1.7.1
|
|
|
2
|
|
|
3 # This file describes the settings to be used by the documentation system
|
|
|
4 # doxygen (www.doxygen.org) for a project
|
|
|
5 #
|
|
|
6 # All text after a hash (#) is considered a comment and will be ignored
|
|
|
7 # The format is:
|
|
|
8 # TAG = value [value, ...]
|
|
|
9 # For lists items can also be appended using:
|
|
|
10 # TAG += value [value, ...]
|
|
|
11 # Values that contain spaces should be placed between quotes (" ")
|
|
|
12
|
|
|
13 #---------------------------------------------------------------------------
|
|
|
14 # Project related configuration options
|
|
|
15 #---------------------------------------------------------------------------
|
|
|
16
|
|
|
17 # This tag specifies the encoding used for all characters in the config file
|
|
|
18 # that follow. The default is UTF-8 which is also the encoding used for all
|
|
|
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
|
|
20 # iconv built into libc) for the transcoding. See
|
|
|
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
|
|
|
22
|
|
|
23 DOXYFILE_ENCODING = UTF-8
|
|
|
24
|
|
|
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
|
|
26 # by quotes) that should identify the project.
|
|
|
27
|
|
|
28 PROJECT_NAME =
|
|
|
29
|
|
|
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
|
|
31 # This could be handy for archiving the generated documentation or
|
|
|
32 # if some version control system is used.
|
|
|
33
|
|
|
34 PROJECT_NUMBER =
|
|
|
35
|
|
|
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
|
|
37 # base path where the generated documentation will be put.
|
|
|
38 # If a relative path is entered, it will be relative to the location
|
|
|
39 # where doxygen was started. If left blank the current directory will be used.
|
|
|
40
|
|
|
41 OUTPUT_DIRECTORY = dox
|
|
|
42
|
|
|
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
|
|
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
|
|
|
45 # format and will distribute the generated files over these directories.
|
|
|
46 # Enabling this option can be useful when feeding doxygen a huge amount of
|
|
|
47 # source files, where putting all generated files in the same directory would
|
|
|
48 # otherwise cause performance problems for the file system.
|
|
|
49
|
|
|
50 CREATE_SUBDIRS = NO
|
|
|
51
|
|
|
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
|
53 # documentation generated by doxygen is written. Doxygen will use this
|
|
|
54 # information to generate all constant output in the proper language.
|
|
|
55 # The default language is English, other supported languages are:
|
|
|
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
|
|
|
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
|
|
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
|
|
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
|
|
|
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
|
|
|
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
|
|
62
|
|
|
63 OUTPUT_LANGUAGE = English
|
|
|
64
|
|
|
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
|
|
66 # include brief member descriptions after the members that are listed in
|
|
|
67 # the file and class documentation (similar to JavaDoc).
|
|
|
68 # Set to NO to disable this.
|
|
|
69
|
|
|
70 BRIEF_MEMBER_DESC = YES
|
|
|
71
|
|
|
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
|
|
73 # the brief description of a member or function before the detailed description.
|
|
|
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
|
75 # brief descriptions will be completely suppressed.
|
|
|
76
|
|
|
77 REPEAT_BRIEF = YES
|
|
|
78
|
|
|
79 # This tag implements a quasi-intelligent brief description abbreviator
|
|
|
80 # that is used to form the text in various listings. Each string
|
|
|
81 # in this list, if found as the leading text of the brief description, will be
|
|
|
82 # stripped from the text and the result after processing the whole list, is
|
|
|
83 # used as the annotated text. Otherwise, the brief description is used as-is.
|
|
|
84 # If left blank, the following values are used ("$name" is automatically
|
|
|
85 # replaced with the name of the entity): "The $name class" "The $name widget"
|
|
|
86 # "The $name file" "is" "provides" "specifies" "contains"
|
|
|
87 # "represents" "a" "an" "the"
|
|
|
88
|
|
|
89 ABBREVIATE_BRIEF =
|
|
|
90
|
|
|
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
|
|
92 # Doxygen will generate a detailed section even if there is only a brief
|
|
|
93 # description.
|
|
|
94
|
|
|
95 ALWAYS_DETAILED_SEC = NO
|
|
|
96
|
|
|
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
|
|
98 # inherited members of a class in the documentation of that class as if those
|
|
|
99 # members were ordinary class members. Constructors, destructors and assignment
|
|
|
100 # operators of the base classes will not be shown.
|
|
|
101
|
|
|
102 INLINE_INHERITED_MEMB = NO
|
|
|
103
|
|
|
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
|
|
105 # path before files name in the file list and in the header files. If set
|
|
|
106 # to NO the shortest path that makes the file name unique will be used.
|
|
|
107
|
|
|
108 FULL_PATH_NAMES = YES
|
|
|
109
|
|
|
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
|
|
111 # can be used to strip a user-defined part of the path. Stripping is
|
|
|
112 # only done if one of the specified strings matches the left-hand part of
|
|
|
113 # the path. The tag can be used to show relative paths in the file list.
|
|
|
114 # If left blank the directory from which doxygen is run is used as the
|
|
|
115 # path to strip.
|
|
|
116
|
|
|
117 STRIP_FROM_PATH =
|
|
|
118
|
|
|
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
|
|
|
120 # the path mentioned in the documentation of a class, which tells
|
|
|
121 # the reader which header file to include in order to use a class.
|
|
|
122 # If left blank only the name of the header file containing the class
|
|
|
123 # definition is used. Otherwise one should specify the include paths that
|
|
|
124 # are normally passed to the compiler using the -I flag.
|
|
|
125
|
|
|
126 STRIP_FROM_INC_PATH =
|
|
|
127
|
|
|
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
|
|
129 # (but less readable) file names. This can be useful is your file systems
|
|
|
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
|
|
|
131
|
|
|
132 SHORT_NAMES = NO
|
|
|
133
|
|
|
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
|
|
135 # will interpret the first line (until the first dot) of a JavaDoc-style
|
|
|
136 # comment as the brief description. If set to NO, the JavaDoc
|
|
|
137 # comments will behave just like regular Qt-style comments
|
|
|
138 # (thus requiring an explicit @brief command for a brief description.)
|
|
|
139
|
|
|
140 JAVADOC_AUTOBRIEF = NO
|
|
|
141
|
|
|
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
|
|
|
143 # interpret the first line (until the first dot) of a Qt-style
|
|
|
144 # comment as the brief description. If set to NO, the comments
|
|
|
145 # will behave just like regular Qt-style comments (thus requiring
|
|
|
146 # an explicit \brief command for a brief description.)
|
|
|
147
|
|
|
148 QT_AUTOBRIEF = NO
|
|
|
149
|
|
|
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
|
|
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
|
|
152 # comments) as a brief description. This used to be the default behaviour.
|
|
|
153 # The new default is to treat a multi-line C++ comment block as a detailed
|
|
|
154 # description. Set this tag to YES if you prefer the old behaviour instead.
|
|
|
155
|
|
|
156 MULTILINE_CPP_IS_BRIEF = NO
|
|
|
157
|
|
|
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
|
|
159 # member inherits the documentation from any documented member that it
|
|
|
160 # re-implements.
|
|
|
161
|
|
|
162 INHERIT_DOCS = YES
|
|
|
163
|
|
|
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
|
|
165 # a new page for each member. If set to NO, the documentation of a member will
|
|
|
166 # be part of the file/class/namespace that contains it.
|
|
|
167
|
|
|
168 SEPARATE_MEMBER_PAGES = NO
|
|
|
169
|
|
|
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
|
|
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
|
|
|
172
|
|
|
173 TAB_SIZE = 8
|
|
|
174
|
|
|
175 # This tag can be used to specify a number of aliases that acts
|
|
|
176 # as commands in the documentation. An alias has the form "name=value".
|
|
|
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
|
|
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
|
|
|
179 # will result in a user-defined paragraph with heading "Side Effects:".
|
|
|
180 # You can put \n's in the value part of an alias to insert newlines.
|
|
|
181
|
|
|
182 ALIASES =
|
|
|
183
|
|
|
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
|
|
185 # sources only. Doxygen will then generate output that is more tailored for C.
|
|
|
186 # For instance, some of the names that are used will be different. The list
|
|
|
187 # of all members will be omitted, etc.
|
|
|
188
|
|
|
189 OPTIMIZE_OUTPUT_FOR_C = NO
|
|
|
190
|
|
|
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
|
|
|
192 # sources only. Doxygen will then generate output that is more tailored for
|
|
|
193 # Java. For instance, namespaces will be presented as packages, qualified
|
|
|
194 # scopes will look different, etc.
|
|
|
195
|
|
|
196 OPTIMIZE_OUTPUT_JAVA = NO
|
|
|
197
|
|
|
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
|
|
199 # sources only. Doxygen will then generate output that is more tailored for
|
|
|
200 # Fortran.
|
|
|
201
|
|
|
202 OPTIMIZE_FOR_FORTRAN = NO
|
|
|
203
|
|
|
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
|
|
205 # sources. Doxygen will then generate output that is tailored for
|
|
|
206 # VHDL.
|
|
|
207
|
|
|
208 OPTIMIZE_OUTPUT_VHDL = NO
|
|
|
209
|
|
|
210 # Doxygen selects the parser to use depending on the extension of the files it
|
|
|
211 # parses. With this tag you can assign which parser to use for a given extension.
|
|
|
212 # Doxygen has a built-in mapping, but you can override or extend it using this
|
|
|
213 # tag. The format is ext=language, where ext is a file extension, and language
|
|
|
214 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
|
|
|
215 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
|
|
|
216 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
|
|
217 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
|
|
|
218 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
|
|
|
219
|
|
|
220 EXTENSION_MAPPING =
|
|
|
221
|
|
|
222 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
|
|
223 # to include (a tag file for) the STL sources as input, then you should
|
|
|
224 # set this tag to YES in order to let doxygen match functions declarations and
|
|
|
225 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
|
|
226 # func(std::string) {}). This also make the inheritance and collaboration
|
|
|
227 # diagrams that involve STL classes more complete and accurate.
|
|
|
228
|
|
|
229 BUILTIN_STL_SUPPORT = NO
|
|
|
230
|
|
|
231 # If you use Microsoft's C++/CLI language, you should set this option to YES to
|
|
|
232 # enable parsing support.
|
|
|
233
|
|
|
234 CPP_CLI_SUPPORT = NO
|
|
|
235
|
|
|
236 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
|
|
|
237 # Doxygen will parse them like normal C++ but will assume all classes use public
|
|
|
238 # instead of private inheritance when no explicit protection keyword is present.
|
|
|
239
|
|
|
240 SIP_SUPPORT = NO
|
|
|
241
|
|
|
242 # For Microsoft's IDL there are propget and propput attributes to indicate getter
|
|
|
243 # and setter methods for a property. Setting this option to YES (the default)
|
|
|
244 # will make doxygen to replace the get and set methods by a property in the
|
|
|
245 # documentation. This will only work if the methods are indeed getting or
|
|
|
246 # setting a simple type. If this is not the case, or you want to show the
|
|
|
247 # methods anyway, you should set this option to NO.
|
|
|
248
|
|
|
249 IDL_PROPERTY_SUPPORT = YES
|
|
|
250
|
|
|
251 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
|
|
252 # tag is set to YES, then doxygen will reuse the documentation of the first
|
|
|
253 # member in the group (if any) for the other members of the group. By default
|
|
|
254 # all members of a group must be documented explicitly.
|
|
|
255
|
|
|
256 DISTRIBUTE_GROUP_DOC = NO
|
|
|
257
|
|
|
258 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
|
|
259 # the same type (for instance a group of public functions) to be put as a
|
|
|
260 # subgroup of that type (e.g. under the Public Functions section). Set it to
|
|
|
261 # NO to prevent subgrouping. Alternatively, this can be done per class using
|
|
|
262 # the \nosubgrouping command.
|
|
|
263
|
|
|
264 SUBGROUPING = YES
|
|
|
265
|
|
|
266 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
|
|
|
267 # is documented as struct, union, or enum with the name of the typedef. So
|
|
|
268 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
|
|
269 # with name TypeT. When disabled the typedef will appear as a member of a file,
|
|
|
270 # namespace, or class. And the struct will be named TypeS. This can typically
|
|
|
271 # be useful for C code in case the coding convention dictates that all compound
|
|
|
272 # types are typedef'ed and only the typedef is referenced, never the tag name.
|
|
|
273
|
|
|
274 TYPEDEF_HIDES_STRUCT = NO
|
|
|
275
|
|
|
276 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
|
|
277 # determine which symbols to keep in memory and which to flush to disk.
|
|
|
278 # When the cache is full, less often used symbols will be written to disk.
|
|
|
279 # For small to medium size projects (<1000 input files) the default value is
|
|
|
280 # probably good enough. For larger projects a too small cache size can cause
|
|
|
281 # doxygen to be busy swapping symbols to and from disk most of the time
|
|
|
282 # causing a significant performance penality.
|
|
|
283 # If the system has enough physical memory increasing the cache will improve the
|
|
|
284 # performance by keeping more symbols in memory. Note that the value works on
|
|
|
285 # a logarithmic scale so increasing the size by one will rougly double the
|
|
|
286 # memory usage. The cache size is given by this formula:
|
|
|
287 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
|
|
288 # corresponding to a cache size of 2^16 = 65536 symbols
|
|
|
289
|
|
|
290 SYMBOL_CACHE_SIZE = 0
|
|
|
291
|
|
|
292 #---------------------------------------------------------------------------
|
|
|
293 # Build related configuration options
|
|
|
294 #---------------------------------------------------------------------------
|
|
|
295
|
|
|
296 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
|
|
297 # documentation are documented, even if no documentation was available.
|
|
|
298 # Private class members and static file members will be hidden unless
|
|
|
299 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
|
|
300
|
|
|
301 EXTRACT_ALL = YES
|
|
|
302
|
|
|
303 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
|
|
304 # will be included in the documentation.
|
|
|
305
|
|
|
306 EXTRACT_PRIVATE = NO
|
|
|
307
|
|
|
308 # If the EXTRACT_STATIC tag is set to YES all static members of a file
|
|
|
309 # will be included in the documentation.
|
|
|
310
|
|
|
311 EXTRACT_STATIC = NO
|
|
|
312
|
|
|
313 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
|
|
314 # defined locally in source files will be included in the documentation.
|
|
|
315 # If set to NO only classes defined in header files are included.
|
|
|
316
|
|
|
317 EXTRACT_LOCAL_CLASSES = YES
|
|
|
318
|
|
|
319 # This flag is only useful for Objective-C code. When set to YES local
|
|
|
320 # methods, which are defined in the implementation section but not in
|
|
|
321 # the interface are included in the documentation.
|
|
|
322 # If set to NO (the default) only methods in the interface are included.
|
|
|
323
|
|
|
324 EXTRACT_LOCAL_METHODS = NO
|
|
|
325
|
|
|
326 # If this flag is set to YES, the members of anonymous namespaces will be
|
|
|
327 # extracted and appear in the documentation as a namespace called
|
|
|
328 # 'anonymous_namespace{file}', where file will be replaced with the base
|
|
|
329 # name of the file that contains the anonymous namespace. By default
|
|
|
330 # anonymous namespace are hidden.
|
|
|
331
|
|
|
332 EXTRACT_ANON_NSPACES = NO
|
|
|
333
|
|
|
334 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
|
|
335 # undocumented members of documented classes, files or namespaces.
|
|
|
336 # If set to NO (the default) these members will be included in the
|
|
|
337 # various overviews, but no documentation section is generated.
|
|
|
338 # This option has no effect if EXTRACT_ALL is enabled.
|
|
|
339
|
|
|
340 HIDE_UNDOC_MEMBERS = NO
|
|
|
341
|
|
|
342 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
|
|
343 # undocumented classes that are normally visible in the class hierarchy.
|
|
|
344 # If set to NO (the default) these classes will be included in the various
|
|
|
345 # overviews. This option has no effect if EXTRACT_ALL is enabled.
|
|
|
346
|
|
|
347 HIDE_UNDOC_CLASSES = NO
|
|
|
348
|
|
|
349 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
|
|
350 # friend (class|struct|union) declarations.
|
|
|
351 # If set to NO (the default) these declarations will be included in the
|
|
|
352 # documentation.
|
|
|
353
|
|
|
354 HIDE_FRIEND_COMPOUNDS = NO
|
|
|
355
|
|
|
356 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
|
|
357 # documentation blocks found inside the body of a function.
|
|
|
358 # If set to NO (the default) these blocks will be appended to the
|
|
|
359 # function's detailed documentation block.
|
|
|
360
|
|
|
361 HIDE_IN_BODY_DOCS = NO
|
|
|
362
|
|
|
363 # The INTERNAL_DOCS tag determines if documentation
|
|
|
364 # that is typed after a \internal command is included. If the tag is set
|
|
|
365 # to NO (the default) then the documentation will be excluded.
|
|
|
366 # Set it to YES to include the internal documentation.
|
|
|
367
|
|
|
368 INTERNAL_DOCS = NO
|
|
|
369
|
|
|
370 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
|
|
371 # file names in lower-case letters. If set to YES upper-case letters are also
|
|
|
372 # allowed. This is useful if you have classes or files whose names only differ
|
|
|
373 # in case and if your file system supports case sensitive file names. Windows
|
|
|
374 # and Mac users are advised to set this option to NO.
|
|
|
375
|
|
|
376 CASE_SENSE_NAMES = YES
|
|
|
377
|
|
|
378 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
|
|
379 # will show members with their full class and namespace scopes in the
|
|
|
380 # documentation. If set to YES the scope will be hidden.
|
|
|
381
|
|
|
382 HIDE_SCOPE_NAMES = NO
|
|
|
383
|
|
|
384 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
|
|
385 # will put a list of the files that are included by a file in the documentation
|
|
|
386 # of that file.
|
|
|
387
|
|
|
388 SHOW_INCLUDE_FILES = YES
|
|
|
389
|
|
|
390 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
|
|
|
391 # will list include files with double quotes in the documentation
|
|
|
392 # rather than with sharp brackets.
|
|
|
393
|
|
|
394 FORCE_LOCAL_INCLUDES = NO
|
|
|
395
|
|
|
396 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
|
|
397 # is inserted in the documentation for inline members.
|
|
|
398
|
|
|
399 INLINE_INFO = YES
|
|
|
400
|
|
|
401 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
|
|
402 # will sort the (detailed) documentation of file and class members
|
|
|
403 # alphabetically by member name. If set to NO the members will appear in
|
|
|
404 # declaration order.
|
|
|
405
|
|
|
406 SORT_MEMBER_DOCS = YES
|
|
|
407
|
|
|
408 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
|
|
409 # brief documentation of file, namespace and class members alphabetically
|
|
|
410 # by member name. If set to NO (the default) the members will appear in
|
|
|
411 # declaration order.
|
|
|
412
|
|
|
413 SORT_BRIEF_DOCS = NO
|
|
|
414
|
|
|
415 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
|
|
|
416 # will sort the (brief and detailed) documentation of class members so that
|
|
|
417 # constructors and destructors are listed first. If set to NO (the default)
|
|
|
418 # the constructors will appear in the respective orders defined by
|
|
|
419 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
|
|
|
420 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
|
|
|
421 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
|
|
|
422
|
|
|
423 SORT_MEMBERS_CTORS_1ST = NO
|
|
|
424
|
|
|
425 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
|
|
426 # hierarchy of group names into alphabetical order. If set to NO (the default)
|
|
|
427 # the group names will appear in their defined order.
|
|
|
428
|
|
|
429 SORT_GROUP_NAMES = NO
|
|
|
430
|
|
|
431 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
|
|
432 # sorted by fully-qualified names, including namespaces. If set to
|
|
|
433 # NO (the default), the class list will be sorted only by class name,
|
|
|
434 # not including the namespace part.
|
|
|
435 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
|
|
436 # Note: This option applies only to the class list, not to the
|
|
|
437 # alphabetical list.
|
|
|
438
|
|
|
439 SORT_BY_SCOPE_NAME = NO
|
|
|
440
|
|
|
441 # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
|
|
442 # disable (NO) the todo list. This list is created by putting \todo
|
|
|
443 # commands in the documentation.
|
|
|
444
|
|
|
445 GENERATE_TODOLIST = YES
|
|
|
446
|
|
|
447 # The GENERATE_TESTLIST tag can be used to enable (YES) or
|
|
|
448 # disable (NO) the test list. This list is created by putting \test
|
|
|
449 # commands in the documentation.
|
|
|
450
|
|
|
451 GENERATE_TESTLIST = YES
|
|
|
452
|
|
|
453 # The GENERATE_BUGLIST tag can be used to enable (YES) or
|
|
|
454 # disable (NO) the bug list. This list is created by putting \bug
|
|
|
455 # commands in the documentation.
|
|
|
456
|
|
|
457 GENERATE_BUGLIST = YES
|
|
|
458
|
|
|
459 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
|
|
460 # disable (NO) the deprecated list. This list is created by putting
|
|
|
461 # \deprecated commands in the documentation.
|
|
|
462
|
|
|
463 GENERATE_DEPRECATEDLIST= YES
|
|
|
464
|
|
|
465 # The ENABLED_SECTIONS tag can be used to enable conditional
|
|
|
466 # documentation sections, marked by \if sectionname ... \endif.
|
|
|
467
|
|
|
468 ENABLED_SECTIONS =
|
|
|
469
|
|
|
470 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
|
|
471 # the initial value of a variable or define consists of for it to appear in
|
|
|
472 # the documentation. If the initializer consists of more lines than specified
|
|
|
473 # here it will be hidden. Use a value of 0 to hide initializers completely.
|
|
|
474 # The appearance of the initializer of individual variables and defines in the
|
|
|
475 # documentation can be controlled using \showinitializer or \hideinitializer
|
|
|
476 # command in the documentation regardless of this setting.
|
|
|
477
|
|
|
478 MAX_INITIALIZER_LINES = 30
|
|
|
479
|
|
|
480 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
|
|
481 # at the bottom of the documentation of classes and structs. If set to YES the
|
|
|
482 # list will mention the files that were used to generate the documentation.
|
|
|
483
|
|
|
484 SHOW_USED_FILES = YES
|
|
|
485
|
|
|
486 # If the sources in your project are distributed over multiple directories
|
|
|
487 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
|
|
|
488 # in the documentation. The default is NO.
|
|
|
489
|
|
|
490 SHOW_DIRECTORIES = NO
|
|
|
491
|
|
|
492 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
|
|
493 # This will remove the Files entry from the Quick Index and from the
|
|
|
494 # Folder Tree View (if specified). The default is YES.
|
|
|
495
|
|
|
496 SHOW_FILES = YES
|
|
|
497
|
|
|
498 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
|
|
499 # Namespaces page.
|
|
|
500 # This will remove the Namespaces entry from the Quick Index
|
|
|
501 # and from the Folder Tree View (if specified). The default is YES.
|
|
|
502
|
|
|
503 SHOW_NAMESPACES = YES
|
|
|
504
|
|
|
505 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
|
|
506 # doxygen should invoke to get the current version for each file (typically from
|
|
|
507 # the version control system). Doxygen will invoke the program by executing (via
|
|
|
508 # popen()) the command <command> <input-file>, where <command> is the value of
|
|
|
509 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
|
|
|
510 # provided by doxygen. Whatever the program writes to standard output
|
|
|
511 # is used as the file version. See the manual for examples.
|
|
|
512
|
|
|
513 FILE_VERSION_FILTER =
|
|
|
514
|
|
|
515 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
|
|
516 # by doxygen. The layout file controls the global structure of the generated
|
|
|
517 # output files in an output format independent way. The create the layout file
|
|
|
518 # that represents doxygen's defaults, run doxygen with the -l option.
|
|
|
519 # You can optionally specify a file name after the option, if omitted
|
|
|
520 # DoxygenLayout.xml will be used as the name of the layout file.
|
|
|
521
|
|
|
522 LAYOUT_FILE =
|
|
|
523
|
|
|
524 #---------------------------------------------------------------------------
|
|
|
525 # configuration options related to warning and progress messages
|
|
|
526 #---------------------------------------------------------------------------
|
|
|
527
|
|
|
528 # The QUIET tag can be used to turn on/off the messages that are generated
|
|
|
529 # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
|
|
530
|
|
|
531 QUIET = NO
|
|
|
532
|
|
|
533 # The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
|
534 # generated by doxygen. Possible values are YES and NO. If left blank
|
|
|
535 # NO is used.
|
|
|
536
|
|
|
537 WARNINGS = YES
|
|
|
538
|
|
|
539 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
|
|
540 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
|
|
541 # automatically be disabled.
|
|
|
542
|
|
|
543 WARN_IF_UNDOCUMENTED = YES
|
|
|
544
|
|
|
545 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
|
|
546 # potential errors in the documentation, such as not documenting some
|
|
|
547 # parameters in a documented function, or documenting parameters that
|
|
|
548 # don't exist or using markup commands wrongly.
|
|
|
549
|
|
|
550 WARN_IF_DOC_ERROR = YES
|
|
|
551
|
|
|
552 # This WARN_NO_PARAMDOC option can be abled to get warnings for
|
|
|
553 # functions that are documented, but have no documentation for their parameters
|
|
|
554 # or return value. If set to NO (the default) doxygen will only warn about
|
|
|
555 # wrong or incomplete parameter documentation, but not about the absence of
|
|
|
556 # documentation.
|
|
|
557
|
|
|
558 WARN_NO_PARAMDOC = NO
|
|
|
559
|
|
|
560 # The WARN_FORMAT tag determines the format of the warning messages that
|
|
|
561 # doxygen can produce. The string should contain the $file, $line, and $text
|
|
|
562 # tags, which will be replaced by the file and line number from which the
|
|
|
563 # warning originated and the warning text. Optionally the format may contain
|
|
|
564 # $version, which will be replaced by the version of the file (if it could
|
|
|
565 # be obtained via FILE_VERSION_FILTER)
|
|
|
566
|
|
|
567 WARN_FORMAT = "$file:$line: $text"
|
|
|
568
|
|
|
569 # The WARN_LOGFILE tag can be used to specify a file to which warning
|
|
|
570 # and error messages should be written. If left blank the output is written
|
|
|
571 # to stderr.
|
|
|
572
|
|
|
573 WARN_LOGFILE =
|
|
|
574
|
|
|
575 #---------------------------------------------------------------------------
|
|
|
576 # configuration options related to the input files
|
|
|
577 #---------------------------------------------------------------------------
|
|
|
578
|
|
|
579 # The INPUT tag can be used to specify the files and/or directories that contain
|
|
|
580 # documented source files. You may enter file names like "myfile.cpp" or
|
|
|
581 # directories like "/usr/src/myproject". Separate the files or directories
|
|
|
582 # with spaces.
|
|
|
583
|
|
|
584 INPUT = paraspace
|
|
|
585
|
|
|
586 # This tag can be used to specify the character encoding of the source files
|
|
|
587 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
|
|
588 # also the default input encoding. Doxygen uses libiconv (or the iconv built
|
|
|
589 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
|
|
|
590 # the list of possible encodings.
|
|
|
591
|
|
|
592 INPUT_ENCODING = UTF-8
|
|
|
593
|
|
|
594 # If the value of the INPUT tag contains directories, you can use the
|
|
|
595 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
|
596 # and *.h) to filter out the source-files in the directories. If left
|
|
|
597 # blank the following patterns are tested:
|
|
|
598 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
|
|
599 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
|
|
|
600
|
|
|
601 FILE_PATTERNS = *.py
|
|
|
602
|
|
|
603 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
|
|
604 # should be searched for input files as well. Possible values are YES and NO.
|
|
|
605 # If left blank NO is used.
|
|
|
606
|
|
|
607 RECURSIVE = YES
|
|
|
608
|
|
|
609 # The EXCLUDE tag can be used to specify files and/or directories that should
|
|
|
610 # excluded from the INPUT source files. This way you can easily exclude a
|
|
|
611 # subdirectory from a directory tree whose root is specified with the INPUT tag.
|
|
|
612
|
|
|
613 EXCLUDE = paraspace/tests
|
|
|
614
|
|
|
615 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
|
|
616 # directories that are symbolic links (a Unix filesystem feature) are excluded
|
|
|
617 # from the input.
|
|
|
618
|
|
|
619 EXCLUDE_SYMLINKS = NO
|
|
|
620
|
|
|
621 # If the value of the INPUT tag contains directories, you can use the
|
|
|
622 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
|
623 # certain files from those directories. Note that the wildcards are matched
|
|
|
624 # against the file with absolute path, so to exclude all test directories
|
|
|
625 # for example use the pattern */test/*
|
|
|
626
|
|
|
627 EXCLUDE_PATTERNS =
|
|
|
628
|
|
|
629 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
|
|
630 # (namespaces, classes, functions, etc.) that should be excluded from the
|
|
|
631 # output. The symbol name can be a fully qualified name, a word, or if the
|
|
|
632 # wildcard * is used, a substring. Examples: ANamespace, AClass,
|
|
|
633 # AClass::ANamespace, ANamespace::*Test
|
|
|
634
|
|
|
635 EXCLUDE_SYMBOLS =
|
|
|
636
|
|
|
637 # The EXAMPLE_PATH tag can be used to specify one or more files or
|
|
|
638 # directories that contain example code fragments that are included (see
|
|
|
639 # the \include command).
|
|
|
640
|
|
|
641 EXAMPLE_PATH =
|
|
|
642
|
|
|
643 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
|
|
644 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
|
645 # and *.h) to filter out the source-files in the directories. If left
|
|
|
646 # blank all files are included.
|
|
|
647
|
|
|
648 EXAMPLE_PATTERNS =
|
|
|
649
|
|
|
650 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
|
|
651 # searched for input files to be used with the \include or \dontinclude
|
|
|
652 # commands irrespective of the value of the RECURSIVE tag.
|
|
|
653 # Possible values are YES and NO. If left blank NO is used.
|
|
|
654
|
|
|
655 EXAMPLE_RECURSIVE = NO
|
|
|
656
|
|
|
657 # The IMAGE_PATH tag can be used to specify one or more files or
|
|
|
658 # directories that contain image that are included in the documentation (see
|
|
|
659 # the \image command).
|
|
|
660
|
|
|
661 IMAGE_PATH =
|
|
|
662
|
|
|
663 # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
|
|
664 # invoke to filter for each input file. Doxygen will invoke the filter program
|
|
|
665 # by executing (via popen()) the command <filter> <input-file>, where <filter>
|
|
|
666 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
|
|
667 # input file. Doxygen will then use the output that the filter program writes
|
|
|
668 # to standard output.
|
|
|
669 # If FILTER_PATTERNS is specified, this tag will be
|
|
|
670 # ignored.
|
|
|
671
|
|
|
672 INPUT_FILTER =
|
|
|
673
|
|
|
674 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
|
|
675 # basis.
|
|
|
676 # Doxygen will compare the file name with each pattern and apply the
|
|
|
677 # filter if there is a match.
|
|
|
678 # The filters are a list of the form:
|
|
|
679 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
|
|
680 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
|
|
|
681 # is applied to all files.
|
|
|
682
|
|
|
683 FILTER_PATTERNS =
|
|
|
684
|
|
|
685 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
|
|
686 # INPUT_FILTER) will be used to filter the input files when producing source
|
|
|
687 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
|
|
688
|
|
|
689 FILTER_SOURCE_FILES = NO
|
|
|
690
|
|
|
691 #---------------------------------------------------------------------------
|
|
|
692 # configuration options related to source browsing
|
|
|
693 #---------------------------------------------------------------------------
|
|
|
694
|
|
|
695 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
|
|
696 # be generated. Documented entities will be cross-referenced with these sources.
|
|
|
697 # Note: To get rid of all source code in the generated output, make sure also
|
|
|
698 # VERBATIM_HEADERS is set to NO.
|
|
|
699
|
|
|
700 SOURCE_BROWSER = NO
|
|
|
701
|
|
|
702 # Setting the INLINE_SOURCES tag to YES will include the body
|
|
|
703 # of functions and classes directly in the documentation.
|
|
|
704
|
|
|
705 INLINE_SOURCES = NO
|
|
|
706
|
|
|
707 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
|
|
708 # doxygen to hide any special comment blocks from generated source code
|
|
|
709 # fragments. Normal C and C++ comments will always remain visible.
|
|
|
710
|
|
|
711 STRIP_CODE_COMMENTS = YES
|
|
|
712
|
|
|
713 # If the REFERENCED_BY_RELATION tag is set to YES
|
|
|
714 # then for each documented function all documented
|
|
|
715 # functions referencing it will be listed.
|
|
|
716
|
|
|
717 REFERENCED_BY_RELATION = NO
|
|
|
718
|
|
|
719 # If the REFERENCES_RELATION tag is set to YES
|
|
|
720 # then for each documented function all documented entities
|
|
|
721 # called/used by that function will be listed.
|
|
|
722
|
|
|
723 REFERENCES_RELATION = NO
|
|
|
724
|
|
|
725 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
|
|
726 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
|
|
727 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
|
|
728 # link to the source code.
|
|
|
729 # Otherwise they will link to the documentation.
|
|
|
730
|
|
|
731 REFERENCES_LINK_SOURCE = YES
|
|
|
732
|
|
|
733 # If the USE_HTAGS tag is set to YES then the references to source code
|
|
|
734 # will point to the HTML generated by the htags(1) tool instead of doxygen
|
|
|
735 # built-in source browser. The htags tool is part of GNU's global source
|
|
|
736 # tagging system (see http://www.gnu.org/software/global/global.html). You
|
|
|
737 # will need version 4.8.6 or higher.
|
|
|
738
|
|
|
739 USE_HTAGS = NO
|
|
|
740
|
|
|
741 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
|
|
742 # will generate a verbatim copy of the header file for each class for
|
|
|
743 # which an include is specified. Set to NO to disable this.
|
|
|
744
|
|
|
745 VERBATIM_HEADERS = YES
|
|
|
746
|
|
|
747 #---------------------------------------------------------------------------
|
|
|
748 # configuration options related to the alphabetical class index
|
|
|
749 #---------------------------------------------------------------------------
|
|
|
750
|
|
|
751 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
|
|
752 # of all compounds will be generated. Enable this if the project
|
|
|
753 # contains a lot of classes, structs, unions or interfaces.
|
|
|
754
|
|
|
755 ALPHABETICAL_INDEX = YES
|
|
|
756
|
|
|
757 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
|
|
758 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
|
|
759 # in which this list will be split (can be a number in the range [1..20])
|
|
|
760
|
|
|
761 COLS_IN_ALPHA_INDEX = 5
|
|
|
762
|
|
|
763 # In case all classes in a project start with a common prefix, all
|
|
|
764 # classes will be put under the same header in the alphabetical index.
|
|
|
765 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
|
|
766 # should be ignored while generating the index headers.
|
|
|
767
|
|
|
768 IGNORE_PREFIX =
|
|
|
769
|
|
|
770 #---------------------------------------------------------------------------
|
|
|
771 # configuration options related to the HTML output
|
|
|
772 #---------------------------------------------------------------------------
|
|
|
773
|
|
|
774 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
|
|
775 # generate HTML output.
|
|
|
776
|
|
|
777 GENERATE_HTML = YES
|
|
|
778
|
|
|
779 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
|
|
780 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
781 # put in front of it. If left blank `html' will be used as the default path.
|
|
|
782
|
|
|
783 HTML_OUTPUT = html
|
|
|
784
|
|
|
785 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
|
|
786 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
|
|
787 # doxygen will generate files with .html extension.
|
|
|
788
|
|
|
789 HTML_FILE_EXTENSION = .html
|
|
|
790
|
|
|
791 # The HTML_HEADER tag can be used to specify a personal HTML header for
|
|
|
792 # each generated HTML page. If it is left blank doxygen will generate a
|
|
|
793 # standard header.
|
|
|
794
|
|
|
795 HTML_HEADER =
|
|
|
796
|
|
|
797 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
|
|
798 # each generated HTML page. If it is left blank doxygen will generate a
|
|
|
799 # standard footer.
|
|
|
800
|
|
|
801 HTML_FOOTER =
|
|
|
802
|
|
|
803 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
|
|
804 # style sheet that is used by each HTML page. It can be used to
|
|
|
805 # fine-tune the look of the HTML output. If the tag is left blank doxygen
|
|
|
806 # will generate a default style sheet. Note that doxygen will try to copy
|
|
|
807 # the style sheet file to the HTML output directory, so don't put your own
|
|
|
808 # stylesheet in the HTML output directory as well, or it will be erased!
|
|
|
809
|
|
|
810 HTML_STYLESHEET =
|
|
|
811
|
|
|
812 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
|
|
813 # Doxygen will adjust the colors in the stylesheet and background images
|
|
|
814 # according to this color. Hue is specified as an angle on a colorwheel,
|
|
|
815 # see http://en.wikipedia.org/wiki/Hue for more information.
|
|
|
816 # For instance the value 0 represents red, 60 is yellow, 120 is green,
|
|
|
817 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
|
|
818 # The allowed range is 0 to 359.
|
|
|
819
|
|
|
820 HTML_COLORSTYLE_HUE = 220
|
|
|
821
|
|
|
822 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
|
|
823 # the colors in the HTML output. For a value of 0 the output will use
|
|
|
824 # grayscales only. A value of 255 will produce the most vivid colors.
|
|
|
825
|
|
|
826 HTML_COLORSTYLE_SAT = 100
|
|
|
827
|
|
|
828 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
|
|
|
829 # the luminance component of the colors in the HTML output. Values below
|
|
|
830 # 100 gradually make the output lighter, whereas values above 100 make
|
|
|
831 # the output darker. The value divided by 100 is the actual gamma applied,
|
|
|
832 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
|
|
|
833 # and 100 does not change the gamma.
|
|
|
834
|
|
|
835 HTML_COLORSTYLE_GAMMA = 80
|
|
|
836
|
|
|
837 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
|
|
838 # page will contain the date and time when the page was generated. Setting
|
|
|
839 # this to NO can help when comparing the output of multiple runs.
|
|
|
840
|
|
|
841 HTML_TIMESTAMP = YES
|
|
|
842
|
|
|
843 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
|
|
844 # files or namespaces will be aligned in HTML using tables. If set to
|
|
|
845 # NO a bullet list will be used.
|
|
|
846
|
|
|
847 HTML_ALIGN_MEMBERS = YES
|
|
|
848
|
|
|
849 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
|
|
850 # documentation will contain sections that can be hidden and shown after the
|
|
|
851 # page has loaded. For this to work a browser that supports
|
|
|
852 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
|
|
|
853 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
|
|
|
854
|
|
|
855 HTML_DYNAMIC_SECTIONS = NO
|
|
|
856
|
|
|
857 # If the GENERATE_DOCSET tag is set to YES, additional index files
|
|
|
858 # will be generated that can be used as input for Apple's Xcode 3
|
|
|
859 # integrated development environment, introduced with OSX 10.5 (Leopard).
|
|
|
860 # To create a documentation set, doxygen will generate a Makefile in the
|
|
|
861 # HTML output directory. Running make will produce the docset in that
|
|
|
862 # directory and running "make install" will install the docset in
|
|
|
863 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
|
|
864 # it at startup.
|
|
|
865 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
|
|
866 # for more information.
|
|
|
867
|
|
|
868 GENERATE_DOCSET = NO
|
|
|
869
|
|
|
870 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
|
|
|
871 # feed. A documentation feed provides an umbrella under which multiple
|
|
|
872 # documentation sets from a single provider (such as a company or product suite)
|
|
|
873 # can be grouped.
|
|
|
874
|
|
|
875 DOCSET_FEEDNAME = "Doxygen generated docs"
|
|
|
876
|
|
|
877 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
|
|
|
878 # should uniquely identify the documentation set bundle. This should be a
|
|
|
879 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
|
|
|
880 # will append .docset to the name.
|
|
|
881
|
|
|
882 DOCSET_BUNDLE_ID = org.doxygen.Project
|
|
|
883
|
|
|
884 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
|
|
|
885 # the documentation publisher. This should be a reverse domain-name style
|
|
|
886 # string, e.g. com.mycompany.MyDocSet.documentation.
|
|
|
887
|
|
|
888 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
|
|
889
|
|
|
890 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
|
|
|
891
|
|
|
892 DOCSET_PUBLISHER_NAME = Publisher
|
|
|
893
|
|
|
894 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
|
|
895 # will be generated that can be used as input for tools like the
|
|
|
896 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
|
|
897 # of the generated HTML documentation.
|
|
|
898
|
|
|
899 GENERATE_HTMLHELP = NO
|
|
|
900
|
|
|
901 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
|
|
902 # be used to specify the file name of the resulting .chm file. You
|
|
|
903 # can add a path in front of the file if the result should not be
|
|
|
904 # written to the html output directory.
|
|
|
905
|
|
|
906 CHM_FILE =
|
|
|
907
|
|
|
908 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
|
|
909 # be used to specify the location (absolute path including file name) of
|
|
|
910 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
|
|
911 # the HTML help compiler on the generated index.hhp.
|
|
|
912
|
|
|
913 HHC_LOCATION =
|
|
|
914
|
|
|
915 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
|
|
916 # controls if a separate .chi index file is generated (YES) or that
|
|
|
917 # it should be included in the master .chm file (NO).
|
|
|
918
|
|
|
919 GENERATE_CHI = NO
|
|
|
920
|
|
|
921 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
|
|
|
922 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
|
|
|
923 # content.
|
|
|
924
|
|
|
925 CHM_INDEX_ENCODING =
|
|
|
926
|
|
|
927 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
|
|
928 # controls whether a binary table of contents is generated (YES) or a
|
|
|
929 # normal table of contents (NO) in the .chm file.
|
|
|
930
|
|
|
931 BINARY_TOC = NO
|
|
|
932
|
|
|
933 # The TOC_EXPAND flag can be set to YES to add extra items for group members
|
|
|
934 # to the contents of the HTML help documentation and to the tree view.
|
|
|
935
|
|
|
936 TOC_EXPAND = NO
|
|
|
937
|
|
|
938 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
|
|
939 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
|
|
|
940 # that can be used as input for Qt's qhelpgenerator to generate a
|
|
|
941 # Qt Compressed Help (.qch) of the generated HTML documentation.
|
|
|
942
|
|
|
943 GENERATE_QHP = NO
|
|
|
944
|
|
|
945 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
|
|
|
946 # be used to specify the file name of the resulting .qch file.
|
|
|
947 # The path specified is relative to the HTML output folder.
|
|
|
948
|
|
|
949 QCH_FILE =
|
|
|
950
|
|
|
951 # The QHP_NAMESPACE tag specifies the namespace to use when generating
|
|
|
952 # Qt Help Project output. For more information please see
|
|
|
953 # http://doc.trolltech.com/qthelpproject.html#namespace
|
|
|
954
|
|
|
955 QHP_NAMESPACE = org.doxygen.Project
|
|
|
956
|
|
|
957 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
|
|
|
958 # Qt Help Project output. For more information please see
|
|
|
959 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
|
|
|
960
|
|
|
961 QHP_VIRTUAL_FOLDER = doc
|
|
|
962
|
|
|
963 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
|
|
|
964 # add. For more information please see
|
|
|
965 # http://doc.trolltech.com/qthelpproject.html#custom-filters
|
|
|
966
|
|
|
967 QHP_CUST_FILTER_NAME =
|
|
|
968
|
|
|
969 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
|
|
|
970 # custom filter to add. For more information please see
|
|
|
971 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
|
|
|
972 # Qt Help Project / Custom Filters</a>.
|
|
|
973
|
|
|
974 QHP_CUST_FILTER_ATTRS =
|
|
|
975
|
|
|
976 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
|
|
977 # project's
|
|
|
978 # filter section matches.
|
|
|
979 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
|
|
|
980 # Qt Help Project / Filter Attributes</a>.
|
|
|
981
|
|
|
982 QHP_SECT_FILTER_ATTRS =
|
|
|
983
|
|
|
984 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
|
|
|
985 # be used to specify the location of Qt's qhelpgenerator.
|
|
|
986 # If non-empty doxygen will try to run qhelpgenerator on the generated
|
|
|
987 # .qhp file.
|
|
|
988
|
|
|
989 QHG_LOCATION =
|
|
|
990
|
|
|
991 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
|
|
992 # will be generated, which together with the HTML files, form an Eclipse help
|
|
|
993 # plugin. To install this plugin and make it available under the help contents
|
|
|
994 # menu in Eclipse, the contents of the directory containing the HTML and XML
|
|
|
995 # files needs to be copied into the plugins directory of eclipse. The name of
|
|
|
996 # the directory within the plugins directory should be the same as
|
|
|
997 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
|
|
|
998 # the help appears.
|
|
|
999
|
|
|
1000 GENERATE_ECLIPSEHELP = NO
|
|
|
1001
|
|
|
1002 # A unique identifier for the eclipse help plugin. When installing the plugin
|
|
|
1003 # the directory name containing the HTML and XML files should also have
|
|
|
1004 # this name.
|
|
|
1005
|
|
|
1006 ECLIPSE_DOC_ID = org.doxygen.Project
|
|
|
1007
|
|
|
1008 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
|
|
1009 # top of each HTML page. The value NO (the default) enables the index and
|
|
|
1010 # the value YES disables it.
|
|
|
1011
|
|
|
1012 DISABLE_INDEX = NO
|
|
|
1013
|
|
|
1014 # This tag can be used to set the number of enum values (range [1..20])
|
|
|
1015 # that doxygen will group on one line in the generated HTML documentation.
|
|
|
1016
|
|
|
1017 ENUM_VALUES_PER_LINE = 4
|
|
|
1018
|
|
|
1019 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
|
|
1020 # structure should be generated to display hierarchical information.
|
|
|
1021 # If the tag value is set to YES, a side panel will be generated
|
|
|
1022 # containing a tree-like index structure (just like the one that
|
|
|
1023 # is generated for HTML Help). For this to work a browser that supports
|
|
|
1024 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
|
|
|
1025 # Windows users are probably better off using the HTML help feature.
|
|
|
1026
|
|
|
1027 GENERATE_TREEVIEW = NO
|
|
|
1028
|
|
|
1029 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
|
|
|
1030 # and Class Hierarchy pages using a tree view instead of an ordered list.
|
|
|
1031
|
|
|
1032 USE_INLINE_TREES = NO
|
|
|
1033
|
|
|
1034 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
|
|
1035 # used to set the initial width (in pixels) of the frame in which the tree
|
|
|
1036 # is shown.
|
|
|
1037
|
|
|
1038 TREEVIEW_WIDTH = 250
|
|
|
1039
|
|
|
1040 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
|
|
|
1041 # links to external symbols imported via tag files in a separate window.
|
|
|
1042
|
|
|
1043 EXT_LINKS_IN_WINDOW = NO
|
|
|
1044
|
|
|
1045 # Use this tag to change the font size of Latex formulas included
|
|
|
1046 # as images in the HTML documentation. The default is 10. Note that
|
|
|
1047 # when you change the font size after a successful doxygen run you need
|
|
|
1048 # to manually remove any form_*.png images from the HTML output directory
|
|
|
1049 # to force them to be regenerated.
|
|
|
1050
|
|
|
1051 FORMULA_FONTSIZE = 10
|
|
|
1052
|
|
|
1053 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
|
|
1054 # generated for formulas are transparent PNGs. Transparent PNGs are
|
|
|
1055 # not supported properly for IE 6.0, but are supported on all modern browsers.
|
|
|
1056 # Note that when changing this option you need to delete any form_*.png files
|
|
|
1057 # in the HTML output before the changes have effect.
|
|
|
1058
|
|
|
1059 FORMULA_TRANSPARENT = YES
|
|
|
1060
|
|
|
1061 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
|
|
1062 # for the HTML output. The underlying search engine uses javascript
|
|
|
1063 # and DHTML and should work on any modern browser. Note that when using
|
|
|
1064 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
|
|
|
1065 # (GENERATE_DOCSET) there is already a search function so this one should
|
|
|
1066 # typically be disabled. For large projects the javascript based search engine
|
|
|
1067 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
|
|
1068
|
|
|
1069 SEARCHENGINE = YES
|
|
|
1070
|
|
|
1071 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
|
|
1072 # implemented using a PHP enabled web server instead of at the web client
|
|
|
1073 # using Javascript. Doxygen will generate the search PHP script and index
|
|
|
1074 # file to put on the web server. The advantage of the server
|
|
|
1075 # based approach is that it scales better to large projects and allows
|
|
|
1076 # full text search. The disadvances is that it is more difficult to setup
|
|
|
1077 # and does not have live searching capabilities.
|
|
|
1078
|
|
|
1079 SERVER_BASED_SEARCH = NO
|
|
|
1080
|
|
|
1081 #---------------------------------------------------------------------------
|
|
|
1082 # configuration options related to the LaTeX output
|
|
|
1083 #---------------------------------------------------------------------------
|
|
|
1084
|
|
|
1085 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
|
|
1086 # generate Latex output.
|
|
|
1087
|
|
|
1088 GENERATE_LATEX = YES
|
|
|
1089
|
|
|
1090 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
|
|
1091 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
1092 # put in front of it. If left blank `latex' will be used as the default path.
|
|
|
1093
|
|
|
1094 LATEX_OUTPUT = latex
|
|
|
1095
|
|
|
1096 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
|
1097 # invoked. If left blank `latex' will be used as the default command name.
|
|
|
1098 # Note that when enabling USE_PDFLATEX this option is only used for
|
|
|
1099 # generating bitmaps for formulas in the HTML output, but not in the
|
|
|
1100 # Makefile that is written to the output directory.
|
|
|
1101
|
|
|
1102 LATEX_CMD_NAME = latex
|
|
|
1103
|
|
|
1104 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
|
|
1105 # generate index for LaTeX. If left blank `makeindex' will be used as the
|
|
|
1106 # default command name.
|
|
|
1107
|
|
|
1108 MAKEINDEX_CMD_NAME = makeindex
|
|
|
1109
|
|
|
1110 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
|
|
1111 # LaTeX documents. This may be useful for small projects and may help to
|
|
|
1112 # save some trees in general.
|
|
|
1113
|
|
|
1114 COMPACT_LATEX = NO
|
|
|
1115
|
|
|
1116 # The PAPER_TYPE tag can be used to set the paper type that is used
|
|
|
1117 # by the printer. Possible values are: a4, a4wide, letter, legal and
|
|
|
1118 # executive. If left blank a4wide will be used.
|
|
|
1119
|
|
|
1120 PAPER_TYPE = a4wide
|
|
|
1121
|
|
|
1122 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
|
|
1123 # packages that should be included in the LaTeX output.
|
|
|
1124
|
|
|
1125 EXTRA_PACKAGES =
|
|
|
1126
|
|
|
1127 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
|
|
1128 # the generated latex document. The header should contain everything until
|
|
|
1129 # the first chapter. If it is left blank doxygen will generate a
|
|
|
1130 # standard header. Notice: only use this tag if you know what you are doing!
|
|
|
1131
|
|
|
1132 LATEX_HEADER =
|
|
|
1133
|
|
|
1134 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
|
|
1135 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
|
|
1136 # contain links (just like the HTML output) instead of page references
|
|
|
1137 # This makes the output suitable for online browsing using a pdf viewer.
|
|
|
1138
|
|
|
1139 PDF_HYPERLINKS = YES
|
|
|
1140
|
|
|
1141 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
|
|
1142 # plain latex in the generated Makefile. Set this option to YES to get a
|
|
|
1143 # higher quality PDF documentation.
|
|
|
1144
|
|
|
1145 USE_PDFLATEX = YES
|
|
|
1146
|
|
|
1147 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
|
|
1148 # command to the generated LaTeX files. This will instruct LaTeX to keep
|
|
|
1149 # running if errors occur, instead of asking the user for help.
|
|
|
1150 # This option is also used when generating formulas in HTML.
|
|
|
1151
|
|
|
1152 LATEX_BATCHMODE = NO
|
|
|
1153
|
|
|
1154 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
|
|
1155 # include the index chapters (such as File Index, Compound Index, etc.)
|
|
|
1156 # in the output.
|
|
|
1157
|
|
|
1158 LATEX_HIDE_INDICES = NO
|
|
|
1159
|
|
|
1160 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
|
|
|
1161 # source code with syntax highlighting in the LaTeX output.
|
|
|
1162 # Note that which sources are shown also depends on other settings
|
|
|
1163 # such as SOURCE_BROWSER.
|
|
|
1164
|
|
|
1165 LATEX_SOURCE_CODE = NO
|
|
|
1166
|
|
|
1167 #---------------------------------------------------------------------------
|
|
|
1168 # configuration options related to the RTF output
|
|
|
1169 #---------------------------------------------------------------------------
|
|
|
1170
|
|
|
1171 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
|
|
1172 # The RTF output is optimized for Word 97 and may not look very pretty with
|
|
|
1173 # other RTF readers or editors.
|
|
|
1174
|
|
|
1175 GENERATE_RTF = NO
|
|
|
1176
|
|
|
1177 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
|
|
1178 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
1179 # put in front of it. If left blank `rtf' will be used as the default path.
|
|
|
1180
|
|
|
1181 RTF_OUTPUT = rtf
|
|
|
1182
|
|
|
1183 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
|
|
1184 # RTF documents. This may be useful for small projects and may help to
|
|
|
1185 # save some trees in general.
|
|
|
1186
|
|
|
1187 COMPACT_RTF = NO
|
|
|
1188
|
|
|
1189 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
|
|
1190 # will contain hyperlink fields. The RTF file will
|
|
|
1191 # contain links (just like the HTML output) instead of page references.
|
|
|
1192 # This makes the output suitable for online browsing using WORD or other
|
|
|
1193 # programs which support those fields.
|
|
|
1194 # Note: wordpad (write) and others do not support links.
|
|
|
1195
|
|
|
1196 RTF_HYPERLINKS = NO
|
|
|
1197
|
|
|
1198 # Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
|
1199 # config file, i.e. a series of assignments. You only have to provide
|
|
|
1200 # replacements, missing definitions are set to their default value.
|
|
|
1201
|
|
|
1202 RTF_STYLESHEET_FILE =
|
|
|
1203
|
|
|
1204 # Set optional variables used in the generation of an rtf document.
|
|
|
1205 # Syntax is similar to doxygen's config file.
|
|
|
1206
|
|
|
1207 RTF_EXTENSIONS_FILE =
|
|
|
1208
|
|
|
1209 #---------------------------------------------------------------------------
|
|
|
1210 # configuration options related to the man page output
|
|
|
1211 #---------------------------------------------------------------------------
|
|
|
1212
|
|
|
1213 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
|
|
1214 # generate man pages
|
|
|
1215
|
|
|
1216 GENERATE_MAN = NO
|
|
|
1217
|
|
|
1218 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
|
|
1219 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
1220 # put in front of it. If left blank `man' will be used as the default path.
|
|
|
1221
|
|
|
1222 MAN_OUTPUT = man
|
|
|
1223
|
|
|
1224 # The MAN_EXTENSION tag determines the extension that is added to
|
|
|
1225 # the generated man pages (default is the subroutine's section .3)
|
|
|
1226
|
|
|
1227 MAN_EXTENSION = .3
|
|
|
1228
|
|
|
1229 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
|
|
1230 # then it will generate one additional man file for each entity
|
|
|
1231 # documented in the real man page(s). These additional files
|
|
|
1232 # only source the real man page, but without them the man command
|
|
|
1233 # would be unable to find the correct page. The default is NO.
|
|
|
1234
|
|
|
1235 MAN_LINKS = NO
|
|
|
1236
|
|
|
1237 #---------------------------------------------------------------------------
|
|
|
1238 # configuration options related to the XML output
|
|
|
1239 #---------------------------------------------------------------------------
|
|
|
1240
|
|
|
1241 # If the GENERATE_XML tag is set to YES Doxygen will
|
|
|
1242 # generate an XML file that captures the structure of
|
|
|
1243 # the code including all documentation.
|
|
|
1244
|
|
|
1245 GENERATE_XML = NO
|
|
|
1246
|
|
|
1247 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
|
|
1248 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
1249 # put in front of it. If left blank `xml' will be used as the default path.
|
|
|
1250
|
|
|
1251 XML_OUTPUT = xml
|
|
|
1252
|
|
|
1253 # The XML_SCHEMA tag can be used to specify an XML schema,
|
|
|
1254 # which can be used by a validating XML parser to check the
|
|
|
1255 # syntax of the XML files.
|
|
|
1256
|
|
|
1257 XML_SCHEMA =
|
|
|
1258
|
|
|
1259 # The XML_DTD tag can be used to specify an XML DTD,
|
|
|
1260 # which can be used by a validating XML parser to check the
|
|
|
1261 # syntax of the XML files.
|
|
|
1262
|
|
|
1263 XML_DTD =
|
|
|
1264
|
|
|
1265 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
|
|
1266 # dump the program listings (including syntax highlighting
|
|
|
1267 # and cross-referencing information) to the XML output. Note that
|
|
|
1268 # enabling this will significantly increase the size of the XML output.
|
|
|
1269
|
|
|
1270 XML_PROGRAMLISTING = YES
|
|
|
1271
|
|
|
1272 #---------------------------------------------------------------------------
|
|
|
1273 # configuration options for the AutoGen Definitions output
|
|
|
1274 #---------------------------------------------------------------------------
|
|
|
1275
|
|
|
1276 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
|
|
1277 # generate an AutoGen Definitions (see autogen.sf.net) file
|
|
|
1278 # that captures the structure of the code including all
|
|
|
1279 # documentation. Note that this feature is still experimental
|
|
|
1280 # and incomplete at the moment.
|
|
|
1281
|
|
|
1282 GENERATE_AUTOGEN_DEF = NO
|
|
|
1283
|
|
|
1284 #---------------------------------------------------------------------------
|
|
|
1285 # configuration options related to the Perl module output
|
|
|
1286 #---------------------------------------------------------------------------
|
|
|
1287
|
|
|
1288 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
|
|
1289 # generate a Perl module file that captures the structure of
|
|
|
1290 # the code including all documentation. Note that this
|
|
|
1291 # feature is still experimental and incomplete at the
|
|
|
1292 # moment.
|
|
|
1293
|
|
|
1294 GENERATE_PERLMOD = NO
|
|
|
1295
|
|
|
1296 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
|
|
1297 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
|
|
1298 # to generate PDF and DVI output from the Perl module output.
|
|
|
1299
|
|
|
1300 PERLMOD_LATEX = NO
|
|
|
1301
|
|
|
1302 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
|
|
1303 # nicely formatted so it can be parsed by a human reader.
|
|
|
1304 # This is useful
|
|
|
1305 # if you want to understand what is going on.
|
|
|
1306 # On the other hand, if this
|
|
|
1307 # tag is set to NO the size of the Perl module output will be much smaller
|
|
|
1308 # and Perl will parse it just the same.
|
|
|
1309
|
|
|
1310 PERLMOD_PRETTY = YES
|
|
|
1311
|
|
|
1312 # The names of the make variables in the generated doxyrules.make file
|
|
|
1313 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
|
|
1314 # This is useful so different doxyrules.make files included by the same
|
|
|
1315 # Makefile don't overwrite each other's variables.
|
|
|
1316
|
|
|
1317 PERLMOD_MAKEVAR_PREFIX =
|
|
|
1318
|
|
|
1319 #---------------------------------------------------------------------------
|
|
|
1320 # Configuration options related to the preprocessor
|
|
|
1321 #---------------------------------------------------------------------------
|
|
|
1322
|
|
|
1323 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
|
|
1324 # evaluate all C-preprocessor directives found in the sources and include
|
|
|
1325 # files.
|
|
|
1326
|
|
|
1327 ENABLE_PREPROCESSING = YES
|
|
|
1328
|
|
|
1329 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
|
|
1330 # names in the source code. If set to NO (the default) only conditional
|
|
|
1331 # compilation will be performed. Macro expansion can be done in a controlled
|
|
|
1332 # way by setting EXPAND_ONLY_PREDEF to YES.
|
|
|
1333
|
|
|
1334 MACRO_EXPANSION = NO
|
|
|
1335
|
|
|
1336 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
|
|
1337 # then the macro expansion is limited to the macros specified with the
|
|
|
1338 # PREDEFINED and EXPAND_AS_DEFINED tags.
|
|
|
1339
|
|
|
1340 EXPAND_ONLY_PREDEF = NO
|
|
|
1341
|
|
|
1342 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
|
|
1343 # in the INCLUDE_PATH (see below) will be search if a #include is found.
|
|
|
1344
|
|
|
1345 SEARCH_INCLUDES = YES
|
|
|
1346
|
|
|
1347 # The INCLUDE_PATH tag can be used to specify one or more directories that
|
|
|
1348 # contain include files that are not input files but should be processed by
|
|
|
1349 # the preprocessor.
|
|
|
1350
|
|
|
1351 INCLUDE_PATH =
|
|
|
1352
|
|
|
1353 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
|
|
1354 # patterns (like *.h and *.hpp) to filter out the header-files in the
|
|
|
1355 # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
|
|
1356 # be used.
|
|
|
1357
|
|
|
1358 INCLUDE_FILE_PATTERNS =
|
|
|
1359
|
|
|
1360 # The PREDEFINED tag can be used to specify one or more macro names that
|
|
|
1361 # are defined before the preprocessor is started (similar to the -D option of
|
|
|
1362 # gcc). The argument of the tag is a list of macros of the form: name
|
|
|
1363 # or name=definition (no spaces). If the definition and the = are
|
|
|
1364 # omitted =1 is assumed. To prevent a macro definition from being
|
|
|
1365 # undefined via #undef or recursively expanded use the := operator
|
|
|
1366 # instead of the = operator.
|
|
|
1367
|
|
|
1368 PREDEFINED =
|
|
|
1369
|
|
|
1370 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
|
|
1371 # this tag can be used to specify a list of macro names that should be expanded.
|
|
|
1372 # The macro definition that is found in the sources will be used.
|
|
|
1373 # Use the PREDEFINED tag if you want to use a different macro definition.
|
|
|
1374
|
|
|
1375 EXPAND_AS_DEFINED =
|
|
|
1376
|
|
|
1377 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
|
|
1378 # doxygen's preprocessor will remove all function-like macros that are alone
|
|
|
1379 # on a line, have an all uppercase name, and do not end with a semicolon. Such
|
|
|
1380 # function macros are typically used for boiler-plate code, and will confuse
|
|
|
1381 # the parser if not removed.
|
|
|
1382
|
|
|
1383 SKIP_FUNCTION_MACROS = YES
|
|
|
1384
|
|
|
1385 #---------------------------------------------------------------------------
|
|
|
1386 # Configuration::additions related to external references
|
|
|
1387 #---------------------------------------------------------------------------
|
|
|
1388
|
|
|
1389 # The TAGFILES option can be used to specify one or more tagfiles.
|
|
|
1390 # Optionally an initial location of the external documentation
|
|
|
1391 # can be added for each tagfile. The format of a tag file without
|
|
|
1392 # this location is as follows:
|
|
|
1393 #
|
|
|
1394 # TAGFILES = file1 file2 ...
|
|
|
1395 # Adding location for the tag files is done as follows:
|
|
|
1396 #
|
|
|
1397 # TAGFILES = file1=loc1 "file2 = loc2" ...
|
|
|
1398 # where "loc1" and "loc2" can be relative or absolute paths or
|
|
|
1399 # URLs. If a location is present for each tag, the installdox tool
|
|
|
1400 # does not have to be run to correct the links.
|
|
|
1401 # Note that each tag file must have a unique name
|
|
|
1402 # (where the name does NOT include the path)
|
|
|
1403 # If a tag file is not located in the directory in which doxygen
|
|
|
1404 # is run, you must also specify the path to the tagfile here.
|
|
|
1405
|
|
|
1406 TAGFILES =
|
|
|
1407
|
|
|
1408 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
|
|
1409 # a tag file that is based on the input files it reads.
|
|
|
1410
|
|
|
1411 GENERATE_TAGFILE =
|
|
|
1412
|
|
|
1413 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
|
|
1414 # in the class index. If set to NO only the inherited external classes
|
|
|
1415 # will be listed.
|
|
|
1416
|
|
|
1417 ALLEXTERNALS = NO
|
|
|
1418
|
|
|
1419 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
|
|
1420 # in the modules index. If set to NO, only the current project's groups will
|
|
|
1421 # be listed.
|
|
|
1422
|
|
|
1423 EXTERNAL_GROUPS = YES
|
|
|
1424
|
|
|
1425 # The PERL_PATH should be the absolute path and name of the perl script
|
|
|
1426 # interpreter (i.e. the result of `which perl').
|
|
|
1427
|
|
|
1428 PERL_PATH = /usr/bin/perl
|
|
|
1429
|
|
|
1430 #---------------------------------------------------------------------------
|
|
|
1431 # Configuration options related to the dot tool
|
|
|
1432 #---------------------------------------------------------------------------
|
|
|
1433
|
|
|
1434 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
|
|
1435 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
|
|
1436 # or super classes. Setting the tag to NO turns the diagrams off. Note that
|
|
|
1437 # this option is superseded by the HAVE_DOT option below. This is only a
|
|
|
1438 # fallback. It is recommended to install and use dot, since it yields more
|
|
|
1439 # powerful graphs.
|
|
|
1440
|
|
|
1441 CLASS_DIAGRAMS = YES
|
|
|
1442
|
|
|
1443 # You can define message sequence charts within doxygen comments using the \msc
|
|
|
1444 # command. Doxygen will then run the mscgen tool (see
|
|
|
1445 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
|
|
|
1446 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
|
|
1447 # the mscgen tool resides. If left empty the tool is assumed to be found in the
|
|
|
1448 # default search path.
|
|
|
1449
|
|
|
1450 MSCGEN_PATH =
|
|
|
1451
|
|
|
1452 # If set to YES, the inheritance and collaboration graphs will hide
|
|
|
1453 # inheritance and usage relations if the target is undocumented
|
|
|
1454 # or is not a class.
|
|
|
1455
|
|
|
1456 HIDE_UNDOC_RELATIONS = YES
|
|
|
1457
|
|
|
1458 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
|
|
1459 # available from the path. This tool is part of Graphviz, a graph visualization
|
|
|
1460 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
|
|
1461 # have no effect if this option is set to NO (the default)
|
|
|
1462
|
|
|
1463 HAVE_DOT = NO
|
|
|
1464
|
|
|
1465 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
|
|
1466 # allowed to run in parallel. When set to 0 (the default) doxygen will
|
|
|
1467 # base this on the number of processors available in the system. You can set it
|
|
|
1468 # explicitly to a value larger than 0 to get control over the balance
|
|
|
1469 # between CPU load and processing speed.
|
|
|
1470
|
|
|
1471 DOT_NUM_THREADS = 0
|
|
|
1472
|
|
|
1473 # By default doxygen will write a font called FreeSans.ttf to the output
|
|
|
1474 # directory and reference it in all dot files that doxygen generates. This
|
|
|
1475 # font does not include all possible unicode characters however, so when you need
|
|
|
1476 # these (or just want a differently looking font) you can specify the font name
|
|
|
1477 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
|
|
|
1478 # which can be done by putting it in a standard location or by setting the
|
|
|
1479 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
|
|
|
1480 # containing the font.
|
|
|
1481
|
|
|
1482 DOT_FONTNAME = FreeSans.ttf
|
|
|
1483
|
|
|
1484 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
|
|
|
1485 # The default size is 10pt.
|
|
|
1486
|
|
|
1487 DOT_FONTSIZE = 10
|
|
|
1488
|
|
|
1489 # By default doxygen will tell dot to use the output directory to look for the
|
|
|
1490 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
|
|
|
1491 # different font using DOT_FONTNAME you can set the path where dot
|
|
|
1492 # can find it using this tag.
|
|
|
1493
|
|
|
1494 DOT_FONTPATH =
|
|
|
1495
|
|
|
1496 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
1497 # will generate a graph for each documented class showing the direct and
|
|
|
1498 # indirect inheritance relations. Setting this tag to YES will force the
|
|
|
1499 # the CLASS_DIAGRAMS tag to NO.
|
|
|
1500
|
|
|
1501 CLASS_GRAPH = YES
|
|
|
1502
|
|
|
1503 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
1504 # will generate a graph for each documented class showing the direct and
|
|
|
1505 # indirect implementation dependencies (inheritance, containment, and
|
|
|
1506 # class references variables) of the class with other documented classes.
|
|
|
1507
|
|
|
1508 COLLABORATION_GRAPH = YES
|
|
|
1509
|
|
|
1510 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
|
|
|
1511 # will generate a graph for groups, showing the direct groups dependencies
|
|
|
1512
|
|
|
1513 GROUP_GRAPHS = YES
|
|
|
1514
|
|
|
1515 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
|
|
1516 # collaboration diagrams in a style similar to the OMG's Unified Modeling
|
|
|
1517 # Language.
|
|
|
1518
|
|
|
1519 UML_LOOK = NO
|
|
|
1520
|
|
|
1521 # If set to YES, the inheritance and collaboration graphs will show the
|
|
|
1522 # relations between templates and their instances.
|
|
|
1523
|
|
|
1524 TEMPLATE_RELATIONS = NO
|
|
|
1525
|
|
|
1526 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
|
|
1527 # tags are set to YES then doxygen will generate a graph for each documented
|
|
|
1528 # file showing the direct and indirect include dependencies of the file with
|
|
|
1529 # other documented files.
|
|
|
1530
|
|
|
1531 INCLUDE_GRAPH = YES
|
|
|
1532
|
|
|
1533 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
|
|
1534 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
|
|
1535 # documented header file showing the documented files that directly or
|
|
|
1536 # indirectly include this file.
|
|
|
1537
|
|
|
1538 INCLUDED_BY_GRAPH = YES
|
|
|
1539
|
|
|
1540 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
|
|
|
1541 # doxygen will generate a call dependency graph for every global function
|
|
|
1542 # or class method. Note that enabling this option will significantly increase
|
|
|
1543 # the time of a run. So in most cases it will be better to enable call graphs
|
|
|
1544 # for selected functions only using the \callgraph command.
|
|
|
1545
|
|
|
1546 CALL_GRAPH = NO
|
|
|
1547
|
|
|
1548 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
|
|
|
1549 # doxygen will generate a caller dependency graph for every global function
|
|
|
1550 # or class method. Note that enabling this option will significantly increase
|
|
|
1551 # the time of a run. So in most cases it will be better to enable caller
|
|
|
1552 # graphs for selected functions only using the \callergraph command.
|
|
|
1553
|
|
|
1554 CALLER_GRAPH = NO
|
|
|
1555
|
|
|
1556 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
|
|
1557 # will graphical hierarchy of all classes instead of a textual one.
|
|
|
1558
|
|
|
1559 GRAPHICAL_HIERARCHY = YES
|
|
|
1560
|
|
|
1561 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
|
|
|
1562 # then doxygen will show the dependencies a directory has on other directories
|
|
|
1563 # in a graphical way. The dependency relations are determined by the #include
|
|
|
1564 # relations between the files in the directories.
|
|
|
1565
|
|
|
1566 DIRECTORY_GRAPH = YES
|
|
|
1567
|
|
|
1568 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
|
1569 # generated by dot. Possible values are png, jpg, or gif
|
|
|
1570 # If left blank png will be used.
|
|
|
1571
|
|
|
1572 DOT_IMAGE_FORMAT = png
|
|
|
1573
|
|
|
1574 # The tag DOT_PATH can be used to specify the path where the dot tool can be
|
|
|
1575 # found. If left blank, it is assumed the dot tool can be found in the path.
|
|
|
1576
|
|
|
1577 DOT_PATH =
|
|
|
1578
|
|
|
1579 # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
|
|
1580 # contain dot files that are included in the documentation (see the
|
|
|
1581 # \dotfile command).
|
|
|
1582
|
|
|
1583 DOTFILE_DIRS =
|
|
|
1584
|
|
|
1585 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
|
|
1586 # nodes that will be shown in the graph. If the number of nodes in a graph
|
|
|
1587 # becomes larger than this value, doxygen will truncate the graph, which is
|
|
|
1588 # visualized by representing a node as a red box. Note that doxygen if the
|
|
|
1589 # number of direct children of the root node in a graph is already larger than
|
|
|
1590 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
|
|
|
1591 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
|
|
1592
|
|
|
1593 DOT_GRAPH_MAX_NODES = 50
|
|
|
1594
|
|
|
1595 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
|
|
1596 # graphs generated by dot. A depth value of 3 means that only nodes reachable
|
|
|
1597 # from the root by following a path via at most 3 edges will be shown. Nodes
|
|
|
1598 # that lay further from the root node will be omitted. Note that setting this
|
|
|
1599 # option to 1 or 2 may greatly reduce the computation time needed for large
|
|
|
1600 # code bases. Also note that the size of a graph can be further restricted by
|
|
|
1601 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
|
|
1602
|
|
|
1603 MAX_DOT_GRAPH_DEPTH = 0
|
|
|
1604
|
|
|
1605 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
|
|
1606 # background. This is disabled by default, because dot on Windows does not
|
|
|
1607 # seem to support this out of the box. Warning: Depending on the platform used,
|
|
|
1608 # enabling this option may lead to badly anti-aliased labels on the edges of
|
|
|
1609 # a graph (i.e. they become hard to read).
|
|
|
1610
|
|
|
1611 DOT_TRANSPARENT = NO
|
|
|
1612
|
|
|
1613 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
|
|
1614 # files in one run (i.e. multiple -o and -T options on the command line). This
|
|
|
1615 # makes dot run faster, but since only newer versions of dot (>1.8.10)
|
|
|
1616 # support this, this feature is disabled by default.
|
|
|
1617
|
|
|
1618 DOT_MULTI_TARGETS = NO
|
|
|
1619
|
|
|
1620 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
|
|
1621 # generate a legend page explaining the meaning of the various boxes and
|
|
|
1622 # arrows in the dot generated graphs.
|
|
|
1623
|
|
|
1624 GENERATE_LEGEND = YES
|
|
|
1625
|
|
|
1626 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
|
|
1627 # remove the intermediate dot files that are used to generate
|
|
|
1628 # the various graphs.
|
|
|
1629
|
|
|
1630 DOT_CLEANUP = YES
|
