Debian Codegraph @

Doxyfile

raw
1 # Doxyfile 1.3.5
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 # Project related 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 = lcmaps
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 = $(VERSION)
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 = doc/apidoc
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, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
44 OUTPUT_LANGUAGE = English
45
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
53
54 USE_WINDOWS_ENCODING = NO
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # include brief member descriptions after the members that are listed in
58 # the file and class documentation (similar to JavaDoc).
59 # Set to NO to disable this.
60
61 BRIEF_MEMBER_DESC = YES
62
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64 # the brief description of a member or function before the detailed description.
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66 # brief descriptions will be completely suppressed.
67
68 REPEAT_BRIEF = YES
69
70 # This tag implements a quasi-intelligent brief description abbreviator
71 # that is used to form the text in various listings. Each string
72 # in this list, if found as the leading text of the brief description, will be
73 # stripped from the text and the result after processing the whole list, is used
74 # as the annotated text. Otherwise, the brief description is used as-is. If left
75 # blank, the following values are used ("$name" is automatically replaced with the
76 # name of the entity): "The $name class" "The $name widget" "The $name file"
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
79 ABBREVIATE_BRIEF =
80
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82 # Doxygen will generate a detailed section even if there is only a brief
83 # description.
84
85 ALWAYS_DETAILED_SEC = NO
86
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88 # members of a class in the documentation of that class as if those members were
89 # ordinary class members. Constructors, destructors and assignment operators of
90 # the base classes will not be shown.
91
92 INLINE_INHERITED_MEMB = NO
93
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95 # path before files name in the file list and in the header files. If set
96 # to NO the shortest path that makes the file name unique will be used.
97
98 FULL_PATH_NAMES = NO
99
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101 # can be used to strip a user-defined part of the path. Stripping is
102 # only done if one of the specified strings matches the left-hand part of
103 # the path. It is allowed to use relative paths in the argument list.
104
105 STRIP_FROM_PATH =
106
107 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108 # (but less readable) file names. This can be useful is your file systems
109 # doesn't support long names like on DOS, Mac, or CD-ROM.
110
111 SHORT_NAMES = NO
112
113 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114 # will interpret the first line (until the first dot) of a JavaDoc-style
115 # comment as the brief description. If set to NO, the JavaDoc
116 # comments will behave just like the Qt-style comments (thus requiring an
117 # explicit @brief command for a brief description.
118
119 JAVADOC_AUTOBRIEF = NO
120
121 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
123 # comments) as a brief description. This used to be the default behaviour.
124 # The new default is to treat a multi-line C++ comment block as a detailed
125 # description. Set this tag to YES if you prefer the old behaviour instead.
126
127 MULTILINE_CPP_IS_BRIEF = NO
128
129 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
130 # will output the detailed description near the top, like JavaDoc.
131 # If set to NO, the detailed description appears after the member
132 # documentation.
133
134 DETAILS_AT_TOP = NO
135
136 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137 # member inherits the documentation from any documented member that it
138 # re-implements.
139
140 INHERIT_DOCS = YES
141
142 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143 # tag is set to YES, then doxygen will reuse the documentation of the first
144 # member in the group (if any) for the other members of the group. By default
145 # all members of a group must be documented explicitly.
146
147 DISTRIBUTE_GROUP_DOC = NO
148
149 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
150 # Doxygen uses this value to replace tabs by spaces in code fragments.
151
152 TAB_SIZE = 8
153
154 # This tag can be used to specify a number of aliases that acts
155 # as commands in the documentation. An alias has the form "name=value".
156 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
157 # put the command \sideeffect (or @sideeffect) in the documentation, which
158 # will result in a user-defined paragraph with heading "Side Effects:".
159 # You can put \n's in the value part of an alias to insert newlines.
160
161 ALIASES =
162
163 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
164 # only. Doxygen will then generate output that is more tailored for C.
165 # For instance, some of the names that are used will be different. The list
166 # of all members will be omitted, etc.
167
168 OPTIMIZE_OUTPUT_FOR_C = YES
169
170 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
171 # only. Doxygen will then generate output that is more tailored for Java.
172 # For instance, namespaces will be presented as packages, qualified scopes
173 # will look different, etc.
174
175 OPTIMIZE_OUTPUT_JAVA = NO
176
177 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
178 # the same type (for instance a group of public functions) to be put as a
179 # subgroup of that type (e.g. under the Public Functions section). Set it to
180 # NO to prevent subgrouping. Alternatively, this can be done per class using
181 # the \nosubgrouping command.
182
183 SUBGROUPING = YES
184
185 #---------------------------------------------------------------------------
186 # Build related configuration options
187 #---------------------------------------------------------------------------
188
189 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
190 # documentation are documented, even if no documentation was available.
191 # Private class members and static file members will be hidden unless
192 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
193
194 EXTRACT_ALL = NO
195
196 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
197 # will be included in the documentation.
198
199 EXTRACT_PRIVATE = NO
200
201 # If the EXTRACT_STATIC tag is set to YES all static members of a file
202 # will be included in the documentation.
203
204 EXTRACT_STATIC = YES
205
206 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
207 # defined locally in source files will be included in the documentation.
208 # If set to NO only classes defined in header files are included.
209
210 EXTRACT_LOCAL_CLASSES = YES
211
212 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
213 # undocumented members of documented classes, files or namespaces.
214 # If set to NO (the default) these members will be included in the
215 # various overviews, but no documentation section is generated.
216 # This option has no effect if EXTRACT_ALL is enabled.
217
218 HIDE_UNDOC_MEMBERS = YES
219
220 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
221 # undocumented classes that are normally visible in the class hierarchy.
222 # If set to NO (the default) these classes will be included in the various
223 # overviews. This option has no effect if EXTRACT_ALL is enabled.
224
225 HIDE_UNDOC_CLASSES = YES
226
227 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
228 # friend (class|struct|union) declarations.
229 # If set to NO (the default) these declarations will be included in the
230 # documentation.
231
232 HIDE_FRIEND_COMPOUNDS = NO
233
234 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
235 # documentation blocks found inside the body of a function.
236 # If set to NO (the default) these blocks will be appended to the
237 # function's detailed documentation block.
238
239 HIDE_IN_BODY_DOCS = NO
240
241 # The INTERNAL_DOCS tag determines if documentation
242 # that is typed after a \internal command is included. If the tag is set
243 # to NO (the default) then the documentation will be excluded.
244 # Set it to YES to include the internal documentation.
245
246 INTERNAL_DOCS = NO
247
248 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
249 # file names in lower-case letters. If set to YES upper-case letters are also
250 # allowed. This is useful if you have classes or files whose names only differ
251 # in case and if your file system supports case sensitive file names. Windows
252 # users are advised to set this option to NO.
253
254 CASE_SENSE_NAMES = YES
255
256 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
257 # will show members with their full class and namespace scopes in the
258 # documentation. If set to YES the scope will be hidden.
259
260 HIDE_SCOPE_NAMES = NO
261
262 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
263 # will put a list of the files that are included by a file in the documentation
264 # of that file.
265
266 SHOW_INCLUDE_FILES = YES
267
268 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
269 # is inserted in the documentation for inline members.
270
271 INLINE_INFO = YES
272
273 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
274 # will sort the (detailed) documentation of file and class members
275 # alphabetically by member name. If set to NO the members will appear in
276 # declaration order.
277
278 SORT_MEMBER_DOCS = YES
279
280 # The GENERATE_TODOLIST tag can be used to enable (YES) or
281 # disable (NO) the todo list. This list is created by putting \todo
282 # commands in the documentation.
283
284 GENERATE_TODOLIST = YES
285
286 # The GENERATE_TESTLIST tag can be used to enable (YES) or
287 # disable (NO) the test list. This list is created by putting \test
288 # commands in the documentation.
289
290 GENERATE_TESTLIST = YES
291
292 # The GENERATE_BUGLIST tag can be used to enable (YES) or
293 # disable (NO) the bug list. This list is created by putting \bug
294 # commands in the documentation.
295
296 GENERATE_BUGLIST = YES
297
298 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
299 # disable (NO) the deprecated list. This list is created by putting
300 # \deprecated commands in the documentation.
301
302 GENERATE_DEPRECATEDLIST= YES
303
304 # The ENABLED_SECTIONS tag can be used to enable conditional
305 # documentation sections, marked by \if sectionname ... \endif.
306
307 ENABLED_SECTIONS =
308
309 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
310 # the initial value of a variable or define consists of for it to appear in
311 # the documentation. If the initializer consists of more lines than specified
312 # here it will be hidden. Use a value of 0 to hide initializers completely.
313 # The appearance of the initializer of individual variables and defines in the
314 # documentation can be controlled using \showinitializer or \hideinitializer
315 # command in the documentation regardless of this setting.
316
317 MAX_INITIALIZER_LINES = 30
318
319 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
320 # at the bottom of the documentation of classes and structs. If set to YES the
321 # list will mention the files that were used to generate the documentation.
322
323 SHOW_USED_FILES = YES
324
325 #---------------------------------------------------------------------------
326 # configuration options related to warning and progress messages
327 #---------------------------------------------------------------------------
328
329 # The QUIET tag can be used to turn on/off the messages that are generated
330 # by doxygen. Possible values are YES and NO. If left blank NO is used.
331
332 QUIET = NO
333
334 # The WARNINGS tag can be used to turn on/off the warning messages that are
335 # generated by doxygen. Possible values are YES and NO. If left blank
336 # NO is used.
337
338 WARNINGS = YES
339
340 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
341 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
342 # automatically be disabled.
343
344 WARN_IF_UNDOCUMENTED = NO
345
346 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
347 # potential errors in the documentation, such as not documenting some
348 # parameters in a documented function, or documenting parameters that
349 # don't exist or using markup commands wrongly.
350
351 WARN_IF_DOC_ERROR = YES
352
353 # The WARN_FORMAT tag determines the format of the warning messages that
354 # doxygen can produce. The string should contain the $file, $line, and $text
355 # tags, which will be replaced by the file and line number from which the
356 # warning originated and the warning text.
357
358 WARN_FORMAT =
359
360 # The WARN_LOGFILE tag can be used to specify a file to which warning
361 # and error messages should be written. If left blank the output is written
362 # to stderr.
363
364 WARN_LOGFILE =
365
366 #---------------------------------------------------------------------------
367 # configuration options related to the input files
368 #---------------------------------------------------------------------------
369
370 # The INPUT tag can be used to specify the files and/or directories that contain
371 # documented source files. You may enter file names like "myfile.cpp" or
372 # directories like "/usr/src/myproject". Separate the files or directories
373 # with spaces.
374
375 INPUT = interface \
376 examples \
377 src \
378 src/evaluationmanager \
379 src/pluginmanager \
380 src/grid_credential_handling \
381 src/grid_credential_handling/gsi_handling \
382 ../lcmaps-plugins-basic/src/localaccount \
383 ../lcmaps-plugins-basic/src/poolaccount \
384 ../lcmaps-plugins-basic/src/ldap_enf \
385 ../lcmaps-plugins-basic/src/posix_enf \
386 ../lcmaps-plugins-basic/src/dummy \
387 ../lcmaps-plugins-voms/src/voms \
388 ../lcmaps-plugins-afs/src/afs \
389 ../lcmaps-plugins-jobrep/src/jobrep
390
391 # If the value of the INPUT tag contains directories, you can use the
392 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
393 # and *.h) to filter out the source-files in the directories. If left
394 # blank the following patterns are tested:
395 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
396 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
397
398 FILE_PATTERNS = *.c \
399 *.h
400
401 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
402 # should be searched for input files as well. Possible values are YES and NO.
403 # If left blank NO is used.
404
405 RECURSIVE = NO
406
407 # The EXCLUDE tag can be used to specify files and/or directories that should
408 # excluded from the INPUT source files. This way you can easily exclude a
409 # subdirectory from a directory tree whose root is specified with the INPUT tag.
410
411 EXCLUDE = CVS \
412 ../org.glite.security.lcmaps-plugins-jobrep/src/jobrep/lcmaps_voms_utils.c \
413 ../org.glite.security.lcmaps-plugins-jobrep/src/jobrep/lcmaps_voms_utils.h \
414 ../org.glite.security.lcmaps-plugins-jobrep/src/jobrep/jobrep_test.c \
415 ../org.glite.security.lcmaps-plugins-jobrep/src/jobrep/jobrep_test.h \
416 ../org.glite.security.lcmaps-interface/interface/lcmaps_types.h \
417 src/pluginmanager/lcmaps_test.c \
418 src/evaluationmanager/pdl_test.c
419
420 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
421 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
422
423 EXCLUDE_SYMLINKS = NO
424
425 # If the value of the INPUT tag contains directories, you can use the
426 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
427 # certain files from those directories.
428
429 EXCLUDE_PATTERNS = plugin_test.* \
430 lcmaps_gridlist.* \
431 test.c \
432 gridmap.c \
433 globus_* \
434 gssapi* \
435 pdl_lex.* \
436 pdl_yacc.*
437
438 # The EXAMPLE_PATH tag can be used to specify one or more files or
439 # directories that contain example code fragments that are included (see
440 # the \include command).
441
442 EXAMPLE_PATH = examples
443
444 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
445 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
446 # and *.h) to filter out the source-files in the directories. If left
447 # blank all files are included.
448
449 EXAMPLE_PATTERNS =
450
451 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
452 # searched for input files to be used with the \include or \dontinclude
453 # commands irrespective of the value of the RECURSIVE tag.
454 # Possible values are YES and NO. If left blank NO is used.
455
456 EXAMPLE_RECURSIVE = NO
457
458 # The IMAGE_PATH tag can be used to specify one or more files or
459 # directories that contain image that are included in the documentation (see
460 # the \image command).
461
462 IMAGE_PATH =
463
464 # The INPUT_FILTER tag can be used to specify a program that doxygen should
465 # invoke to filter for each input file. Doxygen will invoke the filter program
466 # by executing (via popen()) the command <filter> <input-file>, where <filter>
467 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
468 # input file. Doxygen will then use the output that the filter program writes
469 # to standard output.
470
471 INPUT_FILTER =
472
473 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
474 # INPUT_FILTER) will be used to filter the input files when producing source
475 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
476
477 FILTER_SOURCE_FILES = NO
478
479 #---------------------------------------------------------------------------
480 # configuration options related to source browsing
481 #---------------------------------------------------------------------------
482
483 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
484 # be generated. Documented entities will be cross-referenced with these sources.
485 # Note: To get rid of all source code in the generated output, make sure also
486 # VERBATIM_HEADERS is set to NO.
487
488 SOURCE_BROWSER = YES
489
490 # Setting the INLINE_SOURCES tag to YES will include the body
491 # of functions and classes directly in the documentation.
492
493 INLINE_SOURCES = NO
494
495 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
496 # doxygen to hide any special comment blocks from generated source code
497 # fragments. Normal C and C++ comments will always remain visible.
498
499 STRIP_CODE_COMMENTS = YES
500
501 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
502 # then for each documented function all documented
503 # functions referencing it will be listed.
504
505 REFERENCED_BY_RELATION = YES
506
507 # If the REFERENCES_RELATION tag is set to YES (the default)
508 # then for each documented function all documented entities
509 # called/used by that function will be listed.
510
511 REFERENCES_RELATION = YES
512
513 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
514 # will generate a verbatim copy of the header file for each class for
515 # which an include is specified. Set to NO to disable this.
516
517 VERBATIM_HEADERS = YES
518
519 #---------------------------------------------------------------------------
520 # configuration options related to the alphabetical class index
521 #---------------------------------------------------------------------------
522
523 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
524 # of all compounds will be generated. Enable this if the project
525 # contains a lot of classes, structs, unions or interfaces.
526
527 ALPHABETICAL_INDEX = NO
528
529 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
530 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
531 # in which this list will be split (can be a number in the range [1..20])
532
533 COLS_IN_ALPHA_INDEX = 5
534
535 # In case all classes in a project start with a common prefix, all
536 # classes will be put under the same header in the alphabetical index.
537 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
538 # should be ignored while generating the index headers.
539
540 IGNORE_PREFIX =
541
542 #---------------------------------------------------------------------------
543 # configuration options related to the HTML output
544 #---------------------------------------------------------------------------
545
546 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
547 # generate HTML output.
548
549 GENERATE_HTML = YES
550
551 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
552 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
553 # put in front of it. If left blank `html' will be used as the default path.
554
555 HTML_OUTPUT =
556
557 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
558 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
559 # doxygen will generate files with .html extension.
560
561 HTML_FILE_EXTENSION = .html
562
563 # The HTML_HEADER tag can be used to specify a personal HTML header for
564 # each generated HTML page. If it is left blank doxygen will generate a
565 # standard header.
566
567 HTML_HEADER =
568
569 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
570 # each generated HTML page. If it is left blank doxygen will generate a
571 # standard footer.
572
573 HTML_FOOTER =
574
575 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
576 # style sheet that is used by each HTML page. It can be used to
577 # fine-tune the look of the HTML output. If the tag is left blank doxygen
578 # will generate a default style sheet. Note that doxygen will try to copy
579 # the style sheet file to the HTML output directory, so don't put your own
580 # stylesheet in the HTML output directory as well, or it will be erased!
581
582 HTML_STYLESHEET =
583
584 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
585 # files or namespaces will be aligned in HTML using tables. If set to
586 # NO a bullet list will be used.
587
588 HTML_ALIGN_MEMBERS = YES
589
590 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
591 # will be generated that can be used as input for tools like the
592 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
593 # of the generated HTML documentation.
594
595 GENERATE_HTMLHELP = NO
596
597 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
598 # be used to specify the file name of the resulting .chm file. You
599 # can add a path in front of the file if the result should not be
600 # written to the html output directory.
601
602 CHM_FILE =
603
604 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
605 # be used to specify the location (absolute path including file name) of
606 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
607 # the HTML help compiler on the generated index.hhp.
608
609 HHC_LOCATION =
610
611 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
612 # controls if a separate .chi index file is generated (YES) or that
613 # it should be included in the master .chm file (NO).
614
615 GENERATE_CHI = NO
616
617 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
618 # controls whether a binary table of contents is generated (YES) or a
619 # normal table of contents (NO) in the .chm file.
620
621 BINARY_TOC = NO
622
623 # The TOC_EXPAND flag can be set to YES to add extra items for group members
624 # to the contents of the HTML help documentation and to the tree view.
625
626 TOC_EXPAND = NO
627
628 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
629 # top of each HTML page. The value NO (the default) enables the index and
630 # the value YES disables it.
631
632 DISABLE_INDEX = NO
633
634 # This tag can be used to set the number of enum values (range [1..20])
635 # that doxygen will group on one line in the generated HTML documentation.
636
637 ENUM_VALUES_PER_LINE = 4
638
639 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
640 # generated containing a tree-like index structure (just like the one that
641 # is generated for HTML Help). For this to work a browser that supports
642 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
643 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
644 # probably better off using the HTML help feature.
645
646 GENERATE_TREEVIEW = NO
647
648 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
649 # used to set the initial width (in pixels) of the frame in which the tree
650 # is shown.
651
652 TREEVIEW_WIDTH = 250
653
654 #---------------------------------------------------------------------------
655 # configuration options related to the LaTeX output
656 #---------------------------------------------------------------------------
657
658 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
659 # generate Latex output.
660
661 GENERATE_LATEX = YES
662
663 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
664 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
665 # put in front of it. If left blank `latex' will be used as the default path.
666
667 LATEX_OUTPUT =
668
669 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
670 # invoked. If left blank `latex' will be used as the default command name.
671
672 LATEX_CMD_NAME = latex
673
674 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
675 # generate index for LaTeX. If left blank `makeindex' will be used as the
676 # default command name.
677
678 MAKEINDEX_CMD_NAME = makeindex
679
680 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
681 # LaTeX documents. This may be useful for small projects and may help to
682 # save some trees in general.
683
684 COMPACT_LATEX = NO
685
686 # The PAPER_TYPE tag can be used to set the paper type that is used
687 # by the printer. Possible values are: a4, a4wide, letter, legal and
688 # executive. If left blank a4wide will be used.
689
690 PAPER_TYPE = a4wide
691
692 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
693 # packages that should be included in the LaTeX output.
694
695 EXTRA_PACKAGES =
696
697 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
698 # the generated latex document. The header should contain everything until
699 # the first chapter. If it is left blank doxygen will generate a
700 # standard header. Notice: only use this tag if you know what you are doing!
701
702 LATEX_HEADER =
703
704 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
705 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
706 # contain links (just like the HTML output) instead of page references
707 # This makes the output suitable for online browsing using a pdf viewer.
708
709 PDF_HYPERLINKS = YES
710
711 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
712 # plain latex in the generated Makefile. Set this option to YES to get a
713 # higher quality PDF documentation.
714
715 USE_PDFLATEX = YES
716
717 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
718 # command to the generated LaTeX files. This will instruct LaTeX to keep
719 # running if errors occur, instead of asking the user for help.
720 # This option is also used when generating formulas in HTML.
721
722 LATEX_BATCHMODE = YES
723
724 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
725 # include the index chapters (such as File Index, Compound Index, etc.)
726 # in the output.
727
728 LATEX_HIDE_INDICES = NO
729
730 #---------------------------------------------------------------------------
731 # configuration options related to the RTF output
732 #---------------------------------------------------------------------------
733
734 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
735 # The RTF output is optimized for Word 97 and may not look very pretty with
736 # other RTF readers or editors.
737
738 GENERATE_RTF = NO
739
740 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
741 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
742 # put in front of it. If left blank `rtf' will be used as the default path.
743
744 RTF_OUTPUT =
745
746 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
747 # RTF documents. This may be useful for small projects and may help to
748 # save some trees in general.
749
750 COMPACT_RTF = NO
751
752 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
753 # will contain hyperlink fields. The RTF file will
754 # contain links (just like the HTML output) instead of page references.
755 # This makes the output suitable for online browsing using WORD or other
756 # programs which support those fields.
757 # Note: wordpad (write) and others do not support links.
758
759 RTF_HYPERLINKS = NO
760
761 # Load stylesheet definitions from file. Syntax is similar to doxygen's
762 # config file, i.e. a series of assignments. You only have to provide
763 # replacements, missing definitions are set to their default value.
764
765 RTF_STYLESHEET_FILE =
766
767 # Set optional variables used in the generation of an rtf document.
768 # Syntax is similar to doxygen's config file.
769
770 RTF_EXTENSIONS_FILE =
771
772 #---------------------------------------------------------------------------
773 # configuration options related to the man page output
774 #---------------------------------------------------------------------------
775
776 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
777 # generate man pages
778
779 GENERATE_MAN = YES
780
781 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
782 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
783 # put in front of it. If left blank `man' will be used as the default path.
784
785 MAN_OUTPUT =
786
787 # The MAN_EXTENSION tag determines the extension that is added to
788 # the generated man pages (default is the subroutine's section .3)
789
790 MAN_EXTENSION =
791
792 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
793 # then it will generate one additional man file for each entity
794 # documented in the real man page(s). These additional files
795 # only source the real man page, but without them the man command
796 # would be unable to find the correct page. The default is NO.
797
798 MAN_LINKS = NO
799
800 #---------------------------------------------------------------------------
801 # configuration options related to the XML output
802 #---------------------------------------------------------------------------
803
804 # If the GENERATE_XML tag is set to YES Doxygen will
805 # generate an XML file that captures the structure of
806 # the code including all documentation.
807
808 GENERATE_XML = NO
809
810 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
811 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
812 # put in front of it. If left blank `xml' will be used as the default path.
813
814 XML_OUTPUT = xml
815
816 # The XML_SCHEMA tag can be used to specify an XML schema,
817 # which can be used by a validating XML parser to check the
818 # syntax of the XML files.
819
820 XML_SCHEMA =
821
822 # The XML_DTD tag can be used to specify an XML DTD,
823 # which can be used by a validating XML parser to check the
824 # syntax of the XML files.
825
826 XML_DTD =
827
828 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
829 # dump the program listings (including syntax highlighting
830 # and cross-referencing information) to the XML output. Note that
831 # enabling this will significantly increase the size of the XML output.
832
833 XML_PROGRAMLISTING = YES
834
835 #---------------------------------------------------------------------------
836 # configuration options for the AutoGen Definitions output
837 #---------------------------------------------------------------------------
838
839 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
840 # generate an AutoGen Definitions (see autogen.sf.net) file
841 # that captures the structure of the code including all
842 # documentation. Note that this feature is still experimental
843 # and incomplete at the moment.
844
845 GENERATE_AUTOGEN_DEF = NO
846
847 #---------------------------------------------------------------------------
848 # configuration options related to the Perl module output
849 #---------------------------------------------------------------------------
850
851 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
852 # generate a Perl module file that captures the structure of
853 # the code including all documentation. Note that this
854 # feature is still experimental and incomplete at the
855 # moment.
856
857 GENERATE_PERLMOD = NO
858
859 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
860 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
861 # to generate PDF and DVI output from the Perl module output.
862
863 PERLMOD_LATEX = NO
864
865 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
866 # nicely formatted so it can be parsed by a human reader. This is useful
867 # if you want to understand what is going on. On the other hand, if this
868 # tag is set to NO the size of the Perl module output will be much smaller
869 # and Perl will parse it just the same.
870
871 PERLMOD_PRETTY = YES
872
873 # The names of the make variables in the generated doxyrules.make file
874 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
875 # This is useful so different doxyrules.make files included by the same
876 # Makefile don't overwrite each other's variables.
877
878 PERLMOD_MAKEVAR_PREFIX =
879
880 #---------------------------------------------------------------------------
881 # Configuration options related to the preprocessor
882 #---------------------------------------------------------------------------
883
884 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
885 # evaluate all C-preprocessor directives found in the sources and include
886 # files.
887
888 ENABLE_PREPROCESSING = YES
889
890 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
891 # names in the source code. If set to NO (the default) only conditional
892 # compilation will be performed. Macro expansion can be done in a controlled
893 # way by setting EXPAND_ONLY_PREDEF to YES.
894
895 MACRO_EXPANSION = YES
896
897 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
898 # then the macro expansion is limited to the macros specified with the
899 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
900
901 EXPAND_ONLY_PREDEF = YES
902
903 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
904 # in the INCLUDE_PATH (see below) will be search if a #include is found.
905
906 SEARCH_INCLUDES = YES
907
908 # The INCLUDE_PATH tag can be used to specify one or more directories that
909 # contain include files that are not input files but should be processed by
910 # the preprocessor.
911
912 INCLUDE_PATH =
913
914 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
915 # patterns (like *.h and *.hpp) to filter out the header-files in the
916 # directories. If left blank, the patterns specified with FILE_PATTERNS will
917 # be used.
918
919 INCLUDE_FILE_PATTERNS =
920
921 # The PREDEFINED tag can be used to specify one or more macro names that
922 # are defined before the preprocessor is started (similar to the -D option of
923 # gcc). The argument of the tag is a list of macros of the form: name
924 # or name=definition (no spaces). If the definition and the = are
925 # omitted =1 is assumed.
926
927 PREDEFINED = STACK_OF(X509)=STACK_OF_X509 \
928 LCMAPS_GSI_MODE=1 \
929 ALLOW_EMPTY_CREDENTIALS=1 \
930 LCMAPS_USE_DLOPEN
931
932 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
933 # this tag can be used to specify a list of macro names that should be expanded.
934 # The macro definition that is found in the sources will be used.
935 # Use the PREDEFINED tag if you want to use a different macro definition.
936
937 EXPAND_AS_DEFINED = LCMAPS_RETURN_POOLINDEX_C_STORAGE_CLASS \
938 LCMAPS_GSS_ASSIST_GRIDMAP_C_STORAGE_CLASS \
939 LCMAPS_RETURN_POOLINDEX_WITHOUT_GSI_C_STORAGE_CLASS \
940 LCMAPS_C_STORAGE_CLASS
941
942
943 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
944 # doxygen's preprocessor will remove all function-like macros that are alone
945 # on a line, have an all uppercase name, and do not end with a semicolon. Such
946 # function macros are typically used for boiler-plate code, and will confuse the
947 # parser if not removed.
948
949 SKIP_FUNCTION_MACROS = YES
950
951 #---------------------------------------------------------------------------
952 # Configuration::addtions related to external references
953 #---------------------------------------------------------------------------
954
955 # The TAGFILES option can be used to specify one or more tagfiles.
956 # Optionally an initial location of the external documentation
957 # can be added for each tagfile. The format of a tag file without
958 # this location is as follows:
959 # TAGFILES = file1 file2 ...
960 # Adding location for the tag files is done as follows:
961 # TAGFILES = file1=loc1 "file2 = loc2" ...
962 # where "loc1" and "loc2" can be relative or absolute paths or
963 # URLs. If a location is present for each tag, the installdox tool
964 # does not have to be run to correct the links.
965 # Note that each tag file must have a unique name
966 # (where the name does NOT include the path)
967 # If a tag file is not located in the directory in which doxygen
968 # is run, you must also specify the path to the tagfile here.
969
970 TAGFILES =
971
972 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
973 # a tag file that is based on the input files it reads.
974
975 GENERATE_TAGFILE =
976
977 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
978 # in the class index. If set to NO only the inherited external classes
979 # will be listed.
980
981 ALLEXTERNALS = NO
982
983 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
984 # in the modules index. If set to NO, only the current project's groups will
985 # be listed.
986
987 EXTERNAL_GROUPS = YES
988
989 # The PERL_PATH should be the absolute path and name of the perl script
990 # interpreter (i.e. the result of `which perl').
991
992 PERL_PATH =
993
994 #---------------------------------------------------------------------------
995 # Configuration options related to the dot tool
996 #---------------------------------------------------------------------------
997
998 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
999 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1000 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1001 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1002 # recommended to install and use dot, since it yields more powerful graphs.
1003
1004 CLASS_DIAGRAMS = YES
1005
1006 # If set to YES, the inheritance and collaboration graphs will hide
1007 # inheritance and usage relations if the target is undocumented
1008 # or is not a class.
1009
1010 HIDE_UNDOC_RELATIONS = YES
1011
1012 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1013 # available from the path. This tool is part of Graphviz, a graph visualization
1014 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1015 # have no effect if this option is set to NO (the default)
1016
1017 HAVE_DOT = NO
1018
1019 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1020 # will generate a graph for each documented class showing the direct and
1021 # indirect inheritance relations. Setting this tag to YES will force the
1022 # the CLASS_DIAGRAMS tag to NO.
1023
1024 CLASS_GRAPH = YES
1025
1026 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1027 # will generate a graph for each documented class showing the direct and
1028 # indirect implementation dependencies (inheritance, containment, and
1029 # class references variables) of the class with other documented classes.
1030
1031 COLLABORATION_GRAPH = YES
1032
1033 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1034 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1035 # Language.
1036
1037 UML_LOOK = NO
1038
1039 # If set to YES, the inheritance and collaboration graphs will show the
1040 # relations between templates and their instances.
1041
1042 TEMPLATE_RELATIONS = NO
1043
1044 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1045 # tags are set to YES then doxygen will generate a graph for each documented
1046 # file showing the direct and indirect include dependencies of the file with
1047 # other documented files.
1048
1049 INCLUDE_GRAPH = YES
1050
1051 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1052 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1053 # documented header file showing the documented files that directly or
1054 # indirectly include this file.
1055
1056 INCLUDED_BY_GRAPH = YES
1057
1058 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1059 # generate a call dependency graph for every global function or class method.
1060 # Note that enabling this option will significantly increase the time of a run.
1061 # So in most cases it will be better to enable call graphs for selected
1062 # functions only using the \callgraph command.
1063
1064 CALL_GRAPH = NO
1065
1066 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1067 # will graphical hierarchy of all classes instead of a textual one.
1068
1069 GRAPHICAL_HIERARCHY = YES
1070
1071 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1072 # generated by dot. Possible values are png, jpg, or gif
1073 # If left blank png will be used.
1074
1075 DOT_IMAGE_FORMAT = png
1076
1077 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1078 # found. If left blank, it is assumed the dot tool can be found on the path.
1079
1080 DOT_PATH =
1081
1082 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1083 # contain dot files that are included in the documentation (see the
1084 # \dotfile command).
1085
1086 DOTFILE_DIRS =
1087
1088 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1089 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1090 # this value, doxygen will try to truncate the graph, so that it fits within
1091 # the specified constraint. Beware that most browsers cannot cope with very
1092 # large images.
1093
1094 MAX_DOT_GRAPH_WIDTH = 1024
1095
1096 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1097 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1098 # this value, doxygen will try to truncate the graph, so that it fits within
1099 # the specified constraint. Beware that most browsers cannot cope with very
1100 # large images.
1101
1102 MAX_DOT_GRAPH_HEIGHT = 1024
1103
1104 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1105 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1106 # from the root by following a path via at most 3 edges will be shown. Nodes that
1107 # lay further from the root node will be omitted. Note that setting this option to
1108 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1109 # note that a graph may be further truncated if the graph's image dimensions are
1110 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1111 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1112
1113 MAX_DOT_GRAPH_DEPTH = 0
1114
1115 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1116 # generate a legend page explaining the meaning of the various boxes and
1117 # arrows in the dot generated graphs.
1118
1119 GENERATE_LEGEND = YES
1120
1121 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1122 # remove the intermediate dot files that are used to generate
1123 # the various graphs.
1124
1125 DOT_CLEANUP = YES
1126
1127 #---------------------------------------------------------------------------
1128 # Configuration::addtions related to the search engine
1129 #---------------------------------------------------------------------------
1130
1131 # The SEARCHENGINE tag specifies whether or not a search engine should be
1132 # used. If set to NO the values of all tags below this one will be ignored.
1133
1134 SEARCHENGINE = NO