/[escript]/trunk/doc/doxygen/doxygen_esys
ViewVC logotype

Diff of /trunk/doc/doxygen/doxygen_esys

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.3454  
changed lines
  Added in v.3991

  ViewVC Help
Powered by ViewVC 1.1.26