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