Consider the files reload a project reloading, so it takes the lock and everything.
[kdevelop:agateau-kdevelop.git] / Doxyfile
1 # Doxyfile 1.5.1-KDevelop
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = KDevelop
7 PROJECT_NUMBER         = "Version 4.0"
8 OUTPUT_DIRECTORY       = ./apidocs
9 CREATE_SUBDIRS         = NO
10 OUTPUT_LANGUAGE        = English
11 BRIEF_MEMBER_DESC      = YES
12 REPEAT_BRIEF           = YES
13 ABBREVIATE_BRIEF       = "The $name class" \
14                          "The $name widget" \
15                          "The $name file" \
16                          is \
17                          provides \
18                          specifies \
19                          contains \
20                          represents \
21                          a \
22                          an \
23                          the
24 ALWAYS_DETAILED_SEC    = YES
25 INLINE_INHERITED_MEMB  = NO
26 FULL_PATH_NAMES        = YES
27 STRIP_FROM_PATH        = $(PWD)/
28 STRIP_FROM_INC_PATH    = 
29 SHORT_NAMES            = NO
30 JAVADOC_AUTOBRIEF      = YES
31 MULTILINE_CPP_IS_BRIEF = NO
32 INHERIT_DOCS           = YES
33 SEPARATE_MEMBER_PAGES  = NO
34 TAB_SIZE               = 4
35 ALIASES                = obsolete=@deprecated \
36                          "feature=\xrefitem features \"Feature(s)\" \"Features\"" \
37                          "maintainer=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
38                          "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
39                          "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
40                          "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
41                          "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
42                          "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\""
43 OPTIMIZE_OUTPUT_FOR_C  = NO
44 OPTIMIZE_OUTPUT_JAVA   = NO
45 BUILTIN_STL_SUPPORT    = NO
46 DISTRIBUTE_GROUP_DOC   = NO
47 SUBGROUPING            = YES
48 #---------------------------------------------------------------------------
49 # Build related configuration options
50 #---------------------------------------------------------------------------
51 EXTRACT_ALL            = YES
52 EXTRACT_PRIVATE        = YES
53 EXTRACT_STATIC         = YES
54 EXTRACT_LOCAL_CLASSES  = YES
55 EXTRACT_LOCAL_METHODS  = NO
56 HIDE_UNDOC_MEMBERS     = NO
57 HIDE_UNDOC_CLASSES     = NO
58 HIDE_FRIEND_COMPOUNDS  = NO
59 HIDE_IN_BODY_DOCS      = NO
60 INTERNAL_DOCS          = NO
61 CASE_SENSE_NAMES       = YES
62 HIDE_SCOPE_NAMES       = NO
63 SHOW_INCLUDE_FILES     = YES
64 INLINE_INFO            = YES
65 SORT_MEMBER_DOCS       = YES
66 SORT_BRIEF_DOCS        = NO
67 SORT_BY_SCOPE_NAME     = NO
68 GENERATE_TODOLIST      = YES
69 GENERATE_TESTLIST      = NO
70 GENERATE_BUGLIST       = YES
71 GENERATE_DEPRECATEDLIST= YES
72 ENABLED_SECTIONS       = 
73 MAX_INITIALIZER_LINES  = 30
74 SHOW_USED_FILES        = YES
75 SHOW_DIRECTORIES       = NO
76 FILE_VERSION_FILTER    = 
77 #---------------------------------------------------------------------------
78 # configuration options related to warning and progress messages
79 #---------------------------------------------------------------------------
80 QUIET                  = YES
81 WARNINGS               = YES
82 WARN_IF_UNDOCUMENTED   = YES
83 WARN_IF_DOC_ERROR      = YES
84 WARN_NO_PARAMDOC       = NO
85 WARN_FORMAT            = 
86 WARN_LOGFILE           = 
87 #---------------------------------------------------------------------------
88 # configuration options related to the input files
89 #---------------------------------------------------------------------------
90 INPUT                  = doc/api \
91                          lib/interfaces \
92                          lib/config \
93                          lib/editor \
94                          lib/language \
95                          lib/project \
96                          lib/shell \
97                          lib/sublime
98 FILE_PATTERNS          = *.h \
99                          *.cpp \
100                          *.cc \
101                          *.hpp \
102                          *.dox \
103                          *.c++ \
104                          *.cxx \
105                          *.h++ \
106                          *.hh
107 RECURSIVE              = YES
108 EXCLUDE                = 
109 EXCLUDE_SYMLINKS       = NO
110 EXCLUDE_PATTERNS       = *.moc.* \
111                          moc* \
112                          *.all_cpp.* \
113                          *unload.* \
114                          */test/* \
115                          */tests/* \
116                          *face_skel.cpp \
117                          *.ui.h \
118                          kdev*
119 EXAMPLE_PATH           = 
120 EXAMPLE_PATTERNS       = 
121 EXAMPLE_RECURSIVE      = NO
122 IMAGE_PATH             = ./doc/api
123 INPUT_FILTER           = 
124 FILTER_PATTERNS        = 
125 FILTER_SOURCE_FILES    = NO
126 #---------------------------------------------------------------------------
127 # configuration options related to source browsing
128 #---------------------------------------------------------------------------
129 SOURCE_BROWSER         = YES
130 INLINE_SOURCES         = NO
131 STRIP_CODE_COMMENTS    = YES
132 REFERENCED_BY_RELATION = YES
133 REFERENCES_RELATION    = YES
134 REFERENCES_LINK_SOURCE = YES
135 USE_HTAGS              = NO
136 VERBATIM_HEADERS       = NO
137 #---------------------------------------------------------------------------
138 # configuration options related to the alphabetical class index
139 #---------------------------------------------------------------------------
140 ALPHABETICAL_INDEX     = YES
141 COLS_IN_ALPHA_INDEX    = 3
142 IGNORE_PREFIX          = K
143 #---------------------------------------------------------------------------
144 # configuration options related to the HTML output
145 #---------------------------------------------------------------------------
146 GENERATE_HTML          = YES
147 HTML_OUTPUT            = ./html
148 HTML_FILE_EXTENSION    = .html
149 HTML_HEADER            = doc/api/common/header.html
150 HTML_FOOTER            = doc/api/common/footer.html
151 HTML_STYLESHEET        = doc/api/common/doxygen.css
152 HTML_ALIGN_MEMBERS     = YES
153 GENERATE_HTMLHELP      = NO
154 CHM_FILE               = 
155 HHC_LOCATION           = 
156 GENERATE_CHI           = NO
157 BINARY_TOC             = NO
158 TOC_EXPAND             = NO
159 DISABLE_INDEX          = YES
160 ENUM_VALUES_PER_LINE   = 4
161 GENERATE_TREEVIEW      = NO
162 TREEVIEW_WIDTH         = 250
163 #---------------------------------------------------------------------------
164 # configuration options related to the LaTeX output
165 #---------------------------------------------------------------------------
166 GENERATE_LATEX         = NO
167 LATEX_OUTPUT           = ./latex
168 LATEX_CMD_NAME         = latex
169 MAKEINDEX_CMD_NAME     = makeindex
170 COMPACT_LATEX          = YES
171 PAPER_TYPE             = a4wide
172 EXTRA_PACKAGES         = 
173 LATEX_HEADER           = 
174 PDF_HYPERLINKS         = YES
175 USE_PDFLATEX           = YES
176 LATEX_BATCHMODE        = NO
177 LATEX_HIDE_INDICES     = YES
178 #---------------------------------------------------------------------------
179 # configuration options related to the RTF output
180 #---------------------------------------------------------------------------
181 GENERATE_RTF           = NO
182 RTF_OUTPUT             = ./rtf
183 COMPACT_RTF            = NO
184 RTF_HYPERLINKS         = NO
185 RTF_STYLESHEET_FILE    = 
186 RTF_EXTENSIONS_FILE    = 
187 #---------------------------------------------------------------------------
188 # configuration options related to the man page output
189 #---------------------------------------------------------------------------
190 GENERATE_MAN           = NO
191 MAN_OUTPUT             = ./man
192 MAN_EXTENSION          = .kde3
193 MAN_LINKS              = YES
194 #---------------------------------------------------------------------------
195 # configuration options related to the XML output
196 #---------------------------------------------------------------------------
197 GENERATE_XML           = NO
198 XML_OUTPUT             = xml
199 XML_SCHEMA             = 
200 XML_DTD                = 
201 XML_PROGRAMLISTING     = NO
202 #---------------------------------------------------------------------------
203 # configuration options for the AutoGen Definitions output
204 #---------------------------------------------------------------------------
205 GENERATE_AUTOGEN_DEF   = NO
206 #---------------------------------------------------------------------------
207 # configuration options related to the Perl module output
208 #---------------------------------------------------------------------------
209 GENERATE_PERLMOD       = NO
210 PERLMOD_LATEX          = NO
211 PERLMOD_PRETTY         = YES
212 PERLMOD_MAKEVAR_PREFIX = 
213 #---------------------------------------------------------------------------
214 # Configuration options related to the preprocessor   
215 #---------------------------------------------------------------------------
216 ENABLE_PREPROCESSING   = YES
217 MACRO_EXPANSION        = YES
218 EXPAND_ONLY_PREDEF     = NO
219 SEARCH_INCLUDES        = YES
220 INCLUDE_PATH           = 
221 INCLUDE_FILE_PATTERNS  = 
222 PREDEFINED             = ANTLR_USE_NAMESPACE(_x_)=_x_::
223 EXPAND_AS_DEFINED      = 
224 SKIP_FUNCTION_MACROS   = YES
225 #---------------------------------------------------------------------------
226 # Configuration::additions related to external references   
227 #---------------------------------------------------------------------------
228 TAGFILES               = $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/interfaces/interfaces.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/interfaces/html/ \
229                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdecore/kdecore.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdecore/html/ \
230                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdefx/kdefx.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdefx/html/ \
231                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdeui/kdeui.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kdeui/html/ \
232                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/khtml/khtml.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/khtml/html/ \
233                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kio/kio.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kio/html/ \
234                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kjs/kjs.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kjs/html/ \
235                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kparts/kparts.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kparts/html/ \
236                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kutils/kutils.tag=$(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/kutils/html/ \
237                          $(KDEDIR)/share/doc/HTML/en/kdelibs-apidocs/qt/qt.tag=$(QTDIR)/doc/html
238 GENERATE_TAGFILE       = ./apidocs/kdevelop.tag
239 ALLEXTERNALS           = NO
240 EXTERNAL_GROUPS        = NO
241 PERL_PATH              = /usr/bin/perl
242 #---------------------------------------------------------------------------
243 # Configuration options related to the dot tool   
244 #---------------------------------------------------------------------------
245 CLASS_DIAGRAMS         = YES
246 HIDE_UNDOC_RELATIONS   = NO
247 HAVE_DOT               = YES
248 CLASS_GRAPH            = YES
249 COLLABORATION_GRAPH    = YES
250 GROUP_GRAPHS           = YES
251 UML_LOOK               = NO
252 TEMPLATE_RELATIONS     = YES
253 INCLUDE_GRAPH          = YES
254 INCLUDED_BY_GRAPH      = YES
255 CALL_GRAPH             = NO
256 CALLER_GRAPH           = NO
257 GRAPHICAL_HIERARCHY    = YES
258 DIRECTORY_GRAPH        = YES
259 DOT_IMAGE_FORMAT       = png
260 DOT_PATH               = 
261 DOTFILE_DIRS           = 
262 MAX_DOT_GRAPH_DEPTH    = 0
263 DOT_TRANSPARENT        = NO
264 DOT_MULTI_TARGETS      = NO
265 GENERATE_LEGEND        = YES
266 DOT_CLEANUP            = YES
267 #---------------------------------------------------------------------------
268 # Configuration::additions related to the search engine   
269 #---------------------------------------------------------------------------
270 SEARCHENGINE           = NO