2 7036111a 2005-07-22 alex # ngIRCd -- The Next Generation IRC Daemon
3 7036111a 2005-07-22 alex # Copyright (c)2001-2005 Alexander Barton (alex@barton.de)
5 7036111a 2005-07-22 alex # This program is free software; you can redistribute it and/or modify
6 7036111a 2005-07-22 alex # it under the terms of the GNU General Public License as published by
7 7036111a 2005-07-22 alex # the Free Software Foundation; either version 2 of the License, or
8 7036111a 2005-07-22 alex # (at your option) any later version.
9 7036111a 2005-07-22 alex # Please read the file COPYING, README and AUTHORS for more information.
11 9db49e8f 2005-07-23 alex # $Id: Doxyfile,v 1.2 2005/07/23 00:48:38 alex Exp $
14 7036111a 2005-07-22 alex # This file describes the settings to be used by the documentation system
15 7036111a 2005-07-22 alex # doxygen (www.doxygen.org) for ngIRCd.
17 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
18 7036111a 2005-07-22 alex # Project related configuration options
19 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
21 7036111a 2005-07-22 alex # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
22 7036111a 2005-07-22 alex # by quotes) that should identify the project.
24 7036111a 2005-07-22 alex PROJECT_NAME = ngIRCd
26 7036111a 2005-07-22 alex # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
27 7036111a 2005-07-22 alex # base path where the generated documentation will be put.
28 7036111a 2005-07-22 alex # If a relative path is entered, it will be relative to the location
29 7036111a 2005-07-22 alex # where doxygen was started. If left blank the current directory will be used.
31 7036111a 2005-07-22 alex OUTPUT_DIRECTORY = .
33 9db49e8f 2005-07-23 alex # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
34 9db49e8f 2005-07-23 alex # can be used to strip a user-defined part of the path. Stripping is
35 9db49e8f 2005-07-23 alex # only done if one of the specified strings matches the left-hand part of
36 9db49e8f 2005-07-23 alex # the path. The tag can be used to show relative paths in the file list.
37 9db49e8f 2005-07-23 alex # If left blank the directory from which doxygen is run is used as the
38 9db49e8f 2005-07-23 alex # path to strip.
40 9db49e8f 2005-07-23 alex STRIP_FROM_PATH = ../..
42 7036111a 2005-07-22 alex # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
43 7036111a 2005-07-22 alex # will interpret the first line (until the first dot) of a JavaDoc-style
44 7036111a 2005-07-22 alex # comment as the brief description. If set to NO, the JavaDoc
45 7036111a 2005-07-22 alex # comments will behave just like the Qt-style comments (thus requiring an
46 7036111a 2005-07-22 alex # explicit @brief command for a brief description.
48 7036111a 2005-07-22 alex JAVADOC_AUTOBRIEF = YES
50 7036111a 2005-07-22 alex # If the DETAILS_AT_TOP tag is set to YES then Doxygen
51 7036111a 2005-07-22 alex # will output the detailed description near the top, like JavaDoc.
52 7036111a 2005-07-22 alex # If set to NO, the detailed description appears after the member
53 7036111a 2005-07-22 alex # documentation.
55 7036111a 2005-07-22 alex DETAILS_AT_TOP = NO
57 7036111a 2005-07-22 alex # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
58 7036111a 2005-07-22 alex # sources only. Doxygen will then generate output that is more tailored for C.
59 7036111a 2005-07-22 alex # For instance, some of the names that are used will be different. The list
60 7036111a 2005-07-22 alex # of all members will be omitted, etc.
62 7036111a 2005-07-22 alex OPTIMIZE_OUTPUT_FOR_C = YES
64 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
65 7036111a 2005-07-22 alex # Build related configuration options
66 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
68 7036111a 2005-07-22 alex # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
69 7036111a 2005-07-22 alex # documentation are documented, even if no documentation was available.
70 7036111a 2005-07-22 alex # Private class members and static file members will be hidden unless
71 7036111a 2005-07-22 alex # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
73 7036111a 2005-07-22 alex EXTRACT_ALL = YES
75 7036111a 2005-07-22 alex # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
76 7036111a 2005-07-22 alex # will be included in the documentation.
78 7036111a 2005-07-22 alex EXTRACT_PRIVATE = YES
80 7036111a 2005-07-22 alex # If the EXTRACT_STATIC tag is set to YES all static members of a file
81 7036111a 2005-07-22 alex # will be included in the documentation.
83 7036111a 2005-07-22 alex EXTRACT_STATIC = YES
85 7036111a 2005-07-22 alex # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
86 7036111a 2005-07-22 alex # defined locally in source files will be included in the documentation.
87 7036111a 2005-07-22 alex # If set to NO only classes defined in header files are included.
89 7036111a 2005-07-22 alex EXTRACT_LOCAL_CLASSES = YES
91 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
92 7036111a 2005-07-22 alex # configuration options related to the input files
93 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
95 7036111a 2005-07-22 alex # The INPUT tag can be used to specify the files and/or directories that
96 7036111a 2005-07-22 alex # contain documented source files. You may enter file names like "myfile.cpp"
97 7036111a 2005-07-22 alex # or directories like "/usr/src/myproject". Separate the files or directories
98 7036111a 2005-07-22 alex # with spaces.
100 7036111a 2005-07-22 alex INPUT = ../../src
102 7036111a 2005-07-22 alex # The RECURSIVE tag can be used to turn specify whether or not subdirectories
103 7036111a 2005-07-22 alex # should be searched for input files as well. Possible values are YES and NO.
104 7036111a 2005-07-22 alex # If left blank NO is used.
106 7036111a 2005-07-22 alex RECURSIVE = YES
108 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
109 7036111a 2005-07-22 alex # configuration options related to source browsing
110 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
112 7036111a 2005-07-22 alex # If the SOURCE_BROWSER tag is set to YES then a list of source files will
113 7036111a 2005-07-22 alex # be generated. Documented entities will be cross-referenced with these sources.
114 7036111a 2005-07-22 alex # Note: To get rid of all source code in the generated output, make sure also
115 7036111a 2005-07-22 alex # VERBATIM_HEADERS is set to NO.
117 7036111a 2005-07-22 alex SOURCE_BROWSER = YES
119 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
120 7036111a 2005-07-22 alex # Output formats
121 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
123 7036111a 2005-07-22 alex GENERATE_HTML = YES
125 7036111a 2005-07-22 alex HTML_OUTPUT = html
126 7036111a 2005-07-22 alex HTML_FILE_EXTENSION = .html
127 7036111a 2005-07-22 alex HTML_HEADER = header.inc.html
128 7036111a 2005-07-22 alex HTML_FOOTER = footer.inc.html
129 7036111a 2005-07-22 alex HTML_STYLESHEET = ngircd-doc.css
131 7036111a 2005-07-22 alex GENERATE_HTMLHELP = NO
132 7036111a 2005-07-22 alex GENERATE_LATEX = NO
133 7036111a 2005-07-22 alex GENERATE_RTF = NO
134 7036111a 2005-07-22 alex GENERATE_MAN = NO
135 7036111a 2005-07-22 alex GENERATE_XML = NO
136 7036111a 2005-07-22 alex GENERATE_AUTOGEN_DEF = NO
137 7036111a 2005-07-22 alex GENERATE_PERLMOD = NO
139 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
140 7036111a 2005-07-22 alex # Configuration options related to the preprocessor
141 7036111a 2005-07-22 alex #---------------------------------------------------------------------------
143 7036111a 2005-07-22 alex # The PREDEFINED tag can be used to specify one or more macro names that
144 7036111a 2005-07-22 alex # are defined before the preprocessor is started (similar to the -D option of
145 7036111a 2005-07-22 alex # gcc). The argument of the tag is a list of macros of the form: name
146 7036111a 2005-07-22 alex # or name=definition (no spaces). If the definition and the = are
147 7036111a 2005-07-22 alex # omitted =1 is assumed. To prevent a macro definition from being
148 7036111a 2005-07-22 alex # undefined via #undef or recursively expanded use the := operator
149 7036111a 2005-07-22 alex # instead of the = operator.
151 7036111a 2005-07-22 alex PREDEFINED = CONN_MODULE __client_c__
