Added install rules (at least for *nix)
[quassel.git] / Doxyfile
1 # Doxyfile 1.5.1-KDevelop
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = "Quassel IRC"
7 PROJECT_NUMBER         = 0.1
8 OUTPUT_DIRECTORY       = doc
9 CREATE_SUBDIRS         = NO
10 OUTPUT_LANGUAGE        = English
11 USE_WINDOWS_ENCODING   = NO
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = "The $name class" \
15                          "The $name widget" \
16                          "The $name file" \
17                          is \
18                          provides \
19                          specifies \
20                          contains \
21                          represents \
22                          a \
23                          an \
24                          the
25 ALWAYS_DETAILED_SEC    = NO
26 INLINE_INHERITED_MEMB  = YES
27 FULL_PATH_NAMES        = NO
28 STRIP_FROM_PATH        = /
29 STRIP_FROM_INC_PATH    = /home/sputnick/devel/local-quassel/
30 SHORT_NAMES            = YES
31 JAVADOC_AUTOBRIEF      = NO
32 MULTILINE_CPP_IS_BRIEF = NO
33 DETAILS_AT_TOP         = YES
34 INHERIT_DOCS           = YES
35 SEPARATE_MEMBER_PAGES  = NO
36 TAB_SIZE               = 8
37 ALIASES                = 
38 OPTIMIZE_OUTPUT_FOR_C  = NO
39 OPTIMIZE_OUTPUT_JAVA   = NO
40 BUILTIN_STL_SUPPORT    = NO
41 DISTRIBUTE_GROUP_DOC   = YES
42 SUBGROUPING            = YES
43 #---------------------------------------------------------------------------
44 # Build related configuration options
45 #---------------------------------------------------------------------------
46 EXTRACT_ALL            = YES
47 EXTRACT_PRIVATE        = YES
48 EXTRACT_STATIC         = YES
49 EXTRACT_LOCAL_CLASSES  = NO
50 EXTRACT_LOCAL_METHODS  = NO
51 HIDE_UNDOC_MEMBERS     = NO
52 HIDE_UNDOC_CLASSES     = NO
53 HIDE_FRIEND_COMPOUNDS  = NO
54 HIDE_IN_BODY_DOCS      = NO
55 INTERNAL_DOCS          = YES
56 CASE_SENSE_NAMES       = YES
57 HIDE_SCOPE_NAMES       = YES
58 SHOW_INCLUDE_FILES     = YES
59 INLINE_INFO            = YES
60 SORT_MEMBER_DOCS       = NO
61 SORT_BRIEF_DOCS        = NO
62 SORT_BY_SCOPE_NAME     = NO
63 GENERATE_TODOLIST      = YES
64 GENERATE_TESTLIST      = YES
65 GENERATE_BUGLIST       = YES
66 GENERATE_DEPRECATEDLIST= YES
67 ENABLED_SECTIONS       = 
68 MAX_INITIALIZER_LINES  = 30
69 SHOW_USED_FILES        = YES
70 SHOW_DIRECTORIES       = YES
71 FILE_VERSION_FILTER    = 
72 #---------------------------------------------------------------------------
73 # configuration options related to warning and progress messages
74 #---------------------------------------------------------------------------
75 QUIET                  = YES
76 WARNINGS               = YES
77 WARN_IF_UNDOCUMENTED   = YES
78 WARN_IF_DOC_ERROR      = YES
79 WARN_NO_PARAMDOC       = NO
80 WARN_FORMAT            = "$file:$line: $text"
81 WARN_LOGFILE           = 
82 #---------------------------------------------------------------------------
83 # configuration options related to the input files
84 #---------------------------------------------------------------------------
85 INPUT                  = gui \
86                          main \
87                          core \
88                          plugins
89 FILE_PATTERNS          = *.c \
90                          *.cc \
91                          *.cxx \
92                          *.cpp \
93                          *.c++ \
94                          *.java \
95                          *.ii \
96                          *.ixx \
97                          *.ipp \
98                          *.i++ \
99                          *.inl \
100                          *.h \
101                          *.hh \
102                          *.hxx \
103                          *.hpp \
104                          *.h++ \
105                          *.idl \
106                          *.odl \
107                          *.cs \
108                          *.php \
109                          *.php3 \
110                          *.inc \
111                          *.m \
112                          *.mm \
113                          *.dox \
114                          *.C \
115                          *.CC \
116                          *.C++ \
117                          *.II \
118                          *.I++ \
119                          *.H \
120                          *.HH \
121                          *.H++ \
122                          *.CS \
123                          *.PHP \
124                          *.PHP3 \
125                          *.M \
126                          *.MM \
127                          *.C \
128                          *.H \
129                          *.tlh \
130                          *.diff \
131                          *.patch \
132                          *.moc \
133                          *.xpm \
134                          *.dox
135 RECURSIVE              = YES
136 EXCLUDE                = 
137 EXCLUDE_SYMLINKS       = NO
138 EXCLUDE_PATTERNS       = 
139 EXAMPLE_PATH           = 
140 EXAMPLE_PATTERNS       = *
141 EXAMPLE_RECURSIVE      = NO
142 IMAGE_PATH             = 
143 INPUT_FILTER           = 
144 FILTER_PATTERNS        = 
145 FILTER_SOURCE_FILES    = YES
146 #---------------------------------------------------------------------------
147 # configuration options related to source browsing
148 #---------------------------------------------------------------------------
149 SOURCE_BROWSER         = YES
150 INLINE_SOURCES         = NO
151 STRIP_CODE_COMMENTS    = YES
152 REFERENCED_BY_RELATION = YES
153 REFERENCES_RELATION    = YES
154 REFERENCES_LINK_SOURCE = YES
155 USE_HTAGS              = NO
156 VERBATIM_HEADERS       = YES
157 #---------------------------------------------------------------------------
158 # configuration options related to the alphabetical class index
159 #---------------------------------------------------------------------------
160 ALPHABETICAL_INDEX     = YES
161 COLS_IN_ALPHA_INDEX    = 5
162 IGNORE_PREFIX          = 
163 #---------------------------------------------------------------------------
164 # configuration options related to the HTML output
165 #---------------------------------------------------------------------------
166 GENERATE_HTML          = YES
167 HTML_OUTPUT            = html
168 HTML_FILE_EXTENSION    = .html
169 HTML_HEADER            = 
170 HTML_FOOTER            = 
171 HTML_STYLESHEET        = 
172 HTML_ALIGN_MEMBERS     = YES
173 GENERATE_HTMLHELP      = NO
174 CHM_FILE               = 
175 HHC_LOCATION           = 
176 GENERATE_CHI           = NO
177 BINARY_TOC             = NO
178 TOC_EXPAND             = NO
179 DISABLE_INDEX          = NO
180 ENUM_VALUES_PER_LINE   = 4
181 GENERATE_TREEVIEW      = NO
182 TREEVIEW_WIDTH         = 250
183 #---------------------------------------------------------------------------
184 # configuration options related to the LaTeX output
185 #---------------------------------------------------------------------------
186 GENERATE_LATEX         = NO
187 LATEX_OUTPUT           = latex
188 LATEX_CMD_NAME         = latex
189 MAKEINDEX_CMD_NAME     = makeindex
190 COMPACT_LATEX          = NO
191 PAPER_TYPE             = a4wide
192 EXTRA_PACKAGES         = 
193 LATEX_HEADER           = 
194 PDF_HYPERLINKS         = NO
195 USE_PDFLATEX           = YES
196 LATEX_BATCHMODE        = NO
197 LATEX_HIDE_INDICES     = NO
198 #---------------------------------------------------------------------------
199 # configuration options related to the RTF output
200 #---------------------------------------------------------------------------
201 GENERATE_RTF           = NO
202 RTF_OUTPUT             = rtf
203 COMPACT_RTF            = NO
204 RTF_HYPERLINKS         = YES
205 RTF_STYLESHEET_FILE    = 
206 RTF_EXTENSIONS_FILE    = 
207 #---------------------------------------------------------------------------
208 # configuration options related to the man page output
209 #---------------------------------------------------------------------------
210 GENERATE_MAN           = NO
211 MAN_OUTPUT             = man
212 MAN_EXTENSION          = .3
213 MAN_LINKS              = NO
214 #---------------------------------------------------------------------------
215 # configuration options related to the XML output
216 #---------------------------------------------------------------------------
217 GENERATE_XML           = NO
218 XML_OUTPUT             = xml
219 XML_SCHEMA             = 
220 XML_DTD                = 
221 XML_PROGRAMLISTING     = YES
222 #---------------------------------------------------------------------------
223 # configuration options for the AutoGen Definitions output
224 #---------------------------------------------------------------------------
225 GENERATE_AUTOGEN_DEF   = NO
226 #---------------------------------------------------------------------------
227 # configuration options related to the Perl module output
228 #---------------------------------------------------------------------------
229 GENERATE_PERLMOD       = NO
230 PERLMOD_LATEX          = NO
231 PERLMOD_PRETTY         = YES
232 PERLMOD_MAKEVAR_PREFIX = 
233 #---------------------------------------------------------------------------
234 # Configuration options related to the preprocessor   
235 #---------------------------------------------------------------------------
236 ENABLE_PREPROCESSING   = YES
237 MACRO_EXPANSION        = YES
238 EXPAND_ONLY_PREDEF     = NO
239 SEARCH_INCLUDES        = YES
240 INCLUDE_PATH           = /usr/include/qt4
241 INCLUDE_FILE_PATTERNS  = 
242 PREDEFINED             = 
243 EXPAND_AS_DEFINED      = 
244 SKIP_FUNCTION_MACROS   = NO
245 #---------------------------------------------------------------------------
246 # Configuration::additions related to external references   
247 #---------------------------------------------------------------------------
248 TAGFILES               = 
249 GENERATE_TAGFILE       = quassel.tag
250 ALLEXTERNALS           = YES
251 EXTERNAL_GROUPS        = YES
252 PERL_PATH              = /usr/bin/perl
253 #---------------------------------------------------------------------------
254 # Configuration options related to the dot tool   
255 #---------------------------------------------------------------------------
256 CLASS_DIAGRAMS         = YES
257 HIDE_UNDOC_RELATIONS   = YES
258 HAVE_DOT               = YES
259 CLASS_GRAPH            = YES
260 COLLABORATION_GRAPH    = YES
261 GROUP_GRAPHS           = YES
262 UML_LOOK               = YES
263 TEMPLATE_RELATIONS     = NO
264 INCLUDE_GRAPH          = YES
265 INCLUDED_BY_GRAPH      = YES
266 CALL_GRAPH             = YES
267 CALLER_GRAPH           = YES
268 GRAPHICAL_HIERARCHY    = YES
269 DIRECTORY_GRAPH        = YES
270 DOT_IMAGE_FORMAT       = png
271 DOT_PATH               = 
272 DOTFILE_DIRS           = 
273 MAX_DOT_GRAPH_WIDTH    = 1024
274 MAX_DOT_GRAPH_HEIGHT   = 1024
275 MAX_DOT_GRAPH_DEPTH    = 1000
276 DOT_TRANSPARENT        = NO
277 DOT_MULTI_TARGETS      = NO
278 GENERATE_LEGEND        = YES
279 DOT_CLEANUP            = YES
280 #---------------------------------------------------------------------------
281 # Configuration::additions related to the search engine   
282 #---------------------------------------------------------------------------
283 SEARCHENGINE           = NO