Configuration file to generate documentation from source code
[strongswan.git] / Source / charon / documentation.DoxyFile
1 # Doxyfile 1.4.2
2 \r
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 \r
7 PROJECT_NAME = SCEPforLinuxStrongSwan\r
8 \r
9 PROJECT_NUMBER = 1.0\r
10 \r
11 OUTPUT_DIRECTORY = ./doc\r
12 \r
13 CREATE_SUBDIRS = NO\r
14 \r
15 OUTPUT_LANGUAGE = English\r
16 \r
17 USE_WINDOWS_ENCODING = NO\r
18 \r
19 BRIEF_MEMBER_DESC = YES\r
20 \r
21 REPEAT_BRIEF = YES\r
22 \r
23 ABBREVIATE_BRIEF = \r
24 \r
25 ALWAYS_DETAILED_SEC = NO\r
26 \r
27 INLINE_INHERITED_MEMB = NO\r
28 \r
29 FULL_PATH_NAMES = YES\r
30 \r
31 STRIP_FROM_PATH = \r
32 \r
33 STRIP_FROM_INC_PATH = \r
34 \r
35 SHORT_NAMES = NO\r
36 \r
37 JAVADOC_AUTOBRIEF = YES\r
38 \r
39 MULTILINE_CPP_IS_BRIEF = NO\r
40 \r
41 DETAILS_AT_TOP = NO\r
42 \r
43 INHERIT_DOCS = YES\r
44 \r
45 DISTRIBUTE_GROUP_DOC = NO\r
46 \r
47 SEPARATE_MEMBER_PAGES = NO\r
48 \r
49 TAB_SIZE = 8\r
50 \r
51 ALIASES = \r
52 \r
53 OPTIMIZE_OUTPUT_FOR_C = YES\r
54 \r
55 OPTIMIZE_OUTPUT_JAVA = NO\r
56 \r
57 SUBGROUPING = YES\r
58 \r
59 #---------------------------------------------------------------------------
60 # Build related configuration options
61 #---------------------------------------------------------------------------
62 \r
63 EXTRACT_ALL = NO\r
64 \r
65 EXTRACT_PRIVATE = NO\r
66 \r
67 EXTRACT_STATIC = YES\r
68 \r
69 EXTRACT_LOCAL_CLASSES = YES\r
70 \r
71 EXTRACT_LOCAL_METHODS = NO\r
72 \r
73 HIDE_UNDOC_MEMBERS = YES\r
74 \r
75 HIDE_UNDOC_CLASSES = YES\r
76 \r
77 HIDE_FRIEND_COMPOUNDS = NO\r
78 \r
79 HIDE_IN_BODY_DOCS = NO\r
80 \r
81 INTERNAL_DOCS = NO\r
82 \r
83 CASE_SENSE_NAMES = YES\r
84 \r
85 HIDE_SCOPE_NAMES = NO\r
86 \r
87 SHOW_INCLUDE_FILES = YES\r
88 \r
89 INLINE_INFO = YES\r
90 \r
91 SORT_MEMBER_DOCS = YES\r
92 \r
93 SORT_BRIEF_DOCS = NO\r
94 \r
95 SORT_BY_SCOPE_NAME = NO\r
96 \r
97 GENERATE_TODOLIST = NO\r
98 \r
99 GENERATE_TESTLIST = NO\r
100 \r
101 GENERATE_BUGLIST = YES\r
102 \r
103 GENERATE_DEPRECATEDLIST = YES\r
104 \r
105 ENABLED_SECTIONS = \r
106 \r
107 MAX_INITIALIZER_LINES = 30\r
108 \r
109 SHOW_USED_FILES = YES\r
110 \r
111 SHOW_DIRECTORIES = YES\r
112 \r
113 FILE_VERSION_FILTER = \r
114 \r
115 #---------------------------------------------------------------------------
116 # configuration options related to warning and progress messages
117 #---------------------------------------------------------------------------
118 \r
119 QUIET = NO\r
120 \r
121 WARNINGS = YES\r
122 \r
123 WARN_IF_UNDOCUMENTED = YES\r
124 \r
125 WARN_IF_DOC_ERROR = YES\r
126 \r
127 WARN_NO_PARAMDOC = NO\r
128 \r
129 WARN_FORMAT = "$file:$line: $text"\r
130 \r
131 WARN_LOGFILE = \r
132 \r
133 #---------------------------------------------------------------------------
134 # configuration options related to the input files
135 #---------------------------------------------------------------------------
136 \r
137 INPUT = ./\r
138 \r
139 FILE_PATTERNS = \r
140 \r
141 RECURSIVE = YES\r
142 \r
143 EXCLUDE = \r
144 \r
145 EXCLUDE_SYMLINKS = NO\r
146 \r
147 EXCLUDE_PATTERNS = \r
148 \r
149 EXAMPLE_PATH = \r
150 \r
151 EXAMPLE_PATTERNS = \r
152 \r
153 EXAMPLE_RECURSIVE = NO\r
154 \r
155 IMAGE_PATH = \r
156 \r
157 INPUT_FILTER = \r
158 \r
159 FILTER_PATTERNS = \r
160 \r
161 FILTER_SOURCE_FILES = NO\r
162 \r
163 #---------------------------------------------------------------------------
164 # configuration options related to source browsing
165 #---------------------------------------------------------------------------
166 \r
167 SOURCE_BROWSER = NO\r
168 \r
169 INLINE_SOURCES = NO\r
170 \r
171 STRIP_CODE_COMMENTS = YES\r
172 \r
173 REFERENCED_BY_RELATION = NO\r
174 \r
175 REFERENCES_RELATION = NO\r
176 \r
177 VERBATIM_HEADERS = NO\r
178 \r
179 #---------------------------------------------------------------------------
180 # configuration options related to the alphabetical class index
181 #---------------------------------------------------------------------------
182 \r
183 ALPHABETICAL_INDEX = NO\r
184 \r
185 COLS_IN_ALPHA_INDEX = 5\r
186 \r
187 IGNORE_PREFIX = \r
188 \r
189 #---------------------------------------------------------------------------
190 # configuration options related to the HTML output
191 #---------------------------------------------------------------------------
192 \r
193 GENERATE_HTML = YES\r
194 \r
195 HTML_OUTPUT = html\r
196 \r
197 HTML_FILE_EXTENSION = .html\r
198 \r
199 HTML_HEADER = \r
200 \r
201 HTML_FOOTER = \r
202 \r
203 HTML_STYLESHEET = \r
204 \r
205 HTML_ALIGN_MEMBERS = YES\r
206 \r
207 GENERATE_HTMLHELP = NO\r
208 \r
209 CHM_FILE = \r
210 \r
211 HHC_LOCATION = \r
212 \r
213 GENERATE_CHI = NO\r
214 \r
215 BINARY_TOC = NO\r
216 \r
217 TOC_EXPAND = NO\r
218 \r
219 DISABLE_INDEX = NO\r
220 \r
221 ENUM_VALUES_PER_LINE = 4\r
222 \r
223 GENERATE_TREEVIEW = YES\r
224 \r
225 TREEVIEW_WIDTH = 250\r
226 \r
227 #---------------------------------------------------------------------------
228 # configuration options related to the LaTeX output
229 #---------------------------------------------------------------------------
230 \r
231 GENERATE_LATEX = NO\r
232 \r
233 LATEX_OUTPUT = latex\r
234 \r
235 LATEX_CMD_NAME = latex\r
236 \r
237 MAKEINDEX_CMD_NAME = makeindex\r
238 \r
239 COMPACT_LATEX = NO\r
240 \r
241 PAPER_TYPE = a4wide\r
242 \r
243 EXTRA_PACKAGES = \r
244 \r
245 LATEX_HEADER = \r
246 \r
247 PDF_HYPERLINKS = NO\r
248 \r
249 USE_PDFLATEX = NO\r
250 \r
251 LATEX_BATCHMODE = NO\r
252 \r
253 LATEX_HIDE_INDICES = NO\r
254 \r
255 #---------------------------------------------------------------------------
256 # configuration options related to the RTF output
257 #---------------------------------------------------------------------------
258 \r
259 GENERATE_RTF = NO\r
260 \r
261 RTF_OUTPUT = rtf\r
262 \r
263 COMPACT_RTF = NO\r
264 \r
265 RTF_HYPERLINKS = NO\r
266 \r
267 RTF_STYLESHEET_FILE = \r
268 \r
269 RTF_EXTENSIONS_FILE = \r
270 \r
271 #---------------------------------------------------------------------------
272 # configuration options related to the man page output
273 #---------------------------------------------------------------------------
274 \r
275 GENERATE_MAN = YES\r
276 \r
277 MAN_OUTPUT = man\r
278 \r
279 MAN_EXTENSION = .3\r
280 \r
281 MAN_LINKS = YES\r
282 \r
283 #---------------------------------------------------------------------------
284 # configuration options related to the XML output
285 #---------------------------------------------------------------------------
286 \r
287 GENERATE_XML = NO\r
288 \r
289 XML_OUTPUT = xml\r
290 \r
291 XML_SCHEMA = \r
292 \r
293 XML_DTD = \r
294 \r
295 XML_PROGRAMLISTING = YES\r
296 \r
297 #---------------------------------------------------------------------------
298 # configuration options for the AutoGen Definitions output
299 #---------------------------------------------------------------------------
300 \r
301 GENERATE_AUTOGEN_DEF = NO\r
302 \r
303 #---------------------------------------------------------------------------
304 # configuration options related to the Perl module output
305 #---------------------------------------------------------------------------
306 \r
307 GENERATE_PERLMOD = NO\r
308 \r
309 PERLMOD_LATEX = NO\r
310 \r
311 PERLMOD_PRETTY = YES\r
312 \r
313 PERLMOD_MAKEVAR_PREFIX = \r
314 \r
315 #---------------------------------------------------------------------------
316 # Configuration options related to the preprocessor   
317 #---------------------------------------------------------------------------
318 \r
319 ENABLE_PREPROCESSING = YES\r
320 \r
321 MACRO_EXPANSION = NO\r
322 \r
323 EXPAND_ONLY_PREDEF = NO\r
324 \r
325 SEARCH_INCLUDES = YES\r
326 \r
327 INCLUDE_PATH = \r
328 \r
329 INCLUDE_FILE_PATTERNS = \r
330 \r
331 PREDEFINED = \r
332 \r
333 EXPAND_AS_DEFINED = \r
334 \r
335 SKIP_FUNCTION_MACROS = YES\r
336 \r
337 #---------------------------------------------------------------------------
338 # Configuration::additions related to external references   
339 #---------------------------------------------------------------------------
340 \r
341 TAGFILES = \r
342 \r
343 GENERATE_TAGFILE = \r
344 \r
345 ALLEXTERNALS = NO\r
346 \r
347 EXTERNAL_GROUPS = YES\r
348 \r
349 PERL_PATH = /usr/bin/perl\r
350 \r
351 #---------------------------------------------------------------------------
352 # Configuration options related to the dot tool   
353 #---------------------------------------------------------------------------
354 \r
355 CLASS_DIAGRAMS = YES\r
356 \r
357 HIDE_UNDOC_RELATIONS = YES\r
358 \r
359 HAVE_DOT = NO\r
360 \r
361 CLASS_GRAPH = YES\r
362 \r
363 COLLABORATION_GRAPH = YES\r
364 \r
365 GROUP_GRAPHS = YES\r
366 \r
367 UML_LOOK = NO\r
368 \r
369 TEMPLATE_RELATIONS = NO\r
370 \r
371 INCLUDE_GRAPH = YES\r
372 \r
373 INCLUDED_BY_GRAPH = YES\r
374 \r
375 CALL_GRAPH = NO\r
376 \r
377 GRAPHICAL_HIERARCHY = YES\r
378 \r
379 DIRECTORY_GRAPH = YES\r
380 \r
381 DOT_IMAGE_FORMAT = png\r
382 \r
383 DOT_PATH = \r
384 \r
385 DOTFILE_DIRS = \r
386 \r
387 MAX_DOT_GRAPH_WIDTH = 1024\r
388 \r
389 MAX_DOT_GRAPH_HEIGHT = 1024\r
390 \r
391 MAX_DOT_GRAPH_DEPTH = 0\r
392 \r
393 DOT_TRANSPARENT = NO\r
394 \r
395 DOT_MULTI_TARGETS = NO\r
396 \r
397 GENERATE_LEGEND = YES\r
398 \r
399 DOT_CLEANUP = YES\r
400 \r
401 #---------------------------------------------------------------------------
402 # Configuration::additions related to the search engine   
403 #---------------------------------------------------------------------------
404 \r
405 SEARCHENGINE = NO\r
406 \r