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