ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/JSOC/doc/doxygen/doxygen_publ.cfg
Revision: 1.20
Committed: Thu Apr 16 00:35:03 2009 UTC (14 years, 5 months ago) by arta
Branch: MAIN
CVS Tags: Ver_6-0, Ver_6-1, Ver_6-2, Ver_6-3, Ver_6-4, Ver_5-6, Ver_LATEST, NetDRMS_Ver_8-12, Ver_9-41, Ver_DRMSLATEST, NetDRMS_Ver_2-0b, Ver_9-5, Ver_9-4, Ver_9-3, Ver_9-2, Ver_9-1, Ver_9-0, NetDRMS_Ver_2-2, NetDRMS_Ver_2-3, NetDRMS_Ver_2-0, NetDRMS_Ver_2-1, NetDRMS_Ver_2-6, NetDRMS_Ver_2-7, NetDRMS_Ver_2-4, NetDRMS_Ver_2-5, NetDRMS_Ver_LATEST, NetDRMS_Ver_8-8, NetDRMS_Ver_8-10, NetDRMS_Ver_8-11, NetDRMS_Ver_8-4, NetDRMS_Ver_8-5, NetDRMS_Ver_8-6, NetDRMS_Ver_8-7, NetDRMS_Ver_8-0, NetDRMS_Ver_8-1, NetDRMS_Ver_8-2, NetDRMS_Ver_8-3, Ver_8-8, NetDRMS_Ver_2-0b1, Ver_8-2, Ver_8-3, Ver_8-0, Ver_8-1, Ver_8-6, Ver_8-7, Ver_8-4, Ver_8-5, Ver_5-3, Ver_5-2, Ver_5-1, Ver_5-7, Ver_7-0, Ver_5-5, Ver_5-9, Ver_5-8, Ver_8-10, Ver_8-11, Ver_8-12, NetDRMS_Ver_6-4, NetDRMS_Ver_6-2, NetDRMS_Ver_6-3, NetDRMS_Ver_6-0, NetDRMS_Ver_6-1, Ver_5-14, Ver_5-13, Ver_5-12, Ver_5-11, Ver_5-10, NetDRMS_Ver_2-0a2, NetDRMS_Ver_9-9, NetDRMS_Ver_9-41, NetDRMS_Ver_9-1, NetDRMS_Ver_9-0, NetDRMS_Ver_9-3, NetDRMS_Ver_9-2, NetDRMS_Ver_9-5, NetDRMS_Ver_9-4, Ver_7-1, NetDRMS_Ver_7-1, NetDRMS_Ver_7-0, HEAD
Changes since 1.19: +1 -1 lines
Log Message:
Move private API function (not be used in code outside of DRMS library) to _priv.h; Update section 3 in the doxygen documentation - add all code section, with several sub-sections

File Contents

# User Rev Content
1 phil 1.13 # Doxyfile 1.5.7.1
2 arta 1.1
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 phil 1.13 # This tag specifies the encoding used for all characters in the config file
18     # that follow. The default is UTF-8 which is also the encoding used for all
19     # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20     # iconv built into libc) for the transcoding. See
21     # http://www.gnu.org/software/libiconv for the list of possible encodings.
22 arta 1.1
23     DOXYFILE_ENCODING = UTF-8
24    
25     # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26     # by quotes) that should identify the project.
27    
28 phil 1.16 PROJECT_NAME = "JSOC_Documentation"
29 arta 1.1
30     # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31     # This could be handy for archiving the generated documentation or
32     # if some version control system is used.
33    
34     PROJECT_NUMBER = @VERSION@
35    
36     # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37     # base path where the generated documentation will be put.
38     # If a relative path is entered, it will be relative to the location
39     # where doxygen was started. If left blank the current directory will be used.
40    
41 phil 1.17 # phil test
42     # OUTPUT_DIRECTORY = ./
43 arta 1.2 OUTPUT_DIRECTORY = /tmp/doxygen/output
44 arta 1.1
45     # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
46     # 4096 sub-directories (in 2 levels) under the output directory of each output
47     # format and will distribute the generated files over these directories.
48     # Enabling this option can be useful when feeding doxygen a huge amount of
49     # source files, where putting all generated files in the same directory would
50     # otherwise cause performance problems for the file system.
51    
52     CREATE_SUBDIRS = NO
53    
54     # The OUTPUT_LANGUAGE tag is used to specify the language in which all
55     # documentation generated by doxygen is written. Doxygen will use this
56     # information to generate all constant output in the proper language.
57     # The default language is English, other supported languages are:
58     # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
59 phil 1.13 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
60     # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
61     # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
62     # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
63     # Spanish, Swedish, and Ukrainian.
64 arta 1.1
65     OUTPUT_LANGUAGE = English
66    
67     # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
68     # include brief member descriptions after the members that are listed in
69     # the file and class documentation (similar to JavaDoc).
70     # Set to NO to disable this.
71    
72     BRIEF_MEMBER_DESC = YES
73    
74     # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75     # the brief description of a member or function before the detailed description.
76     # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
77     # brief descriptions will be completely suppressed.
78    
79 phil 1.14 REPEAT_BRIEF = YES
80 arta 1.1
81     # This tag implements a quasi-intelligent brief description abbreviator
82     # that is used to form the text in various listings. Each string
83     # in this list, if found as the leading text of the brief description, will be
84     # stripped from the text and the result after processing the whole list, is
85     # used as the annotated text. Otherwise, the brief description is used as-is.
86     # If left blank, the following values are used ("$name" is automatically
87     # replaced with the name of the entity): "The $name class" "The $name widget"
88     # "The $name file" "is" "provides" "specifies" "contains"
89     # "represents" "a" "an" "the"
90    
91     ABBREVIATE_BRIEF =
92    
93     # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
94     # Doxygen will generate a detailed section even if there is only a brief
95     # description.
96    
97     ALWAYS_DETAILED_SEC = NO
98    
99     # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
100     # inherited members of a class in the documentation of that class as if those
101     # members were ordinary class members. Constructors, destructors and assignment
102     # operators of the base classes will not be shown.
103    
104     INLINE_INHERITED_MEMB = NO
105    
106     # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
107     # path before files name in the file list and in the header files. If set
108     # to NO the shortest path that makes the file name unique will be used.
109    
110 phil 1.14 FULL_PATH_NAMES = YES
111 arta 1.1
112     # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
113     # can be used to strip a user-defined part of the path. Stripping is
114     # only done if one of the specified strings matches the left-hand part of
115     # the path. The tag can be used to show relative paths in the file list.
116     # If left blank the directory from which doxygen is run is used as the
117     # path to strip.
118    
119 phil 1.17 # phil test
120 phil 1.14 STRIP_FROM_PATH = /tmp/doxygen/input/JSOC /auto/home0/phil/cvs/JSOC
121 phil 1.17 # STRIP_FROM_PATH = /tmp/doxygen/input/JSOC
122 arta 1.1
123     # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
124     # the path mentioned in the documentation of a class, which tells
125     # the reader which header file to include in order to use a class.
126     # If left blank only the name of the header file containing the class
127     # definition is used. Otherwise one should specify the include paths that
128     # are normally passed to the compiler using the -I flag.
129    
130     STRIP_FROM_INC_PATH =
131    
132     # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
133     # (but less readable) file names. This can be useful is your file systems
134     # doesn't support long names like on DOS, Mac, or CD-ROM.
135    
136     SHORT_NAMES = NO
137    
138     # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
139     # will interpret the first line (until the first dot) of a JavaDoc-style
140     # comment as the brief description. If set to NO, the JavaDoc
141     # comments will behave just like regular Qt-style comments
142     # (thus requiring an explicit @brief command for a brief description.)
143    
144     JAVADOC_AUTOBRIEF = NO
145    
146     # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
147     # interpret the first line (until the first dot) of a Qt-style
148     # comment as the brief description. If set to NO, the comments
149     # will behave just like regular Qt-style comments (thus requiring
150     # an explicit \brief command for a brief description.)
151    
152     QT_AUTOBRIEF = NO
153    
154     # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
155     # treat a multi-line C++ special comment block (i.e. a block of //! or ///
156     # comments) as a brief description. This used to be the default behaviour.
157     # The new default is to treat a multi-line C++ comment block as a detailed
158     # description. Set this tag to YES if you prefer the old behaviour instead.
159    
160     MULTILINE_CPP_IS_BRIEF = NO
161    
162     # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
163     # member inherits the documentation from any documented member that it
164     # re-implements.
165    
166 phil 1.13 INHERIT_DOCS = NO
167 arta 1.1
168     # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
169     # a new page for each member. If set to NO, the documentation of a member will
170     # be part of the file/class/namespace that contains it.
171    
172 phil 1.14 SEPARATE_MEMBER_PAGES = YES
173 arta 1.1
174     # The TAB_SIZE tag can be used to set the number of spaces in a tab.
175     # Doxygen uses this value to replace tabs by spaces in code fragments.
176    
177     TAB_SIZE = 4
178    
179     # This tag can be used to specify a number of aliases that acts
180     # as commands in the documentation. An alias has the form "name=value".
181     # For example adding "sideeffect=\par Side Effects:\n" will allow you to
182     # put the command \sideeffect (or @sideeffect) in the documentation, which
183     # will result in a user-defined paragraph with heading "Side Effects:".
184     # You can put \n's in the value part of an alias to insert newlines.
185    
186     ALIASES =
187    
188     # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
189     # sources only. Doxygen will then generate output that is more tailored for C.
190     # For instance, some of the names that are used will be different. The list
191     # of all members will be omitted, etc.
192    
193 phil 1.13 OPTIMIZE_OUTPUT_FOR_C = YES
194 arta 1.1
195     # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
196 phil 1.13 # sources only. Doxygen will then generate output that is more tailored for
197     # Java. For instance, namespaces will be presented as packages, qualified
198     # scopes will look different, etc.
199 arta 1.1
200     OPTIMIZE_OUTPUT_JAVA = NO
201    
202 phil 1.13 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
203     # sources only. Doxygen will then generate output that is more tailored for
204     # Fortran.
205    
206     OPTIMIZE_FOR_FORTRAN = NO
207    
208     # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
209     # sources. Doxygen will then generate output that is tailored for
210     # VHDL.
211    
212     OPTIMIZE_OUTPUT_VHDL = NO
213    
214     # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
215     # to include (a tag file for) the STL sources as input, then you should
216 arta 1.1 # set this tag to YES in order to let doxygen match functions declarations and
217     # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
218     # func(std::string) {}). This also make the inheritance and collaboration
219     # diagrams that involve STL classes more complete and accurate.
220    
221     BUILTIN_STL_SUPPORT = NO
222    
223     # If you use Microsoft's C++/CLI language, you should set this option to YES to
224     # enable parsing support.
225    
226     CPP_CLI_SUPPORT = NO
227    
228     # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
229     # Doxygen will parse them like normal C++ but will assume all classes use public
230     # instead of private inheritance when no explicit protection keyword is present.
231    
232     SIP_SUPPORT = NO
233    
234 phil 1.13 # For Microsoft's IDL there are propget and propput attributes to indicate getter
235     # and setter methods for a property. Setting this option to YES (the default)
236     # will make doxygen to replace the get and set methods by a property in the
237     # documentation. This will only work if the methods are indeed getting or
238     # setting a simple type. If this is not the case, or you want to show the
239     # methods anyway, you should set this option to NO.
240    
241     IDL_PROPERTY_SUPPORT = NO
242    
243 arta 1.1 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
244     # tag is set to YES, then doxygen will reuse the documentation of the first
245     # member in the group (if any) for the other members of the group. By default
246     # all members of a group must be documented explicitly.
247    
248 phil 1.13 DISTRIBUTE_GROUP_DOC = NO
249 arta 1.1
250     # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
251     # the same type (for instance a group of public functions) to be put as a
252     # subgroup of that type (e.g. under the Public Functions section). Set it to
253     # NO to prevent subgrouping. Alternatively, this can be done per class using
254     # the \nosubgrouping command.
255    
256 arta 1.19 # Trying to fix drms_array documentation disappearing
257     # SUBGROUPING = NO
258     SUBGROUPING = YES
259 arta 1.1
260 phil 1.13 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
261     # is documented as struct, union, or enum with the name of the typedef. So
262 arta 1.1 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
263     # with name TypeT. When disabled the typedef will appear as a member of a file,
264     # namespace, or class. And the struct will be named TypeS. This can typically
265 phil 1.13 # be useful for C code in case the coding convention dictates that all compound
266     # types are typedef'ed and only the typedef is referenced, never the tag name.
267    
268 arta 1.19 TYPEDEF_HIDES_STRUCT = NO
269 arta 1.1
270 phil 1.13 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
271     # determine which symbols to keep in memory and which to flush to disk.
272     # When the cache is full, less often used symbols will be written to disk.
273     # For small to medium size projects (<1000 input files) the default value is
274     # probably good enough. For larger projects a too small cache size can cause
275     # doxygen to be busy swapping symbols to and from disk most of the time
276     # causing a significant performance penality.
277     # If the system has enough physical memory increasing the cache will improve the
278     # performance by keeping more symbols in memory. Note that the value works on
279     # a logarithmic scale so increasing the size by one will rougly double the
280     # memory usage. The cache size is given by this formula:
281     # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
282     # corresponding to a cache size of 2^16 = 65536 symbols
283    
284     SYMBOL_CACHE_SIZE = 0
285 arta 1.1
286     #---------------------------------------------------------------------------
287     # Build related configuration options
288     #---------------------------------------------------------------------------
289    
290     # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
291     # documentation are documented, even if no documentation was available.
292     # Private class members and static file members will be hidden unless
293     # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
294    
295     EXTRACT_ALL = NO
296    
297     # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
298     # will be included in the documentation.
299    
300     EXTRACT_PRIVATE = NO
301    
302     # If the EXTRACT_STATIC tag is set to YES all static members of a file
303     # will be included in the documentation.
304    
305     EXTRACT_STATIC = NO
306    
307     # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
308     # defined locally in source files will be included in the documentation.
309     # If set to NO only classes defined in header files are included.
310    
311 phil 1.14 EXTRACT_LOCAL_CLASSES = YES
312 arta 1.1
313     # This flag is only useful for Objective-C code. When set to YES local
314     # methods, which are defined in the implementation section but not in
315     # the interface are included in the documentation.
316     # If set to NO (the default) only methods in the interface are included.
317    
318     EXTRACT_LOCAL_METHODS = NO
319    
320 phil 1.13 # If this flag is set to YES, the members of anonymous namespaces will be
321     # extracted and appear in the documentation as a namespace called
322     # 'anonymous_namespace{file}', where file will be replaced with the base
323     # name of the file that contains the anonymous namespace. By default
324     # anonymous namespace are hidden.
325 arta 1.1
326     EXTRACT_ANON_NSPACES = NO
327    
328     # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
329     # undocumented members of documented classes, files or namespaces.
330     # If set to NO (the default) these members will be included in the
331     # various overviews, but no documentation section is generated.
332     # This option has no effect if EXTRACT_ALL is enabled.
333    
334     HIDE_UNDOC_MEMBERS = NO
335    
336     # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
337     # undocumented classes that are normally visible in the class hierarchy.
338     # If set to NO (the default) these classes will be included in the various
339     # overviews. This option has no effect if EXTRACT_ALL is enabled.
340    
341     HIDE_UNDOC_CLASSES = NO
342    
343     # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
344     # friend (class|struct|union) declarations.
345     # If set to NO (the default) these declarations will be included in the
346     # documentation.
347    
348     HIDE_FRIEND_COMPOUNDS = NO
349    
350     # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
351     # documentation blocks found inside the body of a function.
352     # If set to NO (the default) these blocks will be appended to the
353     # function's detailed documentation block.
354    
355     HIDE_IN_BODY_DOCS = NO
356    
357     # The INTERNAL_DOCS tag determines if documentation
358     # that is typed after a \internal command is included. If the tag is set
359     # to NO (the default) then the documentation will be excluded.
360     # Set it to YES to include the internal documentation.
361    
362     INTERNAL_DOCS = NO
363    
364     # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
365     # file names in lower-case letters. If set to YES upper-case letters are also
366     # allowed. This is useful if you have classes or files whose names only differ
367     # in case and if your file system supports case sensitive file names. Windows
368     # and Mac users are advised to set this option to NO.
369    
370     CASE_SENSE_NAMES = YES
371    
372     # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
373     # will show members with their full class and namespace scopes in the
374     # documentation. If set to YES the scope will be hidden.
375    
376 phil 1.14 HIDE_SCOPE_NAMES = NO
377 arta 1.1
378     # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
379     # will put a list of the files that are included by a file in the documentation
380     # of that file.
381    
382     SHOW_INCLUDE_FILES = YES
383    
384     # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
385     # is inserted in the documentation for inline members.
386    
387 phil 1.13 INLINE_INFO = NO
388 arta 1.1
389     # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
390     # will sort the (detailed) documentation of file and class members
391     # alphabetically by member name. If set to NO the members will appear in
392     # declaration order.
393    
394 phil 1.18 # phil change
395     SORT_MEMBER_DOCS = YES
396     # SORT_MEMBER_DOCS = NO
397 arta 1.1
398     # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
399     # brief documentation of file, namespace and class members alphabetically
400     # by member name. If set to NO (the default) the members will appear in
401     # declaration order.
402    
403 phil 1.18 # phil change
404     SORT_BRIEF_DOCS = YES
405     # SORT_BRIEF_DOCS = NO
406 arta 1.1
407 phil 1.13 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
408     # hierarchy of group names into alphabetical order. If set to NO (the default)
409     # the group names will appear in their defined order.
410    
411 phil 1.18 # phil change
412     SORT_GROUP_NAMES = YES
413     # SORT_GROUP_NAMES = NO
414 phil 1.13
415 arta 1.1 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
416     # sorted by fully-qualified names, including namespaces. If set to
417     # NO (the default), the class list will be sorted only by class name,
418     # not including the namespace part.
419     # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
420     # Note: This option applies only to the class list, not to the
421     # alphabetical list.
422    
423     SORT_BY_SCOPE_NAME = NO
424    
425     # The GENERATE_TODOLIST tag can be used to enable (YES) or
426     # disable (NO) the todo list. This list is created by putting \todo
427     # commands in the documentation.
428    
429     GENERATE_TODOLIST = YES
430    
431     # The GENERATE_TESTLIST tag can be used to enable (YES) or
432     # disable (NO) the test list. This list is created by putting \test
433     # commands in the documentation.
434    
435     GENERATE_TESTLIST = YES
436    
437     # The GENERATE_BUGLIST tag can be used to enable (YES) or
438     # disable (NO) the bug list. This list is created by putting \bug
439     # commands in the documentation.
440    
441     GENERATE_BUGLIST = YES
442    
443     # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
444     # disable (NO) the deprecated list. This list is created by putting
445     # \deprecated commands in the documentation.
446    
447     GENERATE_DEPRECATEDLIST= YES
448    
449     # The ENABLED_SECTIONS tag can be used to enable conditional
450     # documentation sections, marked by \if sectionname ... \endif.
451    
452     ENABLED_SECTIONS =
453    
454     # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
455     # the initial value of a variable or define consists of for it to appear in
456     # the documentation. If the initializer consists of more lines than specified
457     # here it will be hidden. Use a value of 0 to hide initializers completely.
458     # The appearance of the initializer of individual variables and defines in the
459     # documentation can be controlled using \showinitializer or \hideinitializer
460     # command in the documentation regardless of this setting.
461    
462 phil 1.13 MAX_INITIALIZER_LINES = 0
463 arta 1.1
464     # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
465     # at the bottom of the documentation of classes and structs. If set to YES the
466     # list will mention the files that were used to generate the documentation.
467    
468     SHOW_USED_FILES = YES
469    
470     # If the sources in your project are distributed over multiple directories
471     # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
472     # in the documentation. The default is NO.
473    
474     SHOW_DIRECTORIES = NO
475    
476 phil 1.13 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
477     # This will remove the Files entry from the Quick Index and from the
478     # Folder Tree View (if specified). The default is YES.
479    
480     SHOW_FILES = YES
481    
482     # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
483     # Namespaces page. This will remove the Namespaces entry from the Quick Index
484     # and from the Folder Tree View (if specified). The default is YES.
485    
486     SHOW_NAMESPACES = YES
487    
488 arta 1.1 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
489 phil 1.13 # doxygen should invoke to get the current version for each file (typically from
490     # the version control system). Doxygen will invoke the program by executing (via
491 arta 1.1 # popen()) the command <command> <input-file>, where <command> is the value of
492     # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
493     # provided by doxygen. Whatever the program writes to standard output
494     # is used as the file version. See the manual for examples.
495    
496     FILE_VERSION_FILTER =
497    
498 phil 1.13 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
499     # doxygen. The layout file controls the global structure of the generated output files
500     # in an output format independent way. The create the layout file that represents
501     # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
502     # file name after the option, if omitted DoxygenLayout.xml will be used as the name
503     # of the layout file.
504    
505     LAYOUT_FILE = JsocLayout.xml
506    
507 arta 1.1 #---------------------------------------------------------------------------
508     # configuration options related to warning and progress messages
509     #---------------------------------------------------------------------------
510    
511     # The QUIET tag can be used to turn on/off the messages that are generated
512     # by doxygen. Possible values are YES and NO. If left blank NO is used.
513    
514     QUIET = NO
515    
516     # The WARNINGS tag can be used to turn on/off the warning messages that are
517     # generated by doxygen. Possible values are YES and NO. If left blank
518     # NO is used.
519    
520     WARNINGS = YES
521    
522     # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
523     # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
524     # automatically be disabled.
525    
526     WARN_IF_UNDOCUMENTED = YES
527    
528     # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
529     # potential errors in the documentation, such as not documenting some
530     # parameters in a documented function, or documenting parameters that
531     # don't exist or using markup commands wrongly.
532    
533     WARN_IF_DOC_ERROR = YES
534    
535     # This WARN_NO_PARAMDOC option can be abled to get warnings for
536     # functions that are documented, but have no documentation for their parameters
537     # or return value. If set to NO (the default) doxygen will only warn about
538     # wrong or incomplete parameter documentation, but not about the absence of
539     # documentation.
540    
541     WARN_NO_PARAMDOC = NO
542    
543     # The WARN_FORMAT tag determines the format of the warning messages that
544     # doxygen can produce. The string should contain the $file, $line, and $text
545     # tags, which will be replaced by the file and line number from which the
546     # warning originated and the warning text. Optionally the format may contain
547     # $version, which will be replaced by the version of the file (if it could
548     # be obtained via FILE_VERSION_FILTER)
549    
550     WARN_FORMAT = "$file:$line: $text"
551    
552     # The WARN_LOGFILE tag can be used to specify a file to which warning
553     # and error messages should be written. If left blank the output is written
554     # to stderr.
555    
556     WARN_LOGFILE =
557    
558     #---------------------------------------------------------------------------
559     # configuration options related to the input files
560     #---------------------------------------------------------------------------
561    
562     # The INPUT tag can be used to specify the files and/or directories that contain
563     # documented source files. You may enter file names like "myfile.cpp" or
564     # directories like "/usr/src/myproject". Separate the files or directories
565     # with spaces.
566    
567 phil 1.13 INPUT = ./ \
568 karen 1.12 ../../base/ \
569 phil 1.13 ../../proj/
570 arta 1.1
571 phil 1.13 # This tag can be used to specify the character encoding of the source files
572     # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
573     # also the default input encoding. Doxygen uses libiconv (or the iconv built
574     # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
575     # the list of possible encodings.
576 arta 1.1
577     INPUT_ENCODING = UTF-8
578    
579     # If the value of the INPUT tag contains directories, you can use the
580     # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
581     # and *.h) to filter out the source-files in the directories. If left
582     # blank the following patterns are tested:
583     # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
584     # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
585    
586     FILE_PATTERNS = *.c \
587     *.h \
588     *.txt
589    
590     # The RECURSIVE tag can be used to turn specify whether or not subdirectories
591     # should be searched for input files as well. Possible values are YES and NO.
592     # If left blank NO is used.
593    
594     RECURSIVE = YES
595    
596     # The EXCLUDE tag can be used to specify files and/or directories that should
597     # excluded from the INPUT source files. This way you can easily exclude a
598     # subdirectory from a directory tree whose root is specified with the INPUT tag.
599    
600 phil 1.13 EXCLUDE = ../../base/include \
601     ../../base/drms/doc \
602 phil 1.14 ../../base/drms/fragments
603 arta 1.1
604     # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
605     # directories that are symbolic links (a Unix filesystem feature) are excluded
606     # from the input.
607    
608     EXCLUDE_SYMLINKS = NO
609    
610     # If the value of the INPUT tag contains directories, you can use the
611     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
612     # certain files from those directories. Note that the wildcards are matched
613     # against the file with absolute path, so to exclude all test directories
614     # for example use the pattern */test/*
615    
616 arta 1.20 EXCLUDE_PATTERNS = *_priv.h
617 arta 1.1
618     # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
619 phil 1.13 # (namespaces, classes, functions, etc.) that should be excluded from the
620     # output. The symbol name can be a fully qualified name, a word, or if the
621     # wildcard * is used, a substring. Examples: ANamespace, AClass,
622     # AClass::ANamespace, ANamespace::*Test
623 arta 1.1
624     EXCLUDE_SYMBOLS =
625    
626     # The EXAMPLE_PATH tag can be used to specify one or more files or
627     # directories that contain example code fragments that are included (see
628     # the \include command).
629    
630 phil 1.17 # phil change
631     EXAMPLE_PATH = ../../base/drms/fragments ./
632 phil 1.15 # EXAMPLE_PATH = ../../base/drms/fragments
633 arta 1.1
634     # If the value of the EXAMPLE_PATH tag contains directories, you can use the
635     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
636     # and *.h) to filter out the source-files in the directories. If left
637     # blank all files are included.
638    
639     EXAMPLE_PATTERNS =
640    
641     # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
642     # searched for input files to be used with the \include or \dontinclude
643     # commands irrespective of the value of the RECURSIVE tag.
644     # Possible values are YES and NO. If left blank NO is used.
645    
646     EXAMPLE_RECURSIVE = NO
647    
648     # The IMAGE_PATH tag can be used to specify one or more files or
649     # directories that contain image that are included in the documentation (see
650     # the \image command).
651    
652     IMAGE_PATH =
653    
654     # The INPUT_FILTER tag can be used to specify a program that doxygen should
655     # invoke to filter for each input file. Doxygen will invoke the filter program
656     # by executing (via popen()) the command <filter> <input-file>, where <filter>
657     # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
658     # input file. Doxygen will then use the output that the filter program writes
659     # to standard output. If FILTER_PATTERNS is specified, this tag will be
660     # ignored.
661    
662     INPUT_FILTER =
663    
664     # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
665     # basis. Doxygen will compare the file name with each pattern and apply the
666     # filter if there is a match. The filters are a list of the form:
667     # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
668     # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
669     # is applied to all files.
670    
671     FILTER_PATTERNS =
672    
673     # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
674     # INPUT_FILTER) will be used to filter the input files when producing source
675     # files to browse (i.e. when SOURCE_BROWSER is set to YES).
676    
677     FILTER_SOURCE_FILES = NO
678    
679     #---------------------------------------------------------------------------
680     # configuration options related to source browsing
681     #---------------------------------------------------------------------------
682    
683     # If the SOURCE_BROWSER tag is set to YES then a list of source files will
684     # be generated. Documented entities will be cross-referenced with these sources.
685     # Note: To get rid of all source code in the generated output, make sure also
686 phil 1.13 # VERBATIM_HEADERS is set to NO.
687 arta 1.1
688     SOURCE_BROWSER = YES
689    
690     # Setting the INLINE_SOURCES tag to YES will include the body
691     # of functions and classes directly in the documentation.
692    
693     INLINE_SOURCES = NO
694    
695     # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
696     # doxygen to hide any special comment blocks from generated source code
697     # fragments. Normal C and C++ comments will always remain visible.
698    
699     STRIP_CODE_COMMENTS = YES
700    
701 phil 1.13 # If the REFERENCED_BY_RELATION tag is set to YES
702 arta 1.1 # then for each documented function all documented
703     # functions referencing it will be listed.
704    
705 phil 1.13 REFERENCED_BY_RELATION = NO
706 arta 1.1
707 phil 1.13 # If the REFERENCES_RELATION tag is set to YES
708 arta 1.1 # then for each documented function all documented entities
709     # called/used by that function will be listed.
710    
711 phil 1.13 REFERENCES_RELATION = NO
712 arta 1.1
713     # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
714     # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
715     # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
716     # link to the source code. Otherwise they will link to the documentstion.
717    
718     REFERENCES_LINK_SOURCE = YES
719    
720     # If the USE_HTAGS tag is set to YES then the references to source code
721     # will point to the HTML generated by the htags(1) tool instead of doxygen
722     # built-in source browser. The htags tool is part of GNU's global source
723     # tagging system (see http://www.gnu.org/software/global/global.html). You
724     # will need version 4.8.6 or higher.
725    
726     USE_HTAGS = NO
727    
728     # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
729     # will generate a verbatim copy of the header file for each class for
730     # which an include is specified. Set to NO to disable this.
731    
732     VERBATIM_HEADERS = YES
733    
734     #---------------------------------------------------------------------------
735     # configuration options related to the alphabetical class index
736     #---------------------------------------------------------------------------
737    
738     # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
739     # of all compounds will be generated. Enable this if the project
740     # contains a lot of classes, structs, unions or interfaces.
741    
742     ALPHABETICAL_INDEX = NO
743    
744     # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
745     # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
746     # in which this list will be split (can be a number in the range [1..20])
747    
748     COLS_IN_ALPHA_INDEX = 5
749    
750     # In case all classes in a project start with a common prefix, all
751     # classes will be put under the same header in the alphabetical index.
752     # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
753     # should be ignored while generating the index headers.
754    
755     IGNORE_PREFIX =
756    
757     #---------------------------------------------------------------------------
758     # configuration options related to the HTML output
759     #---------------------------------------------------------------------------
760    
761     # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
762     # generate HTML output.
763    
764     GENERATE_HTML = YES
765    
766     # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
767     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
768     # put in front of it. If left blank `html' will be used as the default path.
769    
770     HTML_OUTPUT = html
771    
772     # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
773     # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
774     # doxygen will generate files with .html extension.
775    
776     HTML_FILE_EXTENSION = .html
777    
778     # The HTML_HEADER tag can be used to specify a personal HTML header for
779     # each generated HTML page. If it is left blank doxygen will generate a
780     # standard header.
781    
782     HTML_HEADER =
783    
784     # The HTML_FOOTER tag can be used to specify a personal HTML footer for
785     # each generated HTML page. If it is left blank doxygen will generate a
786     # standard footer.
787    
788     HTML_FOOTER =
789    
790     # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
791     # style sheet that is used by each HTML page. It can be used to
792     # fine-tune the look of the HTML output. If the tag is left blank doxygen
793     # will generate a default style sheet. Note that doxygen will try to copy
794     # the style sheet file to the HTML output directory, so don't put your own
795     # stylesheet in the HTML output directory as well, or it will be erased!
796    
797 phil 1.18 # phil change
798     HTML_STYLESHEET = ./doxygen.css
799     # HTML_STYLESHEET =
800 arta 1.1
801     # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
802     # files or namespaces will be aligned in HTML using tables. If set to
803     # NO a bullet list will be used.
804    
805     HTML_ALIGN_MEMBERS = YES
806    
807     # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
808     # documentation will contain sections that can be hidden and shown after the
809     # page has loaded. For this to work a browser that supports
810     # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
811     # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
812    
813 phil 1.14 HTML_DYNAMIC_SECTIONS = YES
814 arta 1.1
815 phil 1.13 # If the GENERATE_DOCSET tag is set to YES, additional index files
816     # will be generated that can be used as input for Apple's Xcode 3
817     # integrated development environment, introduced with OSX 10.5 (Leopard).
818     # To create a documentation set, doxygen will generate a Makefile in the
819     # HTML output directory. Running make will produce the docset in that
820     # directory and running "make install" will install the docset in
821     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
822     # it at startup.
823     # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
824    
825     GENERATE_DOCSET = NO
826    
827     # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
828     # feed. A documentation feed provides an umbrella under which multiple
829     # documentation sets from a single provider (such as a company or product suite)
830     # can be grouped.
831    
832     DOCSET_FEEDNAME = "Doxygen generated docs"
833    
834     # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
835     # should uniquely identify the documentation set bundle. This should be a
836     # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
837     # will append .docset to the name.
838    
839     DOCSET_BUNDLE_ID = org.doxygen.Project
840    
841     # If the GENERATE_HTMLHELP tag is set to YES, additional index files
842     # will be generated that can be used as input for tools like the
843     # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
844     # of the generated HTML documentation.
845    
846     GENERATE_HTMLHELP = NO
847    
848 arta 1.1 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
849     # be used to specify the file name of the resulting .chm file. You
850     # can add a path in front of the file if the result should not be
851     # written to the html output directory.
852    
853     CHM_FILE =
854    
855     # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
856     # be used to specify the location (absolute path including file name) of
857     # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
858     # the HTML help compiler on the generated index.hhp.
859    
860     HHC_LOCATION =
861    
862     # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
863     # controls if a separate .chi index file is generated (YES) or that
864     # it should be included in the master .chm file (NO).
865    
866     GENERATE_CHI = NO
867    
868 phil 1.13 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
869     # is used to encode HtmlHelp index (hhk), content (hhc) and project file
870     # content.
871    
872     CHM_INDEX_ENCODING =
873    
874 arta 1.1 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
875     # controls whether a binary table of contents is generated (YES) or a
876     # normal table of contents (NO) in the .chm file.
877    
878     BINARY_TOC = NO
879    
880     # The TOC_EXPAND flag can be set to YES to add extra items for group members
881     # to the contents of the HTML help documentation and to the tree view.
882    
883 phil 1.14 TOC_EXPAND = YES
884 arta 1.1
885 phil 1.13 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
886     # are set, an additional index file will be generated that can be used as input for
887     # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
888     # HTML documentation.
889    
890     GENERATE_QHP = NO
891    
892     # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
893     # be used to specify the file name of the resulting .qch file.
894     # The path specified is relative to the HTML output folder.
895    
896     QCH_FILE =
897    
898     # The QHP_NAMESPACE tag specifies the namespace to use when generating
899     # Qt Help Project output. For more information please see
900     # <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
901    
902     QHP_NAMESPACE = org.doxygen.Project
903    
904     # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
905     # Qt Help Project output. For more information please see
906     # <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
907    
908     QHP_VIRTUAL_FOLDER = doc
909    
910     # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
911     # be used to specify the location of Qt's qhelpgenerator.
912     # If non-empty doxygen will try to run qhelpgenerator on the generated
913     # .qhp file .
914    
915     QHG_LOCATION =
916    
917 arta 1.1 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
918     # top of each HTML page. The value NO (the default) enables the index and
919     # the value YES disables it.
920    
921     DISABLE_INDEX = NO
922    
923     # This tag can be used to set the number of enum values (range [1..20])
924     # that doxygen will group on one line in the generated HTML documentation.
925    
926     ENUM_VALUES_PER_LINE = 4
927    
928 phil 1.13 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
929     # structure should be generated to display hierarchical information.
930     # If the tag value is set to FRAME, a side panel will be generated
931     # containing a tree-like index structure (just like the one that
932 arta 1.1 # is generated for HTML Help). For this to work a browser that supports
933     # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
934     # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
935 phil 1.13 # probably better off using the HTML help feature. Other possible values
936     # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
937     # and Class Hierarchy pages using a tree view instead of an ordered list;
938     # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
939     # disables this behavior completely. For backwards compatibility with previous
940     # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
941     # respectively.
942 arta 1.1
943 phil 1.13 GENERATE_TREEVIEW = FRAME
944 arta 1.1
945     # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
946     # used to set the initial width (in pixels) of the frame in which the tree
947     # is shown.
948    
949     TREEVIEW_WIDTH = 250
950    
951 phil 1.13 # Use this tag to change the font size of Latex formulas included
952     # as images in the HTML documentation. The default is 10. Note that
953     # when you change the font size after a successful doxygen run you need
954     # to manually remove any form_*.png images from the HTML output directory
955     # to force them to be regenerated.
956    
957     FORMULA_FONTSIZE = 10
958    
959 arta 1.1 #---------------------------------------------------------------------------
960     # configuration options related to the LaTeX output
961     #---------------------------------------------------------------------------
962    
963     # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
964     # generate Latex output.
965    
966 phil 1.13 GENERATE_LATEX = NO
967 arta 1.1
968     # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
969     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
970     # put in front of it. If left blank `latex' will be used as the default path.
971    
972     LATEX_OUTPUT = latex
973    
974     # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
975     # invoked. If left blank `latex' will be used as the default command name.
976    
977     LATEX_CMD_NAME = latex
978    
979     # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
980     # generate index for LaTeX. If left blank `makeindex' will be used as the
981     # default command name.
982    
983     MAKEINDEX_CMD_NAME = makeindex
984    
985     # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
986     # LaTeX documents. This may be useful for small projects and may help to
987     # save some trees in general.
988    
989     COMPACT_LATEX = NO
990    
991     # The PAPER_TYPE tag can be used to set the paper type that is used
992     # by the printer. Possible values are: a4, a4wide, letter, legal and
993     # executive. If left blank a4wide will be used.
994    
995 phil 1.13 PAPER_TYPE = letter
996 arta 1.1
997     # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
998     # packages that should be included in the LaTeX output.
999    
1000     EXTRA_PACKAGES =
1001    
1002     # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1003     # the generated latex document. The header should contain everything until
1004     # the first chapter. If it is left blank doxygen will generate a
1005     # standard header. Notice: only use this tag if you know what you are doing!
1006    
1007     LATEX_HEADER =
1008    
1009     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1010     # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1011     # contain links (just like the HTML output) instead of page references
1012     # This makes the output suitable for online browsing using a pdf viewer.
1013    
1014 phil 1.13 PDF_HYPERLINKS = YES
1015 arta 1.1
1016     # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1017     # plain latex in the generated Makefile. Set this option to YES to get a
1018     # higher quality PDF documentation.
1019    
1020 phil 1.13 USE_PDFLATEX = YES
1021 arta 1.1
1022     # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1023     # command to the generated LaTeX files. This will instruct LaTeX to keep
1024     # running if errors occur, instead of asking the user for help.
1025     # This option is also used when generating formulas in HTML.
1026    
1027     LATEX_BATCHMODE = NO
1028    
1029     # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1030     # include the index chapters (such as File Index, Compound Index, etc.)
1031     # in the output.
1032    
1033     LATEX_HIDE_INDICES = NO
1034    
1035     #---------------------------------------------------------------------------
1036     # configuration options related to the RTF output
1037     #---------------------------------------------------------------------------
1038    
1039     # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1040     # The RTF output is optimized for Word 97 and may not look very pretty with
1041     # other RTF readers or editors.
1042    
1043     GENERATE_RTF = NO
1044    
1045     # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1046     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1047     # put in front of it. If left blank `rtf' will be used as the default path.
1048    
1049     RTF_OUTPUT = rtf
1050    
1051     # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1052     # RTF documents. This may be useful for small projects and may help to
1053     # save some trees in general.
1054    
1055     COMPACT_RTF = NO
1056    
1057     # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1058     # will contain hyperlink fields. The RTF file will
1059     # contain links (just like the HTML output) instead of page references.
1060     # This makes the output suitable for online browsing using WORD or other
1061     # programs which support those fields.
1062     # Note: wordpad (write) and others do not support links.
1063    
1064     RTF_HYPERLINKS = NO
1065    
1066     # Load stylesheet definitions from file. Syntax is similar to doxygen's
1067     # config file, i.e. a series of assignments. You only have to provide
1068     # replacements, missing definitions are set to their default value.
1069    
1070     RTF_STYLESHEET_FILE =
1071    
1072     # Set optional variables used in the generation of an rtf document.
1073     # Syntax is similar to doxygen's config file.
1074    
1075     RTF_EXTENSIONS_FILE =
1076    
1077     #---------------------------------------------------------------------------
1078     # configuration options related to the man page output
1079     #---------------------------------------------------------------------------
1080    
1081     # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1082     # generate man pages
1083    
1084 karen 1.12 GENERATE_MAN = YES
1085 arta 1.1
1086     # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1087     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1088     # put in front of it. If left blank `man' will be used as the default path.
1089    
1090 arta 1.3 MAN_OUTPUT = man
1091 arta 1.1
1092     # The MAN_EXTENSION tag determines the extension that is added to
1093     # the generated man pages (default is the subroutine's section .3)
1094    
1095 arta 1.4 MAN_EXTENSION = .3
1096 arta 1.1
1097     # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1098     # then it will generate one additional man file for each entity
1099     # documented in the real man page(s). These additional files
1100     # only source the real man page, but without them the man command
1101     # would be unable to find the correct page. The default is NO.
1102    
1103 arta 1.2 MAN_LINKS = YES
1104 arta 1.1
1105     #---------------------------------------------------------------------------
1106     # configuration options related to the XML output
1107     #---------------------------------------------------------------------------
1108    
1109     # If the GENERATE_XML tag is set to YES Doxygen will
1110     # generate an XML file that captures the structure of
1111     # the code including all documentation.
1112    
1113     GENERATE_XML = NO
1114    
1115     # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1116     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1117     # put in front of it. If left blank `xml' will be used as the default path.
1118    
1119     XML_OUTPUT = xml
1120    
1121     # The XML_SCHEMA tag can be used to specify an XML schema,
1122     # which can be used by a validating XML parser to check the
1123     # syntax of the XML files.
1124    
1125     XML_SCHEMA =
1126    
1127     # The XML_DTD tag can be used to specify an XML DTD,
1128     # which can be used by a validating XML parser to check the
1129     # syntax of the XML files.
1130    
1131     XML_DTD =
1132    
1133     # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1134     # dump the program listings (including syntax highlighting
1135     # and cross-referencing information) to the XML output. Note that
1136     # enabling this will significantly increase the size of the XML output.
1137    
1138     XML_PROGRAMLISTING = YES
1139    
1140     #---------------------------------------------------------------------------
1141     # configuration options for the AutoGen Definitions output
1142     #---------------------------------------------------------------------------
1143    
1144     # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1145     # generate an AutoGen Definitions (see autogen.sf.net) file
1146     # that captures the structure of the code including all
1147     # documentation. Note that this feature is still experimental
1148     # and incomplete at the moment.
1149    
1150     GENERATE_AUTOGEN_DEF = NO
1151    
1152     #---------------------------------------------------------------------------
1153     # configuration options related to the Perl module output
1154     #---------------------------------------------------------------------------
1155    
1156     # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1157     # generate a Perl module file that captures the structure of
1158     # the code including all documentation. Note that this
1159     # feature is still experimental and incomplete at the
1160     # moment.
1161    
1162     GENERATE_PERLMOD = NO
1163    
1164     # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1165     # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1166     # to generate PDF and DVI output from the Perl module output.
1167    
1168     PERLMOD_LATEX = NO
1169    
1170     # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1171     # nicely formatted so it can be parsed by a human reader. This is useful
1172     # if you want to understand what is going on. On the other hand, if this
1173     # tag is set to NO the size of the Perl module output will be much smaller
1174     # and Perl will parse it just the same.
1175    
1176     PERLMOD_PRETTY = YES
1177    
1178     # The names of the make variables in the generated doxyrules.make file
1179     # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1180     # This is useful so different doxyrules.make files included by the same
1181     # Makefile don't overwrite each other's variables.
1182    
1183     PERLMOD_MAKEVAR_PREFIX =
1184    
1185     #---------------------------------------------------------------------------
1186     # Configuration options related to the preprocessor
1187     #---------------------------------------------------------------------------
1188    
1189     # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1190     # evaluate all C-preprocessor directives found in the sources and include
1191     # files.
1192    
1193 phil 1.14 ENABLE_PREPROCESSING = YES
1194 arta 1.1
1195     # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1196     # names in the source code. If set to NO (the default) only conditional
1197     # compilation will be performed. Macro expansion can be done in a controlled
1198     # way by setting EXPAND_ONLY_PREDEF to YES.
1199    
1200     MACRO_EXPANSION = NO
1201    
1202     # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1203     # then the macro expansion is limited to the macros specified with the
1204     # PREDEFINED and EXPAND_AS_DEFINED tags.
1205    
1206     EXPAND_ONLY_PREDEF = NO
1207    
1208     # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1209     # in the INCLUDE_PATH (see below) will be search if a #include is found.
1210    
1211     SEARCH_INCLUDES = YES
1212    
1213     # The INCLUDE_PATH tag can be used to specify one or more directories that
1214     # contain include files that are not input files but should be processed by
1215     # the preprocessor.
1216    
1217 arta 1.8 INCLUDE_PATH = ../../base/include
1218 arta 1.1
1219     # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1220     # patterns (like *.h and *.hpp) to filter out the header-files in the
1221     # directories. If left blank, the patterns specified with FILE_PATTERNS will
1222     # be used.
1223    
1224     INCLUDE_FILE_PATTERNS =
1225    
1226     # The PREDEFINED tag can be used to specify one or more macro names that
1227     # are defined before the preprocessor is started (similar to the -D option of
1228     # gcc). The argument of the tag is a list of macros of the form: name
1229     # or name=definition (no spaces). If the definition and the = are
1230     # omitted =1 is assumed. To prevent a macro definition from being
1231     # undefined via #undef or recursively expanded use the := operator
1232     # instead of the = operator.
1233    
1234     PREDEFINED =
1235    
1236     # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1237     # this tag can be used to specify a list of macro names that should be expanded.
1238     # The macro definition that is found in the sources will be used.
1239     # Use the PREDEFINED tag if you want to use a different macro definition.
1240    
1241     EXPAND_AS_DEFINED =
1242    
1243     # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1244     # doxygen's preprocessor will remove all function-like macros that are alone
1245     # on a line, have an all uppercase name, and do not end with a semicolon. Such
1246     # function macros are typically used for boiler-plate code, and will confuse
1247     # the parser if not removed.
1248    
1249     SKIP_FUNCTION_MACROS = YES
1250    
1251     #---------------------------------------------------------------------------
1252     # Configuration::additions related to external references
1253     #---------------------------------------------------------------------------
1254    
1255     # The TAGFILES option can be used to specify one or more tagfiles.
1256     # Optionally an initial location of the external documentation
1257     # can be added for each tagfile. The format of a tag file without
1258     # this location is as follows:
1259     # TAGFILES = file1 file2 ...
1260     # Adding location for the tag files is done as follows:
1261     # TAGFILES = file1=loc1 "file2 = loc2" ...
1262     # where "loc1" and "loc2" can be relative or absolute paths or
1263     # URLs. If a location is present for each tag, the installdox tool
1264     # does not have to be run to correct the links.
1265     # Note that each tag file must have a unique name
1266     # (where the name does NOT include the path)
1267     # If a tag file is not located in the directory in which doxygen
1268     # is run, you must also specify the path to the tagfile here.
1269    
1270     TAGFILES =
1271    
1272     # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1273     # a tag file that is based on the input files it reads.
1274    
1275     GENERATE_TAGFILE =
1276    
1277     # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1278     # in the class index. If set to NO only the inherited external classes
1279     # will be listed.
1280    
1281     ALLEXTERNALS = NO
1282    
1283     # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1284     # in the modules index. If set to NO, only the current project's groups will
1285     # be listed.
1286    
1287     EXTERNAL_GROUPS = YES
1288    
1289     # The PERL_PATH should be the absolute path and name of the perl script
1290     # interpreter (i.e. the result of `which perl').
1291    
1292     PERL_PATH = /usr/bin/perl
1293    
1294     #---------------------------------------------------------------------------
1295     # Configuration options related to the dot tool
1296     #---------------------------------------------------------------------------
1297    
1298     # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1299     # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1300     # or super classes. Setting the tag to NO turns the diagrams off. Note that
1301     # this option is superseded by the HAVE_DOT option below. This is only a
1302     # fallback. It is recommended to install and use dot, since it yields more
1303     # powerful graphs.
1304    
1305     CLASS_DIAGRAMS = YES
1306    
1307     # You can define message sequence charts within doxygen comments using the \msc
1308 phil 1.13 # command. Doxygen will then run the mscgen tool (see
1309     # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1310     # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1311     # the mscgen tool resides. If left empty the tool is assumed to be found in the
1312     # default search path.
1313 arta 1.1
1314     MSCGEN_PATH =
1315    
1316     # If set to YES, the inheritance and collaboration graphs will hide
1317     # inheritance and usage relations if the target is undocumented
1318     # or is not a class.
1319    
1320     HIDE_UNDOC_RELATIONS = YES
1321    
1322     # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1323     # available from the path. This tool is part of Graphviz, a graph visualization
1324     # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1325     # have no effect if this option is set to NO (the default)
1326    
1327 phil 1.17 # phil test
1328     HAVE_DOT = YES
1329     # HAVE_DOT = NO
1330 arta 1.1
1331 phil 1.13 # By default doxygen will write a font called FreeSans.ttf to the output
1332     # directory and reference it in all dot files that doxygen generates. This
1333     # font does not include all possible unicode characters however, so when you need
1334     # these (or just want a differently looking font) you can specify the font name
1335     # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1336     # which can be done by putting it in a standard location or by setting the
1337     # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1338     # containing the font.
1339    
1340     DOT_FONTNAME = FreeSans
1341    
1342     # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1343     # The default size is 10pt.
1344    
1345 phil 1.17 # phil test
1346     DOT_FONTSIZE = 8
1347     # DOT_FONTSIZE = 10
1348 phil 1.13
1349     # By default doxygen will tell dot to use the output directory to look for the
1350     # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1351     # different font using DOT_FONTNAME you can set the path where dot
1352     # can find it using this tag.
1353    
1354     DOT_FONTPATH =
1355    
1356 arta 1.1 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1357     # will generate a graph for each documented class showing the direct and
1358     # indirect inheritance relations. Setting this tag to YES will force the
1359     # the CLASS_DIAGRAMS tag to NO.
1360    
1361     CLASS_GRAPH = YES
1362    
1363     # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1364     # will generate a graph for each documented class showing the direct and
1365     # indirect implementation dependencies (inheritance, containment, and
1366     # class references variables) of the class with other documented classes.
1367    
1368     COLLABORATION_GRAPH = YES
1369    
1370     # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1371     # will generate a graph for groups, showing the direct groups dependencies
1372    
1373     GROUP_GRAPHS = YES
1374    
1375     # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1376     # collaboration diagrams in a style similar to the OMG's Unified Modeling
1377     # Language.
1378    
1379 phil 1.17 # phil test
1380     # UML_LOOK = YES
1381 arta 1.1 UML_LOOK = NO
1382    
1383     # If set to YES, the inheritance and collaboration graphs will show the
1384     # relations between templates and their instances.
1385    
1386     TEMPLATE_RELATIONS = NO
1387    
1388     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1389     # tags are set to YES then doxygen will generate a graph for each documented
1390     # file showing the direct and indirect include dependencies of the file with
1391     # other documented files.
1392    
1393     INCLUDE_GRAPH = YES
1394    
1395     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1396     # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1397     # documented header file showing the documented files that directly or
1398     # indirectly include this file.
1399    
1400     INCLUDED_BY_GRAPH = YES
1401    
1402 phil 1.13 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1403     # doxygen will generate a call dependency graph for every global function
1404     # or class method. Note that enabling this option will significantly increase
1405     # the time of a run. So in most cases it will be better to enable call graphs
1406     # for selected functions only using the \callgraph command.
1407 arta 1.1
1408     CALL_GRAPH = NO
1409    
1410 phil 1.13 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1411     # doxygen will generate a caller dependency graph for every global function
1412     # or class method. Note that enabling this option will significantly increase
1413     # the time of a run. So in most cases it will be better to enable caller
1414     # graphs for selected functions only using the \callergraph command.
1415 arta 1.1
1416     CALLER_GRAPH = NO
1417    
1418     # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1419     # will graphical hierarchy of all classes instead of a textual one.
1420    
1421     GRAPHICAL_HIERARCHY = YES
1422    
1423     # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1424     # then doxygen will show the dependencies a directory has on other directories
1425     # in a graphical way. The dependency relations are determined by the #include
1426     # relations between the files in the directories.
1427    
1428     DIRECTORY_GRAPH = YES
1429    
1430     # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1431     # generated by dot. Possible values are png, jpg, or gif
1432     # If left blank png will be used.
1433    
1434     DOT_IMAGE_FORMAT = png
1435    
1436     # The tag DOT_PATH can be used to specify the path where the dot tool can be
1437     # found. If left blank, it is assumed the dot tool can be found in the path.
1438    
1439     DOT_PATH =
1440    
1441     # The DOTFILE_DIRS tag can be used to specify one or more directories that
1442     # contain dot files that are included in the documentation (see the
1443     # \dotfile command).
1444    
1445     DOTFILE_DIRS =
1446    
1447 phil 1.13 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1448 arta 1.1 # nodes that will be shown in the graph. If the number of nodes in a graph
1449     # becomes larger than this value, doxygen will truncate the graph, which is
1450 phil 1.13 # visualized by representing a node as a red box. Note that doxygen if the
1451     # number of direct children of the root node in a graph is already larger than
1452     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1453 arta 1.1 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1454    
1455     DOT_GRAPH_MAX_NODES = 50
1456    
1457     # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1458     # graphs generated by dot. A depth value of 3 means that only nodes reachable
1459     # from the root by following a path via at most 3 edges will be shown. Nodes
1460     # that lay further from the root node will be omitted. Note that setting this
1461     # option to 1 or 2 may greatly reduce the computation time needed for large
1462     # code bases. Also note that the size of a graph can be further restricted by
1463     # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1464    
1465     MAX_DOT_GRAPH_DEPTH = 0
1466    
1467     # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1468 phil 1.13 # background. This is disabled by default, because dot on Windows does not
1469     # seem to support this out of the box. Warning: Depending on the platform used,
1470     # enabling this option may lead to badly anti-aliased labels on the edges of
1471     # a graph (i.e. they become hard to read).
1472 arta 1.1
1473 phil 1.13 DOT_TRANSPARENT = NO
1474 arta 1.1
1475     # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1476     # files in one run (i.e. multiple -o and -T options on the command line). This
1477     # makes dot run faster, but since only newer versions of dot (>1.8.10)
1478     # support this, this feature is disabled by default.
1479    
1480     DOT_MULTI_TARGETS = NO
1481    
1482     # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1483     # generate a legend page explaining the meaning of the various boxes and
1484     # arrows in the dot generated graphs.
1485    
1486     GENERATE_LEGEND = YES
1487    
1488     # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1489     # remove the intermediate dot files that are used to generate
1490     # the various graphs.
1491    
1492     DOT_CLEANUP = YES
1493    
1494     #---------------------------------------------------------------------------
1495     # Configuration::additions related to the search engine
1496     #---------------------------------------------------------------------------
1497    
1498     # The SEARCHENGINE tag specifies whether or not a search engine should be
1499     # used. If set to NO the values of all tags below this one will be ignored.
1500    
1501 karen 1.10 SEARCHENGINE = YES