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