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