Annotation of gpl/axl/doc/axl-doc.doxygen, revision 1.1.1.2
1.1 misho 1: # Doxyfile 1.5.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 that
18: # follow. The default is UTF-8 which is also the encoding used for all text before
19: # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20: # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21: # 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 = "AXL: Another XML Library implementation. "
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:
1.1.1.2 ! misho 34: PROJECT_NUMBER = 0.6.7.b4920.g4922
1.1 misho 35:
36: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37: # base path where the generated documentation will be put.
38: # If a relative path is entered, it will be relative to the location
39: # where doxygen was started. If left blank the current directory will be used.
40:
41: OUTPUT_DIRECTORY =
42:
43: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44: # 4096 sub-directories (in 2 levels) under the output directory of each output
45: # format and will distribute the generated files over these directories.
46: # Enabling this option can be useful when feeding doxygen a huge amount of
47: # source files, where putting all generated files in the same directory would
48: # otherwise cause performance problems for the file system.
49:
50: CREATE_SUBDIRS = NO
51:
52: # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53: # documentation generated by doxygen is written. Doxygen will use this
54: # information to generate all constant output in the proper language.
55: # The default language is English, other supported languages are:
56: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57: # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58: # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59: # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60: # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
61:
62: OUTPUT_LANGUAGE = English
63:
64: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65: # include brief member descriptions after the members that are listed in
66: # the file and class documentation (similar to JavaDoc).
67: # Set to NO to disable this.
68:
69: BRIEF_MEMBER_DESC = YES
70:
71: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72: # the brief description of a member or function before the detailed description.
73: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74: # brief descriptions will be completely suppressed.
75:
76: REPEAT_BRIEF = YES
77:
78: # This tag implements a quasi-intelligent brief description abbreviator
79: # that is used to form the text in various listings. Each string
80: # in this list, if found as the leading text of the brief description, will be
81: # stripped from the text and the result after processing the whole list, is
82: # used as the annotated text. Otherwise, the brief description is used as-is.
83: # If left blank, the following values are used ("$name" is automatically
84: # replaced with the name of the entity): "The $name class" "The $name widget"
85: # "The $name file" "is" "provides" "specifies" "contains"
86: # "represents" "a" "an" "the"
87:
88: ABBREVIATE_BRIEF =
89:
90: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91: # Doxygen will generate a detailed section even if there is only a brief
92: # description.
93:
94: ALWAYS_DETAILED_SEC = YES
95:
96: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97: # inherited members of a class in the documentation of that class as if those
98: # members were ordinary class members. Constructors, destructors and assignment
99: # operators of the base classes will not be shown.
100:
101: INLINE_INHERITED_MEMB = NO
102:
103: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104: # path before files name in the file list and in the header files. If set
105: # to NO the shortest path that makes the file name unique will be used.
106:
107: FULL_PATH_NAMES = NO
108:
109: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110: # can be used to strip a user-defined part of the path. Stripping is
111: # only done if one of the specified strings matches the left-hand part of
112: # the path. The tag can be used to show relative paths in the file list.
113: # If left blank the directory from which doxygen is run is used as the
114: # path to strip.
115:
116: STRIP_FROM_PATH =
117:
118: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119: # the path mentioned in the documentation of a class, which tells
120: # the reader which header file to include in order to use a class.
121: # If left blank only the name of the header file containing the class
122: # definition is used. Otherwise one should specify the include paths that
123: # are normally passed to the compiler using the -I flag.
124:
125: STRIP_FROM_INC_PATH =
126:
127: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128: # (but less readable) file names. This can be useful is your file systems
129: # doesn't support long names like on DOS, Mac, or CD-ROM.
130:
131: SHORT_NAMES = NO
132:
133: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134: # will interpret the first line (until the first dot) of a JavaDoc-style
135: # comment as the brief description. If set to NO, the JavaDoc
136: # comments will behave just like regular Qt-style comments
137: # (thus requiring an explicit @brief command for a brief description.)
138:
139: JAVADOC_AUTOBRIEF = YES
140:
141: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142: # interpret the first line (until the first dot) of a Qt-style
143: # comment as the brief description. If set to NO, the comments
144: # will behave just like regular Qt-style comments (thus requiring
145: # an explicit \brief command for a brief description.)
146:
147: QT_AUTOBRIEF = NO
148:
149: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150: # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151: # comments) as a brief description. This used to be the default behaviour.
152: # The new default is to treat a multi-line C++ comment block as a detailed
153: # description. Set this tag to YES if you prefer the old behaviour instead.
154:
155: MULTILINE_CPP_IS_BRIEF = NO
156:
157: # If the DETAILS_AT_TOP tag is set to YES then Doxygen
158: # will output the detailed description near the top, like JavaDoc.
159: # If set to NO, the detailed description appears after the member
160: # documentation.
161:
162: DETAILS_AT_TOP = YES
163:
164: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165: # member inherits the documentation from any documented member that it
166: # re-implements.
167:
168: INHERIT_DOCS = YES
169:
170: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171: # a new page for each member. If set to NO, the documentation of a member will
172: # be part of the file/class/namespace that contains it.
173:
174: SEPARATE_MEMBER_PAGES = YES
175:
176: # The TAB_SIZE tag can be used to set the number of spaces in a tab.
177: # Doxygen uses this value to replace tabs by spaces in code fragments.
178:
179: TAB_SIZE = 8
180:
181: # This tag can be used to specify a number of aliases that acts
182: # as commands in the documentation. An alias has the form "name=value".
183: # For example adding "sideeffect=\par Side Effects:\n" will allow you to
184: # put the command \sideeffect (or @sideeffect) in the documentation, which
185: # will result in a user-defined paragraph with heading "Side Effects:".
186: # You can put \n's in the value part of an alias to insert newlines.
187:
188: ALIASES =
189:
190: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
191: # sources only. Doxygen will then generate output that is more tailored for C.
192: # For instance, some of the names that are used will be different. The list
193: # of all members will be omitted, etc.
194:
195: OPTIMIZE_OUTPUT_FOR_C = YES
196:
197: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
198: # sources only. Doxygen will then generate output that is more tailored for Java.
199: # For instance, namespaces will be presented as packages, qualified scopes
200: # will look different, etc.
201:
202: OPTIMIZE_OUTPUT_JAVA = NO
203:
204: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
205: # include (a tag file for) the STL sources as input, then you should
206: # set this tag to YES in order to let doxygen match functions declarations and
207: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
208: # func(std::string) {}). This also make the inheritance and collaboration
209: # diagrams that involve STL classes more complete and accurate.
210:
211: BUILTIN_STL_SUPPORT = NO
212:
213: # If you use Microsoft's C++/CLI language, you should set this option to YES to
214: # enable parsing support.
215:
216: CPP_CLI_SUPPORT = NO
217:
218: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219: # tag is set to YES, then doxygen will reuse the documentation of the first
220: # member in the group (if any) for the other members of the group. By default
221: # all members of a group must be documented explicitly.
222:
223: DISTRIBUTE_GROUP_DOC = NO
224:
225: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
226: # the same type (for instance a group of public functions) to be put as a
227: # subgroup of that type (e.g. under the Public Functions section). Set it to
228: # NO to prevent subgrouping. Alternatively, this can be done per class using
229: # the \nosubgrouping command.
230:
231: SUBGROUPING = YES
232:
233: #---------------------------------------------------------------------------
234: # Build related configuration options
235: #---------------------------------------------------------------------------
236:
237: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
238: # documentation are documented, even if no documentation was available.
239: # Private class members and static file members will be hidden unless
240: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
241:
242: EXTRACT_ALL = NO
243:
244: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
245: # will be included in the documentation.
246:
247: EXTRACT_PRIVATE = NO
248:
249: # If the EXTRACT_STATIC tag is set to YES all static members of a file
250: # will be included in the documentation.
251:
252: EXTRACT_STATIC = NO
253:
254: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
255: # defined locally in source files will be included in the documentation.
256: # If set to NO only classes defined in header files are included.
257:
258: EXTRACT_LOCAL_CLASSES = NO
259:
260: # This flag is only useful for Objective-C code. When set to YES local
261: # methods, which are defined in the implementation section but not in
262: # the interface are included in the documentation.
263: # If set to NO (the default) only methods in the interface are included.
264:
265: EXTRACT_LOCAL_METHODS = NO
266:
267: # If this flag is set to YES, the members of anonymous namespaces will be extracted
268: # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
269: # where file will be replaced with the base name of the file that contains the anonymous
270: # namespace. By default anonymous namespace are hidden.
271:
272: EXTRACT_ANON_NSPACES = NO
273:
274: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
275: # undocumented members of documented classes, files or namespaces.
276: # If set to NO (the default) these members will be included in the
277: # various overviews, but no documentation section is generated.
278: # This option has no effect if EXTRACT_ALL is enabled.
279:
280: HIDE_UNDOC_MEMBERS = YES
281:
282: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
283: # undocumented classes that are normally visible in the class hierarchy.
284: # If set to NO (the default) these classes will be included in the various
285: # overviews. This option has no effect if EXTRACT_ALL is enabled.
286:
287: HIDE_UNDOC_CLASSES = YES
288:
289: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
290: # friend (class|struct|union) declarations.
291: # If set to NO (the default) these declarations will be included in the
292: # documentation.
293:
294: HIDE_FRIEND_COMPOUNDS = NO
295:
296: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
297: # documentation blocks found inside the body of a function.
298: # If set to NO (the default) these blocks will be appended to the
299: # function's detailed documentation block.
300:
301: HIDE_IN_BODY_DOCS = NO
302:
303: # The INTERNAL_DOCS tag determines if documentation
304: # that is typed after a \internal command is included. If the tag is set
305: # to NO (the default) then the documentation will be excluded.
306: # Set it to YES to include the internal documentation.
307:
308: INTERNAL_DOCS = NO
309:
310: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
311: # file names in lower-case letters. If set to YES upper-case letters are also
312: # allowed. This is useful if you have classes or files whose names only differ
313: # in case and if your file system supports case sensitive file names. Windows
314: # and Mac users are advised to set this option to NO.
315:
316: CASE_SENSE_NAMES = YES
317:
318: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
319: # will show members with their full class and namespace scopes in the
320: # documentation. If set to YES the scope will be hidden.
321:
322: HIDE_SCOPE_NAMES = YES
323:
324: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
325: # will put a list of the files that are included by a file in the documentation
326: # of that file.
327:
328: SHOW_INCLUDE_FILES = NO
329:
330: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
331: # is inserted in the documentation for inline members.
332:
333: INLINE_INFO = NO
334:
335: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
336: # will sort the (detailed) documentation of file and class members
337: # alphabetically by member name. If set to NO the members will appear in
338: # declaration order.
339:
340: SORT_MEMBER_DOCS = YES
341:
342: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
343: # brief documentation of file, namespace and class members alphabetically
344: # by member name. If set to NO (the default) the members will appear in
345: # declaration order.
346:
347: SORT_BRIEF_DOCS = YES
348:
349: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
350: # sorted by fully-qualified names, including namespaces. If set to
351: # NO (the default), the class list will be sorted only by class name,
352: # not including the namespace part.
353: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
354: # Note: This option applies only to the class list, not to the
355: # alphabetical list.
356:
357: SORT_BY_SCOPE_NAME = NO
358:
359: # The GENERATE_TODOLIST tag can be used to enable (YES) or
360: # disable (NO) the todo list. This list is created by putting \todo
361: # commands in the documentation.
362:
363: GENERATE_TODOLIST = YES
364:
365: # The GENERATE_TESTLIST tag can be used to enable (YES) or
366: # disable (NO) the test list. This list is created by putting \test
367: # commands in the documentation.
368:
369: GENERATE_TESTLIST = YES
370:
371: # The GENERATE_BUGLIST tag can be used to enable (YES) or
372: # disable (NO) the bug list. This list is created by putting \bug
373: # commands in the documentation.
374:
375: GENERATE_BUGLIST = YES
376:
377: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
378: # disable (NO) the deprecated list. This list is created by putting
379: # \deprecated commands in the documentation.
380:
381: GENERATE_DEPRECATEDLIST= YES
382:
383: # The ENABLED_SECTIONS tag can be used to enable conditional
384: # documentation sections, marked by \if sectionname ... \endif.
385:
386: ENABLED_SECTIONS =
387:
388: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
389: # the initial value of a variable or define consists of for it to appear in
390: # the documentation. If the initializer consists of more lines than specified
391: # here it will be hidden. Use a value of 0 to hide initializers completely.
392: # The appearance of the initializer of individual variables and defines in the
393: # documentation can be controlled using \showinitializer or \hideinitializer
394: # command in the documentation regardless of this setting.
395:
396: MAX_INITIALIZER_LINES = 30
397:
398: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
399: # at the bottom of the documentation of classes and structs. If set to YES the
400: # list will mention the files that were used to generate the documentation.
401:
402: SHOW_USED_FILES = NO
403:
404: # If the sources in your project are distributed over multiple directories
405: # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
406: # in the documentation. The default is NO.
407:
408: SHOW_DIRECTORIES = NO
409:
410: # The FILE_VERSION_FILTER tag can be used to specify a program or script that
411: # doxygen should invoke to get the current version for each file (typically from the
412: # version control system). Doxygen will invoke the program by executing (via
413: # popen()) the command <command> <input-file>, where <command> is the value of
414: # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
415: # provided by doxygen. Whatever the program writes to standard output
416: # is used as the file version. See the manual for examples.
417:
418: FILE_VERSION_FILTER =
419:
420: #---------------------------------------------------------------------------
421: # configuration options related to warning and progress messages
422: #---------------------------------------------------------------------------
423:
424: # The QUIET tag can be used to turn on/off the messages that are generated
425: # by doxygen. Possible values are YES and NO. If left blank NO is used.
426:
427: QUIET = NO
428:
429: # The WARNINGS tag can be used to turn on/off the warning messages that are
430: # generated by doxygen. Possible values are YES and NO. If left blank
431: # NO is used.
432:
433: WARNINGS = YES
434:
435: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
436: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
437: # automatically be disabled.
438:
439: WARN_IF_UNDOCUMENTED = YES
440:
441: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
442: # potential errors in the documentation, such as not documenting some
443: # parameters in a documented function, or documenting parameters that
444: # don't exist or using markup commands wrongly.
445:
446: WARN_IF_DOC_ERROR = YES
447:
448: # This WARN_NO_PARAMDOC option can be abled to get warnings for
449: # functions that are documented, but have no documentation for their parameters
450: # or return value. If set to NO (the default) doxygen will only warn about
451: # wrong or incomplete parameter documentation, but not about the absence of
452: # documentation.
453:
454: WARN_NO_PARAMDOC = NO
455:
456: # The WARN_FORMAT tag determines the format of the warning messages that
457: # doxygen can produce. The string should contain the $file, $line, and $text
458: # tags, which will be replaced by the file and line number from which the
459: # warning originated and the warning text. Optionally the format may contain
460: # $version, which will be replaced by the version of the file (if it could
461: # be obtained via FILE_VERSION_FILTER)
462:
463: WARN_FORMAT = "$file:$line: $text "
464:
465: # The WARN_LOGFILE tag can be used to specify a file to which warning
466: # and error messages should be written. If left blank the output is written
467: # to stderr.
468:
469: WARN_LOGFILE =
470:
471: #---------------------------------------------------------------------------
472: # configuration options related to the input files
473: #---------------------------------------------------------------------------
474:
475: # The INPUT tag can be used to specify the files and/or directories that contain
476: # documented source files. You may enter file names like "myfile.cpp" or
477: # directories like "/usr/src/myproject". Separate the files or directories
478: # with spaces.
479:
480: INPUT = ../src \
481: ../ns \
482: ../knife/axl-knife.c \
483: ../babel
484:
485: # This tag can be used to specify the character encoding of the source files that
486: # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
487: # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
488: # See http://www.gnu.org/software/libiconv for the list of possible encodings.
489:
490: INPUT_ENCODING = UTF-8
491:
492: # If the value of the INPUT tag contains directories, you can use the
493: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
494: # and *.h) to filter out the source-files in the directories. If left
495: # blank the following patterns are tested:
496: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
497: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
498:
499: FILE_PATTERNS =
500:
501: # The RECURSIVE tag can be used to turn specify whether or not subdirectories
502: # should be searched for input files as well. Possible values are YES and NO.
503: # If left blank NO is used.
504:
505: RECURSIVE = NO
506:
507: # The EXCLUDE tag can be used to specify files and/or directories that should
508: # excluded from the INPUT source files. This way you can easily exclude a
509: # subdirectory from a directory tree whose root is specified with the INPUT tag.
510:
511: EXCLUDE =
512:
513: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
514: # directories that are symbolic links (a Unix filesystem feature) are excluded
515: # from the input.
516:
517: EXCLUDE_SYMLINKS = NO
518:
519: # If the value of the INPUT tag contains directories, you can use the
520: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
521: # certain files from those directories. Note that the wildcards are matched
522: # against the file with absolute path, so to exclude all test directories
523: # for example use the pattern */test/*
524:
525: EXCLUDE_PATTERNS =
526:
527: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
528: # (namespaces, classes, functions, etc.) that should be excluded from the output.
529: # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
530: # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
531:
532: EXCLUDE_SYMBOLS =
533:
534: # The EXAMPLE_PATH tag can be used to specify one or more files or
535: # directories that contain example code fragments that are included (see
536: # the \include command).
537:
538: EXAMPLE_PATH = ../test \
539: ../doc \
540: ../src
541:
542: # If the value of the EXAMPLE_PATH tag contains directories, you can use the
543: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
544: # and *.h) to filter out the source-files in the directories. If left
545: # blank all files are included.
546:
547: EXAMPLE_PATTERNS =
548:
549: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
550: # searched for input files to be used with the \include or \dontinclude
551: # commands irrespective of the value of the RECURSIVE tag.
552: # Possible values are YES and NO. If left blank NO is used.
553:
554: EXAMPLE_RECURSIVE = NO
555:
556: # The IMAGE_PATH tag can be used to specify one or more files or
557: # directories that contain image that are included in the documentation (see
558: # the \image command).
559:
560: IMAGE_PATH = ../doc
561:
562: # The INPUT_FILTER tag can be used to specify a program that doxygen should
563: # invoke to filter for each input file. Doxygen will invoke the filter program
564: # by executing (via popen()) the command <filter> <input-file>, where <filter>
565: # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
566: # input file. Doxygen will then use the output that the filter program writes
567: # to standard output. If FILTER_PATTERNS is specified, this tag will be
568: # ignored.
569:
570: INPUT_FILTER =
571:
572: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
573: # basis. Doxygen will compare the file name with each pattern and apply the
574: # filter if there is a match. The filters are a list of the form:
575: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
576: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
577: # is applied to all files.
578:
579: FILTER_PATTERNS =
580:
581: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
582: # INPUT_FILTER) will be used to filter the input files when producing source
583: # files to browse (i.e. when SOURCE_BROWSER is set to YES).
584:
585: FILTER_SOURCE_FILES = NO
586:
587: #---------------------------------------------------------------------------
588: # configuration options related to source browsing
589: #---------------------------------------------------------------------------
590:
591: # If the SOURCE_BROWSER tag is set to YES then a list of source files will
592: # be generated. Documented entities will be cross-referenced with these sources.
593: # Note: To get rid of all source code in the generated output, make sure also
594: # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
595: # then you must also enable this option. If you don't then doxygen will produce
596: # a warning and turn it on anyway
597:
598: SOURCE_BROWSER = NO
599:
600: # Setting the INLINE_SOURCES tag to YES will include the body
601: # of functions and classes directly in the documentation.
602:
603: INLINE_SOURCES = NO
604:
605: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
606: # doxygen to hide any special comment blocks from generated source code
607: # fragments. Normal C and C++ comments will always remain visible.
608:
609: STRIP_CODE_COMMENTS = YES
610:
611: # If the REFERENCED_BY_RELATION tag is set to YES (the default)
612: # then for each documented function all documented
613: # functions referencing it will be listed.
614:
615: REFERENCED_BY_RELATION = YES
616:
617: # If the REFERENCES_RELATION tag is set to YES (the default)
618: # then for each documented function all documented entities
619: # called/used by that function will be listed.
620:
621: REFERENCES_RELATION = YES
622:
623: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
624: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
625: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
626: # link to the source code. Otherwise they will link to the documentstion.
627:
628: REFERENCES_LINK_SOURCE = YES
629:
630: # If the USE_HTAGS tag is set to YES then the references to source code
631: # will point to the HTML generated by the htags(1) tool instead of doxygen
632: # built-in source browser. The htags tool is part of GNU's global source
633: # tagging system (see http://www.gnu.org/software/global/global.html). You
634: # will need version 4.8.6 or higher.
635:
636: USE_HTAGS = NO
637:
638: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
639: # will generate a verbatim copy of the header file for each class for
640: # which an include is specified. Set to NO to disable this.
641:
642: VERBATIM_HEADERS = NO
643:
644: #---------------------------------------------------------------------------
645: # configuration options related to the alphabetical class index
646: #---------------------------------------------------------------------------
647:
648: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
649: # of all compounds will be generated. Enable this if the project
650: # contains a lot of classes, structs, unions or interfaces.
651:
652: ALPHABETICAL_INDEX = NO
653:
654: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
655: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
656: # in which this list will be split (can be a number in the range [1..20])
657:
658: COLS_IN_ALPHA_INDEX = 5
659:
660: # In case all classes in a project start with a common prefix, all
661: # classes will be put under the same header in the alphabetical index.
662: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
663: # should be ignored while generating the index headers.
664:
665: IGNORE_PREFIX =
666:
667: #---------------------------------------------------------------------------
668: # configuration options related to the HTML output
669: #---------------------------------------------------------------------------
670:
671: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
672: # generate HTML output.
673:
674: GENERATE_HTML = YES
675:
676: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
677: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
678: # put in front of it. If left blank `html' will be used as the default path.
679:
680: HTML_OUTPUT = html
681:
682: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
683: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
684: # doxygen will generate files with .html extension.
685:
686: HTML_FILE_EXTENSION = .html
687:
688: # The HTML_HEADER tag can be used to specify a personal HTML header for
689: # each generated HTML page. If it is left blank doxygen will generate a
690: # standard header.
691:
692: HTML_HEADER = ../doc/axl-doc-header.html
693:
694: # The HTML_FOOTER tag can be used to specify a personal HTML footer for
695: # each generated HTML page. If it is left blank doxygen will generate a
696: # standard footer.
697:
698: HTML_FOOTER = ../doc/axl-doc-footer.html
699:
700: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
701: # style sheet that is used by each HTML page. It can be used to
702: # fine-tune the look of the HTML output. If the tag is left blank doxygen
703: # will generate a default style sheet. Note that doxygen will try to copy
704: # the style sheet file to the HTML output directory, so don't put your own
705: # stylesheet in the HTML output directory as well, or it will be erased!
706:
707: HTML_STYLESHEET =
708:
709: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
710: # files or namespaces will be aligned in HTML using tables. If set to
711: # NO a bullet list will be used.
712:
713: HTML_ALIGN_MEMBERS = YES
714:
715: # If the GENERATE_HTMLHELP tag is set to YES, additional index files
716: # will be generated that can be used as input for tools like the
717: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
718: # of the generated HTML documentation.
719:
720: GENERATE_HTMLHELP = NO
721:
722: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
723: # documentation will contain sections that can be hidden and shown after the
724: # page has loaded. For this to work a browser that supports
725: # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
726: # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
727:
728: HTML_DYNAMIC_SECTIONS = NO
729:
730: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
731: # be used to specify the file name of the resulting .chm file. You
732: # can add a path in front of the file if the result should not be
733: # written to the html output directory.
734:
735: CHM_FILE =
736:
737: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
738: # be used to specify the location (absolute path including file name) of
739: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
740: # the HTML help compiler on the generated index.hhp.
741:
742: HHC_LOCATION =
743:
744: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
745: # controls if a separate .chi index file is generated (YES) or that
746: # it should be included in the master .chm file (NO).
747:
748: GENERATE_CHI = NO
749:
750: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
751: # controls whether a binary table of contents is generated (YES) or a
752: # normal table of contents (NO) in the .chm file.
753:
754: BINARY_TOC = NO
755:
756: # The TOC_EXPAND flag can be set to YES to add extra items for group members
757: # to the contents of the HTML help documentation and to the tree view.
758:
759: TOC_EXPAND = NO
760:
761: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
762: # top of each HTML page. The value NO (the default) enables the index and
763: # the value YES disables it.
764:
765: DISABLE_INDEX = NO
766:
767: # This tag can be used to set the number of enum values (range [1..20])
768: # that doxygen will group on one line in the generated HTML documentation.
769:
770: ENUM_VALUES_PER_LINE = 4
771:
772: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
773: # generated containing a tree-like index structure (just like the one that
774: # is generated for HTML Help). For this to work a browser that supports
775: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
776: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
777: # probably better off using the HTML help feature.
778:
779: GENERATE_TREEVIEW = NO
780:
781: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
782: # used to set the initial width (in pixels) of the frame in which the tree
783: # is shown.
784:
785: TREEVIEW_WIDTH = 250
786:
787: #---------------------------------------------------------------------------
788: # configuration options related to the LaTeX output
789: #---------------------------------------------------------------------------
790:
791: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
792: # generate Latex output.
793:
794: GENERATE_LATEX = NO
795:
796: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
797: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
798: # put in front of it. If left blank `latex' will be used as the default path.
799:
800: LATEX_OUTPUT = latex
801:
802: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
803: # invoked. If left blank `latex' will be used as the default command name.
804:
805: LATEX_CMD_NAME = latex
806:
807: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
808: # generate index for LaTeX. If left blank `makeindex' will be used as the
809: # default command name.
810:
811: MAKEINDEX_CMD_NAME = makeindex
812:
813: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
814: # LaTeX documents. This may be useful for small projects and may help to
815: # save some trees in general.
816:
817: COMPACT_LATEX = NO
818:
819: # The PAPER_TYPE tag can be used to set the paper type that is used
820: # by the printer. Possible values are: a4, a4wide, letter, legal and
821: # executive. If left blank a4wide will be used.
822:
823: PAPER_TYPE = a4wide
824:
825: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
826: # packages that should be included in the LaTeX output.
827:
828: EXTRA_PACKAGES =
829:
830: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
831: # the generated latex document. The header should contain everything until
832: # the first chapter. If it is left blank doxygen will generate a
833: # standard header. Notice: only use this tag if you know what you are doing!
834:
835: LATEX_HEADER =
836:
837: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
838: # is prepared for conversion to pdf (using ps2pdf). The pdf file will
839: # contain links (just like the HTML output) instead of page references
840: # This makes the output suitable for online browsing using a pdf viewer.
841:
842: PDF_HYPERLINKS = YES
843:
844: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
845: # plain latex in the generated Makefile. Set this option to YES to get a
846: # higher quality PDF documentation.
847:
848: USE_PDFLATEX = YES
849:
850: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
851: # command to the generated LaTeX files. This will instruct LaTeX to keep
852: # running if errors occur, instead of asking the user for help.
853: # This option is also used when generating formulas in HTML.
854:
855: LATEX_BATCHMODE = NO
856:
857: # If LATEX_HIDE_INDICES is set to YES then doxygen will not
858: # include the index chapters (such as File Index, Compound Index, etc.)
859: # in the output.
860:
861: LATEX_HIDE_INDICES = NO
862:
863: #---------------------------------------------------------------------------
864: # configuration options related to the RTF output
865: #---------------------------------------------------------------------------
866:
867: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
868: # The RTF output is optimized for Word 97 and may not look very pretty with
869: # other RTF readers or editors.
870:
871: GENERATE_RTF = NO
872:
873: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
874: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
875: # put in front of it. If left blank `rtf' will be used as the default path.
876:
877: RTF_OUTPUT = rtf
878:
879: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
880: # RTF documents. This may be useful for small projects and may help to
881: # save some trees in general.
882:
883: COMPACT_RTF = NO
884:
885: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
886: # will contain hyperlink fields. The RTF file will
887: # contain links (just like the HTML output) instead of page references.
888: # This makes the output suitable for online browsing using WORD or other
889: # programs which support those fields.
890: # Note: wordpad (write) and others do not support links.
891:
892: RTF_HYPERLINKS = NO
893:
894: # Load stylesheet definitions from file. Syntax is similar to doxygen's
895: # config file, i.e. a series of assignments. You only have to provide
896: # replacements, missing definitions are set to their default value.
897:
898: RTF_STYLESHEET_FILE =
899:
900: # Set optional variables used in the generation of an rtf document.
901: # Syntax is similar to doxygen's config file.
902:
903: RTF_EXTENSIONS_FILE =
904:
905: #---------------------------------------------------------------------------
906: # configuration options related to the man page output
907: #---------------------------------------------------------------------------
908:
909: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
910: # generate man pages
911:
912: GENERATE_MAN = NO
913:
914: # The MAN_OUTPUT tag is used to specify where the man pages will be put.
915: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
916: # put in front of it. If left blank `man' will be used as the default path.
917:
918: MAN_OUTPUT = man
919:
920: # The MAN_EXTENSION tag determines the extension that is added to
921: # the generated man pages (default is the subroutine's section .3)
922:
923: MAN_EXTENSION = .3
924:
925: # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
926: # then it will generate one additional man file for each entity
927: # documented in the real man page(s). These additional files
928: # only source the real man page, but without them the man command
929: # would be unable to find the correct page. The default is NO.
930:
931: MAN_LINKS = NO
932:
933: #---------------------------------------------------------------------------
934: # configuration options related to the XML output
935: #---------------------------------------------------------------------------
936:
937: # If the GENERATE_XML tag is set to YES Doxygen will
938: # generate an XML file that captures the structure of
939: # the code including all documentation.
940:
941: GENERATE_XML = NO
942:
943: # The XML_OUTPUT tag is used to specify where the XML pages will be put.
944: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
945: # put in front of it. If left blank `xml' will be used as the default path.
946:
947: XML_OUTPUT = xml
948:
949: # The XML_SCHEMA tag can be used to specify an XML schema,
950: # which can be used by a validating XML parser to check the
951: # syntax of the XML files.
952:
953: XML_SCHEMA =
954:
955: # The XML_DTD tag can be used to specify an XML DTD,
956: # which can be used by a validating XML parser to check the
957: # syntax of the XML files.
958:
959: XML_DTD =
960:
961: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
962: # dump the program listings (including syntax highlighting
963: # and cross-referencing information) to the XML output. Note that
964: # enabling this will significantly increase the size of the XML output.
965:
966: XML_PROGRAMLISTING = YES
967:
968: #---------------------------------------------------------------------------
969: # configuration options for the AutoGen Definitions output
970: #---------------------------------------------------------------------------
971:
972: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
973: # generate an AutoGen Definitions (see autogen.sf.net) file
974: # that captures the structure of the code including all
975: # documentation. Note that this feature is still experimental
976: # and incomplete at the moment.
977:
978: GENERATE_AUTOGEN_DEF = NO
979:
980: #---------------------------------------------------------------------------
981: # configuration options related to the Perl module output
982: #---------------------------------------------------------------------------
983:
984: # If the GENERATE_PERLMOD tag is set to YES Doxygen will
985: # generate a Perl module file that captures the structure of
986: # the code including all documentation. Note that this
987: # feature is still experimental and incomplete at the
988: # moment.
989:
990: GENERATE_PERLMOD = NO
991:
992: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
993: # the necessary Makefile rules, Perl scripts and LaTeX code to be able
994: # to generate PDF and DVI output from the Perl module output.
995:
996: PERLMOD_LATEX = NO
997:
998: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
999: # nicely formatted so it can be parsed by a human reader. This is useful
1000: # if you want to understand what is going on. On the other hand, if this
1001: # tag is set to NO the size of the Perl module output will be much smaller
1002: # and Perl will parse it just the same.
1003:
1004: PERLMOD_PRETTY = YES
1005:
1006: # The names of the make variables in the generated doxyrules.make file
1007: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1008: # This is useful so different doxyrules.make files included by the same
1009: # Makefile don't overwrite each other's variables.
1010:
1011: PERLMOD_MAKEVAR_PREFIX =
1012:
1013: #---------------------------------------------------------------------------
1014: # Configuration options related to the preprocessor
1015: #---------------------------------------------------------------------------
1016:
1017: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1018: # evaluate all C-preprocessor directives found in the sources and include
1019: # files.
1020:
1021: ENABLE_PREPROCESSING = YES
1022:
1023: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1024: # names in the source code. If set to NO (the default) only conditional
1025: # compilation will be performed. Macro expansion can be done in a controlled
1026: # way by setting EXPAND_ONLY_PREDEF to YES.
1027:
1028: MACRO_EXPANSION = NO
1029:
1030: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1031: # then the macro expansion is limited to the macros specified with the
1032: # PREDEFINED and EXPAND_AS_DEFINED tags.
1033:
1034: EXPAND_ONLY_PREDEF = NO
1035:
1036: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1037: # in the INCLUDE_PATH (see below) will be search if a #include is found.
1038:
1039: SEARCH_INCLUDES = YES
1040:
1041: # The INCLUDE_PATH tag can be used to specify one or more directories that
1042: # contain include files that are not input files but should be processed by
1043: # the preprocessor.
1044:
1045: INCLUDE_PATH =
1046:
1047: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1048: # patterns (like *.h and *.hpp) to filter out the header-files in the
1049: # directories. If left blank, the patterns specified with FILE_PATTERNS will
1050: # be used.
1051:
1052: INCLUDE_FILE_PATTERNS =
1053:
1054: # The PREDEFINED tag can be used to specify one or more macro names that
1055: # are defined before the preprocessor is started (similar to the -D option of
1056: # gcc). The argument of the tag is a list of macros of the form: name
1057: # or name=definition (no spaces). If the definition and the = are
1058: # omitted =1 is assumed. To prevent a macro definition from being
1059: # undefined via #undef or recursively expanded use the := operator
1060: # instead of the = operator.
1061:
1062: PREDEFINED =
1063:
1064: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1065: # this tag can be used to specify a list of macro names that should be expanded.
1066: # The macro definition that is found in the sources will be used.
1067: # Use the PREDEFINED tag if you want to use a different macro definition.
1068:
1069: EXPAND_AS_DEFINED =
1070:
1071: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1072: # doxygen's preprocessor will remove all function-like macros that are alone
1073: # on a line, have an all uppercase name, and do not end with a semicolon. Such
1074: # function macros are typically used for boiler-plate code, and will confuse
1075: # the parser if not removed.
1076:
1077: SKIP_FUNCTION_MACROS = YES
1078:
1079: #---------------------------------------------------------------------------
1080: # Configuration::additions related to external references
1081: #---------------------------------------------------------------------------
1082:
1083: # The TAGFILES option can be used to specify one or more tagfiles.
1084: # Optionally an initial location of the external documentation
1085: # can be added for each tagfile. The format of a tag file without
1086: # this location is as follows:
1087: # TAGFILES = file1 file2 ...
1088: # Adding location for the tag files is done as follows:
1089: # TAGFILES = file1=loc1 "file2 = loc2" ...
1090: # where "loc1" and "loc2" can be relative or absolute paths or
1091: # URLs. If a location is present for each tag, the installdox tool
1092: # does not have to be run to correct the links.
1093: # Note that each tag file must have a unique name
1094: # (where the name does NOT include the path)
1095: # If a tag file is not located in the directory in which doxygen
1096: # is run, you must also specify the path to the tagfile here.
1097:
1098: TAGFILES =
1099:
1100: # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1101: # a tag file that is based on the input files it reads.
1102:
1103: GENERATE_TAGFILE =
1104:
1105: # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1106: # in the class index. If set to NO only the inherited external classes
1107: # will be listed.
1108:
1109: ALLEXTERNALS = NO
1110:
1111: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1112: # in the modules index. If set to NO, only the current project's groups will
1113: # be listed.
1114:
1115: EXTERNAL_GROUPS = YES
1116:
1117: # The PERL_PATH should be the absolute path and name of the perl script
1118: # interpreter (i.e. the result of `which perl').
1119:
1120: PERL_PATH = /usr/bin/perl
1121:
1122: #---------------------------------------------------------------------------
1123: # Configuration options related to the dot tool
1124: #---------------------------------------------------------------------------
1125:
1126: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1127: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1128: # or super classes. Setting the tag to NO turns the diagrams off. Note that
1129: # this option is superseded by the HAVE_DOT option below. This is only a
1130: # fallback. It is recommended to install and use dot, since it yields more
1131: # powerful graphs.
1132:
1133: CLASS_DIAGRAMS = NO
1134:
1135: # You can define message sequence charts within doxygen comments using the \msc
1136: # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1137: # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1138: # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1139: # be found in the default search path.
1140:
1141: MSCGEN_PATH =
1142:
1143: # If set to YES, the inheritance and collaboration graphs will hide
1144: # inheritance and usage relations if the target is undocumented
1145: # or is not a class.
1146:
1147: HIDE_UNDOC_RELATIONS = YES
1148:
1149: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1150: # available from the path. This tool is part of Graphviz, a graph visualization
1151: # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1152: # have no effect if this option is set to NO (the default)
1153:
1154: HAVE_DOT = NO
1155:
1156: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1157: # will generate a graph for each documented class showing the direct and
1158: # indirect inheritance relations. Setting this tag to YES will force the
1159: # the CLASS_DIAGRAMS tag to NO.
1160:
1161: CLASS_GRAPH = YES
1162:
1163: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1164: # will generate a graph for each documented class showing the direct and
1165: # indirect implementation dependencies (inheritance, containment, and
1166: # class references variables) of the class with other documented classes.
1167:
1168: COLLABORATION_GRAPH = YES
1169:
1170: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1171: # will generate a graph for groups, showing the direct groups dependencies
1172:
1173: GROUP_GRAPHS = YES
1174:
1175: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1176: # collaboration diagrams in a style similar to the OMG's Unified Modeling
1177: # Language.
1178:
1179: UML_LOOK = NO
1180:
1181: # If set to YES, the inheritance and collaboration graphs will show the
1182: # relations between templates and their instances.
1183:
1184: TEMPLATE_RELATIONS = NO
1185:
1186: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1187: # tags are set to YES then doxygen will generate a graph for each documented
1188: # file showing the direct and indirect include dependencies of the file with
1189: # other documented files.
1190:
1191: INCLUDE_GRAPH = YES
1192:
1193: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1194: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1195: # documented header file showing the documented files that directly or
1196: # indirectly include this file.
1197:
1198: INCLUDED_BY_GRAPH = YES
1199:
1200: # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1201: # generate a call dependency graph for every global function or class method.
1202: # Note that enabling this option will significantly increase the time of a run.
1203: # So in most cases it will be better to enable call graphs for selected
1204: # functions only using the \callgraph command.
1205:
1206: CALL_GRAPH = NO
1207:
1208: # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1209: # generate a caller dependency graph for every global function or class method.
1210: # Note that enabling this option will significantly increase the time of a run.
1211: # So in most cases it will be better to enable caller graphs for selected
1212: # functions only using the \callergraph command.
1213:
1214: CALLER_GRAPH = NO
1215:
1216: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1217: # will graphical hierarchy of all classes instead of a textual one.
1218:
1219: GRAPHICAL_HIERARCHY = YES
1220:
1221: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1222: # then doxygen will show the dependencies a directory has on other directories
1223: # in a graphical way. The dependency relations are determined by the #include
1224: # relations between the files in the directories.
1225:
1226: DIRECTORY_GRAPH = YES
1227:
1228: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1229: # generated by dot. Possible values are png, jpg, or gif
1230: # If left blank png will be used.
1231:
1232: DOT_IMAGE_FORMAT = png
1233:
1234: # The tag DOT_PATH can be used to specify the path where the dot tool can be
1235: # found. If left blank, it is assumed the dot tool can be found in the path.
1236:
1237: DOT_PATH =
1238:
1239: # The DOTFILE_DIRS tag can be used to specify one or more directories that
1240: # contain dot files that are included in the documentation (see the
1241: # \dotfile command).
1242:
1243: DOTFILE_DIRS =
1244:
1245: # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1246: # nodes that will be shown in the graph. If the number of nodes in a graph
1247: # becomes larger than this value, doxygen will truncate the graph, which is
1248: # visualized by representing a node as a red box. Note that doxygen if the number
1249: # of direct children of the root node in a graph is already larger than
1250: # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1251: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1252:
1253: DOT_GRAPH_MAX_NODES = 50
1254:
1255: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1256: # graphs generated by dot. A depth value of 3 means that only nodes reachable
1257: # from the root by following a path via at most 3 edges will be shown. Nodes
1258: # that lay further from the root node will be omitted. Note that setting this
1259: # option to 1 or 2 may greatly reduce the computation time needed for large
1260: # code bases. Also note that the size of a graph can be further restricted by
1261: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1262:
1263: MAX_DOT_GRAPH_DEPTH = 0
1264:
1265: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1266: # background. This is disabled by default, which results in a white background.
1267: # Warning: Depending on the platform used, enabling this option may lead to
1268: # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1269: # read).
1270:
1271: DOT_TRANSPARENT = NO
1272:
1273: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1274: # files in one run (i.e. multiple -o and -T options on the command line). This
1275: # makes dot run faster, but since only newer versions of dot (>1.8.10)
1276: # support this, this feature is disabled by default.
1277:
1278: DOT_MULTI_TARGETS = NO
1279:
1280: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1281: # generate a legend page explaining the meaning of the various boxes and
1282: # arrows in the dot generated graphs.
1283:
1284: GENERATE_LEGEND = YES
1285:
1286: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1287: # remove the intermediate dot files that are used to generate
1288: # the various graphs.
1289:
1290: DOT_CLEANUP = YES
1291:
1292: #---------------------------------------------------------------------------
1293: # Configuration::additions related to the search engine
1294: #---------------------------------------------------------------------------
1295:
1296: # The SEARCHENGINE tag specifies whether or not a search engine should be
1297: # used. If set to NO the values of all tags below this one will be ignored.
1298:
1299: SEARCHENGINE = YES
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to axl-doc.doxygen CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / gpl / axl / doc