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