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