2 e936a79f 2005-04-09 alex # ngIRCd -- The Next Generation IRC Daemon
3 e936a79f 2005-04-09 alex # Copyright (c)2001-2005 Alexander Barton (alex@barton.de)
5 e936a79f 2005-04-09 alex # This program is free software; you can redistribute it and/or modify
6 e936a79f 2005-04-09 alex # it under the terms of the GNU General Public License as published by
7 e936a79f 2005-04-09 alex # the Free Software Foundation; either version 2 of the License, or
8 e936a79f 2005-04-09 alex # (at your option) any later version.
9 e936a79f 2005-04-09 alex # Please read the file COPYING, README and AUTHORS for more information.
11 e936a79f 2005-04-09 alex # $Id: Doxyfile,v 1.1 2005/04/09 12:21:51 alex Exp $
14 e936a79f 2005-04-09 alex # This file describes the settings to be used by the documentation system
15 e936a79f 2005-04-09 alex # doxygen (www.doxygen.org) for ngIRCd.
17 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
18 e936a79f 2005-04-09 alex # Project related configuration options
19 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
21 e936a79f 2005-04-09 alex # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
22 e936a79f 2005-04-09 alex # by quotes) that should identify the project.
24 e936a79f 2005-04-09 alex PROJECT_NAME = ngIRCd
26 e936a79f 2005-04-09 alex # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
27 e936a79f 2005-04-09 alex # base path where the generated documentation will be put.
28 e936a79f 2005-04-09 alex # If a relative path is entered, it will be relative to the location
29 e936a79f 2005-04-09 alex # where doxygen was started. If left blank the current directory will be used.
31 e936a79f 2005-04-09 alex OUTPUT_DIRECTORY = ../doc/src
33 e936a79f 2005-04-09 alex # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
34 e936a79f 2005-04-09 alex # will interpret the first line (until the first dot) of a JavaDoc-style
35 e936a79f 2005-04-09 alex # comment as the brief description. If set to NO, the JavaDoc
36 e936a79f 2005-04-09 alex # comments will behave just like the Qt-style comments (thus requiring an
37 e936a79f 2005-04-09 alex # explicit @brief command for a brief description.
39 e936a79f 2005-04-09 alex JAVADOC_AUTOBRIEF = YES
41 e936a79f 2005-04-09 alex # If the DETAILS_AT_TOP tag is set to YES then Doxygen
42 e936a79f 2005-04-09 alex # will output the detailed description near the top, like JavaDoc.
43 e936a79f 2005-04-09 alex # If set to NO, the detailed description appears after the member
44 e936a79f 2005-04-09 alex # documentation.
46 e936a79f 2005-04-09 alex DETAILS_AT_TOP = NO
48 e936a79f 2005-04-09 alex # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
49 e936a79f 2005-04-09 alex # sources only. Doxygen will then generate output that is more tailored for C.
50 e936a79f 2005-04-09 alex # For instance, some of the names that are used will be different. The list
51 e936a79f 2005-04-09 alex # of all members will be omitted, etc.
53 e936a79f 2005-04-09 alex OPTIMIZE_OUTPUT_FOR_C = YES
55 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
56 e936a79f 2005-04-09 alex # Build related configuration options
57 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
59 e936a79f 2005-04-09 alex # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
60 e936a79f 2005-04-09 alex # documentation are documented, even if no documentation was available.
61 e936a79f 2005-04-09 alex # Private class members and static file members will be hidden unless
62 e936a79f 2005-04-09 alex # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
64 e936a79f 2005-04-09 alex EXTRACT_ALL = YES
66 e936a79f 2005-04-09 alex # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
67 e936a79f 2005-04-09 alex # will be included in the documentation.
69 e936a79f 2005-04-09 alex EXTRACT_PRIVATE = YES
71 e936a79f 2005-04-09 alex # If the EXTRACT_STATIC tag is set to YES all static members of a file
72 e936a79f 2005-04-09 alex # will be included in the documentation.
74 e936a79f 2005-04-09 alex EXTRACT_STATIC = YES
76 e936a79f 2005-04-09 alex # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
77 e936a79f 2005-04-09 alex # defined locally in source files will be included in the documentation.
78 e936a79f 2005-04-09 alex # If set to NO only classes defined in header files are included.
80 e936a79f 2005-04-09 alex EXTRACT_LOCAL_CLASSES = YES
82 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
83 e936a79f 2005-04-09 alex # configuration options related to the input files
84 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
86 e936a79f 2005-04-09 alex # The INPUT tag can be used to specify the files and/or directories that
87 e936a79f 2005-04-09 alex # contain documented source files. You may enter file names like "myfile.cpp"
88 e936a79f 2005-04-09 alex # or directories like "/usr/src/myproject". Separate the files or directories
89 e936a79f 2005-04-09 alex # with spaces.
91 e936a79f 2005-04-09 alex INPUT = ngircd portab tool
93 e936a79f 2005-04-09 alex # The RECURSIVE tag can be used to turn specify whether or not subdirectories
94 e936a79f 2005-04-09 alex # should be searched for input files as well. Possible values are YES and NO.
95 e936a79f 2005-04-09 alex # If left blank NO is used.
97 e936a79f 2005-04-09 alex RECURSIVE = YES
99 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
100 e936a79f 2005-04-09 alex # configuration options related to source browsing
101 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
103 e936a79f 2005-04-09 alex # If the SOURCE_BROWSER tag is set to YES then a list of source files will
104 e936a79f 2005-04-09 alex # be generated. Documented entities will be cross-referenced with these sources.
105 e936a79f 2005-04-09 alex # Note: To get rid of all source code in the generated output, make sure also
106 e936a79f 2005-04-09 alex # VERBATIM_HEADERS is set to NO.
108 e936a79f 2005-04-09 alex SOURCE_BROWSER = YES
110 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
111 e936a79f 2005-04-09 alex # Output formats
112 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
114 e936a79f 2005-04-09 alex GENERATE_HTML = YES
115 e936a79f 2005-04-09 alex GENERATE_HTMLHELP = NO
116 e936a79f 2005-04-09 alex GENERATE_LATEX = NO
117 e936a79f 2005-04-09 alex GENERATE_RTF = NO
118 e936a79f 2005-04-09 alex GENERATE_MAN = NO
119 e936a79f 2005-04-09 alex GENERATE_XML = NO
120 e936a79f 2005-04-09 alex GENERATE_AUTOGEN_DEF = NO
121 e936a79f 2005-04-09 alex GENERATE_PERLMOD = NO
123 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
124 e936a79f 2005-04-09 alex # Configuration options related to the preprocessor
125 e936a79f 2005-04-09 alex #---------------------------------------------------------------------------
127 e936a79f 2005-04-09 alex # The PREDEFINED tag can be used to specify one or more macro names that
128 e936a79f 2005-04-09 alex # are defined before the preprocessor is started (similar to the -D option of
129 e936a79f 2005-04-09 alex # gcc). The argument of the tag is a list of macros of the form: name
130 e936a79f 2005-04-09 alex # or name=definition (no spaces). If the definition and the = are
131 e936a79f 2005-04-09 alex # omitted =1 is assumed. To prevent a macro definition from being
132 e936a79f 2005-04-09 alex # undefined via #undef or recursively expanded use the := operator
133 e936a79f 2005-04-09 alex # instead of the = operator.
135 e936a79f 2005-04-09 alex PREDEFINED = CONN_MODULE __client_c__
