/[cvs]/eggdrop1.9/Doxyfile
ViewVC logotype

Annotation of /eggdrop1.9/Doxyfile

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.2 - (hide annotations) (download)
Tue Nov 21 01:38:40 2006 UTC (12 years, 4 months ago) by sven
Branch: MAIN
Changes since 1.1: +8 -1 lines

Added a few aliases to the Doxygen file to help generate a full list of all
binds:

\bind to create a new page listing all documented binds on a single page
      linked from "Related Pages"

\name, \flags, \match to add a paragraph for the Name, Flags and Matches

\stackable, \breakable to add a note stating the bind is stackable/breakable

\noparam, \noreturn to add a paragraph stating the bind has no parameters/return value

Documented the binds used in core and botnet. Look at the changelog for an
example of how to use them. Here's an example of the
doxygen output: http://www.semidefinite.de/eggdropDocs/bind.html

1 sven 1.1 # Doxyfile 1.3.5
2    
3     # This file describes the settings to be used by the documentation system
4     # doxygen (www.doxygen.org) for a project
5     #
6     # All text after a hash (#) is considered a comment and will be ignored
7     # The format is:
8     # TAG = value [value, ...]
9     # For lists items can also be appended using:
10     # TAG += value [value, ...]
11     # Values that contain spaces should be placed between quotes (" ")
12    
13     #---------------------------------------------------------------------------
14     # Project related configuration options
15     #---------------------------------------------------------------------------
16    
17     # 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 = "eggdrop1.9"
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 = doc/developer
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:
39     # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40     # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41     # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42     # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43    
44     OUTPUT_LANGUAGE = English
45    
46     # This tag can be used to specify the encoding used in the generated output.
47     # The encoding is not always determined by the language that is chosen,
48     # but also whether or not the output is meant for Windows or non-Windows users.
49     # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50     # forces the Windows encoding (this is the default for the Windows binary),
51     # whereas setting the tag to NO uses a Unix-style encoding (the default for
52     # all platforms other than Windows).
53    
54     USE_WINDOWS_ENCODING = NO
55    
56     # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57     # include brief member descriptions after the members that are listed in
58     # the file and class documentation (similar to JavaDoc).
59     # Set to NO to disable this.
60    
61     BRIEF_MEMBER_DESC = YES
62    
63     # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64     # the brief description of a member or function before the detailed description.
65     # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66     # brief descriptions will be completely suppressed.
67    
68     REPEAT_BRIEF = YES
69    
70     # This tag implements a quasi-intelligent brief description abbreviator
71     # that is used to form the text in various listings. Each string
72     # in this list, if found as the leading text of the brief description, will be
73     # stripped from the text and the result after processing the whole list, is used
74     # as the annotated text. Otherwise, the brief description is used as-is. If left
75     # blank, the following values are used ("$name" is automatically replaced with the
76     # name of the entity): "The $name class" "The $name widget" "The $name file"
77     # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78    
79     ABBREVIATE_BRIEF =
80    
81     # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82     # Doxygen will generate a detailed section even if there is only a brief
83     # description.
84    
85     ALWAYS_DETAILED_SEC = YES
86    
87     # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88     # members of a class in the documentation of that class as if those members were
89     # ordinary class members. Constructors, destructors and assignment operators of
90     # the base classes will not be shown.
91    
92     INLINE_INHERITED_MEMB = YES
93    
94     # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95     # path before files name in the file list and in the header files. If set
96     # to NO the shortest path that makes the file name unique will be used.
97    
98     FULL_PATH_NAMES = YES
99    
100     # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101     # can be used to strip a user-defined part of the path. Stripping is
102     # only done if one of the specified strings matches the left-hand part of
103     # the path. It is allowed to use relative paths in the argument list.
104    
105     STRIP_FROM_PATH =
106    
107     # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108     # (but less readable) file names. This can be useful is your file systems
109     # doesn't support long names like on DOS, Mac, or CD-ROM.
110    
111     SHORT_NAMES = NO
112    
113     # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114     # will interpret the first line (until the first dot) of a JavaDoc-style
115     # comment as the brief description. If set to NO, the JavaDoc
116     # comments will behave just like the Qt-style comments (thus requiring an
117     # explicit @brief command for a brief description.
118    
119     JAVADOC_AUTOBRIEF = NO
120    
121     # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122     # treat a multi-line C++ special comment block (i.e. a block of //! or ///
123     # comments) as a brief description. This used to be the default behaviour.
124     # The new default is to treat a multi-line C++ comment block as a detailed
125     # description. Set this tag to YES if you prefer the old behaviour instead.
126    
127     MULTILINE_CPP_IS_BRIEF = NO
128    
129     # If the DETAILS_AT_TOP tag is set to YES then Doxygen
130     # will output the detailed description near the top, like JavaDoc.
131     # If set to NO, the detailed description appears after the member
132     # documentation.
133    
134     DETAILS_AT_TOP = YES
135    
136     # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137     # member inherits the documentation from any documented member that it
138     # re-implements.
139    
140     INHERIT_DOCS = YES
141    
142     # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143     # tag is set to YES, then doxygen will reuse the documentation of the first
144     # member in the group (if any) for the other members of the group. By default
145     # all members of a group must be documented explicitly.
146    
147     DISTRIBUTE_GROUP_DOC = NO
148    
149     # The TAB_SIZE tag can be used to set the number of spaces in a tab.
150     # Doxygen uses this value to replace tabs by spaces in code fragments.
151    
152     TAB_SIZE = 2
153    
154     # This tag can be used to specify a number of aliases that acts
155     # as commands in the documentation. An alias has the form "name=value".
156     # For example adding "sideeffect=\par Side Effects:\n" will allow you to
157     # put the command \sideeffect (or @sideeffect) in the documentation, which
158     # will result in a user-defined paragraph with heading "Side Effects:".
159     # You can put \n's in the value part of an alias to insert newlines.
160    
161 sven 1.2 ALIASES = "bind=\xrefitem bind \"Bind\" \"Bind List\""
162     ALIASES += "name=\par \"Name:\" "
163     ALIASES += "flags=\par \"Flags:\" "
164     ALIASES += "match=\par \"Match:\" "
165     ALIASES += "stackable=\par \"Note:\" This bind is stackable."
166     ALIASES += "breakable=\par \"Note:\" This bind is stackable and breakable."
167     ALIASES += "noparam=\par \"Parameters:\" None."
168     ALIASES += "noreturn=\return Any return value will be ignored."
169 sven 1.1
170     # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
171     # only. Doxygen will then generate output that is more tailored for C.
172     # For instance, some of the names that are used will be different. The list
173     # of all members will be omitted, etc.
174    
175     OPTIMIZE_OUTPUT_FOR_C = YES
176    
177     # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
178     # only. Doxygen will then generate output that is more tailored for Java.
179     # For instance, namespaces will be presented as packages, qualified scopes
180     # will look different, etc.
181    
182     OPTIMIZE_OUTPUT_JAVA = NO
183    
184     # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
185     # the same type (for instance a group of public functions) to be put as a
186     # subgroup of that type (e.g. under the Public Functions section). Set it to
187     # NO to prevent subgrouping. Alternatively, this can be done per class using
188     # the \nosubgrouping command.
189    
190     SUBGROUPING = YES
191    
192     #---------------------------------------------------------------------------
193     # Build related configuration options
194     #---------------------------------------------------------------------------
195    
196     # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
197     # documentation are documented, even if no documentation was available.
198     # Private class members and static file members will be hidden unless
199     # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
200    
201     EXTRACT_ALL = YES
202    
203     # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
204     # will be included in the documentation.
205    
206     EXTRACT_PRIVATE = YES
207    
208     # If the EXTRACT_STATIC tag is set to YES all static members of a file
209     # will be included in the documentation.
210    
211     EXTRACT_STATIC = YES
212    
213     # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
214     # defined locally in source files will be included in the documentation.
215     # If set to NO only classes defined in header files are included.
216    
217     EXTRACT_LOCAL_CLASSES = YES
218    
219     # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
220     # undocumented members of documented classes, files or namespaces.
221     # If set to NO (the default) these members will be included in the
222     # various overviews, but no documentation section is generated.
223     # This option has no effect if EXTRACT_ALL is enabled.
224    
225     HIDE_UNDOC_MEMBERS = NO
226    
227     # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
228     # undocumented classes that are normally visible in the class hierarchy.
229     # If set to NO (the default) these classes will be included in the various
230     # overviews. This option has no effect if EXTRACT_ALL is enabled.
231    
232     HIDE_UNDOC_CLASSES = NO
233    
234     # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
235     # friend (class|struct|union) declarations.
236     # If set to NO (the default) these declarations will be included in the
237     # documentation.
238    
239     HIDE_FRIEND_COMPOUNDS = NO
240    
241     # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
242     # documentation blocks found inside the body of a function.
243     # If set to NO (the default) these blocks will be appended to the
244     # function's detailed documentation block.
245    
246     HIDE_IN_BODY_DOCS = NO
247    
248     # The INTERNAL_DOCS tag determines if documentation
249     # that is typed after a \internal command is included. If the tag is set
250     # to NO (the default) then the documentation will be excluded.
251     # Set it to YES to include the internal documentation.
252    
253     INTERNAL_DOCS = NO
254    
255     # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
256     # file names in lower-case letters. If set to YES upper-case letters are also
257     # allowed. This is useful if you have classes or files whose names only differ
258     # in case and if your file system supports case sensitive file names. Windows
259     # users are advised to set this option to NO.
260    
261     CASE_SENSE_NAMES = YES
262    
263     # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
264     # will show members with their full class and namespace scopes in the
265     # documentation. If set to YES the scope will be hidden.
266    
267     HIDE_SCOPE_NAMES = NO
268    
269     # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
270     # will put a list of the files that are included by a file in the documentation
271     # of that file.
272    
273     SHOW_INCLUDE_FILES = YES
274    
275     # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
276     # is inserted in the documentation for inline members.
277    
278     INLINE_INFO = YES
279    
280     # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
281     # will sort the (detailed) documentation of file and class members
282     # alphabetically by member name. If set to NO the members will appear in
283     # declaration order.
284    
285     SORT_MEMBER_DOCS = YES
286    
287     # The GENERATE_TODOLIST tag can be used to enable (YES) or
288     # disable (NO) the todo list. This list is created by putting \todo
289     # commands in the documentation.
290    
291     GENERATE_TODOLIST = YES
292    
293     # The GENERATE_TESTLIST tag can be used to enable (YES) or
294     # disable (NO) the test list. This list is created by putting \test
295     # commands in the documentation.
296    
297     GENERATE_TESTLIST = YES
298    
299     # The GENERATE_BUGLIST tag can be used to enable (YES) or
300     # disable (NO) the bug list. This list is created by putting \bug
301     # commands in the documentation.
302    
303     GENERATE_BUGLIST = YES
304    
305     # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
306     # disable (NO) the deprecated list. This list is created by putting
307     # \deprecated commands in the documentation.
308    
309     GENERATE_DEPRECATEDLIST= YES
310    
311     # The ENABLED_SECTIONS tag can be used to enable conditional
312     # documentation sections, marked by \if sectionname ... \endif.
313    
314     ENABLED_SECTIONS =
315    
316     # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
317     # the initial value of a variable or define consists of for it to appear in
318     # the documentation. If the initializer consists of more lines than specified
319     # here it will be hidden. Use a value of 0 to hide initializers completely.
320     # The appearance of the initializer of individual variables and defines in the
321     # documentation can be controlled using \showinitializer or \hideinitializer
322     # command in the documentation regardless of this setting.
323    
324     MAX_INITIALIZER_LINES = 30
325    
326     # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
327     # at the bottom of the documentation of classes and structs. If set to YES the
328     # list will mention the files that were used to generate the documentation.
329    
330     SHOW_USED_FILES = YES
331    
332     #---------------------------------------------------------------------------
333     # configuration options related to warning and progress messages
334     #---------------------------------------------------------------------------
335    
336     # The QUIET tag can be used to turn on/off the messages that are generated
337     # by doxygen. Possible values are YES and NO. If left blank NO is used.
338    
339     QUIET = YES
340    
341     # The WARNINGS tag can be used to turn on/off the warning messages that are
342     # generated by doxygen. Possible values are YES and NO. If left blank
343     # NO is used.
344    
345     WARNINGS = YES
346    
347     # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
348     # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
349     # automatically be disabled.
350    
351     WARN_IF_UNDOCUMENTED = YES
352    
353     # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
354     # potential errors in the documentation, such as not documenting some
355     # parameters in a documented function, or documenting parameters that
356     # don't exist or using markup commands wrongly.
357    
358     WARN_IF_DOC_ERROR = YES
359    
360     # The WARN_FORMAT tag determines the format of the warning messages that
361     # doxygen can produce. The string should contain the $file, $line, and $text
362     # tags, which will be replaced by the file and line number from which the
363     # warning originated and the warning text.
364    
365     WARN_FORMAT = "$file:$line: $text"
366    
367     # The WARN_LOGFILE tag can be used to specify a file to which warning
368     # and error messages should be written. If left blank the output is written
369     # to stderr.
370    
371     WARN_LOGFILE =
372    
373     #---------------------------------------------------------------------------
374     # configuration options related to the input files
375     #---------------------------------------------------------------------------
376    
377     # The INPUT tag can be used to specify the files and/or directories that contain
378     # documented source files. You may enter file names like "myfile.cpp" or
379     # directories like "/usr/src/myproject". Separate the files or directories
380     # with spaces.
381    
382     INPUT = src lib/eggdrop modules
383    
384     # If the value of the INPUT tag contains directories, you can use the
385     # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
386     # and *.h) to filter out the source-files in the directories. If left
387     # blank the following patterns are tested:
388     # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
389     # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
390    
391     FILE_PATTERNS = *.c *.h
392    
393     # The RECURSIVE tag can be used to turn specify whether or not subdirectories
394     # should be searched for input files as well. Possible values are YES and NO.
395     # If left blank NO is used.
396    
397     RECURSIVE = YES
398    
399     # The EXCLUDE tag can be used to specify files and/or directories that should
400     # excluded from the INPUT source files. This way you can easily exclude a
401     # subdirectory from a directory tree whose root is specified with the INPUT tag.
402    
403     EXCLUDE = src/cryptapi.h
404    
405     # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
406     # that are symbolic links (a Unix filesystem feature) are excluded from the input.
407    
408     EXCLUDE_SYMLINKS = NO
409    
410     # If the value of the INPUT tag contains directories, you can use the
411     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
412     # certain files from those directories.
413    
414     EXCLUDE_PATTERNS =
415    
416     # The EXAMPLE_PATH tag can be used to specify one or more files or
417     # directories that contain example code fragments that are included (see
418     # the \include command).
419    
420     EXAMPLE_PATH =
421    
422     # If the value of the EXAMPLE_PATH tag contains directories, you can use the
423     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
424     # and *.h) to filter out the source-files in the directories. If left
425     # blank all files are included.
426    
427     EXAMPLE_PATTERNS =
428    
429     # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
430     # searched for input files to be used with the \include or \dontinclude
431     # commands irrespective of the value of the RECURSIVE tag.
432     # Possible values are YES and NO. If left blank NO is used.
433    
434     EXAMPLE_RECURSIVE = NO
435    
436     # The IMAGE_PATH tag can be used to specify one or more files or
437     # directories that contain image that are included in the documentation (see
438     # the \image command).
439    
440     IMAGE_PATH =
441    
442     # The INPUT_FILTER tag can be used to specify a program that doxygen should
443     # invoke to filter for each input file. Doxygen will invoke the filter program
444     # by executing (via popen()) the command <filter> <input-file>, where <filter>
445     # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
446     # input file. Doxygen will then use the output that the filter program writes
447     # to standard output.
448    
449     INPUT_FILTER =
450    
451     # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
452     # INPUT_FILTER) will be used to filter the input files when producing source
453     # files to browse (i.e. when SOURCE_BROWSER is set to YES).
454    
455     FILTER_SOURCE_FILES = NO
456    
457     #---------------------------------------------------------------------------
458     # configuration options related to source browsing
459     #---------------------------------------------------------------------------
460    
461     # If the SOURCE_BROWSER tag is set to YES then a list of source files will
462     # be generated. Documented entities will be cross-referenced with these sources.
463     # Note: To get rid of all source code in the generated output, make sure also
464     # VERBATIM_HEADERS is set to NO.
465    
466     SOURCE_BROWSER = YES
467    
468     # Setting the INLINE_SOURCES tag to YES will include the body
469     # of functions and classes directly in the documentation.
470    
471     INLINE_SOURCES = YES
472    
473     # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
474     # doxygen to hide any special comment blocks from generated source code
475     # fragments. Normal C and C++ comments will always remain visible.
476    
477     STRIP_CODE_COMMENTS = YES
478    
479     # If the REFERENCED_BY_RELATION tag is set to YES (the default)
480     # then for each documented function all documented
481     # functions referencing it will be listed.
482    
483     REFERENCED_BY_RELATION = YES
484    
485     # If the REFERENCES_RELATION tag is set to YES (the default)
486     # then for each documented function all documented entities
487     # called/used by that function will be listed.
488    
489     REFERENCES_RELATION = YES
490    
491     # References will link to the documentation, not the source.
492    
493     REFERENCES_LINK_SOURCE = NO
494    
495     # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
496     # will generate a verbatim copy of the header file for each class for
497     # which an include is specified. Set to NO to disable this.
498    
499     VERBATIM_HEADERS = YES
500    
501     #---------------------------------------------------------------------------
502     # configuration options related to the alphabetical class index
503     #---------------------------------------------------------------------------
504    
505     # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
506     # of all compounds will be generated. Enable this if the project
507     # contains a lot of classes, structs, unions or interfaces.
508    
509     ALPHABETICAL_INDEX = YES
510    
511     # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
512     # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
513     # in which this list will be split (can be a number in the range [1..20])
514    
515     COLS_IN_ALPHA_INDEX = 5
516    
517     # In case all classes in a project start with a common prefix, all
518     # classes will be put under the same header in the alphabetical index.
519     # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
520     # should be ignored while generating the index headers.
521    
522     IGNORE_PREFIX =
523    
524     #---------------------------------------------------------------------------
525     # configuration options related to the HTML output
526     #---------------------------------------------------------------------------
527    
528     # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
529     # generate HTML output.
530    
531     GENERATE_HTML = YES
532    
533     # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
534     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
535     # put in front of it. If left blank `html' will be used as the default path.
536    
537     HTML_OUTPUT = html
538    
539     # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
540     # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
541     # doxygen will generate files with .html extension.
542    
543     HTML_FILE_EXTENSION = .html
544    
545     # The HTML_HEADER tag can be used to specify a personal HTML header for
546     # each generated HTML page. If it is left blank doxygen will generate a
547     # standard header.
548    
549     HTML_HEADER =
550    
551     # The HTML_FOOTER tag can be used to specify a personal HTML footer for
552     # each generated HTML page. If it is left blank doxygen will generate a
553     # standard footer.
554    
555     HTML_FOOTER =
556    
557     # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
558     # style sheet that is used by each HTML page. It can be used to
559     # fine-tune the look of the HTML output. If the tag is left blank doxygen
560     # will generate a default style sheet. Note that doxygen will try to copy
561     # the style sheet file to the HTML output directory, so don't put your own
562     # stylesheet in the HTML output directory as well, or it will be erased!
563    
564     HTML_STYLESHEET =
565    
566     # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
567     # files or namespaces will be aligned in HTML using tables. If set to
568     # NO a bullet list will be used.
569    
570     HTML_ALIGN_MEMBERS = YES
571    
572     # If the GENERATE_HTMLHELP tag is set to YES, additional index files
573     # will be generated that can be used as input for tools like the
574     # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
575     # of the generated HTML documentation.
576    
577     GENERATE_HTMLHELP = NO
578    
579     # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
580     # be used to specify the file name of the resulting .chm file. You
581     # can add a path in front of the file if the result should not be
582     # written to the html output directory.
583    
584     CHM_FILE =
585    
586     # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
587     # be used to specify the location (absolute path including file name) of
588     # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
589     # the HTML help compiler on the generated index.hhp.
590    
591     HHC_LOCATION =
592    
593     # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
594     # controls if a separate .chi index file is generated (YES) or that
595     # it should be included in the master .chm file (NO).
596    
597     GENERATE_CHI = NO
598    
599     # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
600     # controls whether a binary table of contents is generated (YES) or a
601     # normal table of contents (NO) in the .chm file.
602    
603     BINARY_TOC = NO
604    
605     # The TOC_EXPAND flag can be set to YES to add extra items for group members
606     # to the contents of the HTML help documentation and to the tree view.
607    
608     TOC_EXPAND = NO
609    
610     # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
611     # top of each HTML page. The value NO (the default) enables the index and
612     # the value YES disables it.
613    
614     DISABLE_INDEX = NO
615    
616     # This tag can be used to set the number of enum values (range [1..20])
617     # that doxygen will group on one line in the generated HTML documentation.
618    
619     ENUM_VALUES_PER_LINE = 4
620    
621     # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
622     # generated containing a tree-like index structure (just like the one that
623     # is generated for HTML Help). For this to work a browser that supports
624     # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
625     # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
626     # probably better off using the HTML help feature.
627    
628     GENERATE_TREEVIEW = NO
629    
630     # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
631     # used to set the initial width (in pixels) of the frame in which the tree
632     # is shown.
633    
634     TREEVIEW_WIDTH = 250
635    
636     #---------------------------------------------------------------------------
637     # Configuration options related to the preprocessor
638     #---------------------------------------------------------------------------
639    
640     # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
641     # evaluate all C-preprocessor directives found in the sources and include
642     # files.
643    
644     ENABLE_PREPROCESSING = YES
645    
646     # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
647     # names in the source code. If set to NO (the default) only conditional
648     # compilation will be performed. Macro expansion can be done in a controlled
649     # way by setting EXPAND_ONLY_PREDEF to YES.
650    
651     MACRO_EXPANSION = NO
652    
653     # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
654     # then the macro expansion is limited to the macros specified with the
655     # PREDEFINED and EXPAND_AS_PREDEFINED tags.
656    
657     EXPAND_ONLY_PREDEF = NO
658    
659     # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
660     # in the INCLUDE_PATH (see below) will be search if a #include is found.
661    
662     SEARCH_INCLUDES = YES
663    
664     # The INCLUDE_PATH tag can be used to specify one or more directories that
665     # contain include files that are not input files but should be processed by
666     # the preprocessor.
667    
668     INCLUDE_PATH =
669    
670     # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
671     # patterns (like *.h and *.hpp) to filter out the header-files in the
672     # directories. If left blank, the patterns specified with FILE_PATTERNS will
673     # be used.
674    
675     INCLUDE_FILE_PATTERNS =
676    
677     # The PREDEFINED tag can be used to specify one or more macro names that
678     # are defined before the preprocessor is started (similar to the -D option of
679     # gcc). The argument of the tag is a list of macros of the form: name
680     # or name=definition (no spaces). If the definition and the = are
681     # omitted =1 is assumed.
682    
683     PREDEFINED =
684    
685     # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
686     # this tag can be used to specify a list of macro names that should be expanded.
687     # The macro definition that is found in the sources will be used.
688     # Use the PREDEFINED tag if you want to use a different macro definition.
689    
690     EXPAND_AS_DEFINED =
691    
692     # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
693     # doxygen's preprocessor will remove all function-like macros that are alone
694     # on a line, have an all uppercase name, and do not end with a semicolon. Such
695     # function macros are typically used for boiler-plate code, and will confuse the
696     # parser if not removed.
697    
698     SKIP_FUNCTION_MACROS = YES
699    
700     #---------------------------------------------------------------------------
701     # Configuration::addtions related to external references
702     #---------------------------------------------------------------------------
703    
704     # The TAGFILES option can be used to specify one or more tagfiles.
705     # Optionally an initial location of the external documentation
706     # can be added for each tagfile. The format of a tag file without
707     # this location is as follows:
708     # TAGFILES = file1 file2 ...
709     # Adding location for the tag files is done as follows:
710     # TAGFILES = file1=loc1 "file2 = loc2" ...
711     # where "loc1" and "loc2" can be relative or absolute paths or
712     # URLs. If a location is present for each tag, the installdox tool
713     # does not have to be run to correct the links.
714     # Note that each tag file must have a unique name
715     # (where the name does NOT include the path)
716     # If a tag file is not located in the directory in which doxygen
717     # is run, you must also specify the path to the tagfile here.
718    
719     TAGFILES =
720    
721     # When a file name is specified after GENERATE_TAGFILE, doxygen will create
722     # a tag file that is based on the input files it reads.
723    
724     GENERATE_TAGFILE =
725    
726     # If the ALLEXTERNALS tag is set to YES all external classes will be listed
727     # in the class index. If set to NO only the inherited external classes
728     # will be listed.
729    
730     ALLEXTERNALS = NO
731    
732     # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
733     # in the modules index. If set to NO, only the current project's groups will
734     # be listed.
735    
736     EXTERNAL_GROUPS = YES
737    
738     # The PERL_PATH should be the absolute path and name of the perl script
739     # interpreter (i.e. the result of `which perl').
740    
741     PERL_PATH = /usr/bin/perl
742    
743     #---------------------------------------------------------------------------
744     # Configuration options related to the dot tool
745     #---------------------------------------------------------------------------
746    
747     # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
748     # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
749     # super classes. Setting the tag to NO turns the diagrams off. Note that this
750     # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
751     # recommended to install and use dot, since it yields more powerful graphs.
752    
753     CLASS_DIAGRAMS = YES
754    
755     # If set to YES, the inheritance and collaboration graphs will hide
756     # inheritance and usage relations if the target is undocumented
757     # or is not a class.
758    
759     HIDE_UNDOC_RELATIONS = NO
760    
761     # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
762     # available from the path. This tool is part of Graphviz, a graph visualization
763     # toolkit from AT&T and Lucent Bell Labs. The other options in this section
764     # have no effect if this option is set to NO (the default)
765    
766     HAVE_DOT = YES
767    
768     # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
769     # will generate a graph for each documented class showing the direct and
770     # indirect inheritance relations. Setting this tag to YES will force the
771     # the CLASS_DIAGRAMS tag to NO.
772    
773     CLASS_GRAPH = YES
774    
775     # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
776     # will generate a graph for each documented class showing the direct and
777     # indirect implementation dependencies (inheritance, containment, and
778     # class references variables) of the class with other documented classes.
779    
780     COLLABORATION_GRAPH = NO
781    
782     # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
783     # collaboration diagrams in a style similar to the OMG's Unified Modeling
784     # Language.
785    
786     UML_LOOK = NO
787    
788     # If set to YES, the inheritance and collaboration graphs will show the
789     # relations between templates and their instances.
790    
791     TEMPLATE_RELATIONS = YES
792    
793     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
794     # tags are set to YES then doxygen will generate a graph for each documented
795     # file showing the direct and indirect include dependencies of the file with
796     # other documented files.
797    
798     INCLUDE_GRAPH = NO
799    
800     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
801     # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
802     # documented header file showing the documented files that directly or
803     # indirectly include this file.
804    
805     INCLUDED_BY_GRAPH = NO
806    
807     # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
808     # generate a call dependency graph for every global function or class method.
809     # Note that enabling this option will significantly increase the time of a run.
810     # So in most cases it will be better to enable call graphs for selected
811     # functions only using the \callgraph command.
812    
813     CALL_GRAPH = NO
814    
815     # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
816     # will graphical hierarchy of all classes instead of a textual one.
817    
818     GRAPHICAL_HIERARCHY = YES
819    
820     # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
821     # generated by dot. Possible values are png, jpg, or gif
822     # If left blank png will be used.
823    
824     DOT_IMAGE_FORMAT = png
825    
826     # The tag DOT_PATH can be used to specify the path where the dot tool can be
827     # found. If left blank, it is assumed the dot tool can be found on the path.
828    
829     DOT_PATH =
830    
831     # The DOTFILE_DIRS tag can be used to specify one or more directories that
832     # contain dot files that are included in the documentation (see the
833     # \dotfile command).
834    
835     DOTFILE_DIRS =
836    
837     # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
838     # (in pixels) of the graphs generated by dot. If a graph becomes larger than
839     # this value, doxygen will try to truncate the graph, so that it fits within
840     # the specified constraint. Beware that most browsers cannot cope with very
841     # large images.
842    
843     MAX_DOT_GRAPH_WIDTH = 1024
844    
845     # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
846     # (in pixels) of the graphs generated by dot. If a graph becomes larger than
847     # this value, doxygen will try to truncate the graph, so that it fits within
848     # the specified constraint. Beware that most browsers cannot cope with very
849     # large images.
850    
851     MAX_DOT_GRAPH_HEIGHT = 1024
852    
853     # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
854     # graphs generated by dot. A depth value of 3 means that only nodes reachable
855     # from the root by following a path via at most 3 edges will be shown. Nodes that
856     # lay further from the root node will be omitted. Note that setting this option to
857     # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
858     # note that a graph may be further truncated if the graph's image dimensions are
859     # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
860     # If 0 is used for the depth value (the default), the graph is not depth-constrained.
861    
862     MAX_DOT_GRAPH_DEPTH = 0
863    
864     # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
865     # generate a legend page explaining the meaning of the various boxes and
866     # arrows in the dot generated graphs.
867    
868     GENERATE_LEGEND = YES
869    
870     # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
871     # remove the intermediate dot files that are used to generate
872     # the various graphs.
873    
874     DOT_CLEANUP = YES
875    
876     #---------------------------------------------------------------------------
877     # Configuration::addtions related to the search engine
878     #---------------------------------------------------------------------------
879    
880     # The SEARCHENGINE tag specifies whether or not a search engine should be
881     # used. If set to NO the values of all tags below this one will be ignored.
882    
883     SEARCHENGINE = NO
884     GENERATE_LATEX = NO

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23