Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

Doxyfile

Go to the documentation of this file.
00001 # Doxyfile 1.1.1
00002 
00003 # This file describes the settings to be used by doxygen for a project
00004 #
00005 # All text after a hash (#) is considered a comment and will be ignored
00006 # The format is:
00007 #       TAG = value [value, ...]
00008 # Values that contain spaces should be placed between quotes (" ")
00009 
00010 #---------------------------------------------------------------------------
00011 # General configuration options
00012 #---------------------------------------------------------------------------
00013 
00014 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded
00015 # by quotes) that should identify the project. 
00016 
00017 PROJECT_NAME         =  Groupware
00018 
00019 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
00020 # This could be handy for archiving the generated documentation or 
00021 # if some version control system is used.
00022 
00023 PROJECT_NUMBER       = 
00024 
00025 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
00026 # base path where the generated documentation will be put. 
00027 # If a relative path is entered, it will be relative to the location 
00028 # where doxygen was started. If left blank the current directory will be used.
00029 
00030 OUTPUT_DIRECTORY     = DOC
00031 
00032 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
00033 # documentation generated by doxygen is written. Doxygen will use this
00034 # information to generate all constant output in the proper language.
00035 # The default language is English, other supported languages are: 
00036 # Dutch, French, Italian, Czech, Swedish, German and Japanese
00037 
00038 OUTPUT_LANGUAGE      = English
00039 
00040 # The QUIET tag can be used to turn on/off the messages that are generated
00041 # by doxygen. Possible values are YES and NO. If left blank NO is used.
00042 
00043 QUIET                = NO
00044 
00045 # The WARNINGS tag can be used to turn on/off the warning messages that are
00046 # generated by doxygen. Possible values are YES and NO. If left blank
00047 # NO is used.
00048 
00049 WARNINGS             = YES
00050 
00051 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
00052 # top of each HTML page. The value NO (the default) enables the index and
00053 # the value YES disables it.
00054 
00055 DISABLE_INDEX        = NO
00056 
00057 # If the EXTRACT_ALL tag is set to YES all classes and functions will be
00058 # included in the documentation, even if no documentation was available.
00059 
00060 EXTRACT_ALL          = YES
00061 
00062 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
00063 # will be included in the documentation.
00064 
00065 EXTRACT_PRIVATE      = YES
00066 
00067 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
00068 # undocumented members inside documented classes or files.
00069 
00070 HIDE_UNDOC_MEMBERS   = NO
00071 
00072 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all
00073 # undocumented classes.
00074 
00075 HIDE_UNDOC_CLASSES   = NO
00076 
00077 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
00078 # include brief member descriptions after the members that are listed in 
00079 # the file and class documentation (similar to JavaDoc).
00080 # Set to NO to disable this.
00081 
00082 BRIEF_MEMBER_DESC    = YES
00083 
00084 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
00085 # the brief description of a member or function before the detailed description.
00086 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
00087 # brief descriptions will be completely suppressed.
00088 
00089 REPEAT_BRIEF         = YES
00090 
00091 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
00092 # Doxygen will generate a detailed section even if there is only a brief
00093 # description.
00094 
00095 ALWAYS_DETAILED_SEC  = NO
00096 
00097 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
00098 # path before files name in the file list and in the header files. If set
00099 # to NO the shortest path that makes the file name unique will be used.
00100 
00101 FULL_PATH_NAMES      = NO
00102 
00103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
00104 # can be used to strip a user defined part of the path. Stripping is
00105 # only done if one of the specified strings matches the left-hand part of
00106 # the path.
00107 
00108 STRIP_FROM_PATH      = 
00109 
00110 # The INTERNAL_DOCS tag determines if documentation
00111 # that is typed after a \internal command is included. If the tag is set 
00112 # to NO (the default) then the documentation will be excluded.
00113 # Set it to YES to include the internal documentation.
00114 
00115 INTERNAL_DOCS        = NO
00116 
00117 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
00118 # generate a class diagram (in Html and LaTeX) for classes with base or
00119 # super classes. Setting the tag to NO turns the diagrams off.
00120 
00121 CLASS_DIAGRAMS       = YES
00122 
00123 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
00124 # be generated. Documented entities will be cross-referenced with these sources.
00125 
00126 SOURCE_BROWSER       = YES
00127 
00128 # Setting the INLINE_SOURCES tag to YES will include the body
00129 # of functions and classes directly in the documentation.
00130 
00131 INLINE_SOURCES       = YES
00132 
00133 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
00134 # doxygen to hide any special comment blocks from generated source code
00135 # fragments. Normal C and C++ comments will always remain visible.
00136 
00137 STRIP_CODE_COMMENTS  = YES
00138 
00139 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
00140 # will only generate file names in lower case letters. If set to
00141 # YES upper case letters are also allowed. This is useful if you have
00142 # classes or files whose names only differ in case and if your file system
00143 # supports case sensitive file names.
00144 
00145 CASE_SENSE_NAMES     = NO
00146 
00147 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
00148 # will generate a verbatim copy of the header file for each class for
00149 # which an include is specified. Set to NO to disable this.
00150 
00151 VERBATIM_HEADERS     = YES
00152 
00153 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
00154 # will put list of the files that are included by a file in the documentation
00155 # of that file.
00156 
00157 SHOW_INCLUDE_FILES   = YES
00158 
00159 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
00160 # will interpret the first line (until the first dot) of a JavaDoc-style
00161 # comment as the brief description. If set to NO, the Javadoc-style will
00162 # behave just like the Qt-style comments.
00163 
00164 JAVADOC_AUTOBRIEF    = YES
00165 
00166 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
00167 # member inherits the documentation from any documented member that it
00168 # reimplements.
00169 
00170 INHERIT_DOCS         = YES
00171 
00172 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
00173 # is inserted in the documentation for inline members.
00174 
00175 INLINE_INFO          = YES
00176 
00177 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
00178 # will sort the (detailed) documentation of file and class members 
00179 # alphabetically by member name. If set to NO the members will appear in
00180 # declaration order.
00181 
00182 SORT_MEMBER_DOCS     = YES
00183 
00184 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
00185 # Doxygen uses this value to replace tabs by spaces in code fragments.
00186 
00187 TAB_SIZE             = 8
00188 
00189 #---------------------------------------------------------------------------
00190 # configuration options related to the input files
00191 #---------------------------------------------------------------------------
00192 
00193 # The INPUT tag can be used to specify the files and/or directories that contain 
00194 # documented source files. You may enter file names like "myfile.cpp" or 
00195 # directories like "/usr/src/myproject". Separate the files or directories 
00196 # with spaces.
00197 
00198 INPUT                =  /home/fanchon/DIST/SYSTEM/GROUP_ATOM_V2
00199 
00200 # If the value of the INPUT tag contains directories, you can use the 
00201 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
00202 # and *.h) to filter out the source-files in the directories. If left 
00203 # blank all files are included.
00204 
00205 FILE_PATTERNS        = 
00206 
00207 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
00208 # should be searched for input files as well. Possible values are YES and NO.
00209 # If left blank NO is used.
00210 
00211 RECURSIVE            = NO
00212 
00213 # The EXCLUDE tag can be used to specify files and/or directories that should
00214 # excluded from the INPUT source files. This way you can easily exclude a 
00215 # subdirectory from a directory tree whose root is specified with the INPUT tag.
00216 
00217 EXCLUDE              = 
00218 
00219 # If the value of the INPUT tag contains directories, you can use the
00220 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
00221 # certain files from those directories.
00222 
00223 EXCLUDE_PATTERNS     = *.dat
00224 
00225 # The EXAMPLE_PATH tag can be used to specify one or more files or 
00226 # directories that contain example code fragments that are included (see 
00227 # the \include command).
00228 
00229 EXAMPLE_PATH         = 
00230 
00231 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
00232 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
00233 # and *.h) to filter out the source-files in the directories. If left 
00234 # blank all files are included.
00235 
00236 EXAMPLE_PATTERNS     = 
00237 
00238 # The IMAGE_PATH tag can be used to specify one or more files or 
00239 # directories that contain image that are included in the documentation (see 
00240 # the \image command).
00241 
00242 IMAGE_PATH           = 
00243 
00244 # The INPUT_FILTER tag can be used to specify a program that doxygen should
00245 # invoke to filter for each input file. Doxygen will invoke the filter program 
00246 # by executing (via popen()) the command <filter> <input-file>, where <filter>
00247 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
00248 # input file. Doxygen will then use the output that the filter program writes
00249 # to standard output.
00250 
00251 INPUT_FILTER         = 
00252 
00253 #---------------------------------------------------------------------------
00254 # configuration options related to the HTML output
00255 #---------------------------------------------------------------------------
00256 
00257 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
00258 # generate HTML output
00259 
00260 GENERATE_HTML        = YES
00261 
00262 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
00263 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
00264 # put in front of it. If left blank `html' will be used as the default path.
00265 
00266 HTML_OUTPUT          = html
00267 
00268 # The HTML_HEADER tag can be used to specify a personal HTML header for 
00269 # each generated HTML page. If it is left blank doxygen will generate a 
00270 # standard header.
00271 
00272 HTML_HEADER          = 
00273 
00274 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
00275 # each generated HTML page. If it is left blank doxygen will generate a 
00276 # standard footer.
00277 
00278 HTML_FOOTER          = 
00279 
00280 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
00281 # style sheet that is used by each HTML page. It can be used to 
00282 # fine-tune the look of the HTML output. If the tag is left blank doxygen
00283 # will generate a default style sheet
00284 
00285 HTML_STYLESHEET      = 
00286 
00287 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
00288 # files or namespaces will be aligned in HTML using tables. If set to
00289 # NO a bullet list will be used.
00290 
00291 HTML_ALIGN_MEMBERS   = YES
00292 
00293 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
00294 # will be generated that can be used as input for tools like the
00295 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
00296 # of the generated HTML documentation.
00297 
00298 GENERATE_HTMLHELP    = NO
00299 
00300 #---------------------------------------------------------------------------
00301 # configuration options related to the alphabetical class index
00302 #---------------------------------------------------------------------------
00303 
00304 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
00305 # of all compounds will be generated. Enable this if the project
00306 # contains a lot of classes, structs, unions or interfaces.
00307 
00308 ALPHABETICAL_INDEX   = YES
00309 
00310 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
00311 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
00312 # in which this list will be split (can be a number in the range [1..20])
00313 
00314 COLS_IN_ALPHA_INDEX  = 5
00315 
00316 # In case all classes in a project start with a common prefix, all
00317 # classes will be put under the same header in the alphabetical index.
00318 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
00319 # should be ignored while generating the index headers.
00320 
00321 IGNORE_PREFIX        = 
00322 
00323 #---------------------------------------------------------------------------
00324 # configuration options related to the LaTeX output
00325 #---------------------------------------------------------------------------
00326 
00327 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
00328 # generate Latex output.
00329 
00330 GENERATE_LATEX       = NO
00331 
00332 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
00333 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
00334 # put in front of it. If left blank `latex' will be used as the default path.
00335 
00336 LATEX_OUTPUT         = latex
00337 
00338 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
00339 # LaTeX documents. This may be useful for small projects and may help to
00340 # save some trees in general.
00341 
00342 COMPACT_LATEX        = NO
00343 
00344 # The PAPER_TYPE tag can be used to set the paper type that is used
00345 # by the printer. Possible values are: a4, a4wide, letter, legal and 
00346 # executive. If left blank a4wide will be used.
00347 
00348 PAPER_TYPE           = a4wide
00349 
00350 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
00351 # packages that should be included in the LaTeX output.
00352 
00353 EXTRA_PACKAGES       = 
00354 
00355 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
00356 # the generated latex document. The header should contain everything until
00357 # the first chapter. If it is left blank doxygen will generate a 
00358 # standard header. Notice: only use this tag if you know what you are doing!
00359 
00360 LATEX_HEADER         = 
00361 
00362 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
00363 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
00364 # contain links (just like the HTML output) instead of page references
00365 # This makes the output suitable for online browsing using a pdf viewer.
00366 
00367 PDF_HYPERLINKS       = NO
00368 
00369 
00370 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode.
00371 # command to the generated LaTeX files. This will instruct LaTeX to keep
00372 # running if errors occur, instead of asking the user for help.
00373 # This option is also used when generating formulas in HTML.
00374 LATEX_BATCHMODE    = NO
00375 #---------------------------------------------------------------------------
00376 # configuration options related to the RTF output
00377 #---------------------------------------------------------------------------
00378 
00379 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
00380 # For now this is experimental and is disabled by default. The RTF output
00381 # is optimised for Word 97 and may not look too pretty with other readers
00382 # or editors.
00383 
00384 GENERATE_RTF         = NO
00385 
00386 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
00387 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
00388 # put in front of it. If left blank `rtf' will be used as the default path.
00389 
00390 RTF_OUTPUT           = rtf
00391 
00392 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
00393 # RTF documents. This may be useful for small projects and may help to
00394 # save some trees in general.
00395 
00396 COMPACT_RTF          = NO
00397 
00398 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
00399 # will contain hyperlink fields. The RTF file will
00400 # contain links (just like the HTML output) instead of page references.
00401 # This makes the output suitable for online browsing using a WORD or other.
00402 # programs which support those fields.
00403 # Note: wordpad (write) and others do not support links.
00404 
00405 RTF_HYPERLINKS       = NO
00406 #---------------------------------------------------------------------------
00407 # configuration options related to the man page output
00408 #---------------------------------------------------------------------------
00409 
00410 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
00411 # generate man pages
00412 
00413 GENERATE_MAN         = YES
00414 
00415 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
00416 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
00417 # put in front of it. If left blank `man' will be used as the default path.
00418 
00419 MAN_OUTPUT           = man
00420 
00421 # The MAN_EXTENSION tag determines the extension that is added to
00422 # the generated man pages (default is the subroutine's section .3)
00423 
00424 MAN_EXTENSION        = .3
00425 
00426 #---------------------------------------------------------------------------
00427 # Configuration options related to the preprocessor 
00428 #---------------------------------------------------------------------------
00429 
00430 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
00431 # evaluate all C-preprocessor directives found in the sources and include
00432 # files.
00433 
00434 ENABLE_PREPROCESSING = YES
00435 
00436 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
00437 # names in the source code. If set to NO (the default) only conditional 
00438 # compilation will be performed.
00439 
00440 MACRO_EXPANSION      = NO
00441 
00442 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
00443 # in the INCLUDE_PATH (see below) will be search if a #include is found.
00444 
00445 SEARCH_INCLUDES      = YES
00446 
00447 # The INCLUDE_PATH tag can be used to specify one or more directories that
00448 # contain include files that are not input files but should be processed by
00449 # the preprocessor.
00450 
00451 INCLUDE_PATH         = 
00452 
00453 # The PREDEFINED tag can be used to specify one or more macro names that
00454 # are defined before the preprocessor is started (similar to the -D option of
00455 # gcc). The argument of the tag is a list of macros of the form: name
00456 # or name=definition (no spaces). If the definition and the = are 
00457 # omitted =1 is assumed.
00458 
00459 PREDEFINED           = 
00460 
00461 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
00462 # then the macro expansion is limited to the macros specified with the
00463 # PREDEFINED tag.
00464 
00465 EXPAND_ONLY_PREDEF   = NO
00466 
00467 #---------------------------------------------------------------------------
00468 # Configuration options related to external references 
00469 #---------------------------------------------------------------------------
00470 
00471 # The TAGFILES tag can be used to specify one or more tagfiles. 
00472 
00473 TAGFILES             = 
00474 
00475 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
00476 # a tag file that is based on the input files it reads.
00477 
00478 GENERATE_TAGFILE     = 
00479 
00480 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
00481 # in the class index. If set to NO only the inherited external classes
00482 # will be listed.
00483 
00484 ALLEXTERNALS         = NO
00485 
00486 # The PERL_PATH should be the absolute path and name of the perl script
00487 # interpreter (i.e. the result of `which perl').
00488 
00489 PERL_PATH            = /usr/bin/perl
00490 
00491 #---------------------------------------------------------------------------
00492 # Configuration options related to the dot tool 
00493 #---------------------------------------------------------------------------
00494 
00495 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
00496 # available from the path. This tool is part of Graphviz, a graph visualization
00497 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
00498 # have no effect if this option is set to NO (the default)
00499 
00500 HAVE_DOT             = NO
00501 
00502 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
00503 # will generate a graph for each documented class showing the direct and
00504 # indirect implementation dependencies (inheritance, containment, and
00505 # class references variables) of the class with other documented classes.
00506 
00507 COLLABORATION_GRAPH  = YES
00508 
00509 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
00510 # YES then doxygen will generate a graph for each documented file showing
00511 # the direct and indirect include dependencies of the file with other 
00512 # documented files.
00513 
00514 INCLUDE_GRAPH        = YES
00515 
00516 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
00517 # will graphical hierarchy of all classes instead of a textual one.
00518 
00519 GRAPHICAL_HIERARCHY  = YES
00520 
00521 #---------------------------------------------------------------------------
00522 # Configuration options related to the search engine 
00523 #---------------------------------------------------------------------------
00524 
00525 # The SEARCHENGINE tag specifies whether or not a search engine should be 
00526 # used. If set to NO the values of all tags below this one will be ignored.
00527 
00528 SEARCHENGINE         = NO
00529 
00530 # The CGI_NAME tag should be the name of the CGI script that
00531 # starts the search engine (doxysearch) with the correct parameters.
00532 # A script with this name will be generated by doxygen.
00533 
00534 CGI_NAME             = search.cgi
00535 
00536 # The CGI_URL tag should be the absolute URL to the directory where the
00537 # cgi binaries are located. See the documentation of your http daemon for 
00538 # details.
00539 
00540 CGI_URL              = 
00541 
00542 # The DOC_URL tag should be the absolute URL to the directory where the
00543 # documentation is located. If left blank the absolute path to the 
00544 # documentation, with file:// prepended to it, will be used.
00545 
00546 DOC_URL              = 
00547 
00548 # The DOC_ABSPATH tag should be the absolute path to the directory where the
00549 # documentation is located. If left blank the directory on the local machine
00550 # will be used.
00551 
00552 DOC_ABSPATH          = 
00553 
00554 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
00555 # is installed.
00556 
00557 BIN_ABSPATH          = /usr/local/bin/
00558 
00559 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
00560 # documentation generated for other projects. This allows doxysearch to search
00561 # the documentation for these projects as well.
00562 
00563 EXT_DOC_PATHS        = 

Generated at Mon Mar 1 18:05:54 2004 for Groupware by doxygen 1.1.1 written by Dimitri van Heesch, © 1997-2000