Annotation of parser3/src/doc/doxygen.cfg, revision 1.19
1.14 parser 1: # Doxyfile 1.2.10
1.1 paf 2:
1.14 parser 3: # This file describes the settings to be used by the documentation system
4: # doxygen (www.doxygen.org) for a project
1.1 paf 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: # General configuration options
15: #---------------------------------------------------------------------------
16:
17: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18: # by quotes) that should identify the project.
19:
20: PROJECT_NAME = "Parser3 Source Code"
21:
22: # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23: # This could be handy for archiving the generated documentation or
24: # if some version control system is used.
25:
26: PROJECT_NUMBER =
27:
28: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29: # base path where the generated documentation will be put.
30: # If a relative path is entered, it will be relative to the location
31: # where doxygen was started. If left blank the current directory will be used.
32:
33: OUTPUT_DIRECTORY =
34:
35: # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36: # documentation generated by doxygen is written. Doxygen will use this
37: # information to generate all constant output in the proper language.
38: # The default language is English, other supported languages are:
1.14 parser 39: # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40: # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41: # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
1.1 paf 42:
1.13 parser 43: OUTPUT_LANGUAGE = Russian
1.1 paf 44:
45: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46: # documentation are documented, even if no documentation was available.
47: # Private class members and static file members will be hidden unless
48: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49:
1.11 paf 50: EXTRACT_ALL = YES
1.1 paf 51:
52: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53: # will be included in the documentation.
54:
1.9 paf 55: EXTRACT_PRIVATE = YES
1.1 paf 56:
57: # If the EXTRACT_STATIC tag is set to YES all static members of a file
58: # will be included in the documentation.
59:
1.3 paf 60: EXTRACT_STATIC = YES
1.1 paf 61:
62: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
63: # undocumented members of documented classes, files or namespaces.
64: # If set to NO (the default) these members will be included in the
65: # various overviews, but no documentation section is generated.
66: # This option has no effect if EXTRACT_ALL is enabled.
67:
68: HIDE_UNDOC_MEMBERS = NO
69:
70: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
71: # undocumented classes that are normally visible in the class hierarchy.
72: # If set to NO (the default) these class will be included in the various
73: # overviews. This option has no effect if EXTRACT_ALL is enabled.
74:
75: HIDE_UNDOC_CLASSES = NO
76:
77: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
78: # include brief member descriptions after the members that are listed in
79: # the file and class documentation (similar to JavaDoc).
80: # Set to NO to disable this.
81:
82: BRIEF_MEMBER_DESC = YES
83:
84: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
85: # the brief description of a member or function before the detailed description.
86: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
87: # brief descriptions will be completely suppressed.
88:
89: REPEAT_BRIEF = YES
90:
91: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92: # Doxygen will generate a detailed section even if there is only a brief
93: # description.
94:
95: ALWAYS_DETAILED_SEC = NO
96:
97: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
98: # path before files name in the file list and in the header files. If set
99: # to NO the shortest path that makes the file name unique will be used.
100:
101: FULL_PATH_NAMES = NO
102:
103: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
104: # can be used to strip a user defined part of the path. Stripping is
105: # only done if one of the specified strings matches the left-hand part of
106: # the path. It is allowed to use relative paths in the argument list.
107:
108: STRIP_FROM_PATH =
109:
110: # The INTERNAL_DOCS tag determines if documentation
111: # that is typed after a \internal command is included. If the tag is set
112: # to NO (the default) then the documentation will be excluded.
113: # Set it to YES to include the internal documentation.
114:
115: INTERNAL_DOCS = NO
116:
117: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
118: # generate a class diagram (in Html and LaTeX) for classes with base or
119: # super classes. Setting the tag to NO turns the diagrams off.
120:
121: CLASS_DIAGRAMS = YES
122:
123: # If the SOURCE_BROWSER tag is set to YES then a list of source files will
124: # be generated. Documented entities will be cross-referenced with these sources.
125:
126: SOURCE_BROWSER = YES
127:
128: # Setting the INLINE_SOURCES tag to YES will include the body
129: # of functions and classes directly in the documentation.
130:
131: INLINE_SOURCES = NO
132:
133: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
134: # doxygen to hide any special comment blocks from generated source code
135: # fragments. Normal C and C++ comments will always remain visible.
136:
137: STRIP_CODE_COMMENTS = YES
138:
139: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
140: # file names in lower case letters. If set to YES upper case letters are also
141: # allowed. This is useful if you have classes or files whose names only differ
142: # in case and if your file system supports case sensitive file names. Windows
143: # users are adviced to set this option to NO.
144:
145: CASE_SENSE_NAMES = YES
146:
1.14 parser 147: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
148: # (but less readable) file names. This can be useful is your file systems
149: # doesn't support long names like on DOS, Mac, or CD-ROM.
150:
151: SHORT_NAMES = NO
152:
1.1 paf 153: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
154: # will show members with their full class and namespace scopes in the
155: # documentation. If set to YES the scope will be hidden.
156:
157: HIDE_SCOPE_NAMES = NO
158:
159: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
160: # will generate a verbatim copy of the header file for each class for
161: # which an include is specified. Set to NO to disable this.
162:
163: VERBATIM_HEADERS = YES
164:
165: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
166: # will put list of the files that are included by a file in the documentation
167: # of that file.
168:
169: SHOW_INCLUDE_FILES = YES
170:
171: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
172: # will interpret the first line (until the first dot) of a JavaDoc-style
173: # comment as the brief description. If set to NO, the JavaDoc
174: # comments will behave just like the Qt-style comments (thus requiring an
175: # explict @brief command for a brief description.
176:
177: JAVADOC_AUTOBRIEF = YES
178:
179: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
180: # member inherits the documentation from any documented member that it
181: # reimplements.
182:
183: INHERIT_DOCS = YES
184:
185: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
186: # is inserted in the documentation for inline members.
187:
188: INLINE_INFO = NO
189:
190: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
191: # will sort the (detailed) documentation of file and class members
192: # alphabetically by member name. If set to NO the members will appear in
193: # declaration order.
194:
195: SORT_MEMBER_DOCS = NO
196:
197: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
198: # tag is set to YES, then doxygen will reuse the documentation of the first
199: # member in the group (if any) for the other members of the group. By default
200: # all members of a group must be documented explicitly.
201:
202: DISTRIBUTE_GROUP_DOC = YES
203:
204: # The TAB_SIZE tag can be used to set the number of spaces in a tab.
205: # Doxygen uses this value to replace tabs by spaces in code fragments.
206:
207: TAB_SIZE = 4
208:
209: # The ENABLE_SECTIONS tag can be used to enable conditional
210: # documentation sections, marked by \if sectionname ... \endif.
211:
212: ENABLED_SECTIONS =
213:
214: # The GENERATE_TODOLIST tag can be used to enable (YES) or
215: # disable (NO) the todo list. This list is created by putting \todo
216: # commands in the documentation.
217:
218: GENERATE_TODOLIST = YES
219:
220: # The GENERATE_TESTLIST tag can be used to enable (YES) or
221: # disable (NO) the test list. This list is created by putting \test
222: # commands in the documentation.
223:
224: GENERATE_TESTLIST = YES
225:
226: # The GENERATE_BUGLIST tag can be used to enable (YES) or
227: # disable (NO) the bug list. This list is created by putting \bug
228: # commands in the documentation.
229:
230: GENERATE_BUGLIST = YES
231:
232: # This tag can be used to specify a number of aliases that acts
233: # as commands in the documentation. An alias has the form "name=value".
234: # For example adding "sideeffect=\par Side Effects:\n" will allow you to
235: # put the command \sideeffect (or @sideeffect) in the documentation, which
236: # will result in a user defined paragraph with heading "Side Effects:".
237: # You can put \n's in the value part of an alias to insert newlines.
238:
239: ALIASES =
240:
241: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
242: # the initial value of a variable or define consist of for it to appear in
243: # the documentation. If the initializer consists of more lines than specified
244: # here it will be hidden. Use a value of 0 to hide initializers completely.
245: # The appearance of the initializer of individual variables and defines in the
246: # documentation can be controlled using \showinitializer or \hideinitializer
247: # command in the documentation regardless of this setting.
248:
249: MAX_INITIALIZER_LINES = 30
250:
251: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
252: # only. Doxygen will then generate output that is more tailored for C.
253: # For instance some of the names that are used will be different. The list
254: # of all members will be omitted, etc.
255:
256: OPTIMIZE_OUTPUT_FOR_C = NO
257:
258: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
259: # at the bottom of the documentation of classes and structs. If set to YES the
260: # list will mention the files that were used to generate the documentation.
261:
262: SHOW_USED_FILES = YES
263:
264: #---------------------------------------------------------------------------
265: # configuration options related to warning and progress messages
266: #---------------------------------------------------------------------------
267:
268: # The QUIET tag can be used to turn on/off the messages that are generated
269: # by doxygen. Possible values are YES and NO. If left blank NO is used.
270:
271: QUIET = NO
272:
273: # The WARNINGS tag can be used to turn on/off the warning messages that are
274: # generated by doxygen. Possible values are YES and NO. If left blank
275: # NO is used.
276:
277: WARNINGS = YES
278:
279: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
280: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
281: # automatically be disabled.
282:
1.13 parser 283: WARN_IF_UNDOCUMENTED = NO
284: #YES
1.1 paf 285:
286: # The WARN_FORMAT tag determines the format of the warning messages that
287: # doxygen can produce. The string should contain the $file, $line, and $text
288: # tags, which will be replaced by the file and line number from which the
289: # warning originated and the warning text.
290:
291: WARN_FORMAT = "$file($line): $text"
292:
293: # The WARN_LOGFILE tag can be used to specify a file to which warning
294: # and error messages should be written. If left blank the output is written
295: # to stderr.
296:
297: WARN_LOGFILE =
298:
299: #---------------------------------------------------------------------------
300: # configuration options related to the input files
301: #---------------------------------------------------------------------------
302:
303: # The INPUT tag can be used to specify the files and/or directories that contain
304: # documented source files. You may enter file names like "myfile.cpp" or
305: # directories like "/usr/src/myproject". Separate the files or directories
306: # with spaces.
307:
1.8 paf 308: INPUT = ..
1.1 paf 309:
310: # If the value of the INPUT tag contains directories, you can use the
311: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
312: # and *.h) to filter out the source-files in the directories. If left
313: # blank all files are included.
314:
1.8 paf 315: FILE_PATTERNS = *.h *.C *.y *.dox
1.1 paf 316:
317: # The RECURSIVE tag can be used to turn specify whether or not subdirectories
318: # should be searched for input files as well. Possible values are YES and NO.
319: # If left blank NO is used.
320:
321: RECURSIVE = YES
322:
323: # The EXCLUDE tag can be used to specify files and/or directories that should
324: # excluded from the INPUT source files. This way you can easily exclude a
325: # subdirectory from a directory tree whose root is specified with the INPUT tag.
326:
1.18 parser 327: EXCLUDE = ../pcre ../libltdl
1.1 paf 328:
329: # If the value of the INPUT tag contains directories, you can use the
330: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
331: # certain files from those directories.
332:
1.18 parser 333: EXCLUDE_PATTERNS = *.tab.* */z/* */.libs/*
1.1 paf 334:
335: # The EXAMPLE_PATH tag can be used to specify one or more files or
336: # directories that contain example code fragments that are included (see
337: # the \include command).
338:
339: EXAMPLE_PATH =
340:
341: # If the value of the EXAMPLE_PATH tag contains directories, you can use the
342: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
343: # and *.h) to filter out the source-files in the directories. If left
344: # blank all files are included.
345:
346: EXAMPLE_PATTERNS =
347:
348: # The IMAGE_PATH tag can be used to specify one or more files or
349: # directories that contain image that are included in the documentation (see
350: # the \image command).
351:
352: IMAGE_PATH =
353:
354: # The INPUT_FILTER tag can be used to specify a program that doxygen should
355: # invoke to filter for each input file. Doxygen will invoke the filter program
356: # by executing (via popen()) the command <filter> <input-file>, where <filter>
357: # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
358: # input file. Doxygen will then use the output that the filter program writes
359: # to standard output.
360:
361: INPUT_FILTER =
362:
363: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
364: # INPUT_FILTER) will be used to filter the input files when producing source
365: # files to browse.
366:
367: FILTER_SOURCE_FILES = NO
368:
369: #---------------------------------------------------------------------------
370: # configuration options related to the alphabetical class index
371: #---------------------------------------------------------------------------
372:
373: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
374: # of all compounds will be generated. Enable this if the project
375: # contains a lot of classes, structs, unions or interfaces.
376:
1.13 parser 377: ALPHABETICAL_INDEX = YES
378: #NO
1.1 paf 379:
380: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
381: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
382: # in which this list will be split (can be a number in the range [1..20])
383:
384: COLS_IN_ALPHA_INDEX = 5
385:
386: # In case all classes in a project start with a common prefix, all
387: # classes will be put under the same header in the alphabetical index.
388: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
389: # should be ignored while generating the index headers.
390:
391: IGNORE_PREFIX =
392:
393: #---------------------------------------------------------------------------
394: # configuration options related to the HTML output
395: #---------------------------------------------------------------------------
396:
397: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
398: # generate HTML output.
399:
400: GENERATE_HTML = YES
401:
402: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
403: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
404: # put in front of it. If left blank `html' will be used as the default path.
405:
406: HTML_OUTPUT =
407:
408: # The HTML_HEADER tag can be used to specify a personal HTML header for
409: # each generated HTML page. If it is left blank doxygen will generate a
410: # standard header.
411:
412: HTML_HEADER =
413:
414: # The HTML_FOOTER tag can be used to specify a personal HTML footer for
415: # each generated HTML page. If it is left blank doxygen will generate a
416: # standard footer.
417:
418: HTML_FOOTER =
419:
420: # The HTML_STYLESHEET tag can be used to specify a user defined cascading
421: # style sheet that is used by each HTML page. It can be used to
422: # fine-tune the look of the HTML output. If the tag is left blank doxygen
423: # will generate a default style sheet
424:
425: HTML_STYLESHEET =
426:
427: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
428: # files or namespaces will be aligned in HTML using tables. If set to
429: # NO a bullet list will be used.
430:
431: HTML_ALIGN_MEMBERS = YES
432:
433: # If the GENERATE_HTMLHELP tag is set to YES, additional index files
434: # will be generated that can be used as input for tools like the
435: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
436: # of the generated HTML documentation.
437:
1.13 parser 438: GENERATE_HTMLHELP = YES
439: #NO
1.1 paf 440:
441: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
442: # controls if a separate .chi index file is generated (YES) or that
443: # it should be included in the master .chm file (NO).
444:
1.13 parser 445: GENERATE_CHI = YES
446: #NO
1.1 paf 447:
448: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
449: # controls whether a binary table of contents is generated (YES) or a
450: # normal table of contents (NO) in the .chm file.
451:
1.19 ! paf 452: BINARY_TOC = NO
1.1 paf 453:
1.14 parser 454: # The TOC_EXPAND flag can be set to YES to add extra items for group members
1.1 paf 455: # to the contents of the Html help documentation and to the tree view.
456:
1.19 ! paf 457: TOC_EXPAND = YES
1.1 paf 458:
459: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
460: # top of each HTML page. The value NO (the default) enables the index and
461: # the value YES disables it.
462:
1.13 parser 463: DISABLE_INDEX = YES
464: #NO
1.1 paf 465:
466: # This tag can be used to set the number of enum values (range [1..20])
467: # that doxygen will group on one line in the generated HTML documentation.
468:
469: ENUM_VALUES_PER_LINE = 4
470:
471: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
472: # generated containing a tree-like index structure (just like the one that
473: # is generated for HTML Help). For this to work a browser that supports
474: # JavaScript and frames is required (for instance Netscape 4.0+
475: # or Internet explorer 4.0+).
476:
1.13 parser 477: GENERATE_TREEVIEW = YES
478: #NO
1.1 paf 479:
480: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
481: # used to set the initial width (in pixels) of the frame in which the tree
482: # is shown.
483:
484: TREEVIEW_WIDTH = 250
485:
486: #---------------------------------------------------------------------------
487: # configuration options related to the LaTeX output
488: #---------------------------------------------------------------------------
489:
490: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
491: # generate Latex output.
492:
493: GENERATE_LATEX = NO
494:
495: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
496: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
497: # put in front of it. If left blank `latex' will be used as the default path.
498:
499: LATEX_OUTPUT = latex
500:
501: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
502: # LaTeX documents. This may be useful for small projects and may help to
503: # save some trees in general.
504:
505: COMPACT_LATEX = NO
506:
507: # The PAPER_TYPE tag can be used to set the paper type that is used
508: # by the printer. Possible values are: a4, a4wide, letter, legal and
509: # executive. If left blank a4wide will be used.
510:
511: PAPER_TYPE = a4wide
512:
513: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
514: # packages that should be included in the LaTeX output.
515:
516: EXTRA_PACKAGES =
517:
518: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
519: # the generated latex document. The header should contain everything until
520: # the first chapter. If it is left blank doxygen will generate a
521: # standard header. Notice: only use this tag if you know what you are doing!
522:
523: LATEX_HEADER =
524:
525: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
526: # is prepared for conversion to pdf (using ps2pdf). The pdf file will
527: # contain links (just like the HTML output) instead of page references
528: # This makes the output suitable for online browsing using a pdf viewer.
529:
530: PDF_HYPERLINKS = NO
531:
532: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
533: # plain latex in the generated Makefile. Set this option to YES to get a
534: # higher quality PDF documentation.
535:
536: USE_PDFLATEX = NO
537:
538: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
539: # command to the generated LaTeX files. This will instruct LaTeX to keep
540: # running if errors occur, instead of asking the user for help.
541: # This option is also used when generating formulas in HTML.
542:
543: LATEX_BATCHMODE = NO
544:
545: #---------------------------------------------------------------------------
546: # configuration options related to the RTF output
547: #---------------------------------------------------------------------------
548:
549: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
550: # The RTF output is optimised for Word 97 and may not look very pretty with
551: # other RTF readers or editors.
552:
553: GENERATE_RTF = NO
554:
555: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
556: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
557: # put in front of it. If left blank `rtf' will be used as the default path.
558:
559: RTF_OUTPUT = rtf
560:
561: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
562: # RTF documents. This may be useful for small projects and may help to
563: # save some trees in general.
564:
565: COMPACT_RTF = NO
566:
567: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
568: # will contain hyperlink fields. The RTF file will
569: # contain links (just like the HTML output) instead of page references.
1.14 parser 570: # This makes the output suitable for online browsing using WORD or other
1.1 paf 571: # programs which support those fields.
572: # Note: wordpad (write) and others do not support links.
573:
574: RTF_HYPERLINKS = NO
575:
576: # Load stylesheet definitions from file. Syntax is similar to doxygen's
577: # config file, i.e. a series of assigments. You only have to provide
578: # replacements, missing definitions are set to their default value.
579:
580: RTF_STYLESHEET_FILE =
581:
1.14 parser 582: # Set optional variables used in the generation of an rtf document.
583: # Syntax is similar to doxygen's config file.
584:
585: RTF_EXTENSIONS_FILE =
586:
1.1 paf 587: #---------------------------------------------------------------------------
588: # configuration options related to the man page output
589: #---------------------------------------------------------------------------
590:
591: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
592: # generate man pages
593:
594: GENERATE_MAN = NO
595:
596: # The MAN_OUTPUT tag is used to specify where the man pages will be put.
597: # If a relative path is entered the value of OUTPUT_DIRECTORY will be
598: # put in front of it. If left blank `man' will be used as the default path.
599:
600: MAN_OUTPUT = man
601:
602: # The MAN_EXTENSION tag determines the extension that is added to
603: # the generated man pages (default is the subroutine's section .3)
604:
1.14 parser 605: MAN_EXTENSION =
606:
607: # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
608: # then it will generate one additional man file for each entity
609: # documented in the real man page(s). These additional files
610: # only source the real man page, but without them the man command
611: # would be unable to find the correct page. The default is NO.
612:
613: MAN_LINKS = NO
614:
615: #---------------------------------------------------------------------------
616: # configuration options related to the XML output
617: #---------------------------------------------------------------------------
618:
619: # If the GENERATE_XML tag is set to YES Doxygen will
620: # generate an XML file that captures the structure of
621: # the code including all documentation. Note that this
622: # feature is still experimental and incomplete at the
623: # moment.
624:
625: GENERATE_XML = NO
1.1 paf 626:
627: #---------------------------------------------------------------------------
628: # Configuration options related to the preprocessor
629: #---------------------------------------------------------------------------
630:
631: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
632: # evaluate all C-preprocessor directives found in the sources and include
633: # files.
634:
635: ENABLE_PREPROCESSING = YES
636:
637: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
638: # names in the source code. If set to NO (the default) only conditional
639: # compilation will be performed. Macro expansion can be done in a controlled
640: # way by setting EXPAND_ONLY_PREDEF to YES.
641:
642: MACRO_EXPANSION = NO
643:
644: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
645: # then the macro expansion is limited to the macros specified with the
646: # PREDEFINED and EXPAND_AS_PREDEFINED tags.
647:
648: EXPAND_ONLY_PREDEF = NO
649:
650: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
651: # in the INCLUDE_PATH (see below) will be search if a #include is found.
652:
653: SEARCH_INCLUDES = YES
654:
655: # The INCLUDE_PATH tag can be used to specify one or more directories that
656: # contain include files that are not input files but should be processed by
657: # the preprocessor.
658:
659: INCLUDE_PATH =
660:
661: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
662: # patterns (like *.h and *.hpp) to filter out the header-files in the
663: # directories. If left blank, the patterns specified with FILE_PATTERNS will
664: # be used.
665:
666: INCLUDE_FILE_PATTERNS =
667:
668: # The PREDEFINED tag can be used to specify one or more macro names that
669: # are defined before the preprocessor is started (similar to the -D option of
670: # gcc). The argument of the tag is a list of macros of the form: name
671: # or name=definition (no spaces). If the definition and the = are
672: # omitted =1 is assumed.
673:
1.16 parser 674: PREDEFINED = DOXYGEN WIN32 MULTITHREAD XML
1.1 paf 675:
676: # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
677: # this tag can be used to specify a list of macro names that should be expanded.
678: # The macro definition that is found in the sources will be used.
679: # Use the PREDEFINED tag if you want to use a different macro definition.
680:
681: EXPAND_AS_DEFINED =
682:
683: #---------------------------------------------------------------------------
684: # Configuration::addtions related to external references
685: #---------------------------------------------------------------------------
686:
687: # The TAGFILES tag can be used to specify one or more tagfiles.
688:
689: TAGFILES =
690:
691: # When a file name is specified after GENERATE_TAGFILE, doxygen will create
692: # a tag file that is based on the input files it reads.
693:
694: GENERATE_TAGFILE =
695:
696: # If the ALLEXTERNALS tag is set to YES all external classes will be listed
697: # in the class index. If set to NO only the inherited external classes
698: # will be listed.
699:
700: ALLEXTERNALS = NO
701:
702: # The PERL_PATH should be the absolute path and name of the perl script
703: # interpreter (i.e. the result of `which perl').
704:
705: PERL_PATH = /usr/bin/perl
706:
707: #---------------------------------------------------------------------------
708: # Configuration options related to the dot tool
709: #---------------------------------------------------------------------------
710:
711: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
712: # available from the path. This tool is part of Graphviz, a graph visualization
713: # toolkit from AT&T and Lucent Bell Labs. The other options in this section
714: # have no effect if this option is set to NO (the default)
715:
1.13 parser 716: HAVE_DOT = YES
717: #NO
1.1 paf 718:
719: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
720: # will generate a graph for each documented class showing the direct and
721: # indirect inheritance relations. Setting this tag to YES will force the
722: # the CLASS_DIAGRAMS tag to NO.
723:
724: CLASS_GRAPH = YES
725:
726: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
727: # will generate a graph for each documented class showing the direct and
728: # indirect implementation dependencies (inheritance, containment, and
729: # class references variables) of the class with other documented classes.
730:
731: COLLABORATION_GRAPH = YES
732:
1.14 parser 733: # If set to YES, the inheritance and collaboration graphs will show the
734: # relations between templates and their instances.
735:
736: TEMPLATE_RELATIONS = YES
737:
738: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
739: # tags are set to YES then doxygen will generate a graph for each documented
740: # file showing the direct and indirect include dependencies of the file with
741: # other documented files.
1.1 paf 742:
743: INCLUDE_GRAPH = YES
744:
1.14 parser 745: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
746: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
747: # documented header file showing the documented files that directly or
748: # indirectly include this file.
1.1 paf 749:
750: INCLUDED_BY_GRAPH = YES
751:
752: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
753: # will graphical hierarchy of all classes instead of a textual one.
754:
755: GRAPHICAL_HIERARCHY = YES
756:
757: # The tag DOT_PATH can be used to specify the path where the dot tool can be
758: # found. If left blank, it is assumed the dot tool can be found on the path.
759:
1.18 parser 760: DOT_PATH = "C:\Program Files\doxygen\3rd"
1.14 parser 761:
762: # The DOTFILE_DIRS tag can be used to specify one or more directories that
763: # contain dot files that are included in the documentation (see the
764: # \dotfile command).
765:
766: DOTFILE_DIRS =
1.1 paf 767:
768: # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
769: # (in pixels) of the graphs generated by dot. If a graph becomes larger than
770: # this value, doxygen will try to truncate the graph, so that it fits within
771: # the specified constraint. Beware that most browsers cannot cope with very
772: # large images.
773:
774: MAX_DOT_GRAPH_WIDTH = 1024
775:
776: # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
777: # (in pixels) of the graphs generated by dot. If a graph becomes larger than
778: # this value, doxygen will try to truncate the graph, so that it fits within
779: # the specified constraint. Beware that most browsers cannot cope with very
780: # large images.
781:
782: MAX_DOT_GRAPH_HEIGHT = 1024
783:
784: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
785: # generate a legend page explaining the meaning of the various boxes and
786: # arrows in the dot generated graphs.
787:
788: GENERATE_LEGEND = YES
789:
790: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
791: # remove the intermedate dot files that are used to generate
792: # the various graphs.
793:
794: DOT_CLEANUP = YES
795:
796: #---------------------------------------------------------------------------
797: # Configuration::addtions related to the search engine
798: #---------------------------------------------------------------------------
799:
800: # The SEARCHENGINE tag specifies whether or not a search engine should be
801: # used. If set to NO the values of all tags below this one will be ignored.
802:
803: SEARCHENGINE = NO
804:
805: # The CGI_NAME tag should be the name of the CGI script that
806: # starts the search engine (doxysearch) with the correct parameters.
807: # A script with this name will be generated by doxygen.
808:
809: CGI_NAME = search.cgi
810:
811: # The CGI_URL tag should be the absolute URL to the directory where the
812: # cgi binaries are located. See the documentation of your http daemon for
813: # details.
814:
815: CGI_URL =
816:
817: # The DOC_URL tag should be the absolute URL to the directory where the
818: # documentation is located. If left blank the absolute path to the
819: # documentation, with file:// prepended to it, will be used.
820:
821: DOC_URL =
822:
823: # The DOC_ABSPATH tag should be the absolute path to the directory where the
824: # documentation is located. If left blank the directory on the local machine
825: # will be used.
826:
827: DOC_ABSPATH =
828:
829: # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
830: # is installed.
831:
832: BIN_ABSPATH = /usr/local/bin/
833:
834: # The EXT_DOC_PATHS tag can be used to specify one or more paths to
835: # documentation generated for other projects. This allows doxysearch to search
836: # the documentation for these projects as well.
837:
838: EXT_DOC_PATHS =
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to doxygen.cfg CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / doc