1 # Doxyfile 1.2.11.1 |
|
2 |
|
3 # This file describes the settings to be used by the documentation system |
|
4 # doxygen (www.doxygen.org) for a project |
|
5 # |
|
6 # All text after a hash (#) is considered a comment and will be ignored |
|
7 # The format is: |
|
8 # TAG = value [value, ...] |
|
9 # For lists items can also be appended using: |
|
10 # TAG += value [value, ...] |
|
11 # Values that contain spaces should be placed between quotes (" ") |
|
12 |
|
13 #--------------------------------------------------------------------------- |
|
14 # General configuration options |
|
15 #--------------------------------------------------------------------------- |
|
16 |
|
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
|
18 # by quotes) that should identify the project. |
|
19 |
|
20 PROJECT_NAME = "Crypto" |
|
21 |
|
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
|
23 # This could be handy for archiving the generated documentation or |
|
24 # if some version control system is used. |
|
25 |
|
26 PROJECT_NUMBER = |
|
27 |
|
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
|
29 # base path where the generated documentation will be put. |
|
30 # If a relative path is entered, it will be relative to the location |
|
31 # where doxygen was started. If left blank the current directory will be used. |
|
32 |
|
33 OUTPUT_DIRECTORY = ../docs |
|
34 |
|
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
|
36 # documentation generated by doxygen is written. Doxygen will use this |
|
37 # information to generate all constant output in the proper language. |
|
38 # The default language is English, other supported languages are: |
|
39 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, |
|
40 # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, |
|
41 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. |
|
42 |
|
43 OUTPUT_LANGUAGE = English |
|
44 |
|
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
|
46 # documentation are documented, even if no documentation was available. |
|
47 # Private class members and static file members will be hidden unless |
|
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
|
49 |
|
50 EXTRACT_ALL = YES |
|
51 |
|
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
|
53 # will be included in the documentation. |
|
54 |
|
55 EXTRACT_PRIVATE = NO |
|
56 |
|
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file |
|
58 # will be included in the documentation. |
|
59 |
|
60 EXTRACT_STATIC = YES |
|
61 |
|
62 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
|
63 # undocumented members of documented classes, files or namespaces. |
|
64 # If set to NO (the default) these members will be included in the |
|
65 # various overviews, but no documentation section is generated. |
|
66 # This option has no effect if EXTRACT_ALL is enabled. |
|
67 |
|
68 HIDE_UNDOC_MEMBERS = NO |
|
69 |
|
70 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
|
71 # undocumented classes that are normally visible in the class hierarchy. |
|
72 # If set to NO (the default) these class will be included in the various |
|
73 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
|
74 |
|
75 HIDE_UNDOC_CLASSES = NO |
|
76 |
|
77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
|
78 # include brief member descriptions after the members that are listed in |
|
79 # the file and class documentation (similar to JavaDoc). |
|
80 # Set to NO to disable this. |
|
81 |
|
82 BRIEF_MEMBER_DESC = YES |
|
83 |
|
84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
|
85 # the brief description of a member or function before the detailed description. |
|
86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
|
87 # brief descriptions will be completely suppressed. |
|
88 |
|
89 REPEAT_BRIEF = YES |
|
90 |
|
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
|
92 # Doxygen will generate a detailed section even if there is only a brief |
|
93 # description. |
|
94 |
|
95 ALWAYS_DETAILED_SEC = YES |
|
96 |
|
97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
|
98 # path before files name in the file list and in the header files. If set |
|
99 # to NO the shortest path that makes the file name unique will be used. |
|
100 |
|
101 FULL_PATH_NAMES = NO |
|
102 |
|
103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
|
104 # can be used to strip a user defined part of the path. Stripping is |
|
105 # only done if one of the specified strings matches the left-hand part of |
|
106 # the path. It is allowed to use relative paths in the argument list. |
|
107 |
|
108 STRIP_FROM_PATH = ../.. |
|
109 |
|
110 # The INTERNAL_DOCS tag determines if documentation |
|
111 # that is typed after a \internal command is included. If the tag is set |
|
112 # to NO (the default) then the documentation will be excluded. |
|
113 # Set it to YES to include the internal documentation. |
|
114 |
|
115 INTERNAL_DOCS = NO |
|
116 |
|
117 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
|
118 # generate a class diagram (in Html and LaTeX) for classes with base or |
|
119 # super classes. Setting the tag to NO turns the diagrams off. |
|
120 |
|
121 CLASS_DIAGRAMS = YES |
|
122 |
|
123 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
|
124 # be generated. Documented entities will be cross-referenced with these sources. |
|
125 |
|
126 SOURCE_BROWSER = YES |
|
127 |
|
128 # Setting the INLINE_SOURCES tag to YES will include the body |
|
129 # of functions and classes directly in the documentation. |
|
130 |
|
131 INLINE_SOURCES = NO |
|
132 |
|
133 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
|
134 # doxygen to hide any special comment blocks from generated source code |
|
135 # fragments. Normal C and C++ comments will always remain visible. |
|
136 |
|
137 STRIP_CODE_COMMENTS = YES |
|
138 |
|
139 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
|
140 # file names in lower case letters. If set to YES upper case letters are also |
|
141 # allowed. This is useful if you have classes or files whose names only differ |
|
142 # in case and if your file system supports case sensitive file names. Windows |
|
143 # users are adviced to set this option to NO. |
|
144 |
|
145 CASE_SENSE_NAMES = YES |
|
146 |
|
147 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
|
148 # (but less readable) file names. This can be useful is your file systems |
|
149 # doesn't support long names like on DOS, Mac, or CD-ROM. |
|
150 |
|
151 SHORT_NAMES = NO |
|
152 |
|
153 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
|
154 # will show members with their full class and namespace scopes in the |
|
155 # documentation. If set to YES the scope will be hidden. |
|
156 |
|
157 HIDE_SCOPE_NAMES = NO |
|
158 |
|
159 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
|
160 # will generate a verbatim copy of the header file for each class for |
|
161 # which an include is specified. Set to NO to disable this. |
|
162 |
|
163 VERBATIM_HEADERS = YES |
|
164 |
|
165 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
|
166 # will put list of the files that are included by a file in the documentation |
|
167 # of that file. |
|
168 |
|
169 SHOW_INCLUDE_FILES = YES |
|
170 |
|
171 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
|
172 # will interpret the first line (until the first dot) of a JavaDoc-style |
|
173 # comment as the brief description. If set to NO, the JavaDoc |
|
174 # comments will behave just like the Qt-style comments (thus requiring an |
|
175 # explict @brief command for a brief description. |
|
176 |
|
177 JAVADOC_AUTOBRIEF = YES |
|
178 |
|
179 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
|
180 # member inherits the documentation from any documented member that it |
|
181 # reimplements. |
|
182 |
|
183 INHERIT_DOCS = YES |
|
184 |
|
185 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
|
186 # is inserted in the documentation for inline members. |
|
187 |
|
188 INLINE_INFO = YES |
|
189 |
|
190 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
|
191 # will sort the (detailed) documentation of file and class members |
|
192 # alphabetically by member name. If set to NO the members will appear in |
|
193 # declaration order. |
|
194 |
|
195 SORT_MEMBER_DOCS = YES |
|
196 |
|
197 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
|
198 # tag is set to YES, then doxygen will reuse the documentation of the first |
|
199 # member in the group (if any) for the other members of the group. By default |
|
200 # all members of a group must be documented explicitly. |
|
201 |
|
202 DISTRIBUTE_GROUP_DOC = NO |
|
203 |
|
204 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
|
205 # Doxygen uses this value to replace tabs by spaces in code fragments. |
|
206 |
|
207 TAB_SIZE = 4 |
|
208 |
|
209 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
|
210 # disable (NO) the list. This list is created by putting keyword |
|
211 # commands in the documentation. |
|
212 |
|
213 GENERATE_TODOLIST = YES |
|
214 |
|
215 # The GENERATE_TESTLIST tag can be used to enable (YES) or |
|
216 # disable (NO) the test list. This list is created by putting \test |
|
217 # commands in the documentation. |
|
218 |
|
219 GENERATE_TESTLIST = YES |
|
220 |
|
221 # The GENERATE_BUGLIST tag can be used to enable (YES) or |
|
222 # disable (NO) the list. This list is created by putting keyword |
|
223 # commands in the documentation. |
|
224 |
|
225 GENERATE_BUGLIST = YES |
|
226 |
|
227 # This tag can be used to specify a number of aliases that acts |
|
228 # as commands in the documentation. An alias has the form "name=value". |
|
229 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
|
230 # put the command \sideeffect (or @sideeffect) in the documentation, which |
|
231 # will result in a user defined paragraph with heading "Side Effects:". |
|
232 # You can put \n's in the value part of an alias to insert newlines. |
|
233 |
|
234 ALIASES = |
|
235 |
|
236 # The ENABLED_SECTIONS tag can be used to enable conditional |
|
237 # documentation sections, marked by \if sectionname ... \endif. |
|
238 |
|
239 ENABLED_SECTIONS = |
|
240 |
|
241 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
|
242 # the initial value of a variable or define consist of for it to appear in |
|
243 # the documentation. If the initializer consists of more lines than specified |
|
244 # here it will be hidden. Use a value of 0 to hide initializers completely. |
|
245 # The appearance of the initializer of individual variables and defines in the |
|
246 # documentation can be controlled using \showinitializer or \hideinitializer |
|
247 # command in the documentation regardless of this setting. |
|
248 |
|
249 MAX_INITIALIZER_LINES = 30 |
|
250 |
|
251 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
|
252 # only. Doxygen will then generate output that is more tailored for C. |
|
253 # For instance some of the names that are used will be different. The list |
|
254 # of all members will be omitted, etc. |
|
255 |
|
256 OPTIMIZE_OUTPUT_FOR_C = NO |
|
257 |
|
258 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
|
259 # at the bottom of the documentation of classes and structs. If set to YES the |
|
260 # list will mention the files that were used to generate the documentation. |
|
261 |
|
262 SHOW_USED_FILES = YES |
|
263 |
|
264 #--------------------------------------------------------------------------- |
|
265 # configuration options related to warning and progress messages |
|
266 #--------------------------------------------------------------------------- |
|
267 |
|
268 # The QUIET tag can be used to turn on/off the messages that are generated |
|
269 # by doxygen. Possible values are YES and NO. If left blank NO is used. |
|
270 |
|
271 QUIET = NO |
|
272 |
|
273 # The WARNINGS tag can be used to turn on/off the warning messages that are |
|
274 # generated by doxygen. Possible values are YES and NO. If left blank |
|
275 # NO is used. |
|
276 |
|
277 WARNINGS = YES |
|
278 |
|
279 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
|
280 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
|
281 # automatically be disabled. |
|
282 |
|
283 WARN_IF_UNDOCUMENTED = YES |
|
284 |
|
285 # The WARN_FORMAT tag determines the format of the warning messages that |
|
286 # doxygen can produce. The string should contain the $file, $line, and $text |
|
287 # tags, which will be replaced by the file and line number from which the |
|
288 # warning originated and the warning text. |
|
289 |
|
290 WARN_FORMAT = |
|
291 |
|
292 # The WARN_LOGFILE tag can be used to specify a file to which warning |
|
293 # and error messages should be written. If left blank the output is written |
|
294 # to stderr. |
|
295 |
|
296 WARN_LOGFILE = |
|
297 |
|
298 #--------------------------------------------------------------------------- |
|
299 # configuration options related to the input files |
|
300 #--------------------------------------------------------------------------- |
|
301 |
|
302 # The INPUT tag can be used to specify the files and/or directories that contain |
|
303 # documented source files. You may enter file names like "myfile.cpp" or |
|
304 # directories like "/usr/src/myproject". Separate the files or directories |
|
305 # with spaces. |
|
306 |
|
307 INPUT = ../inc/ ../docs/ ../source |
|
308 |
|
309 # If the value of the INPUT tag contains directories, you can use the |
|
310 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|
311 # and *.h) to filter out the source-files in the directories. If left |
|
312 # blank all files are included. |
|
313 |
|
314 FILE_PATTERNS = *.h *.dox *.inl *.cpp |
|
315 |
|
316 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
|
317 # should be searched for input files as well. Possible values are YES and NO. |
|
318 # If left blank NO is used. |
|
319 |
|
320 RECURSIVE = YES |
|
321 |
|
322 # The EXCLUDE tag can be used to specify files and/or directories that should |
|
323 # excluded from the INPUT source files. This way you can easily exclude a |
|
324 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
|
325 |
|
326 EXCLUDE = |
|
327 |
|
328 # If the value of the INPUT tag contains directories, you can use the |
|
329 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
|
330 # certain files from those directories. |
|
331 |
|
332 EXCLUDE_PATTERNS = |
|
333 |
|
334 # The EXAMPLE_PATH tag can be used to specify one or more files or |
|
335 # directories that contain example code fragments that are included (see |
|
336 # the \include command). |
|
337 |
|
338 EXAMPLE_PATH = |
|
339 |
|
340 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
|
341 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|
342 # and *.h) to filter out the source-files in the directories. If left |
|
343 # blank all files are included. |
|
344 |
|
345 EXAMPLE_PATTERNS = |
|
346 |
|
347 # The IMAGE_PATH tag can be used to specify one or more files or |
|
348 # directories that contain image that are included in the documentation (see |
|
349 # the \image command). |
|
350 |
|
351 IMAGE_PATH = ../docsrc |
|
352 |
|
353 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
|
354 # invoke to filter for each input file. Doxygen will invoke the filter program |
|
355 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
|
356 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
|
357 # input file. Doxygen will then use the output that the filter program writes |
|
358 # to standard output. |
|
359 |
|
360 INPUT_FILTER = |
|
361 |
|
362 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
|
363 # INPUT_FILTER) will be used to filter the input files when producing source |
|
364 # files to browse. |
|
365 |
|
366 FILTER_SOURCE_FILES = NO |
|
367 |
|
368 #--------------------------------------------------------------------------- |
|
369 # configuration options related to the alphabetical class index |
|
370 #--------------------------------------------------------------------------- |
|
371 |
|
372 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
|
373 # of all compounds will be generated. Enable this if the project |
|
374 # contains a lot of classes, structs, unions or interfaces. |
|
375 |
|
376 ALPHABETICAL_INDEX = YES |
|
377 |
|
378 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
|
379 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
|
380 # in which this list will be split (can be a number in the range [1..20]) |
|
381 |
|
382 COLS_IN_ALPHA_INDEX = 5 |
|
383 |
|
384 # In case all classes in a project start with a common prefix, all |
|
385 # classes will be put under the same header in the alphabetical index. |
|
386 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
|
387 # should be ignored while generating the index headers. |
|
388 |
|
389 IGNORE_PREFIX = CCT TCT MCT |
|
390 |
|
391 #--------------------------------------------------------------------------- |
|
392 # configuration options related to the HTML output |
|
393 #--------------------------------------------------------------------------- |
|
394 |
|
395 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
|
396 # generate HTML output. |
|
397 |
|
398 GENERATE_HTML = YES |
|
399 |
|
400 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
|
401 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
402 # put in front of it. If left blank `html' will be used as the default path. |
|
403 |
|
404 HTML_OUTPUT = |
|
405 |
|
406 # The HTML_HEADER tag can be used to specify a personal HTML header for |
|
407 # each generated HTML page. If it is left blank doxygen will generate a |
|
408 # standard header. |
|
409 |
|
410 HTML_HEADER = |
|
411 |
|
412 # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
|
413 # each generated HTML page. If it is left blank doxygen will generate a |
|
414 # standard footer. |
|
415 |
|
416 HTML_FOOTER = |
|
417 |
|
418 # The HTML_STYLESHEET tag can be used to specify a user defined cascading |
|
419 # style sheet that is used by each HTML page. It can be used to |
|
420 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
|
421 # will generate a default style sheet |
|
422 |
|
423 HTML_STYLESHEET = |
|
424 |
|
425 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
|
426 # files or namespaces will be aligned in HTML using tables. If set to |
|
427 # NO a bullet list will be used. |
|
428 |
|
429 HTML_ALIGN_MEMBERS = YES |
|
430 |
|
431 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
|
432 # will be generated that can be used as input for tools like the |
|
433 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
|
434 # of the generated HTML documentation. |
|
435 |
|
436 GENERATE_HTMLHELP = YES |
|
437 |
|
438 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
|
439 # controls if a separate .chi index file is generated (YES) or that |
|
440 # it should be included in the master .chm file (NO). |
|
441 |
|
442 GENERATE_CHI = NO |
|
443 |
|
444 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
|
445 # controls whether a binary table of contents is generated (YES) or a |
|
446 # normal table of contents (NO) in the .chm file. |
|
447 |
|
448 BINARY_TOC = NO |
|
449 |
|
450 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
|
451 # to the contents of the Html help documentation and to the tree view. |
|
452 |
|
453 TOC_EXPAND = NO |
|
454 |
|
455 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
|
456 # top of each HTML page. The value NO (the default) enables the index and |
|
457 # the value YES disables it. |
|
458 |
|
459 DISABLE_INDEX = NO |
|
460 |
|
461 # This tag can be used to set the number of enum values (range [1..20]) |
|
462 # that doxygen will group on one line in the generated HTML documentation. |
|
463 |
|
464 ENUM_VALUES_PER_LINE = 4 |
|
465 |
|
466 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
|
467 # generated containing a tree-like index structure (just like the one that |
|
468 # is generated for HTML Help). For this to work a browser that supports |
|
469 # JavaScript and frames is required (for instance Netscape 4.0+ |
|
470 # or Internet explorer 4.0+). |
|
471 |
|
472 GENERATE_TREEVIEW = YES |
|
473 |
|
474 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
|
475 # used to set the initial width (in pixels) of the frame in which the tree |
|
476 # is shown. |
|
477 |
|
478 TREEVIEW_WIDTH = 250 |
|
479 |
|
480 #--------------------------------------------------------------------------- |
|
481 # configuration options related to the LaTeX output |
|
482 #--------------------------------------------------------------------------- |
|
483 |
|
484 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
|
485 # generate Latex output. |
|
486 |
|
487 GENERATE_LATEX = NO |
|
488 |
|
489 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
|
490 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
491 # put in front of it. If left blank `latex' will be used as the default path. |
|
492 |
|
493 LATEX_OUTPUT = |
|
494 |
|
495 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
|
496 # LaTeX documents. This may be useful for small projects and may help to |
|
497 # save some trees in general. |
|
498 |
|
499 COMPACT_LATEX = NO |
|
500 |
|
501 # The PAPER_TYPE tag can be used to set the paper type that is used |
|
502 # by the printer. Possible values are: a4, a4wide, letter, legal and |
|
503 # executive. If left blank a4wide will be used. |
|
504 |
|
505 PAPER_TYPE = a4wide |
|
506 |
|
507 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
|
508 # packages that should be included in the LaTeX output. |
|
509 |
|
510 EXTRA_PACKAGES = |
|
511 |
|
512 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
|
513 # the generated latex document. The header should contain everything until |
|
514 # the first chapter. If it is left blank doxygen will generate a |
|
515 # standard header. Notice: only use this tag if you know what you are doing! |
|
516 |
|
517 LATEX_HEADER = |
|
518 |
|
519 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
|
520 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
|
521 # contain links (just like the HTML output) instead of page references |
|
522 # This makes the output suitable for online browsing using a pdf viewer. |
|
523 |
|
524 PDF_HYPERLINKS = NO |
|
525 |
|
526 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
|
527 # plain latex in the generated Makefile. Set this option to YES to get a |
|
528 # higher quality PDF documentation. |
|
529 |
|
530 USE_PDFLATEX = NO |
|
531 |
|
532 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
|
533 # command to the generated LaTeX files. This will instruct LaTeX to keep |
|
534 # running if errors occur, instead of asking the user for help. |
|
535 # This option is also used when generating formulas in HTML. |
|
536 |
|
537 LATEX_BATCHMODE = NO |
|
538 |
|
539 #--------------------------------------------------------------------------- |
|
540 # configuration options related to the RTF output |
|
541 #--------------------------------------------------------------------------- |
|
542 |
|
543 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
|
544 # The RTF output is optimised for Word 97 and may not look very pretty with |
|
545 # other RTF readers or editors. |
|
546 |
|
547 GENERATE_RTF = NO |
|
548 |
|
549 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
|
550 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
551 # put in front of it. If left blank `rtf' will be used as the default path. |
|
552 |
|
553 RTF_OUTPUT = |
|
554 |
|
555 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
|
556 # RTF documents. This may be useful for small projects and may help to |
|
557 # save some trees in general. |
|
558 |
|
559 COMPACT_RTF = NO |
|
560 |
|
561 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
|
562 # will contain hyperlink fields. The RTF file will |
|
563 # contain links (just like the HTML output) instead of page references. |
|
564 # This makes the output suitable for online browsing using WORD or other |
|
565 # programs which support those fields. |
|
566 # Note: wordpad (write) and others do not support links. |
|
567 |
|
568 RTF_HYPERLINKS = YES |
|
569 |
|
570 # Load stylesheet definitions from file. Syntax is similar to that of doxygen's |
|
571 # config file, i.e. a series of assigments. You only have to provide |
|
572 # replacements, missing definitions are set to their default value. |
|
573 |
|
574 RTF_STYLESHEET_FILE = |
|
575 |
|
576 # Set optional variables used in the generation of an rtf document. |
|
577 # Syntax is similar to that of doxygen's config file. |
|
578 |
|
579 RTF_EXTENSIONS_FILE = |
|
580 |
|
581 #--------------------------------------------------------------------------- |
|
582 # configuration options related to the man page output |
|
583 #--------------------------------------------------------------------------- |
|
584 |
|
585 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
|
586 # generate man pages |
|
587 |
|
588 GENERATE_MAN = NO |
|
589 |
|
590 # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
|
591 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
592 # put in front of it. If left blank `man' will be used as the default path. |
|
593 |
|
594 MAN_OUTPUT = |
|
595 |
|
596 # The MAN_EXTENSION tag determines the extension that is added to |
|
597 # the generated man pages (default is the subroutine's section .3) |
|
598 |
|
599 MAN_EXTENSION = |
|
600 |
|
601 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
|
602 # then it will generate one additional man file for each entity |
|
603 # documented in the real man page(s). These additional files |
|
604 # only source the real man page, but without them the man command |
|
605 # would be unable to find the correct page. The default is NO. |
|
606 |
|
607 MAN_LINKS = NO |
|
608 |
|
609 #--------------------------------------------------------------------------- |
|
610 # configuration options related to the XML output |
|
611 #--------------------------------------------------------------------------- |
|
612 |
|
613 # If the GENERATE_XML tag is set to YES Doxygen will |
|
614 # generate an XML file that captures the structure of |
|
615 # the code including all documentation. Note that this |
|
616 # feature is still experimental and not complete at the |
|
617 # moment. |
|
618 |
|
619 GENERATE_XML = NO |
|
620 |
|
621 #--------------------------------------------------------------------------- |
|
622 # Configuration options related to the preprocessor |
|
623 #--------------------------------------------------------------------------- |
|
624 |
|
625 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
|
626 # evaluate all C-preprocessor directives found in the sources and include |
|
627 # files. |
|
628 |
|
629 ENABLE_PREPROCESSING = YES |
|
630 |
|
631 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
|
632 # names in the source code. If set to NO (the default) only conditional |
|
633 # compilation will be performed. Macro expansion can be done in a controlled |
|
634 # way by setting EXPAND_ONLY_PREDEF to YES. |
|
635 |
|
636 MACRO_EXPANSION = NO |
|
637 |
|
638 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
|
639 # then the macro expansion is limited to the macros specified with the |
|
640 # PREDEFINED and EXPAND_AS_PREDEFINED tags. |
|
641 |
|
642 EXPAND_ONLY_PREDEF = NO |
|
643 |
|
644 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
|
645 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
|
646 |
|
647 SEARCH_INCLUDES = YES |
|
648 |
|
649 # The INCLUDE_PATH tag can be used to specify one or more directories that |
|
650 # contain include files that are not input files but should be processed by |
|
651 # the preprocessor. |
|
652 |
|
653 INCLUDE_PATH = |
|
654 |
|
655 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
|
656 # patterns (like *.h and *.hpp) to filter out the header-files in the |
|
657 # directories. If left blank, the patterns specified with FILE_PATTERNS will |
|
658 # be used. |
|
659 |
|
660 INCLUDE_FILE_PATTERNS = |
|
661 |
|
662 # The PREDEFINED tag can be used to specify one or more macro names that |
|
663 # are defined before the preprocessor is started (similar to the -D option of |
|
664 # gcc). The argument of the tag is a list of macros of the form: name |
|
665 # or name=definition (no spaces). If the definition and the = are |
|
666 # omitted =1 is assumed. |
|
667 |
|
668 PREDEFINED = SYMBIAN_CRYPTO |
|
669 |
|
670 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then |
|
671 # this tag can be used to specify a list of macro names that should be expanded. |
|
672 # The macro definition that is found in the sources will be used. |
|
673 # Use the PREDEFINED tag if you want to use a different macro definition. |
|
674 |
|
675 EXPAND_AS_DEFINED = |
|
676 |
|
677 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
|
678 # doxygen's preprocessor will remove all function-like macros that are alone |
|
679 # on a line and do not end with a semicolon. Such function macros are typically |
|
680 # used for boiler-plate code, and will confuse the parser if not removed. |
|
681 |
|
682 SKIP_FUNCTION_MACROS = YES |
|
683 |
|
684 #--------------------------------------------------------------------------- |
|
685 # Configuration::addtions related to external references |
|
686 #--------------------------------------------------------------------------- |
|
687 |
|
688 # The TAGFILES tag can be used to specify one or more tagfiles. |
|
689 |
|
690 TAGFILES = |
|
691 |
|
692 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
|
693 # a tag file that is based on the input files it reads. |
|
694 |
|
695 GENERATE_TAGFILE = DOXYTAGS |
|
696 |
|
697 # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
|
698 # in the class index. If set to NO only the inherited external classes |
|
699 # will be listed. |
|
700 |
|
701 ALLEXTERNALS = NO |
|
702 |
|
703 # The PERL_PATH should be the absolute path and name of the perl script |
|
704 # interpreter (i.e. the result of `which perl'). |
|
705 |
|
706 PERL_PATH = |
|
707 |
|
708 #--------------------------------------------------------------------------- |
|
709 # Configuration options related to the dot tool |
|
710 #--------------------------------------------------------------------------- |
|
711 |
|
712 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
|
713 # available from the path. This tool is part of Graphviz, a graph visualization |
|
714 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
|
715 # have no effect if this option is set to NO (the default) |
|
716 |
|
717 HAVE_DOT = YES |
|
718 |
|
719 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|
720 # will generate a graph for each documented class showing the direct and |
|
721 # indirect inheritance relations. Setting this tag to YES will force the |
|
722 # the CLASS_DIAGRAMS tag to NO. |
|
723 |
|
724 CLASS_GRAPH = YES |
|
725 |
|
726 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|
727 # will generate a graph for each documented class showing the direct and |
|
728 # indirect implementation dependencies (inheritance, containment, and |
|
729 # class references variables) of the class with other documented classes. |
|
730 |
|
731 COLLABORATION_GRAPH = YES |
|
732 |
|
733 # If set to YES, the inheritance and collaboration graphs will show the |
|
734 # relations between templates and their instances. |
|
735 |
|
736 TEMPLATE_RELATIONS = YES |
|
737 |
|
738 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
|
739 # tags are set to YES then doxygen will generate a graph for each documented |
|
740 # file showing the direct and indirect include dependencies of the file with |
|
741 # other documented files. |
|
742 |
|
743 INCLUDE_GRAPH = YES |
|
744 |
|
745 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
|
746 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
|
747 # documented header file showing the documented files that directly or |
|
748 # indirectly include this file. |
|
749 |
|
750 INCLUDED_BY_GRAPH = YES |
|
751 |
|
752 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
|
753 # will graphical hierarchy of all classes instead of a textual one. |
|
754 |
|
755 GRAPHICAL_HIERARCHY = YES |
|
756 |
|
757 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
|
758 # found. If left blank, it is assumed the dot tool can be found on the path. |
|
759 |
|
760 DOT_PATH = |
|
761 |
|
762 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
|
763 # contain dot files that are included in the documentation (see the |
|
764 # \dotfile command). |
|
765 |
|
766 DOTFILE_DIRS = |
|
767 |
|
768 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
|
769 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
770 # this value, doxygen will try to truncate the graph, so that it fits within |
|
771 # the specified constraint. Beware that most browsers cannot cope with very |
|
772 # large images. |
|
773 |
|
774 MAX_DOT_GRAPH_WIDTH = 1024 |
|
775 |
|
776 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
|
777 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
778 # this value, doxygen will try to truncate the graph, so that it fits within |
|
779 # the specified constraint. Beware that most browsers cannot cope with very |
|
780 # large images. |
|
781 |
|
782 MAX_DOT_GRAPH_HEIGHT = 1024 |
|
783 |
|
784 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
|
785 # generate a legend page explaining the meaning of the various boxes and |
|
786 # arrows in the dot generated graphs. |
|
787 |
|
788 GENERATE_LEGEND = YES |
|
789 |
|
790 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
|
791 # remove the intermedate dot files that are used to generate |
|
792 # the various graphs. |
|
793 |
|
794 DOT_CLEANUP = YES |
|
795 |
|
796 #--------------------------------------------------------------------------- |
|
797 # Configuration::addtions related to the search engine |
|
798 #--------------------------------------------------------------------------- |
|
799 |
|
800 # The SEARCHENGINE tag specifies whether or not a search engine should be |
|
801 # used. If set to NO the values of all tags below this one will be ignored. |
|
802 |
|
803 SEARCHENGINE = NO |
|
804 |
|
805 # The CGI_NAME tag should be the name of the CGI script that |
|
806 # starts the search engine (doxysearch) with the correct parameters. |
|
807 # A script with this name will be generated by doxygen. |
|
808 |
|
809 CGI_NAME = |
|
810 |
|
811 # The CGI_URL tag should be the absolute URL to the directory where the |
|
812 # cgi binaries are located. See the documentation of your http daemon for |
|
813 # details. |
|
814 |
|
815 CGI_URL = |
|
816 |
|
817 # The DOC_URL tag should be the absolute URL to the directory where the |
|
818 # documentation is located. If left blank the absolute path to the |
|
819 # documentation, with file:// prepended to it, will be used. |
|
820 |
|
821 DOC_URL = |
|
822 |
|
823 # The DOC_ABSPATH tag should be the absolute path to the directory where the |
|
824 # documentation is located. If left blank the directory on the local machine |
|
825 # will be used. |
|
826 |
|
827 DOC_ABSPATH = |
|
828 |
|
829 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary |
|
830 # is installed. |
|
831 |
|
832 BIN_ABSPATH = |
|
833 |
|
834 # The EXT_DOC_PATHS tag can be used to specify one or more paths to |
|
835 # documentation generated for other projects. This allows doxysearch to search |
|
836 # the documentation for these projects as well. |
|
837 |
|
838 EXT_DOC_PATHS = |
|
839 |
|
840 ALIASES = panic=@exception \ |
|
841 leave=@exception \ |
|
842 "capability=@par Capabilities" \ |
|
843 "internalTechnology=@par Internal technology" \ |
|
844 "internalComponent=@par Internal component"\ |
|
845 "internalAll=@par Internal all" \ |
|
846 "prototype=@par Prototype" \ |
|
847 "interim=@par Interim" \ |
|
848 "released=@par Released" \ |
|
849 "removed=@par Removed" \ |
|
850 "publishedPartner=@par Published-partner" \ |
|
851 "publishedAll=@par Published-all" \ |
|
852 "test=@par test" |
|