/[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.1 - (hide annotations) (download)
Tue Nov 14 14:51:22 2006 UTC (12 years, 6 months ago) by sven
Branch: MAIN

Misc:
 * Bind table flag BIND_BREAKABLE now includes BIND_STACKABLE, doesn't make
   sense otherwise.
 * If the line buffer contains more than one line of text do a check if the
   index is still valid after every callback (the sockbuf might have been
   deleted).
 * Added a "Doxygen" file in the root dir. It will generate html output in
   doc/developer/html. (The dir will be created by doxygen.)

Partyline stuff:
 * Partychan join and quit functions have an extra parameter indicating if
   the event is triggered because of someone joining/quitting or botnet
   restructuring.
 * Renamed partychan_msg() to chan_msg and made it static. It can now either
   msg the whole channel or just everyone on the local bot on the channel.
 * New functions partychan_msg() (works like before) and localchan_msg() to
   send it to every local user of the chan.
 * Added stuff to the partymember struct: A pointer to the bot the user is
   on, a malloc'd string containing the full unique name in the form
   "id:nick@bot", a pointer into this string to the full name "nick@bot"
   and a pointer to the common name of the user, "nick" for local users and
   "nick@bot" for users on other bots.
 * The id of a partymember is no longer unique, only unique to the bot the
   user is on. The nick was never unique. TODO: Change the script modules
   to take care of that!
 * A partymember is now part of two double linked lists: A list of all
   partymembers and a list of all partymembers on the bot.
 * Removed the partymember_lookup_* functions. partymember_lookup() takes
   cares of all the stuff.
 * Added functions to count all users on a bot and delete all users on a bot.

Ircpartyline:
 * IRC requires nicks to be unique for everyone and useing the usual "@" in
   the "nick@bot" form doesn't work at all on IRC. Therefor the nick format
   is now: "nick*bot:id" for remote users and "nick:id" for local users.

Script stuff:
 * Added a new script parameter: 'B': A bot.
 * TODO: Change the script modules to use it!

Botnet stuff:
 * Added botnet.[ch]. Fully documented!
 * Changed the oldbotnet module to use the new botnet API. Only very basic
   stuff works atm: Bot links, unlinks, partymember joins, quits and chatter.
   But at least it doesn't matter any more if the bot is a leaf or a hub.

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23