source: TI05-delivery/trunk/Doxyfile @ 1117

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/Doxyfile@1117
Revision 1117, 43.8 KB checked in by spascoe, 16 years ago (diff)

The server-side Authz extensions and python bindings have been taken out of
bbftp source files and now exist in ndg.c and ndg.h.

API documentation can now be generated with doxygen. Just type "doxygen"
in the trunk directory.

Line 
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
20PROJECT_NAME           = "NDG Delivery Service"
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
26PROJECT_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
33OUTPUT_DIRECTORY       = ./doc/doxygen
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
44OUTPUT_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
54USE_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
61BRIEF_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
68REPEAT_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
79ABBREVIATE_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
85ALWAYS_DETAILED_SEC    = NO
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
92INLINE_INHERITED_MEMB  = NO
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
98FULL_PATH_NAMES        = NO
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
105STRIP_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
111SHORT_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
119JAVADOC_AUTOBRIEF      = YES
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
127MULTILINE_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
134DETAILS_AT_TOP         = NO
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
140INHERIT_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
147DISTRIBUTE_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
152TAB_SIZE               = 8
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
161ALIASES                =
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
168OPTIMIZE_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
175OPTIMIZE_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
183SUBGROUPING            = 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
194EXTRACT_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
199EXTRACT_PRIVATE        = NO
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
204EXTRACT_STATIC         = NO
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
210EXTRACT_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
218HIDE_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
225HIDE_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
232HIDE_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
239HIDE_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
246INTERNAL_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
254CASE_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
260HIDE_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
266SHOW_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
271INLINE_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
278SORT_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
284GENERATE_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
290GENERATE_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
296GENERATE_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
302GENERATE_DEPRECATEDLIST= YES
303
304# The ENABLED_SECTIONS tag can be used to enable conditional
305# documentation sections, marked by \if sectionname ... \endif.
306
307ENABLED_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
317MAX_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
323SHOW_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
332QUIET                  = NO
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
338WARNINGS               = 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
344WARN_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
351WARN_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
358WARN_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
364WARN_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
375INPUT  = src/bbftp-server-3.2.0/bbftpd/ndg.c
376
377
378# If the value of the INPUT tag contains directories, you can use the
379# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
380# and *.h) to filter out the source-files in the directories. If left
381# blank the following patterns are tested:
382# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
383# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
384
385FILE_PATTERNS          =
386
387# The RECURSIVE tag can be used to turn specify whether or not subdirectories
388# should be searched for input files as well. Possible values are YES and NO.
389# If left blank NO is used.
390
391RECURSIVE              = NO
392
393# The EXCLUDE tag can be used to specify files and/or directories that should
394# excluded from the INPUT source files. This way you can easily exclude a
395# subdirectory from a directory tree whose root is specified with the INPUT tag.
396
397EXCLUDE                =
398
399# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
400# that are symbolic links (a Unix filesystem feature) are excluded from the input.
401
402EXCLUDE_SYMLINKS       = NO
403
404# If the value of the INPUT tag contains directories, you can use the
405# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
406# certain files from those directories.
407
408EXCLUDE_PATTERNS       =
409
410# The EXAMPLE_PATH tag can be used to specify one or more files or
411# directories that contain example code fragments that are included (see
412# the \include command).
413
414EXAMPLE_PATH           =
415
416# If the value of the EXAMPLE_PATH tag contains directories, you can use the
417# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
418# and *.h) to filter out the source-files in the directories. If left
419# blank all files are included.
420
421EXAMPLE_PATTERNS       =
422
423# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
424# searched for input files to be used with the \include or \dontinclude
425# commands irrespective of the value of the RECURSIVE tag.
426# Possible values are YES and NO. If left blank NO is used.
427
428EXAMPLE_RECURSIVE      = NO
429
430# The IMAGE_PATH tag can be used to specify one or more files or
431# directories that contain image that are included in the documentation (see
432# the \image command).
433
434IMAGE_PATH             =
435
436# The INPUT_FILTER tag can be used to specify a program that doxygen should
437# invoke to filter for each input file. Doxygen will invoke the filter program
438# by executing (via popen()) the command <filter> <input-file>, where <filter>
439# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
440# input file. Doxygen will then use the output that the filter program writes
441# to standard output.
442
443INPUT_FILTER           =
444
445# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
446# INPUT_FILTER) will be used to filter the input files when producing source
447# files to browse (i.e. when SOURCE_BROWSER is set to YES).
448
449FILTER_SOURCE_FILES    = NO
450
451#---------------------------------------------------------------------------
452# configuration options related to source browsing
453#---------------------------------------------------------------------------
454
455# If the SOURCE_BROWSER tag is set to YES then a list of source files will
456# be generated. Documented entities will be cross-referenced with these sources.
457# Note: To get rid of all source code in the generated output, make sure also
458# VERBATIM_HEADERS is set to NO.
459
460SOURCE_BROWSER         = NO
461
462# Setting the INLINE_SOURCES tag to YES will include the body
463# of functions and classes directly in the documentation.
464
465INLINE_SOURCES         = NO
466
467# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
468# doxygen to hide any special comment blocks from generated source code
469# fragments. Normal C and C++ comments will always remain visible.
470
471STRIP_CODE_COMMENTS    = YES
472
473# If the REFERENCED_BY_RELATION tag is set to YES (the default)
474# then for each documented function all documented
475# functions referencing it will be listed.
476
477REFERENCED_BY_RELATION = YES
478
479# If the REFERENCES_RELATION tag is set to YES (the default)
480# then for each documented function all documented entities
481# called/used by that function will be listed.
482
483REFERENCES_RELATION    = YES
484
485# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
486# will generate a verbatim copy of the header file for each class for
487# which an include is specified. Set to NO to disable this.
488
489VERBATIM_HEADERS       = YES
490
491#---------------------------------------------------------------------------
492# configuration options related to the alphabetical class index
493#---------------------------------------------------------------------------
494
495# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
496# of all compounds will be generated. Enable this if the project
497# contains a lot of classes, structs, unions or interfaces.
498
499ALPHABETICAL_INDEX     = NO
500
501# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
502# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
503# in which this list will be split (can be a number in the range [1..20])
504
505COLS_IN_ALPHA_INDEX    = 5
506
507# In case all classes in a project start with a common prefix, all
508# classes will be put under the same header in the alphabetical index.
509# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
510# should be ignored while generating the index headers.
511
512IGNORE_PREFIX          =
513
514#---------------------------------------------------------------------------
515# configuration options related to the HTML output
516#---------------------------------------------------------------------------
517
518# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
519# generate HTML output.
520
521GENERATE_HTML          = YES
522
523# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
524# If a relative path is entered the value of OUTPUT_DIRECTORY will be
525# put in front of it. If left blank `html' will be used as the default path.
526
527HTML_OUTPUT            = html
528
529# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
530# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
531# doxygen will generate files with .html extension.
532
533HTML_FILE_EXTENSION    = .html
534
535# The HTML_HEADER tag can be used to specify a personal HTML header for
536# each generated HTML page. If it is left blank doxygen will generate a
537# standard header.
538
539HTML_HEADER            =
540
541# The HTML_FOOTER tag can be used to specify a personal HTML footer for
542# each generated HTML page. If it is left blank doxygen will generate a
543# standard footer.
544
545HTML_FOOTER            =
546
547# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
548# style sheet that is used by each HTML page. It can be used to
549# fine-tune the look of the HTML output. If the tag is left blank doxygen
550# will generate a default style sheet. Note that doxygen will try to copy
551# the style sheet file to the HTML output directory, so don't put your own
552# stylesheet in the HTML output directory as well, or it will be erased!
553
554HTML_STYLESHEET        =
555
556# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
557# files or namespaces will be aligned in HTML using tables. If set to
558# NO a bullet list will be used.
559
560HTML_ALIGN_MEMBERS     = YES
561
562# If the GENERATE_HTMLHELP tag is set to YES, additional index files
563# will be generated that can be used as input for tools like the
564# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
565# of the generated HTML documentation.
566
567GENERATE_HTMLHELP      = NO
568
569# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
570# be used to specify the file name of the resulting .chm file. You
571# can add a path in front of the file if the result should not be
572# written to the html output directory.
573
574CHM_FILE               =
575
576# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
577# be used to specify the location (absolute path including file name) of
578# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
579# the HTML help compiler on the generated index.hhp.
580
581HHC_LOCATION           =
582
583# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
584# controls if a separate .chi index file is generated (YES) or that
585# it should be included in the master .chm file (NO).
586
587GENERATE_CHI           = NO
588
589# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
590# controls whether a binary table of contents is generated (YES) or a
591# normal table of contents (NO) in the .chm file.
592
593BINARY_TOC             = NO
594
595# The TOC_EXPAND flag can be set to YES to add extra items for group members
596# to the contents of the HTML help documentation and to the tree view.
597
598TOC_EXPAND             = NO
599
600# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
601# top of each HTML page. The value NO (the default) enables the index and
602# the value YES disables it.
603
604DISABLE_INDEX          = NO
605
606# This tag can be used to set the number of enum values (range [1..20])
607# that doxygen will group on one line in the generated HTML documentation.
608
609ENUM_VALUES_PER_LINE   = 4
610
611# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
612# generated containing a tree-like index structure (just like the one that
613# is generated for HTML Help). For this to work a browser that supports
614# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
615# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
616# probably better off using the HTML help feature.
617
618GENERATE_TREEVIEW      = NO
619
620# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
621# used to set the initial width (in pixels) of the frame in which the tree
622# is shown.
623
624TREEVIEW_WIDTH         = 250
625
626#---------------------------------------------------------------------------
627# configuration options related to the LaTeX output
628#---------------------------------------------------------------------------
629
630# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
631# generate Latex output.
632
633GENERATE_LATEX         = YES
634
635# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
636# If a relative path is entered the value of OUTPUT_DIRECTORY will be
637# put in front of it. If left blank `latex' will be used as the default path.
638
639LATEX_OUTPUT           = latex
640
641# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
642# invoked. If left blank `latex' will be used as the default command name.
643
644LATEX_CMD_NAME         = latex
645
646# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
647# generate index for LaTeX. If left blank `makeindex' will be used as the
648# default command name.
649
650MAKEINDEX_CMD_NAME     = makeindex
651
652# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
653# LaTeX documents. This may be useful for small projects and may help to
654# save some trees in general.
655
656COMPACT_LATEX          = NO
657
658# The PAPER_TYPE tag can be used to set the paper type that is used
659# by the printer. Possible values are: a4, a4wide, letter, legal and
660# executive. If left blank a4wide will be used.
661
662PAPER_TYPE             = a4wide
663
664# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
665# packages that should be included in the LaTeX output.
666
667EXTRA_PACKAGES         =
668
669# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
670# the generated latex document. The header should contain everything until
671# the first chapter. If it is left blank doxygen will generate a
672# standard header. Notice: only use this tag if you know what you are doing!
673
674LATEX_HEADER           =
675
676# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
677# is prepared for conversion to pdf (using ps2pdf). The pdf file will
678# contain links (just like the HTML output) instead of page references
679# This makes the output suitable for online browsing using a pdf viewer.
680
681PDF_HYPERLINKS         = NO
682
683# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
684# plain latex in the generated Makefile. Set this option to YES to get a
685# higher quality PDF documentation.
686
687USE_PDFLATEX           = YES
688
689# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
690# command to the generated LaTeX files. This will instruct LaTeX to keep
691# running if errors occur, instead of asking the user for help.
692# This option is also used when generating formulas in HTML.
693
694LATEX_BATCHMODE        = NO
695
696# If LATEX_HIDE_INDICES is set to YES then doxygen will not
697# include the index chapters (such as File Index, Compound Index, etc.)
698# in the output.
699
700LATEX_HIDE_INDICES     = NO
701
702#---------------------------------------------------------------------------
703# configuration options related to the RTF output
704#---------------------------------------------------------------------------
705
706# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
707# The RTF output is optimized for Word 97 and may not look very pretty with
708# other RTF readers or editors.
709
710GENERATE_RTF           = NO
711
712# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
713# If a relative path is entered the value of OUTPUT_DIRECTORY will be
714# put in front of it. If left blank `rtf' will be used as the default path.
715
716RTF_OUTPUT             = rtf
717
718# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
719# RTF documents. This may be useful for small projects and may help to
720# save some trees in general.
721
722COMPACT_RTF            = NO
723
724# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
725# will contain hyperlink fields. The RTF file will
726# contain links (just like the HTML output) instead of page references.
727# This makes the output suitable for online browsing using WORD or other
728# programs which support those fields.
729# Note: wordpad (write) and others do not support links.
730
731RTF_HYPERLINKS         = NO
732
733# Load stylesheet definitions from file. Syntax is similar to doxygen's
734# config file, i.e. a series of assignments. You only have to provide
735# replacements, missing definitions are set to their default value.
736
737RTF_STYLESHEET_FILE    =
738
739# Set optional variables used in the generation of an rtf document.
740# Syntax is similar to doxygen's config file.
741
742RTF_EXTENSIONS_FILE    =
743
744#---------------------------------------------------------------------------
745# configuration options related to the man page output
746#---------------------------------------------------------------------------
747
748# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
749# generate man pages
750
751GENERATE_MAN           = NO
752
753# The MAN_OUTPUT tag is used to specify where the man pages will be put.
754# If a relative path is entered the value of OUTPUT_DIRECTORY will be
755# put in front of it. If left blank `man' will be used as the default path.
756
757MAN_OUTPUT             = man
758
759# The MAN_EXTENSION tag determines the extension that is added to
760# the generated man pages (default is the subroutine's section .3)
761
762MAN_EXTENSION          = .3
763
764# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
765# then it will generate one additional man file for each entity
766# documented in the real man page(s). These additional files
767# only source the real man page, but without them the man command
768# would be unable to find the correct page. The default is NO.
769
770MAN_LINKS              = NO
771
772#---------------------------------------------------------------------------
773# configuration options related to the XML output
774#---------------------------------------------------------------------------
775
776# If the GENERATE_XML tag is set to YES Doxygen will
777# generate an XML file that captures the structure of
778# the code including all documentation.
779
780GENERATE_XML           = NO
781
782# The XML_OUTPUT tag is used to specify where the XML pages will be put.
783# If a relative path is entered the value of OUTPUT_DIRECTORY will be
784# put in front of it. If left blank `xml' will be used as the default path.
785
786XML_OUTPUT             = xml
787
788# The XML_SCHEMA tag can be used to specify an XML schema,
789# which can be used by a validating XML parser to check the
790# syntax of the XML files.
791
792XML_SCHEMA             =
793
794# The XML_DTD tag can be used to specify an XML DTD,
795# which can be used by a validating XML parser to check the
796# syntax of the XML files.
797
798XML_DTD                =
799
800# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
801# dump the program listings (including syntax highlighting
802# and cross-referencing information) to the XML output. Note that
803# enabling this will significantly increase the size of the XML output.
804
805XML_PROGRAMLISTING     = YES
806
807#---------------------------------------------------------------------------
808# configuration options for the AutoGen Definitions output
809#---------------------------------------------------------------------------
810
811# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
812# generate an AutoGen Definitions (see autogen.sf.net) file
813# that captures the structure of the code including all
814# documentation. Note that this feature is still experimental
815# and incomplete at the moment.
816
817GENERATE_AUTOGEN_DEF   = NO
818
819#---------------------------------------------------------------------------
820# configuration options related to the Perl module output
821#---------------------------------------------------------------------------
822
823# If the GENERATE_PERLMOD tag is set to YES Doxygen will
824# generate a Perl module file that captures the structure of
825# the code including all documentation. Note that this
826# feature is still experimental and incomplete at the
827# moment.
828
829GENERATE_PERLMOD       = NO
830
831# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
832# the necessary Makefile rules, Perl scripts and LaTeX code to be able
833# to generate PDF and DVI output from the Perl module output.
834
835PERLMOD_LATEX          = NO
836
837# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
838# nicely formatted so it can be parsed by a human reader.  This is useful
839# if you want to understand what is going on.  On the other hand, if this
840# tag is set to NO the size of the Perl module output will be much smaller
841# and Perl will parse it just the same.
842
843PERLMOD_PRETTY         = YES
844
845# The names of the make variables in the generated doxyrules.make file
846# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
847# This is useful so different doxyrules.make files included by the same
848# Makefile don't overwrite each other's variables.
849
850PERLMOD_MAKEVAR_PREFIX =
851
852#---------------------------------------------------------------------------
853# Configuration options related to the preprocessor   
854#---------------------------------------------------------------------------
855
856# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
857# evaluate all C-preprocessor directives found in the sources and include
858# files.
859
860ENABLE_PREPROCESSING   = NO
861
862# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
863# names in the source code. If set to NO (the default) only conditional
864# compilation will be performed. Macro expansion can be done in a controlled
865# way by setting EXPAND_ONLY_PREDEF to YES.
866
867MACRO_EXPANSION        = NO
868
869# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
870# then the macro expansion is limited to the macros specified with the
871# PREDEFINED and EXPAND_AS_PREDEFINED tags.
872
873EXPAND_ONLY_PREDEF     = NO
874
875# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
876# in the INCLUDE_PATH (see below) will be search if a #include is found.
877
878SEARCH_INCLUDES        = YES
879
880# The INCLUDE_PATH tag can be used to specify one or more directories that
881# contain include files that are not input files but should be processed by
882# the preprocessor.
883
884INCLUDE_PATH           = src/bbftp-server-3.2.0/includes
885
886# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
887# patterns (like *.h and *.hpp) to filter out the header-files in the
888# directories. If left blank, the patterns specified with FILE_PATTERNS will
889# be used.
890
891INCLUDE_FILE_PATTERNS  =
892
893# The PREDEFINED tag can be used to specify one or more macro names that
894# are defined before the preprocessor is started (similar to the -D option of
895# gcc). The argument of the tag is a list of macros of the form: name
896# or name=definition (no spaces). If the definition and the = are
897# omitted =1 is assumed.
898
899PREDEFINED             = NDG_AUTH LOCAL_SYSLOG_FACILITY NDG_PYTHON_EMBED
900
901# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
902# this tag can be used to specify a list of macro names that should be expanded.
903# The macro definition that is found in the sources will be used.
904# Use the PREDEFINED tag if you want to use a different macro definition.
905
906EXPAND_AS_DEFINED      =
907
908# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
909# doxygen's preprocessor will remove all function-like macros that are alone
910# on a line, have an all uppercase name, and do not end with a semicolon. Such
911# function macros are typically used for boiler-plate code, and will confuse the
912# parser if not removed.
913
914SKIP_FUNCTION_MACROS   = YES
915
916#---------------------------------------------------------------------------
917# Configuration::addtions related to external references   
918#---------------------------------------------------------------------------
919
920# The TAGFILES option can be used to specify one or more tagfiles.
921# Optionally an initial location of the external documentation
922# can be added for each tagfile. The format of a tag file without
923# this location is as follows:
924#   TAGFILES = file1 file2 ...
925# Adding location for the tag files is done as follows:
926#   TAGFILES = file1=loc1 "file2 = loc2" ...
927# where "loc1" and "loc2" can be relative or absolute paths or
928# URLs. If a location is present for each tag, the installdox tool
929# does not have to be run to correct the links.
930# Note that each tag file must have a unique name
931# (where the name does NOT include the path)
932# If a tag file is not located in the directory in which doxygen
933# is run, you must also specify the path to the tagfile here.
934
935TAGFILES               =
936
937# When a file name is specified after GENERATE_TAGFILE, doxygen will create
938# a tag file that is based on the input files it reads.
939
940GENERATE_TAGFILE       =
941
942# If the ALLEXTERNALS tag is set to YES all external classes will be listed
943# in the class index. If set to NO only the inherited external classes
944# will be listed.
945
946ALLEXTERNALS           = NO
947
948# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
949# in the modules index. If set to NO, only the current project's groups will
950# be listed.
951
952EXTERNAL_GROUPS        = YES
953
954# The PERL_PATH should be the absolute path and name of the perl script
955# interpreter (i.e. the result of `which perl').
956
957PERL_PATH              = /usr/bin/perl
958
959#---------------------------------------------------------------------------
960# Configuration options related to the dot tool   
961#---------------------------------------------------------------------------
962
963# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
964# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
965# super classes. Setting the tag to NO turns the diagrams off. Note that this
966# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
967# recommended to install and use dot, since it yields more powerful graphs.
968
969CLASS_DIAGRAMS         = YES
970
971# If set to YES, the inheritance and collaboration graphs will hide
972# inheritance and usage relations if the target is undocumented
973# or is not a class.
974
975HIDE_UNDOC_RELATIONS   = YES
976
977# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
978# available from the path. This tool is part of Graphviz, a graph visualization
979# toolkit from AT&T and Lucent Bell Labs. The other options in this section
980# have no effect if this option is set to NO (the default)
981
982HAVE_DOT               = NO
983
984# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
985# will generate a graph for each documented class showing the direct and
986# indirect inheritance relations. Setting this tag to YES will force the
987# the CLASS_DIAGRAMS tag to NO.
988
989CLASS_GRAPH            = NO
990
991# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
992# will generate a graph for each documented class showing the direct and
993# indirect implementation dependencies (inheritance, containment, and
994# class references variables) of the class with other documented classes.
995
996COLLABORATION_GRAPH    = NO
997
998# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
999# collaboration diagrams in a style similar to the OMG's Unified Modeling
1000# Language.
1001
1002UML_LOOK               = NO
1003
1004# If set to YES, the inheritance and collaboration graphs will show the
1005# relations between templates and their instances.
1006
1007TEMPLATE_RELATIONS     = NO
1008
1009# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1010# tags are set to YES then doxygen will generate a graph for each documented
1011# file showing the direct and indirect include dependencies of the file with
1012# other documented files.
1013
1014INCLUDE_GRAPH          = YES
1015
1016# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1017# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1018# documented header file showing the documented files that directly or
1019# indirectly include this file.
1020
1021INCLUDED_BY_GRAPH      = YES
1022
1023# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1024# generate a call dependency graph for every global function or class method.
1025# Note that enabling this option will significantly increase the time of a run.
1026# So in most cases it will be better to enable call graphs for selected
1027# functions only using the \callgraph command.
1028
1029CALL_GRAPH             = NO
1030
1031# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1032# will graphical hierarchy of all classes instead of a textual one.
1033
1034GRAPHICAL_HIERARCHY    = YES
1035
1036# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1037# generated by dot. Possible values are png, jpg, or gif
1038# If left blank png will be used.
1039
1040DOT_IMAGE_FORMAT       = png
1041
1042# The tag DOT_PATH can be used to specify the path where the dot tool can be
1043# found. If left blank, it is assumed the dot tool can be found on the path.
1044
1045DOT_PATH               =
1046
1047# The DOTFILE_DIRS tag can be used to specify one or more directories that
1048# contain dot files that are included in the documentation (see the
1049# \dotfile command).
1050
1051DOTFILE_DIRS           =
1052
1053# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1054# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1055# this value, doxygen will try to truncate the graph, so that it fits within
1056# the specified constraint. Beware that most browsers cannot cope with very
1057# large images.
1058
1059MAX_DOT_GRAPH_WIDTH    = 1024
1060
1061# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1062# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1063# this value, doxygen will try to truncate the graph, so that it fits within
1064# the specified constraint. Beware that most browsers cannot cope with very
1065# large images.
1066
1067MAX_DOT_GRAPH_HEIGHT   = 1024
1068
1069# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1070# graphs generated by dot. A depth value of 3 means that only nodes reachable
1071# from the root by following a path via at most 3 edges will be shown. Nodes that
1072# lay further from the root node will be omitted. Note that setting this option to
1073# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1074# note that a graph may be further truncated if the graph's image dimensions are
1075# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1076# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1077
1078MAX_DOT_GRAPH_DEPTH    = 0
1079
1080# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1081# generate a legend page explaining the meaning of the various boxes and
1082# arrows in the dot generated graphs.
1083
1084GENERATE_LEGEND        = YES
1085
1086# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1087# remove the intermediate dot files that are used to generate
1088# the various graphs.
1089
1090DOT_CLEANUP            = YES
1091
1092#---------------------------------------------------------------------------
1093# Configuration::addtions related to the search engine   
1094#---------------------------------------------------------------------------
1095
1096# The SEARCHENGINE tag specifies whether or not a search engine should be
1097# used. If set to NO the values of all tags below this one will be ignored.
1098
1099SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.