/[svn]/ircd-hybrid-7.2/doxygen.conf
ViewVC logotype

Annotation of /ircd-hybrid-7.2/doxygen.conf

Parent Directory Parent Directory | Revision Log Revision Log


Revision 30 - (hide annotations)
Sun Oct 2 20:03:27 2005 UTC (14 years ago) by adx
Original Path: ircd-hybrid/doxygen.conf
File size: 44290 byte(s)
- imported sources
- can be moved later according to the directory/branching scheme,
  but we need the svn up

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

Properties

Name Value
svn:eol-style native
svn:keywords "Id Revision"

svnadmin@ircd-hybrid.org
ViewVC Help
Powered by ViewVC 1.1.26