/[PAMELA software]/yoda/Doxyfile.in
ViewVC logotype

Contents of /yoda/Doxyfile.in

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6.0 - (show annotations) (download)
Tue Feb 7 17:10:40 2006 UTC (18 years, 9 months ago) by kusanagi
Branch: MAIN
CVS Tags: YODA6_2/01, YODA6_2/00, YODA6_3/19, YODA6_3/18, YODA6_3/13, YODA6_3/12, YODA6_3/11, YODA6_3/10, YODA6_3/17, YODA6_3/16, YODA6_3/15, YODA6_3/14, YODA6_3/06, YODA6_1/00, YODA6_0/00, YODA6_3/04, YODA6_3/05, YODA6_3/20, YODA6_3/07, YODA6_3/00, YODA6_3/01, YODA6_3/02, YODA6_3/03, YODA6_3/08, YODA6_3/09, HEAD
Changes since 5.0: +0 -0 lines
Error occurred while calculating annotation data.
Several new features in this revision:
a) all the packets are conform to the Mass Memory Format specifications (http://people.roma2.infn.it/~cpu/Mass_Memory_Format.html)
b) unpacking either using the old files structure OR the new one file unpacking.
c) parametrized root files compression factor
d) deleting of the following packet: TofTest, TrkTest, TrkEvent.
e) the Tracker routines now work without the use of temp files.

The point a) allow Yoda to unpack in the root file all the packets generated by the CPU. According to the MassMemoryFormat; that is three possible data are available:

1) almost explicit structure of the packet (like for Log, Tracker, Mcmd, etc....);
2) dummy data collection structure (InitHeader, InitTrailer, CalibHeader, CalibTrailer);
3) just the data of the packet (almost all Alarm and Init procedures). The class regarding this packets have only one parameters, a TArrayC class, which contain the data-block included in the packet (tat is the data below the packet Header).

The point b) has been implemented as a consequence of an agreement about a more compact structure of the unpacked data. Up to now the structure of each unpacked data consisted of a folder, named after the packet type, and three files: xxx.Header.root, xxx.NamePacket.root, xxx.Registry.root.
Starting from this release YODA, by default will unpack the data in a unique root file. The structure of this file will consist of:
- several TTree(s) named after the packet type;
- into each TTree are foreseen three TBranche(s):
    - 'Header'  (the old xxx.Header.root file)
    - 'NameOfThePacket' (the old xxx.Event.root file or the xxx.Event.DETECTOR.root)
    - 'Registry' (the old xxx.Registry.root file)

Anyway is still possible, but deprecated, to unpack using the old structure, passing to the "yoda" command the optional parameter "-multifile"

The point c) has been implemented because is well know that writing time in a TTree is as much fast as much lower is the compression factor for the root file; anyway for a PAMELA dat file, a compression equal to 0 will generate a root file which will be more than two times the original size. To modify the compression parameter just add the optional parameter "-c [0-9]" to the yoda command line.

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

  ViewVC Help
Powered by ViewVC 1.1.23