/[svn]/liblscp/trunk/doc/liblscp.doxygen.in
ViewVC logotype

Diff of /liblscp/trunk/doc/liblscp.doxygen.in

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

revision 3518 by capela, Fri Jun 4 14:32:51 2004 UTC revision 3519 by capela, Sun Jun 30 17:01:00 2019 UTC
# Line 1  Line 1 
1  # Doxyfile 1.3.6  # Doxyfile 1.8.11
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 double hash (##) is considered a comment and is placed in
7    # front of the TAG it is preceding.
8    #
9    # All text after a single hash (#) is considered a comment and will be ignored.
10  # The format is:  # The format is:
11  #       TAG = value [value, ...]  # TAG = value [value, ...]
12  # For lists items can also be appended using:  # For lists, items can also be appended using:
13  #       TAG += value [value, ...]  # TAG += value [value, ...]
14  # Values that contain spaces should be placed between quotes (" ")  # Values that contain spaces should be placed between quotes (\" \").
15    
16  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
17  # Project related configuration options  # Project related configuration options
18  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
19    
20  # The PROJECT_NAME tag is a single word (or a sequence of words surrounded  # This tag specifies the encoding used for all characters in the config file
21  # by quotes) that should identify the project.  # that follow. The default is UTF-8 which is also the encoding used for all text
22    # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23    # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24    # for the list of possible encodings.
25    # The default value is: UTF-8.
26    
27    DOXYFILE_ENCODING      = UTF-8
28    
29    # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30    # double-quotes, unless you are using Doxywizard) that should identify the
31    # project for which the documentation is generated. This name is used in the
32    # title of most generated pages and in a few other places.
33    # The default value is: My Project.
34    
35  PROJECT_NAME           = @PACKAGE@  PROJECT_NAME           = @PACKAGE@
36    
37  # 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. This
38  # This could be handy for archiving the generated documentation or  # could be handy for archiving the generated documentation or if some version
39  # if some version control system is used.  # control system is used.
40    
41  PROJECT_NUMBER         = @VERSION@  PROJECT_NUMBER         = @VERSION@
42    
43  # 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
44  # base path where the generated documentation will be put.  # for a project that appears at the top of each page and should give viewer a
45  # If a relative path is entered, it will be relative to the location  # quick idea about the purpose of the project. Keep the description short.
46  # where doxygen was started. If left blank the current directory will be used.  
47    PROJECT_BRIEF          =
48    
49    # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50    # in the documentation. The maximum height of the logo should not exceed 55
51    # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52    # the logo to the output directory.
53    
54    PROJECT_LOGO           =
55    
56    # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57    # into which the generated documentation will be written. If a relative path is
58    # entered, it will be relative to the location where doxygen was started. If
59    # left blank the current directory will be used.
60    
61  OUTPUT_DIRECTORY       = .  OUTPUT_DIRECTORY       = .
62    
63  # The OUTPUT_LANGUAGE tag is used to specify the language in which all  # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64  # documentation generated by doxygen is written. Doxygen will use this  # directories (in 2 levels) under the output directory of each output format and
65  # information to generate all constant output in the proper language.  # will distribute the generated files over these directories. Enabling this
66  # The default language is English, other supported languages are:  # option can be useful when feeding doxygen a huge amount of source files, where
67  # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,  # putting all generated files in the same directory would otherwise causes
68  # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en  # performance problems for the file system.
69  # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,  # The default value is: NO.
70  # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.  
71    CREATE_SUBDIRS         = NO
72    
73    # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74    # characters to appear in the names of generated files. If set to NO, non-ASCII
75    # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76    # U+3044.
77    # The default value is: NO.
78    
79    ALLOW_UNICODE_NAMES    = NO
80    
81    # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82    # documentation generated by doxygen is written. Doxygen will use this
83    # information to generate all constant output in the proper language.
84    # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85    # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86    # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87    # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88    # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89    # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90    # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91    # Ukrainian and Vietnamese.
92    # The default value is: English.
93    
94  OUTPUT_LANGUAGE        = English  OUTPUT_LANGUAGE        = English
95    
96  # This tag can be used to specify the encoding used in the generated output.  # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97  # The encoding is not always determined by the language that is chosen,  # descriptions after the members that are listed in the file and class
98  # but also whether or not the output is meant for Windows or non-Windows users.  # documentation (similar to Javadoc). Set to NO to disable this.
99  # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES  # The default value is: YES.
 # forces the Windows encoding (this is the default for the Windows binary),  
 # whereas setting the tag to NO uses a Unix-style encoding (the default for  
 # all platforms other than Windows).  
   
 USE_WINDOWS_ENCODING   = NO  
   
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
 # include brief member descriptions after the members that are listed in  
 # the file and class documentation (similar to JavaDoc).  
 # Set to NO to disable this.  
100    
101  BRIEF_MEMBER_DESC      = YES  BRIEF_MEMBER_DESC      = YES
102    
103  # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend  # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104  # the brief description of a member or function before the detailed description.  # description of a member or function before the detailed description
105  # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the  #
106    # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107  # brief descriptions will be completely suppressed.  # brief descriptions will be completely suppressed.
108    # The default value is: YES.
109    
110  REPEAT_BRIEF           = YES  REPEAT_BRIEF           = YES
111    
112  # This tag implements a quasi-intelligent brief description abbreviator  # This tag implements a quasi-intelligent brief description abbreviator that is
113  # that is used to form the text in various listings. Each string  # used to form the text in various listings. Each string in this list, if found
114  # in this list, if found as the leading text of the brief description, will be  # as the leading text of the brief description, will be stripped from the text
115  # stripped from the text and the result after processing the whole list, is used  # and the result, after processing the whole list, is used as the annotated
116  # as the annotated text. Otherwise, the brief description is used as-is. If left  # text. Otherwise, the brief description is used as-is. If left blank, the
117  # blank, the following values are used ("$name" is automatically replaced with the  # following values are used ($name is automatically replaced with the name of
118  # name of the entity): "The $name class" "The $name widget" "The $name file"  # the entity):The $name class, The $name widget, The $name file, is, provides,
119  # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"  # specifies, contains, represents, a, an and the.
120    
121  ABBREVIATE_BRIEF       =  ABBREVIATE_BRIEF       =
122    
123  # 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
124  # 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
125  # description.  # description.
126    # The default value is: NO.
127    
128  ALWAYS_DETAILED_SEC    = NO  ALWAYS_DETAILED_SEC    = NO
129    
130  # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited  # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131  # members of a class in the documentation of that class as if those members were  # inherited members of a class in the documentation of that class as if those
132  # ordinary class members. Constructors, destructors and assignment operators of  # members were ordinary class members. Constructors, destructors and assignment
133  # the base classes will not be shown.  # operators of the base classes will not be shown.
134    # The default value is: NO.
135    
136  INLINE_INHERITED_MEMB  = NO  INLINE_INHERITED_MEMB  = NO
137    
138  # 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, doxygen will prepend the full path
139  # path before files name in the file list and in the header files. If set  # before files name in the file list and in the header files. If set to NO the
140  # to NO the shortest path that makes the file name unique will be used.  # shortest path that makes the file name unique will be used
141    # The default value is: YES.
142    
143  FULL_PATH_NAMES        = NO  FULL_PATH_NAMES        = NO
144    
145  # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146  # can be used to strip a user-defined part of the path. Stripping is  # Stripping is only done if one of the specified strings matches the left-hand
147  # only done if one of the specified strings matches the left-hand part of  # part of the path. The tag can be used to show relative paths in the file list.
148  # the path. It is allowed to use relative paths in the argument list.  # If left blank the directory from which doxygen is run is used as the path to
149  # If left blank the directory from which doxygen is run is used as the  # strip.
150  # path to strip.  #
151    # Note that you can specify absolute paths here, but also relative paths, which
152  STRIP_FROM_PATH        =  # will be relative from the directory where doxygen is started.
153    # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154  # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter  
155  # (but less readable) file names. This can be useful is your file systems  STRIP_FROM_PATH        =
156  # doesn't support long names like on DOS, Mac, or CD-ROM.  
157    # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158    # path mentioned in the documentation of a class, which tells the reader which
159    # header file to include in order to use a class. If left blank only the name of
160    # the header file containing the class definition is used. Otherwise one should
161    # specify the list of include paths that are normally passed to the compiler
162    # using the -I flag.
163    
164    STRIP_FROM_INC_PATH    =
165    
166    # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167    # less readable) file names. This can be useful is your file systems doesn't
168    # support long names like on DOS, Mac, or CD-ROM.
169    # The default value is: NO.
170    
171  SHORT_NAMES            = NO  SHORT_NAMES            = NO
172    
173  # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174  # will interpret the first line (until the first dot) of a JavaDoc-style  # first line (until the first dot) of a Javadoc-style comment as the brief
175  # comment as the brief description. If set to NO, the JavaDoc  # description. If set to NO, the Javadoc-style will behave just like regular Qt-
176  # comments will behave just like the Qt-style comments (thus requiring an  # style comments (thus requiring an explicit @brief command for a brief
177  # explicit @brief command for a brief description.  # description.)
178    # The default value is: NO.
179    
180  JAVADOC_AUTOBRIEF      = NO  JAVADOC_AUTOBRIEF      = NO
181    
182  # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183  # treat a multi-line C++ special comment block (i.e. a block of //! or ///  # line (until the first dot) of a Qt-style comment as the brief description. If
184  # comments) as a brief description. This used to be the default behaviour.  # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185  # The new default is to treat a multi-line C++ comment block as a detailed  # requiring an explicit \brief command for a brief description.)
186  # description. Set this tag to YES if you prefer the old behaviour instead.  # The default value is: NO.
187    
188    QT_AUTOBRIEF           = NO
189    
190    # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191    # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192    # a brief description. This used to be the default behavior. The new default is
193    # to treat a multi-line C++ comment block as a detailed description. Set this
194    # tag to YES if you prefer the old behavior instead.
195    #
196    # Note that setting this tag to YES also means that rational rose comments are
197    # not recognized any more.
198    # The default value is: NO.
199    
200  MULTILINE_CPP_IS_BRIEF = NO  MULTILINE_CPP_IS_BRIEF = NO
201    
202  # If the DETAILS_AT_TOP tag is set to YES then Doxygen  # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203  # will output the detailed description near the top, like JavaDoc.  # documentation from any documented member that it re-implements.
204  # If set to NO, the detailed description appears after the member  # The default value is: YES.
 # 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  
 # re-implements.  
205    
206  INHERIT_DOCS           = YES  INHERIT_DOCS           = YES
207    
208  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209  # tag is set to YES, then doxygen will reuse the documentation of the first  # page for each member. If set to NO, the documentation of a member will be part
210  # member in the group (if any) for the other members of the group. By default  # of the file/class/namespace that contains it.
211  # all members of a group must be documented explicitly.  # The default value is: NO.
212    
213  DISTRIBUTE_GROUP_DOC   = NO  SEPARATE_MEMBER_PAGES  = NO
214    
215  # 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. Doxygen
216  # Doxygen uses this value to replace tabs by spaces in code fragments.  # uses this value to replace tabs by spaces in code fragments.
217    # Minimum value: 1, maximum value: 16, default value: 4.
218    
219  TAB_SIZE               = 4  TAB_SIZE               = 4
220    
221  # 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 act as commands in
222  # as commands in the documentation. An alias has the form "name=value".  # the documentation. An alias has the form:
223  # For example adding "sideeffect=\par Side Effects:\n" will allow you to  # name=value
224  # put the command \sideeffect (or @sideeffect) in the documentation, which  # For example adding
225  # will result in a user-defined paragraph with heading "Side Effects:".  # "sideeffect=@par Side Effects:\n"
226  # You can put \n's in the value part of an alias to insert newlines.  # will allow you to put the command \sideeffect (or @sideeffect) in the
227    # documentation, which will result in a user-defined paragraph with heading
228  ALIASES                =  # "Side Effects:". You can put \n's in the value part of an alias to insert
229    # newlines.
230  # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources  
231  # only. Doxygen will then generate output that is more tailored for C.  ALIASES                =
232  # For instance, some of the names that are used will be different. The list  
233  # of all members will be omitted, etc.  # This tag can be used to specify a number of word-keyword mappings (TCL only).
234    # A mapping has the form "name=value". For example adding "class=itcl::class"
235    # will allow you to use the command class in the itcl::class meaning.
236    
237    TCL_SUBST              =
238    
239    # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240    # only. Doxygen will then generate output that is more tailored for C. For
241    # instance, some of the names that are used will be different. The list of all
242    # members will be omitted, etc.
243    # The default value is: NO.
244    
245  OPTIMIZE_OUTPUT_FOR_C  = YES  OPTIMIZE_OUTPUT_FOR_C  = YES
246    
247  # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources  # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248  # only. Doxygen will then generate output that is more tailored for Java.  # Python sources only. Doxygen will then generate output that is more tailored
249  # For instance, namespaces will be presented as packages, qualified scopes  # for that language. For instance, namespaces will be presented as packages,
250  # will look different, etc.  # qualified scopes will look different, etc.
251    # The default value is: NO.
252    
253  OPTIMIZE_OUTPUT_JAVA   = NO  OPTIMIZE_OUTPUT_JAVA   = NO
254    
255  # Set the SUBGROUPING tag to YES (the default) to allow class member groups of  # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256  # the same type (for instance a group of public functions) to be put as a  # sources. Doxygen will then generate output that is tailored for Fortran.
257  # subgroup of that type (e.g. under the Public Functions section). Set it to  # The default value is: NO.
258  # NO to prevent subgrouping. Alternatively, this can be done per class using  
259  # the \nosubgrouping command.  OPTIMIZE_FOR_FORTRAN   = NO
260    
261    # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262    # sources. Doxygen will then generate output that is tailored for VHDL.
263    # The default value is: NO.
264    
265    OPTIMIZE_OUTPUT_VHDL   = NO
266    
267    # Doxygen selects the parser to use depending on the extension of the files it
268    # parses. With this tag you can assign which parser to use for a given
269    # extension. Doxygen has a built-in mapping, but you can override or extend it
270    # using this tag. The format is ext=language, where ext is a file extension, and
271    # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272    # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273    # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274    # Fortran. In the later case the parser tries to guess whether the code is fixed
275    # or free formatted code, this is the default for Fortran type files), VHDL. For
276    # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277    # and .f files as C (default is Fortran), use: inc=Fortran f=C.
278    #
279    # Note: For files without extension you can use no_extension as a placeholder.
280    #
281    # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282    # the files are not read by doxygen.
283    
284    EXTENSION_MAPPING      =
285    
286    # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287    # according to the Markdown format, which allows for more readable
288    # documentation. See http://daringfireball.net/projects/markdown/ for details.
289    # The output of markdown processing is further processed by doxygen, so you can
290    # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291    # case of backward compatibilities issues.
292    # The default value is: YES.
293    
294    MARKDOWN_SUPPORT       = YES
295    
296    # When enabled doxygen tries to link words that correspond to documented
297    # classes, or namespaces to their corresponding documentation. Such a link can
298    # be prevented in individual cases by putting a % sign in front of the word or
299    # globally by setting AUTOLINK_SUPPORT to NO.
300    # The default value is: YES.
301    
302    AUTOLINK_SUPPORT       = YES
303    
304    # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305    # to include (a tag file for) the STL sources as input, then you should set this
306    # tag to YES in order to let doxygen match functions declarations and
307    # definitions whose arguments contain STL classes (e.g. func(std::string);
308    # versus func(std::string) {}). This also make the inheritance and collaboration
309    # diagrams that involve STL classes more complete and accurate.
310    # The default value is: NO.
311    
312    BUILTIN_STL_SUPPORT    = NO
313    
314    # If you use Microsoft's C++/CLI language, you should set this option to YES to
315    # enable parsing support.
316    # The default value is: NO.
317    
318    CPP_CLI_SUPPORT        = NO
319    
320    # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321    # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322    # will parse them like normal C++ but will assume all classes use public instead
323    # of private inheritance when no explicit protection keyword is present.
324    # The default value is: NO.
325    
326    SIP_SUPPORT            = NO
327    
328    # For Microsoft's IDL there are propget and propput attributes to indicate
329    # getter and setter methods for a property. Setting this option to YES will make
330    # doxygen to replace the get and set methods by a property in the documentation.
331    # This will only work if the methods are indeed getting or setting a simple
332    # type. If this is not the case, or you want to show the methods anyway, you
333    # should set this option to NO.
334    # The default value is: YES.
335    
336    IDL_PROPERTY_SUPPORT   = YES
337    
338    # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339    # tag is set to YES then doxygen will reuse the documentation of the first
340    # member in the group (if any) for the other members of the group. By default
341    # all members of a group must be documented explicitly.
342    # The default value is: NO.
343    
344    DISTRIBUTE_GROUP_DOC   = NO
345    
346    # If one adds a struct or class to a group and this option is enabled, then also
347    # any nested class or struct is added to the same group. By default this option
348    # is disabled and one has to add nested compounds explicitly via \ingroup.
349    # The default value is: NO.
350    
351    GROUP_NESTED_COMPOUNDS = NO
352    
353    # Set the SUBGROUPING tag to YES to allow class member groups of the same type
354    # (for instance a group of public functions) to be put as a subgroup of that
355    # type (e.g. under the Public Functions section). Set it to NO to prevent
356    # subgrouping. Alternatively, this can be done per class using the
357    # \nosubgrouping command.
358    # The default value is: YES.
359    
360  SUBGROUPING            = YES  SUBGROUPING            = YES
361    
362    # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
363    # are shown inside the group in which they are included (e.g. using \ingroup)
364    # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
365    # and RTF).
366    #
367    # Note that this feature does not work in combination with
368    # SEPARATE_MEMBER_PAGES.
369    # The default value is: NO.
370    
371    INLINE_GROUPED_CLASSES = NO
372    
373    # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
374    # with only public data fields or simple typedef fields will be shown inline in
375    # the documentation of the scope in which they are defined (i.e. file,
376    # namespace, or group documentation), provided this scope is documented. If set
377    # to NO, structs, classes, and unions are shown on a separate page (for HTML and
378    # Man pages) or section (for LaTeX and RTF).
379    # The default value is: NO.
380    
381    INLINE_SIMPLE_STRUCTS  = NO
382    
383    # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
384    # enum is documented as struct, union, or enum with the name of the typedef. So
385    # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
386    # with name TypeT. When disabled the typedef will appear as a member of a file,
387    # namespace, or class. And the struct will be named TypeS. This can typically be
388    # useful for C code in case the coding convention dictates that all compound
389    # types are typedef'ed and only the typedef is referenced, never the tag name.
390    # The default value is: NO.
391    
392    TYPEDEF_HIDES_STRUCT   = NO
393    
394    # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
395    # cache is used to resolve symbols given their name and scope. Since this can be
396    # an expensive process and often the same symbol appears multiple times in the
397    # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398    # doxygen will become slower. If the cache is too large, memory is wasted. The
399    # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
400    # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
401    # symbols. At the end of a run doxygen will report the cache usage and suggest
402    # the optimal cache size from a speed point of view.
403    # Minimum value: 0, maximum value: 9, default value: 0.
404    
405    LOOKUP_CACHE_SIZE      = 0
406    
407  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
408  # Build related configuration options  # Build related configuration options
409  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
410    
411  # 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
412  # documentation are documented, even if no documentation was available.  # documentation are documented, even if no documentation was available. Private
413  # Private class members and static file members will be hidden unless  # class members and static file members will be hidden unless the
414  # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES  # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
415    # Note: This will also disable the warnings about undocumented members that are
416    # normally produced when WARNINGS is set to YES.
417    # The default value is: NO.
418    
419  EXTRACT_ALL            = YES  EXTRACT_ALL            = YES
420    
421  # 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 will
422  # will be included in the documentation.  # be included in the documentation.
423    # The default value is: NO.
424    
425  EXTRACT_PRIVATE        = NO  EXTRACT_PRIVATE        = NO
426    
427  # 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
428  # will be included in the documentation.  # scope will be included in the documentation.
429    # The default value is: NO.
430    
431    EXTRACT_PACKAGE        = NO
432    
433    # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
434    # included in the documentation.
435    # The default value is: NO.
436    
437  EXTRACT_STATIC         = NO  EXTRACT_STATIC         = NO
438    
439  # 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) defined
440  # defined locally in source files will be included in the documentation.  # locally in source files will be included in the documentation. If set to NO,
441  # If set to NO only classes defined in header files are included.  # only classes defined in header files are included. Does not have any effect
442    # for Java sources.
443    # The default value is: YES.
444    
445  EXTRACT_LOCAL_CLASSES  = YES  EXTRACT_LOCAL_CLASSES  = YES
446    
447  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  # This flag is only useful for Objective-C code. If set to YES, local methods,
448  # undocumented members of documented classes, files or namespaces.  # which are defined in the implementation section but not in the interface are
449  # If set to NO (the default) these members will be included in the  # included in the documentation. If set to NO, only methods in the interface are
450  # various overviews, but no documentation section is generated.  # included.
451  # This option has no effect if EXTRACT_ALL is enabled.  # The default value is: NO.
452    
453    EXTRACT_LOCAL_METHODS  = NO
454    
455    # If this flag is set to YES, the members of anonymous namespaces will be
456    # extracted and appear in the documentation as a namespace called
457    # 'anonymous_namespace{file}', where file will be replaced with the base name of
458    # the file that contains the anonymous namespace. By default anonymous namespace
459    # are hidden.
460    # The default value is: NO.
461    
462    EXTRACT_ANON_NSPACES   = NO
463    
464    # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
465    # undocumented members inside documented classes or files. If set to NO these
466    # members will be included in the various overviews, but no documentation
467    # section is generated. This option has no effect if EXTRACT_ALL is enabled.
468    # The default value is: NO.
469    
470  HIDE_UNDOC_MEMBERS     = NO  HIDE_UNDOC_MEMBERS     = NO
471    
472  # 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
473  # undocumented classes that are normally visible in the class hierarchy.  # undocumented classes that are normally visible in the class hierarchy. If set
474  # If set to NO (the default) these classes will be included in the various  # to NO, these classes will be included in the various overviews. This option
475  # overviews. This option has no effect if EXTRACT_ALL is enabled.  # has no effect if EXTRACT_ALL is enabled.
476    # The default value is: NO.
477    
478  HIDE_UNDOC_CLASSES     = NO  HIDE_UNDOC_CLASSES     = NO
479    
480  # 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 friend
481  # friend (class|struct|union) declarations.  # (class|struct|union) declarations. If set to NO, these declarations will be
482  # If set to NO (the default) these declarations will be included in the  # included in the documentation.
483  # documentation.  # The default value is: NO.
484    
485  HIDE_FRIEND_COMPOUNDS  = NO  HIDE_FRIEND_COMPOUNDS  = NO
486    
487  # 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
488  # documentation blocks found inside the body of a function.  # documentation blocks found inside the body of a function. If set to NO, these
489  # If set to NO (the default) these blocks will be appended to the  # blocks will be appended to the function's detailed documentation block.
490  # function's detailed documentation block.  # The default value is: NO.
491    
492  HIDE_IN_BODY_DOCS      = NO  HIDE_IN_BODY_DOCS      = NO
493    
494  # The INTERNAL_DOCS tag determines if documentation  # The INTERNAL_DOCS tag determines if documentation that is typed after a
495  # that is typed after a \internal command is included. If the tag is set  # \internal command is included. If the tag is set to NO then the documentation
496  # to NO (the default) then the documentation will be excluded.  # will be excluded. Set it to YES to include the internal documentation.
497  # Set it to YES to include the internal documentation.  # The default value is: NO.
498    
499  INTERNAL_DOCS          = NO  INTERNAL_DOCS          = NO
500    
501  # 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 file
502  # file names in lower-case letters. If set to YES upper-case letters are also  # names in lower-case letters. If set to YES, upper-case letters are also
503  # 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
504  # 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
505  # users are advised to set this option to NO.  # and Mac users are advised to set this option to NO.
506    # The default value is: system dependent.
507    
508  CASE_SENSE_NAMES       = YES  CASE_SENSE_NAMES       = YES
509    
510  # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen  # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
511  # will show members with their full class and namespace scopes in the  # their full class and namespace scopes in the documentation. If set to YES, the
512  # documentation. If set to YES the scope will be hidden.  # scope will be hidden.
513    # The default value is: NO.
514    
515  HIDE_SCOPE_NAMES       = NO  HIDE_SCOPE_NAMES       = NO
516    
517  # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
518  # will put a list of the files that are included by a file in the documentation  # append additional text to a page's title, such as Class Reference. If set to
519  # of that file.  # YES the compound reference will be hidden.
520    # The default value is: NO.
521    
522    HIDE_COMPOUND_REFERENCE= NO
523    
524    # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
525    # the files that are included by a file in the documentation of that file.
526    # The default value is: YES.
527    
528  SHOW_INCLUDE_FILES     = YES  SHOW_INCLUDE_FILES     = YES
529    
530  # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
531  # is inserted in the documentation for inline members.  # grouped member an include statement to the documentation, telling the reader
532    # which file to include in order to use the member.
533    # The default value is: NO.
534    
535    SHOW_GROUPED_MEMB_INC  = NO
536    
537    # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
538    # files with double quotes in the documentation rather than with sharp brackets.
539    # The default value is: NO.
540    
541    FORCE_LOCAL_INCLUDES   = NO
542    
543    # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
544    # documentation for inline members.
545    # The default value is: YES.
546    
547  INLINE_INFO            = YES  INLINE_INFO            = YES
548    
549  # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
550  # will sort the (detailed) documentation of file and class members  # (detailed) documentation of file and class members alphabetically by member
551  # alphabetically by member name. If set to NO the members will appear in  # name. If set to NO, the members will appear in declaration order.
552  # declaration order.  # The default value is: YES.
553    
554  SORT_MEMBER_DOCS       = YES  SORT_MEMBER_DOCS       = YES
555    
556  # 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 brief
557  # brief documentation of file, namespace and class members alphabetically  # descriptions of file, namespace and class members alphabetically by member
558  # by member name. If set to NO (the default) the members will appear in  # name. If set to NO, the members will appear in declaration order. Note that
559  # declaration order.  # this will also influence the order of the classes in the class list.
560    # The default value is: NO.
561    
562  SORT_BRIEF_DOCS        = NO  SORT_BRIEF_DOCS        = NO
563    
564  # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be  # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
565  # sorted by fully-qualified names, including namespaces. If set to  # (brief and detailed) documentation of class members so that constructors and
566  # NO (the default), the class list will be sorted only by class name,  # destructors are listed first. If set to NO the constructors will appear in the
567  # not including the namespace part.  # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
568    # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
569    # member documentation.
570    # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
571    # detailed member documentation.
572    # The default value is: NO.
573    
574    SORT_MEMBERS_CTORS_1ST = NO
575    
576    # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577    # of group names into alphabetical order. If set to NO the group names will
578    # appear in their defined order.
579    # The default value is: NO.
580    
581    SORT_GROUP_NAMES       = NO
582    
583    # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584    # fully-qualified names, including namespaces. If set to NO, the class list will
585    # be sorted only by class name, not including the namespace part.
586  # 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.
587  # Note: This option applies only to the class list, not to the  # Note: This option applies only to the class list, not to the alphabetical
588  # alphabetical list.  # list.
589    # The default value is: NO.
590    
591  SORT_BY_SCOPE_NAME     = NO  SORT_BY_SCOPE_NAME     = NO
592    
593  # The GENERATE_TODOLIST tag can be used to enable (YES) or  # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
594  # disable (NO) the todo list. This list is created by putting \todo  # type resolution of all parameters of a function it will reject a match between
595  # commands in the documentation.  # the prototype and the implementation of a member function even if there is
596    # only one candidate or it is obvious which candidate to choose by doing a
597    # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
598    # accept a match between prototype and implementation in such cases.
599    # The default value is: NO.
600    
601    STRICT_PROTO_MATCHING  = NO
602    
603    # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
604    # list. This list is created by putting \todo commands in the documentation.
605    # The default value is: YES.
606    
607  GENERATE_TODOLIST      = YES  GENERATE_TODOLIST      = YES
608    
609  # The GENERATE_TESTLIST tag can be used to enable (YES) or  # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
610  # disable (NO) the test list. This list is created by putting \test  # list. This list is created by putting \test commands in the documentation.
611  # commands in the documentation.  # The default value is: YES.
612    
613  GENERATE_TESTLIST      = YES  GENERATE_TESTLIST      = YES
614    
615  # The GENERATE_BUGLIST tag can be used to enable (YES) or  # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
616  # disable (NO) the bug list. This list is created by putting \bug  # list. This list is created by putting \bug commands in the documentation.
617  # commands in the documentation.  # The default value is: YES.
618    
619  GENERATE_BUGLIST       = YES  GENERATE_BUGLIST       = YES
620    
621  # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or  # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
622  # disable (NO) the deprecated list. This list is created by putting  # the deprecated list. This list is created by putting \deprecated commands in
623  # \deprecated commands in the documentation.  # the documentation.
624    # The default value is: YES.
625    
626  GENERATE_DEPRECATEDLIST= YES  GENERATE_DEPRECATEDLIST= YES
627    
628  # The ENABLED_SECTIONS tag can be used to enable conditional  # The ENABLED_SECTIONS tag can be used to enable conditional documentation
629  # documentation sections, marked by \if sectionname ... \endif.  # sections, marked by \if <section_label> ... \endif and \cond <section_label>
630    # ... \endcond blocks.
631  ENABLED_SECTIONS       =  
632    ENABLED_SECTIONS       =
633  # The MAX_INITIALIZER_LINES tag determines the maximum number of lines  
634  # the initial value of a variable or define consists of for it to appear in  # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
635  # the documentation. If the initializer consists of more lines than specified  # initial value of a variable or macro / define can have for it to appear in the
636  # here it will be hidden. Use a value of 0 to hide initializers completely.  # documentation. If the initializer consists of more lines than specified here
637  # The appearance of the initializer of individual variables and defines in the  # it will be hidden. Use a value of 0 to hide initializers completely. The
638  # documentation can be controlled using \showinitializer or \hideinitializer  # appearance of the value of individual variables and macros / defines can be
639  # command in the documentation regardless of this setting.  # controlled using \showinitializer or \hideinitializer command in the
640    # documentation regardless of this setting.
641    # Minimum value: 0, maximum value: 10000, default value: 30.
642    
643  MAX_INITIALIZER_LINES  = 30  MAX_INITIALIZER_LINES  = 30
644    
645  # 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 at
646  # at the bottom of the documentation of classes and structs. If set to YES the  # the bottom of the documentation of classes and structs. If set to YES, the
647  # list will mention the files that were used to generate the documentation.  # list will mention the files that were used to generate the documentation.
648    # The default value is: YES.
649    
650  SHOW_USED_FILES        = YES  SHOW_USED_FILES        = YES
651    
652    # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
653    # will remove the Files entry from the Quick Index and from the Folder Tree View
654    # (if specified).
655    # The default value is: YES.
656    
657    SHOW_FILES             = YES
658    
659    # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
660    # page. This will remove the Namespaces entry from the Quick Index and from the
661    # Folder Tree View (if specified).
662    # The default value is: YES.
663    
664    SHOW_NAMESPACES        = YES
665    
666    # The FILE_VERSION_FILTER tag can be used to specify a program or script that
667    # doxygen should invoke to get the current version for each file (typically from
668    # the version control system). Doxygen will invoke the program by executing (via
669    # popen()) the command command input-file, where command is the value of the
670    # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
671    # by doxygen. Whatever the program writes to standard output is used as the file
672    # version. For an example see the documentation.
673    
674    FILE_VERSION_FILTER    =
675    
676    # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
677    # by doxygen. The layout file controls the global structure of the generated
678    # output files in an output format independent way. To create the layout file
679    # that represents doxygen's defaults, run doxygen with the -l option. You can
680    # optionally specify a file name after the option, if omitted DoxygenLayout.xml
681    # will be used as the name of the layout file.
682    #
683    # Note that if you run doxygen from a directory containing a file called
684    # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
685    # tag is left empty.
686    
687    LAYOUT_FILE            =
688    
689    # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
690    # the reference definitions. This must be a list of .bib files. The .bib
691    # extension is automatically appended if omitted. This requires the bibtex tool
692    # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
693    # For LaTeX the style of the bibliography can be controlled using
694    # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
695    # search path. See also \cite for info how to create references.
696    
697    CITE_BIB_FILES         =
698    
699  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
700  # configuration options related to warning and progress messages  # Configuration options related to warning and progress messages
701  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
702    
703  # 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 to
704  # by doxygen. Possible values are YES and NO. If left blank NO is used.  # standard output by doxygen. If QUIET is set to YES this implies that the
705    # messages are off.
706    # The default value is: NO.
707    
708  QUIET                  = NO  QUIET                  = NO
709    
710  # 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
711  # generated by doxygen. Possible values are YES and NO. If left blank  # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
712  # NO is used.  # this implies that the warnings are on.
713    #
714    # Tip: Turn warnings on while writing the documentation.
715    # The default value is: YES.
716    
717  WARNINGS               = YES  WARNINGS               = YES
718    
719  # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720  # for undocumented members. If EXTRACT_ALL is set to YES then this flag will  # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
721  # automatically be disabled.  # will automatically be disabled.
722    # The default value is: YES.
723    
724  WARN_IF_UNDOCUMENTED   = YES  WARN_IF_UNDOCUMENTED   = YES
725    
726  # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for  # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
727  # potential errors in the documentation, such as not documenting some  # potential errors in the documentation, such as not documenting some parameters
728  # parameters in a documented function, or documenting parameters that  # in a documented function, or documenting parameters that don't exist or using
729  # don't exist or using markup commands wrongly.  # markup commands wrongly.
730    # The default value is: YES.
731    
732  WARN_IF_DOC_ERROR      = YES  WARN_IF_DOC_ERROR      = YES
733    
734  # The WARN_FORMAT tag determines the format of the warning messages that  # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
735  # doxygen can produce. The string should contain the $file, $line, and $text  # are documented, but have no documentation for their parameters or return
736  # tags, which will be replaced by the file and line number from which the  # value. If set to NO, doxygen will only warn about wrong or incomplete
737  # warning originated and the warning text.  # parameter documentation, but not about the absence of documentation.
738    # The default value is: NO.
739    
740    WARN_NO_PARAMDOC       = NO
741    
742    # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
743    # a warning is encountered.
744    # The default value is: NO.
745    
746    WARN_AS_ERROR          = NO
747    
748    # The WARN_FORMAT tag determines the format of the warning messages that doxygen
749    # can produce. The string should contain the $file, $line, and $text tags, which
750    # will be replaced by the file and line number from which the warning originated
751    # and the warning text. Optionally the format may contain $version, which will
752    # be replaced by the version of the file (if it could be obtained via
753    # FILE_VERSION_FILTER)
754    # The default value is: $file:$line: $text.
755    
756  WARN_FORMAT            = "$file:$line: $text"  WARN_FORMAT            = "$file:$line: $text"
757    
758  # 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 and error
759  # and error messages should be written. If left blank the output is written  # messages should be written. If left blank the output is written to standard
760  # to stderr.  # error (stderr).
761    
762  WARN_LOGFILE           =  WARN_LOGFILE           =
763    
764  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
765  # configuration options related to the input files  # Configuration options related to the input files
766  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
767    
768  # The INPUT tag can be used to specify the files and/or directories that contain  # The INPUT tag is used to specify the files and/or directories that contain
769  # documented source files. You may enter file names like "myfile.cpp" or  # documented source files. You may enter file names like myfile.cpp or
770  # directories like "/usr/src/myproject". Separate the files or directories  # directories like /usr/src/myproject. Separate the files or directories with
771  # with spaces.  # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
772    # Note: If this tag is empty the current directory is searched.
773    
774  INPUT                  = @top_srcdir@  INPUT                  = @top_srcdir@
775    
776  # If the value of the INPUT tag contains directories, you can use the  # This tag can be used to specify the character encoding of the source files
777  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
778  # and *.h) to filter out the source-files in the directories. If left  # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
779  # blank the following patterns are tested:  # documentation (see: http://www.gnu.org/software/libiconv) for the list of
780  # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp  # possible encodings.
781  # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc  # The default value is: UTF-8.
782    
783  FILE_PATTERNS          = *.dox *.h *.c  INPUT_ENCODING         = UTF-8
784    
785  # The RECURSIVE tag can be used to turn specify whether or not subdirectories  # If the value of the INPUT tag contains directories, you can use the
786  # should be searched for input files as well. Possible values are YES and NO.  # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
787  # If left blank NO is used.  # *.h) to filter out the source-files in the directories.
788    #
789    # Note that for custom extensions or not directly supported extensions you also
790    # need to set EXTENSION_MAPPING for the extension otherwise the files are not
791    # read by doxygen.
792    #
793    # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
794    # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
795    # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
796    # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
797    # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
798    
799    FILE_PATTERNS          = *.dox \
800                             *.h \
801                             *.c
802    
803    # The RECURSIVE tag can be used to specify whether or not subdirectories should
804    # be searched for input files as well.
805    # The default value is: NO.
806    
807  RECURSIVE              = YES  RECURSIVE              = YES
808    
809  # 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
810  # 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
811  # 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.
812    #
813    # Note that relative paths are relative to the directory from which doxygen is
814    # run.
815    
816  EXCLUDE                = common.h common.c  EXCLUDE                = common.h \
817                             common.c
818    
819  # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories  # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
820  # that are symbolic links (a Unix filesystem feature) are excluded from the input.  # directories that are symbolic links (a Unix file system feature) are excluded
821    # from the input.
822    # The default value is: NO.
823    
824  EXCLUDE_SYMLINKS       = NO  EXCLUDE_SYMLINKS       = NO
825    
826  # 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
827  # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
828  # certain files from those directories.  # certain files from those directories.
829    #
830    # Note that the wildcards are matched against the file with absolute path, so to
831    # exclude all test directories for example use the pattern */test/*
832    
833    EXCLUDE_PATTERNS       =
834    
835  EXCLUDE_PATTERNS       =  # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
836    # (namespaces, classes, functions, etc.) that should be excluded from the
837    # output. The symbol name can be a fully qualified name, a word, or if the
838    # wildcard * is used, a substring. Examples: ANamespace, AClass,
839    # AClass::ANamespace, ANamespace::*Test
840    #
841    # Note that the wildcards are matched against the file with absolute path, so to
842    # exclude all test directories use the pattern */test/*
843    
844    EXCLUDE_SYMBOLS        =
845    
846  # 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 directories
847  # directories that contain example code fragments that are included (see  # that contain example code fragments that are included (see the \include
848  # the \include command).  # command).
849    
850  EXAMPLE_PATH           = @top_srcdir@/examples  EXAMPLE_PATH           = @top_srcdir@/examples
851    
852  # 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
853  # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
854  # and *.h) to filter out the source-files in the directories. If left  # *.h) to filter out the source-files in the directories. If left blank all
855  # blank all files are included.  # files are included.
856    
857  EXAMPLE_PATTERNS       = *.h *.c  EXAMPLE_PATTERNS       = *.h \
858                             *.c
859  # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be  
860  # searched for input files to be used with the \include or \dontinclude  # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
861  # commands irrespective of the value of the RECURSIVE tag.  # searched for input files to be used with the \include or \dontinclude commands
862  # Possible values are YES and NO. If left blank NO is used.  # irrespective of the value of the RECURSIVE tag.
863    # The default value is: NO.
864    
865  EXAMPLE_RECURSIVE      = NO  EXAMPLE_RECURSIVE      = NO
866    
867  # 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 directories
868  # directories that contain image that are included in the documentation (see  # that contain images that are to be included in the documentation (see the
869  # the \image command).  # \image command).
870    
871  IMAGE_PATH             =  IMAGE_PATH             =
872    
873  # 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
874  # 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
875  # by executing (via popen()) the command <filter> <input-file>, where <filter>  # by executing (via popen()) the command:
876  # is the value of the INPUT_FILTER tag, and <input-file> is the name of an  #
877  # input file. Doxygen will then use the output that the filter program writes  # <filter> <input-file>
878  # to standard output.  #
879    # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
880  INPUT_FILTER           =  # name of an input file. Doxygen will then use the output that the filter
881    # program writes to standard output. If FILTER_PATTERNS is specified, this tag
882  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  # will be ignored.
883  # INPUT_FILTER) will be used to filter the input files when producing source  #
884  # files to browse (i.e. when SOURCE_BROWSER is set to YES).  # Note that the filter must not add or remove lines; it is applied before the
885    # code is scanned, but not when the output code is generated. If lines are added
886    # or removed, the anchors will not be placed correctly.
887    #
888    # Note that for custom extensions or not directly supported extensions you also
889    # need to set EXTENSION_MAPPING for the extension otherwise the files are not
890    # properly processed by doxygen.
891    
892    INPUT_FILTER           =
893    
894    # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
895    # basis. Doxygen will compare the file name with each pattern and apply the
896    # filter if there is a match. The filters are a list of the form: pattern=filter
897    # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
898    # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
899    # patterns match the file name, INPUT_FILTER is applied.
900    #
901    # Note that for custom extensions or not directly supported extensions you also
902    # need to set EXTENSION_MAPPING for the extension otherwise the files are not
903    # properly processed by doxygen.
904    
905    FILTER_PATTERNS        =
906    
907    # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
908    # INPUT_FILTER) will also be used to filter the input files that are used for
909    # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
910    # The default value is: NO.
911    
912  FILTER_SOURCE_FILES    = NO  FILTER_SOURCE_FILES    = NO
913    
914    # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
915    # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
916    # it is also possible to disable source filtering for a specific pattern using
917    # *.ext= (so without naming a filter).
918    # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
919    
920    FILTER_SOURCE_PATTERNS =
921    
922    # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
923    # is part of the input, its contents will be placed on the main page
924    # (index.html). This can be useful if you have a project on for instance GitHub
925    # and want to reuse the introduction page also for the doxygen output.
926    
927    USE_MDFILE_AS_MAINPAGE =
928    
929  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
930  # configuration options related to source browsing  # Configuration options related to source browsing
931  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
932    
933  # 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 be
934  # be generated. Documented entities will be cross-referenced with these sources.  # generated. Documented entities will be cross-referenced with these sources.
935  # Note: To get rid of all source code in the generated output, make sure also  #
936  # VERBATIM_HEADERS is set to NO.  # Note: To get rid of all source code in the generated output, make sure that
937    # also VERBATIM_HEADERS is set to NO.
938    # The default value is: NO.
939    
940  SOURCE_BROWSER         = NO  SOURCE_BROWSER         = NO
941    
942  # Setting the INLINE_SOURCES tag to YES will include the body  # Setting the INLINE_SOURCES tag to YES will include the body of functions,
943  # of functions and classes directly in the documentation.  # classes and enums directly into the documentation.
944    # The default value is: NO.
945    
946  INLINE_SOURCES         = NO  INLINE_SOURCES         = NO
947    
948  # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
949  # doxygen to hide any special comment blocks from generated source code  # special comment blocks from generated source code fragments. Normal C, C++ and
950  # fragments. Normal C and C++ comments will always remain visible.  # Fortran comments will always remain visible.
951    # The default value is: YES.
952    
953  STRIP_CODE_COMMENTS    = YES  STRIP_CODE_COMMENTS    = YES
954    
955  # If the REFERENCED_BY_RELATION tag is set to YES (the default)  # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
956  # then for each documented function all documented  # function all documented functions referencing it will be listed.
957  # functions referencing it will be listed.  # The default value is: NO.
958    
959  REFERENCED_BY_RELATION = YES  REFERENCED_BY_RELATION = YES
960    
961  # If the REFERENCES_RELATION tag is set to YES (the default)  # If the REFERENCES_RELATION tag is set to YES then for each documented function
962  # then for each documented function all documented entities  # all documented entities called/used by that function will be listed.
963  # called/used by that function will be listed.  # The default value is: NO.
964    
965  REFERENCES_RELATION    = YES  REFERENCES_RELATION    = YES
966    
967  # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
968  # will generate a verbatim copy of the header file for each class for  # to YES then the hyperlinks from functions in REFERENCES_RELATION and
969  # which an include is specified. Set to NO to disable this.  # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
970    # link to the documentation.
971    # The default value is: YES.
972    
973    REFERENCES_LINK_SOURCE = YES
974    
975    # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
976    # source code will show a tooltip with additional information such as prototype,
977    # brief description and links to the definition and documentation. Since this
978    # will make the HTML file larger and loading of large files a bit slower, you
979    # can opt to disable this feature.
980    # The default value is: YES.
981    # This tag requires that the tag SOURCE_BROWSER is set to YES.
982    
983    SOURCE_TOOLTIPS        = YES
984    
985    # If the USE_HTAGS tag is set to YES then the references to source code will
986    # point to the HTML generated by the htags(1) tool instead of doxygen built-in
987    # source browser. The htags tool is part of GNU's global source tagging system
988    # (see http://www.gnu.org/software/global/global.html). You will need version
989    # 4.8.6 or higher.
990    #
991    # To use it do the following:
992    # - Install the latest version of global
993    # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
994    # - Make sure the INPUT points to the root of the source tree
995    # - Run doxygen as normal
996    #
997    # Doxygen will invoke htags (and that will in turn invoke gtags), so these
998    # tools must be available from the command line (i.e. in the search path).
999    #
1000    # The result: instead of the source browser generated by doxygen, the links to
1001    # source code will now point to the output of htags.
1002    # The default value is: NO.
1003    # This tag requires that the tag SOURCE_BROWSER is set to YES.
1004    
1005    USE_HTAGS              = NO
1006    
1007    # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1008    # verbatim copy of the header file for each class for which an include is
1009    # specified. Set to NO to disable this.
1010    # See also: Section \class.
1011    # The default value is: YES.
1012    
1013  VERBATIM_HEADERS       = YES  VERBATIM_HEADERS       = YES
1014    
1015    # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1016    # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1017    # cost of reduced performance. This can be particularly helpful with template
1018    # rich C++ code for which doxygen's built-in parser lacks the necessary type
1019    # information.
1020    # Note: The availability of this option depends on whether or not doxygen was
1021    # generated with the -Duse-libclang=ON option for CMake.
1022    # The default value is: NO.
1023    
1024    CLANG_ASSISTED_PARSING = NO
1025    
1026    # If clang assisted parsing is enabled you can provide the compiler with command
1027    # line options that you would normally use when invoking the compiler. Note that
1028    # the include paths will already be set by doxygen for the files and directories
1029    # specified with INPUT and INCLUDE_PATH.
1030    # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1031    
1032    CLANG_OPTIONS          =
1033    
1034  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1035  # configuration options related to the alphabetical class index  # Configuration options related to the alphabetical class index
1036  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1037    
1038  # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1039  # of all compounds will be generated. Enable this if the project  # compounds will be generated. Enable this if the project contains a lot of
1040  # contains a lot of classes, structs, unions or interfaces.  # classes, structs, unions or interfaces.
1041    # The default value is: YES.
1042    
1043  ALPHABETICAL_INDEX     = NO  ALPHABETICAL_INDEX     = NO
1044    
1045  # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1046  # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  # which the alphabetical index list will be split.
1047  # in which this list will be split (can be a number in the range [1..20])  # Minimum value: 1, maximum value: 20, default value: 5.
1048    # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1049    
1050  COLS_IN_ALPHA_INDEX    = 5  COLS_IN_ALPHA_INDEX    = 5
1051    
1052  # 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 classes will
1053  # classes will be put under the same header in the alphabetical index.  # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1054  # The IGNORE_PREFIX tag can be used to specify one or more prefixes that  # can be used to specify a prefix (or a list of prefixes) that should be ignored
1055  # should be ignored while generating the index headers.  # while generating the index headers.
1056    # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1057    
1058  IGNORE_PREFIX          =  IGNORE_PREFIX          =
1059    
1060  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1061  # configuration options related to the HTML output  # Configuration options related to the HTML output
1062  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1063    
1064  # If the GENERATE_HTML tag is set to YES (the default) Doxygen will  # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1065  # generate HTML output.  # The default value is: YES.
1066    
1067  GENERATE_HTML          = YES  GENERATE_HTML          = YES
1068    
1069  # 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. If a
1070  # If a relative path is entered the value of OUTPUT_DIRECTORY will be  # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1071  # put in front of it. If left blank `html' will be used as the default path.  # it.
1072    # The default directory is: html.
1073    # This tag requires that the tag GENERATE_HTML is set to YES.
1074    
1075  HTML_OUTPUT            = html  HTML_OUTPUT            = html
1076    
1077  # 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 each
1078  # each generated HTML page (for example: .htm,.php,.asp). If it is left blank  # generated HTML page (for example: .htm, .php, .asp).
1079  # doxygen will generate files with .html extension.  # The default value is: .html.
1080    # This tag requires that the tag GENERATE_HTML is set to YES.
1081    
1082  HTML_FILE_EXTENSION    = .html  HTML_FILE_EXTENSION    = .html
1083    
1084  # The HTML_HEADER tag can be used to specify a personal HTML header for  # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1085  # each generated HTML page. If it is left blank doxygen will generate a  # each generated HTML page. If the tag is left blank doxygen will generate a
1086  # standard header.  # standard header.
1087    #
1088    # To get valid HTML the header file that includes any scripts and style sheets
1089    # that doxygen needs, which is dependent on the configuration options used (e.g.
1090    # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1091    # default header using
1092    # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1093    # YourConfigFile
1094    # and then modify the file new_header.html. See also section "Doxygen usage"
1095    # for information on how to generate the default header that doxygen normally
1096    # uses.
1097    # Note: The header is subject to change so you typically have to regenerate the
1098    # default header when upgrading to a newer version of doxygen. For a description
1099    # of the possible markers and block names see the documentation.
1100    # This tag requires that the tag GENERATE_HTML is set to YES.
1101    
1102    HTML_HEADER            =
1103    
1104    # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1105    # generated HTML page. If the tag is left blank doxygen will generate a standard
1106    # footer. See HTML_HEADER for more information on how to generate a default
1107    # footer and what special commands can be used inside the footer. See also
1108    # section "Doxygen usage" for information on how to generate the default footer
1109    # that doxygen normally uses.
1110    # This tag requires that the tag GENERATE_HTML is set to YES.
1111    
1112    HTML_FOOTER            =
1113    
1114    # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1115    # sheet that is used by each HTML page. It can be used to fine-tune the look of
1116    # the HTML output. If left blank doxygen will generate a default style sheet.
1117    # See also section "Doxygen usage" for information on how to generate the style
1118    # sheet that doxygen normally uses.
1119    # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1120    # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1121    # obsolete.
1122    # This tag requires that the tag GENERATE_HTML is set to YES.
1123    
1124    HTML_STYLESHEET        =
1125    
1126    # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1127    # cascading style sheets that are included after the standard style sheets
1128    # created by doxygen. Using this option one can overrule certain style aspects.
1129    # This is preferred over using HTML_STYLESHEET since it does not replace the
1130    # standard style sheet and is therefore more robust against future updates.
1131    # Doxygen will copy the style sheet files to the output directory.
1132    # Note: The order of the extra style sheet files is of importance (e.g. the last
1133    # style sheet in the list overrules the setting of the previous ones in the
1134    # list). For an example see the documentation.
1135    # This tag requires that the tag GENERATE_HTML is set to YES.
1136    
1137    HTML_EXTRA_STYLESHEET  =
1138    
1139    # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1140    # other source files which should be copied to the HTML output directory. Note
1141    # that these files will be copied to the base HTML output directory. Use the
1142    # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1143    # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1144    # files will be copied as-is; there are no commands or markers available.
1145    # This tag requires that the tag GENERATE_HTML is set to YES.
1146    
1147    HTML_EXTRA_FILES       =
1148    
1149    # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1150    # will adjust the colors in the style sheet and background images according to
1151    # this color. Hue is specified as an angle on a colorwheel, see
1152    # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1153    # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1154    # purple, and 360 is red again.
1155    # Minimum value: 0, maximum value: 359, default value: 220.
1156    # This tag requires that the tag GENERATE_HTML is set to YES.
1157    
1158    HTML_COLORSTYLE_HUE    = 220
1159    
1160    # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1161    # in the HTML output. For a value of 0 the output will use grayscales only. A
1162    # value of 255 will produce the most vivid colors.
1163    # Minimum value: 0, maximum value: 255, default value: 100.
1164    # This tag requires that the tag GENERATE_HTML is set to YES.
1165    
1166    HTML_COLORSTYLE_SAT    = 100
1167    
1168    # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1169    # luminance component of the colors in the HTML output. Values below 100
1170    # gradually make the output lighter, whereas values above 100 make the output
1171    # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1172    # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1173    # change the gamma.
1174    # Minimum value: 40, maximum value: 240, default value: 80.
1175    # This tag requires that the tag GENERATE_HTML is set to YES.
1176    
1177    HTML_COLORSTYLE_GAMMA  = 80
1178    
1179    # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1180    # page will contain the date and time when the page was generated. Setting this
1181    # to YES can help to show when doxygen was last run and thus if the
1182    # documentation is up to date.
1183    # The default value is: NO.
1184    # This tag requires that the tag GENERATE_HTML is set to YES.
1185    
1186    HTML_TIMESTAMP         = NO
1187    
1188    # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1189    # documentation will contain sections that can be hidden and shown after the
1190    # page has loaded.
1191    # The default value is: NO.
1192    # This tag requires that the tag GENERATE_HTML is set to YES.
1193    
1194    HTML_DYNAMIC_SECTIONS  = NO
1195    
1196    # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1197    # shown in the various tree structured indices initially; the user can expand
1198    # and collapse entries dynamically later on. Doxygen will expand the tree to
1199    # such a level that at most the specified number of entries are visible (unless
1200    # a fully collapsed tree already exceeds this amount). So setting the number of
1201    # entries 1 will produce a full collapsed tree by default. 0 is a special value
1202    # representing an infinite number of entries and will result in a full expanded
1203    # tree by default.
1204    # Minimum value: 0, maximum value: 9999, default value: 100.
1205    # This tag requires that the tag GENERATE_HTML is set to YES.
1206    
1207    HTML_INDEX_NUM_ENTRIES = 100
1208    
1209    # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1210    # generated that can be used as input for Apple's Xcode 3 integrated development
1211    # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1212    # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1213    # Makefile in the HTML output directory. Running make will produce the docset in
1214    # that directory and running make install will install the docset in
1215    # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1216    # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1217    # for more information.
1218    # The default value is: NO.
1219    # This tag requires that the tag GENERATE_HTML is set to YES.
1220    
1221    GENERATE_DOCSET        = NO
1222    
1223    # This tag determines the name of the docset feed. A documentation feed provides
1224    # an umbrella under which multiple documentation sets from a single provider
1225    # (such as a company or product suite) can be grouped.
1226    # The default value is: Doxygen generated docs.
1227    # This tag requires that the tag GENERATE_DOCSET is set to YES.
1228    
1229    DOCSET_FEEDNAME        = "Doxygen generated docs"
1230    
1231    # This tag specifies a string that should uniquely identify the documentation
1232    # set bundle. This should be a reverse domain-name style string, e.g.
1233    # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1234    # The default value is: org.doxygen.Project.
1235    # This tag requires that the tag GENERATE_DOCSET is set to YES.
1236    
1237    DOCSET_BUNDLE_ID       = org.doxygen.Project
1238    
1239    # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1240    # the documentation publisher. This should be a reverse domain-name style
1241    # string, e.g. com.mycompany.MyDocSet.documentation.
1242    # The default value is: org.doxygen.Publisher.
1243    # This tag requires that the tag GENERATE_DOCSET is set to YES.
1244    
1245    DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1246    
1247    # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1248    # The default value is: Publisher.
1249    # This tag requires that the tag GENERATE_DOCSET is set to YES.
1250    
1251    DOCSET_PUBLISHER_NAME  = Publisher
1252    
1253    # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1254    # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1255    # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1256    # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1257    # Windows.
1258    #
1259    # The HTML Help Workshop contains a compiler that can convert all HTML output
1260    # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1261    # files are now used as the Windows 98 help format, and will replace the old
1262    # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1263    # HTML files also contain an index, a table of contents, and you can search for
1264    # words in the documentation. The HTML workshop also contains a viewer for
1265    # compressed HTML files.
1266    # The default value is: NO.
1267    # This tag requires that the tag GENERATE_HTML is set to YES.
1268    
1269  HTML_HEADER            =  GENERATE_HTMLHELP      = NO
1270    
1271  # The HTML_FOOTER tag can be used to specify a personal HTML footer for  # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1272  # each generated HTML page. If it is left blank doxygen will generate a  # file. You can add a path in front of the file if the result should not be
1273  # standard footer.  # written to the html output directory.
1274    # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1275    
1276  HTML_FOOTER            =  CHM_FILE               =
1277    
1278  # The HTML_STYLESHEET tag can be used to specify a user-defined cascading  # The HHC_LOCATION tag can be used to specify the location (absolute path
1279  # style sheet that is used by each HTML page. It can be used to  # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1280  # fine-tune the look of the HTML output. If the tag is left blank doxygen  # doxygen will try to run the HTML help compiler on the generated index.hhp.
1281  # will generate a default style sheet. Note that doxygen will try to copy  # The file has to be specified with full path.
1282  # the style sheet file to the HTML output directory, so don't put your own  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1283  # stylesheet in the HTML output directory as well, or it will be erased!  
1284    HHC_LOCATION           =
1285    
1286    # The GENERATE_CHI flag controls if a separate .chi index file is generated
1287    # (YES) or that it should be included in the master .chm file (NO).
1288    # The default value is: NO.
1289    # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1290    
1291  HTML_STYLESHEET        =  GENERATE_CHI           = NO
1292    
1293  # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1294  # files or namespaces will be aligned in HTML using tables. If set to  # and project file content.
1295  # NO a bullet list will be used.  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1296    
1297    CHM_INDEX_ENCODING     =
1298    
1299    # The BINARY_TOC flag controls whether a binary table of contents is generated
1300    # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1301    # enables the Previous and Next buttons.
1302    # The default value is: NO.
1303    # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1304    
1305  HTML_ALIGN_MEMBERS     = YES  BINARY_TOC             = NO
1306    
1307  # If the GENERATE_HTMLHELP tag is set to YES, additional index files  # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1308  # will be generated that can be used as input for tools like the  # the table of contents of the HTML help documentation and to the tree view.
1309  # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  # The default value is: NO.
1310  # of the generated HTML documentation.  # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1311    
1312  GENERATE_HTMLHELP      = NO  TOC_EXPAND             = NO
1313    
1314  # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1315  # be used to specify the file name of the resulting .chm file. You  # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1316  # can add a path in front of the file if the result should not be  # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1317  # written to the html output directory.  # (.qch) of the generated HTML documentation.
1318    # The default value is: NO.
1319    # This tag requires that the tag GENERATE_HTML is set to YES.
1320    
1321    GENERATE_QHP           = NO
1322    
1323    # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1324    # the file name of the resulting .qch file. The path specified is relative to
1325    # the HTML output folder.
1326    # This tag requires that the tag GENERATE_QHP is set to YES.
1327    
1328    QCH_FILE               =
1329    
1330    # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1331    # Project output. For more information please see Qt Help Project / Namespace
1332    # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1333    # The default value is: org.doxygen.Project.
1334    # This tag requires that the tag GENERATE_QHP is set to YES.
1335    
1336    QHP_NAMESPACE          = org.doxygen.Project
1337    
1338    # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1339    # Help Project output. For more information please see Qt Help Project / Virtual
1340    # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1341    # folders).
1342    # The default value is: doc.
1343    # This tag requires that the tag GENERATE_QHP is set to YES.
1344    
1345    QHP_VIRTUAL_FOLDER     = doc
1346    
1347    # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1348    # filter to add. For more information please see Qt Help Project / Custom
1349    # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1350    # filters).
1351    # This tag requires that the tag GENERATE_QHP is set to YES.
1352    
1353    QHP_CUST_FILTER_NAME   =
1354    
1355    # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1356    # custom filter to add. For more information please see Qt Help Project / Custom
1357    # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1358    # filters).
1359    # This tag requires that the tag GENERATE_QHP is set to YES.
1360    
1361    QHP_CUST_FILTER_ATTRS  =
1362    
1363    # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1364    # project's filter section matches. Qt Help Project / Filter Attributes (see:
1365    # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1366    # This tag requires that the tag GENERATE_QHP is set to YES.
1367    
1368    QHP_SECT_FILTER_ATTRS  =
1369    
1370    # The QHG_LOCATION tag can be used to specify the location of Qt's
1371    # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1372    # generated .qhp file.
1373    # This tag requires that the tag GENERATE_QHP is set to YES.
1374    
1375    QHG_LOCATION           =
1376    
1377    # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1378    # generated, together with the HTML files, they form an Eclipse help plugin. To
1379    # install this plugin and make it available under the help contents menu in
1380    # Eclipse, the contents of the directory containing the HTML and XML files needs
1381    # to be copied into the plugins directory of eclipse. The name of the directory
1382    # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1383    # After copying Eclipse needs to be restarted before the help appears.
1384    # The default value is: NO.
1385    # This tag requires that the tag GENERATE_HTML is set to YES.
1386    
1387    GENERATE_ECLIPSEHELP   = NO
1388    
1389    # A unique identifier for the Eclipse help plugin. When installing the plugin
1390    # the directory name containing the HTML and XML files should also have this
1391    # name. Each documentation set should have its own identifier.
1392    # The default value is: org.doxygen.Project.
1393    # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1394    
1395    ECLIPSE_DOC_ID         = org.doxygen.Project
1396    
1397    # If you want full control over the layout of the generated HTML pages it might
1398    # be necessary to disable the index and replace it with your own. The
1399    # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1400    # of each HTML page. A value of NO enables the index and the value YES disables
1401    # it. Since the tabs in the index contain the same information as the navigation
1402    # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1403    # The default value is: NO.
1404    # This tag requires that the tag GENERATE_HTML is set to YES.
1405    
1406  CHM_FILE               =  DISABLE_INDEX          = YES
1407    
1408  # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can  # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1409  # be used to specify the location (absolute path including file name) of  # structure should be generated to display hierarchical information. If the tag
1410  # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run  # value is set to YES, a side panel will be generated containing a tree-like
1411  # the HTML help compiler on the generated index.hhp.  # index structure (just like the one that is generated for HTML Help). For this
1412    # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1413  HHC_LOCATION           =  # (i.e. any modern browser). Windows users are probably better off using the
1414    # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1415  # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  # further fine-tune the look of the index. As an example, the default style
1416  # controls if a separate .chi index file is generated (YES) or that  # sheet generated by doxygen has an example that shows how to put an image at
1417  # it should be included in the master .chm file (NO).  # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1418    # the same information as the tab index, you could consider setting
1419    # DISABLE_INDEX to YES when enabling this option.
1420    # The default value is: NO.
1421    # This tag requires that the tag GENERATE_HTML is set to YES.
1422    
1423  GENERATE_CHI           = NO  GENERATE_TREEVIEW      = NO
1424    
1425  # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1426  # controls whether a binary table of contents is generated (YES) or a  # doxygen will group on one line in the generated HTML documentation.
1427  # normal table of contents (NO) in the .chm file.  #
1428    # Note that a value of 0 will completely suppress the enum values from appearing
1429    # in the overview section.
1430    # Minimum value: 0, maximum value: 20, default value: 4.
1431    # This tag requires that the tag GENERATE_HTML is set to YES.
1432    
1433  BINARY_TOC             = NO  ENUM_VALUES_PER_LINE   = 4
1434    
1435  # The TOC_EXPAND flag can be set to YES to add extra items for group members  # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1436  # to the contents of the HTML help documentation and to the tree view.  # to set the initial width (in pixels) of the frame in which the tree is shown.
1437    # Minimum value: 0, maximum value: 1500, default value: 250.
1438    # This tag requires that the tag GENERATE_HTML is set to YES.
1439    
1440  TOC_EXPAND             = NO  TREEVIEW_WIDTH         = 250
1441    
1442  # The DISABLE_INDEX tag can be used to turn on/off the condensed index at  # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1443  # top of each HTML page. The value NO (the default) enables the index and  # external symbols imported via tag files in a separate window.
1444  # the value YES disables it.  # The default value is: NO.
1445    # This tag requires that the tag GENERATE_HTML is set to YES.
1446    
1447    EXT_LINKS_IN_WINDOW    = NO
1448    
1449    # Use this tag to change the font size of LaTeX formulas included as images in
1450    # the HTML documentation. When you change the font size after a successful
1451    # doxygen run you need to manually remove any form_*.png images from the HTML
1452    # output directory to force them to be regenerated.
1453    # Minimum value: 8, maximum value: 50, default value: 10.
1454    # This tag requires that the tag GENERATE_HTML is set to YES.
1455    
1456    FORMULA_FONTSIZE       = 10
1457    
1458    # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1459    # generated for formulas are transparent PNGs. Transparent PNGs are not
1460    # supported properly for IE 6.0, but are supported on all modern browsers.
1461    #
1462    # Note that when changing this option you need to delete any form_*.png files in
1463    # the HTML output directory before the changes have effect.
1464    # The default value is: YES.
1465    # This tag requires that the tag GENERATE_HTML is set to YES.
1466    
1467    FORMULA_TRANSPARENT    = YES
1468    
1469    # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1470    # http://www.mathjax.org) which uses client side Javascript for the rendering
1471    # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1472    # installed or if you want to formulas look prettier in the HTML output. When
1473    # enabled you may also need to install MathJax separately and configure the path
1474    # to it using the MATHJAX_RELPATH option.
1475    # The default value is: NO.
1476    # This tag requires that the tag GENERATE_HTML is set to YES.
1477    
1478    USE_MATHJAX            = NO
1479    
1480    # When MathJax is enabled you can set the default output format to be used for
1481    # the MathJax output. See the MathJax site (see:
1482    # http://docs.mathjax.org/en/latest/output.html) for more details.
1483    # Possible values are: HTML-CSS (which is slower, but has the best
1484    # compatibility), NativeMML (i.e. MathML) and SVG.
1485    # The default value is: HTML-CSS.
1486    # This tag requires that the tag USE_MATHJAX is set to YES.
1487    
1488    MATHJAX_FORMAT         = HTML-CSS
1489    
1490    # When MathJax is enabled you need to specify the location relative to the HTML
1491    # output directory using the MATHJAX_RELPATH option. The destination directory
1492    # should contain the MathJax.js script. For instance, if the mathjax directory
1493    # is located at the same level as the HTML output directory, then
1494    # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1495    # Content Delivery Network so you can quickly see the result without installing
1496    # MathJax. However, it is strongly recommended to install a local copy of
1497    # MathJax from http://www.mathjax.org before deployment.
1498    # The default value is: http://cdn.mathjax.org/mathjax/latest.
1499    # This tag requires that the tag USE_MATHJAX is set to YES.
1500    
1501    MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1502    
1503    # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1504    # extension names that should be enabled during MathJax rendering. For example
1505    # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1506    # This tag requires that the tag USE_MATHJAX is set to YES.
1507    
1508    MATHJAX_EXTENSIONS     =
1509    
1510    # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1511    # of code that will be used on startup of the MathJax code. See the MathJax site
1512    # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1513    # example see the documentation.
1514    # This tag requires that the tag USE_MATHJAX is set to YES.
1515    
1516    MATHJAX_CODEFILE       =
1517    
1518    # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1519    # the HTML output. The underlying search engine uses javascript and DHTML and
1520    # should work on any modern browser. Note that when using HTML help
1521    # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1522    # there is already a search function so this one should typically be disabled.
1523    # For large projects the javascript based search engine can be slow, then
1524    # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1525    # search using the keyboard; to jump to the search box use <access key> + S
1526    # (what the <access key> is depends on the OS and browser, but it is typically
1527    # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1528    # key> to jump into the search results window, the results can be navigated
1529    # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1530    # the search. The filter options can be selected when the cursor is inside the
1531    # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1532    # to select a filter and <Enter> or <escape> to activate or cancel the filter
1533    # option.
1534    # The default value is: YES.
1535    # This tag requires that the tag GENERATE_HTML is set to YES.
1536    
1537  DISABLE_INDEX          = YES  SEARCHENGINE           = NO
1538    
1539    # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1540    # implemented using a web server instead of a web client using Javascript. There
1541    # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1542    # setting. When disabled, doxygen will generate a PHP script for searching and
1543    # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1544    # and searching needs to be provided by external tools. See the section
1545    # "External Indexing and Searching" for details.
1546    # The default value is: NO.
1547    # This tag requires that the tag SEARCHENGINE is set to YES.
1548    
1549    SERVER_BASED_SEARCH    = NO
1550    
1551    # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1552    # script for searching. Instead the search results are written to an XML file
1553    # which needs to be processed by an external indexer. Doxygen will invoke an
1554    # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1555    # search results.
1556    #
1557    # Doxygen ships with an example indexer (doxyindexer) and search engine
1558    # (doxysearch.cgi) which are based on the open source search engine library
1559    # Xapian (see: http://xapian.org/).
1560    #
1561    # See the section "External Indexing and Searching" for details.
1562    # The default value is: NO.
1563    # This tag requires that the tag SEARCHENGINE is set to YES.
1564    
1565  # This tag can be used to set the number of enum values (range [1..20])  EXTERNAL_SEARCH        = NO
 # that doxygen will group on one line in the generated HTML documentation.  
1566    
1567  ENUM_VALUES_PER_LINE   = 4  # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1568    # which will return the search results when EXTERNAL_SEARCH is enabled.
1569    #
1570    # Doxygen ships with an example indexer (doxyindexer) and search engine
1571    # (doxysearch.cgi) which are based on the open source search engine library
1572    # Xapian (see: http://xapian.org/). See the section "External Indexing and
1573    # Searching" for details.
1574    # This tag requires that the tag SEARCHENGINE is set to YES.
1575    
1576  # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be  SEARCHENGINE_URL       =
 # generated containing a tree-like index structure (just like the one that  
 # is generated for HTML Help). For this to work a browser that supports  
 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,  
 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  
 # probably better off using the HTML help feature.  
1577    
1578  GENERATE_TREEVIEW      = NO  # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1579    # search data is written to a file for indexing by an external tool. With the
1580    # SEARCHDATA_FILE tag the name of this file can be specified.
1581    # The default file is: searchdata.xml.
1582    # This tag requires that the tag SEARCHENGINE is set to YES.
1583    
1584  # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  SEARCHDATA_FILE        = searchdata.xml
 # used to set the initial width (in pixels) of the frame in which the tree  
 # is shown.  
1585    
1586  TREEVIEW_WIDTH         = 250  # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1587    # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1588    # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1589    # projects and redirect the results back to the right project.
1590    # This tag requires that the tag SEARCHENGINE is set to YES.
1591    
1592    EXTERNAL_SEARCH_ID     =
1593    
1594    # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1595    # projects other than the one defined by this configuration file, but that are
1596    # all added to the same external search index. Each project needs to have a
1597    # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1598    # to a relative location where the documentation can be found. The format is:
1599    # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1600    # This tag requires that the tag SEARCHENGINE is set to YES.
1601    
1602    EXTRA_SEARCH_MAPPINGS  =
1603    
1604  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1605  # configuration options related to the LaTeX output  # Configuration options related to the LaTeX output
1606  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1607    
1608  # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1609  # generate Latex output.  # The default value is: YES.
1610    
1611  GENERATE_LATEX         = NO  GENERATE_LATEX         = NO
1612    
1613  # 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. If a
1614  # If a relative path is entered the value of OUTPUT_DIRECTORY will be  # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1615  # put in front of it. If left blank `latex' will be used as the default path.  # it.
1616    # The default directory is: latex.
1617    # This tag requires that the tag GENERATE_LATEX is set to YES.
1618    
1619  LATEX_OUTPUT           = latex  LATEX_OUTPUT           = latex
1620    
1621  # 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
1622  # invoked. If left blank `latex' will be used as the default command name.  # invoked.
1623    #
1624    # Note that when enabling USE_PDFLATEX this option is only used for generating
1625    # bitmaps for formulas in the HTML output, but not in the Makefile that is
1626    # written to the output directory.
1627    # The default file is: latex.
1628    # This tag requires that the tag GENERATE_LATEX is set to YES.
1629    
1630  LATEX_CMD_NAME         = latex  LATEX_CMD_NAME         = latex
1631    
1632  # 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 generate
1633  # generate index for LaTeX. If left blank `makeindex' will be used as the  # index for LaTeX.
1634  # default command name.  # The default file is: makeindex.
1635    # This tag requires that the tag GENERATE_LATEX is set to YES.
1636    
1637  MAKEINDEX_CMD_NAME     = makeindex  MAKEINDEX_CMD_NAME     = makeindex
1638    
1639  # 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 LaTeX
1640  # LaTeX documents. This may be useful for small projects and may help to  # documents. This may be useful for small projects and may help to save some
1641  # save some trees in general.  # trees in general.
1642    # The default value is: NO.
1643    # This tag requires that the tag GENERATE_LATEX is set to YES.
1644    
1645  COMPACT_LATEX          = NO  COMPACT_LATEX          = NO
1646    
1647  # 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 by the
1648  # by the printer. Possible values are: a4, a4wide, letter, legal and  # printer.
1649  # executive. If left blank a4wide will be used.  # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1650    # 14 inches) and executive (7.25 x 10.5 inches).
1651    # The default value is: a4.
1652    # This tag requires that the tag GENERATE_LATEX is set to YES.
1653    
1654  PAPER_TYPE             = a4wide  PAPER_TYPE             = a4wide
1655    
1656  # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1657  # packages that should be included in the LaTeX output.  # that should be included in the LaTeX output. The package can be specified just
1658    # by its name or with the correct syntax as to be used with the LaTeX
1659    # \usepackage command. To get the times font for instance you can specify :
1660    # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1661    # To use the option intlimits with the amsmath package you can specify:
1662    # EXTRA_PACKAGES=[intlimits]{amsmath}
1663    # If left blank no extra packages will be included.
1664    # This tag requires that the tag GENERATE_LATEX is set to YES.
1665    
1666    EXTRA_PACKAGES         =
1667    
1668    # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1669    # generated LaTeX document. The header should contain everything until the first
1670    # chapter. If it is left blank doxygen will generate a standard header. See
1671    # section "Doxygen usage" for information on how to let doxygen write the
1672    # default header to a separate file.
1673    #
1674    # Note: Only use a user-defined header if you know what you are doing! The
1675    # following commands have a special meaning inside the header: $title,
1676    # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1677    # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1678    # string, for the replacement values of the other commands the user is referred
1679    # to HTML_HEADER.
1680    # This tag requires that the tag GENERATE_LATEX is set to YES.
1681    
1682    LATEX_HEADER           =
1683    
1684    # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1685    # generated LaTeX document. The footer should contain everything after the last
1686    # chapter. If it is left blank doxygen will generate a standard footer. See
1687    # LATEX_HEADER for more information on how to generate a default footer and what
1688    # special commands can be used inside the footer.
1689    #
1690    # Note: Only use a user-defined footer if you know what you are doing!
1691    # This tag requires that the tag GENERATE_LATEX is set to YES.
1692    
1693  EXTRA_PACKAGES         =  LATEX_FOOTER           =
1694    
1695  # The LATEX_HEADER tag can be used to specify a personal LaTeX header for  # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1696  # the generated latex document. The header should contain everything until  # LaTeX style sheets that are included after the standard style sheets created
1697  # the first chapter. If it is left blank doxygen will generate a  # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1698  # standard header. Notice: only use this tag if you know what you are doing!  # will copy the style sheet files to the output directory.
1699    # Note: The order of the extra style sheet files is of importance (e.g. the last
1700  LATEX_HEADER           =  # style sheet in the list overrules the setting of the previous ones in the
1701    # list).
1702  # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  # This tag requires that the tag GENERATE_LATEX is set to YES.
1703  # is prepared for conversion to pdf (using ps2pdf). The pdf file will  
1704  # contain links (just like the HTML output) instead of page references  LATEX_EXTRA_STYLESHEET =
1705  # This makes the output suitable for online browsing using a pdf viewer.  
1706    # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1707    # other source files which should be copied to the LATEX_OUTPUT output
1708    # directory. Note that the files will be copied as-is; there are no commands or
1709    # markers available.
1710    # This tag requires that the tag GENERATE_LATEX is set to YES.
1711    
1712    LATEX_EXTRA_FILES      =
1713    
1714    # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1715    # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1716    # contain links (just like the HTML output) instead of page references. This
1717    # makes the output suitable for online browsing using a PDF viewer.
1718    # The default value is: YES.
1719    # This tag requires that the tag GENERATE_LATEX is set to YES.
1720    
1721  PDF_HYPERLINKS         = NO  PDF_HYPERLINKS         = NO
1722    
1723  # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1724  # plain latex in the generated Makefile. Set this option to YES to get a  # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1725  # higher quality PDF documentation.  # higher quality PDF documentation.
1726    # The default value is: YES.
1727    # This tag requires that the tag GENERATE_LATEX is set to YES.
1728    
1729  USE_PDFLATEX           = NO  USE_PDFLATEX           = NO
1730    
1731  # 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
1732  # command to the generated LaTeX files. This will instruct LaTeX to keep  # command to the generated LaTeX files. This will instruct LaTeX to keep running
1733  # running if errors occur, instead of asking the user for help.  # if errors occur, instead of asking the user for help. This option is also used
1734  # This option is also used when generating formulas in HTML.  # when generating formulas in HTML.
1735    # The default value is: NO.
1736    # This tag requires that the tag GENERATE_LATEX is set to YES.
1737    
1738  LATEX_BATCHMODE        = NO  LATEX_BATCHMODE        = NO
1739    
1740  # If LATEX_HIDE_INDICES is set to YES then doxygen will not  # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1741  # include the index chapters (such as File Index, Compound Index, etc.)  # index chapters (such as File Index, Compound Index, etc.) in the output.
1742  # in the output.  # The default value is: NO.
1743    # This tag requires that the tag GENERATE_LATEX is set to YES.
1744    
1745  LATEX_HIDE_INDICES     = NO  LATEX_HIDE_INDICES     = NO
1746    
1747    # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1748    # code with syntax highlighting in the LaTeX output.
1749    #
1750    # Note that which sources are shown also depends on other settings such as
1751    # SOURCE_BROWSER.
1752    # The default value is: NO.
1753    # This tag requires that the tag GENERATE_LATEX is set to YES.
1754    
1755    LATEX_SOURCE_CODE      = NO
1756    
1757    # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1758    # bibliography, e.g. plainnat, or ieeetr. See
1759    # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1760    # The default value is: plain.
1761    # This tag requires that the tag GENERATE_LATEX is set to YES.
1762    
1763    LATEX_BIB_STYLE        = plain
1764    
1765    # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1766    # page will contain the date and time when the page was generated. Setting this
1767    # to NO can help when comparing the output of multiple runs.
1768    # The default value is: NO.
1769    # This tag requires that the tag GENERATE_LATEX is set to YES.
1770    
1771    LATEX_TIMESTAMP        = NO
1772    
1773  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1774  # configuration options related to the RTF output  # Configuration options related to the RTF output
1775  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1776    
1777  # 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. The
1778  # The RTF output is optimized for Word 97 and may not look very pretty with  # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1779  # other RTF readers or editors.  # readers/editors.
1780    # The default value is: NO.
1781    
1782  GENERATE_RTF           = NO  GENERATE_RTF           = NO
1783    
1784  # 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. If a
1785  # If a relative path is entered the value of OUTPUT_DIRECTORY will be  # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1786  # put in front of it. If left blank `rtf' will be used as the default path.  # it.
1787    # The default directory is: rtf.
1788    # This tag requires that the tag GENERATE_RTF is set to YES.
1789    
1790  RTF_OUTPUT             = rtf  RTF_OUTPUT             = rtf
1791    
1792  # 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 RTF
1793  # RTF documents. This may be useful for small projects and may help to  # documents. This may be useful for small projects and may help to save some
1794  # save some trees in general.  # trees in general.
1795    # The default value is: NO.
1796    # This tag requires that the tag GENERATE_RTF is set to YES.
1797    
1798  COMPACT_RTF            = NO  COMPACT_RTF            = NO
1799    
1800  # 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 will
1801  # will contain hyperlink fields. The RTF file will  # contain hyperlink fields. The RTF file will contain links (just like the HTML
1802  # contain links (just like the HTML output) instead of page references.  # output) instead of page references. This makes the output suitable for online
1803  # This makes the output suitable for online browsing using WORD or other  # browsing using Word or some other Word compatible readers that support those
1804  # programs which support those fields.  # fields.
1805  # Note: wordpad (write) and others do not support links.  #
1806    # Note: WordPad (write) and others do not support links.
1807    # The default value is: NO.
1808    # This tag requires that the tag GENERATE_RTF is set to YES.
1809    
1810  RTF_HYPERLINKS         = NO  RTF_HYPERLINKS         = NO
1811    
1812  # Load stylesheet definitions from file. Syntax is similar to doxygen's  # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1813  # config file, i.e. a series of assignments. You only have to provide  # file, i.e. a series of assignments. You only have to provide replacements,
1814  # replacements, missing definitions are set to their default value.  # missing definitions are set to their default value.
1815    #
1816    # See also section "Doxygen usage" for information on how to generate the
1817    # default style sheet that doxygen normally uses.
1818    # This tag requires that the tag GENERATE_RTF is set to YES.
1819    
1820    RTF_STYLESHEET_FILE    =
1821    
1822  RTF_STYLESHEET_FILE    =  # Set optional variables used in the generation of an RTF document. Syntax is
1823    # similar to doxygen's config file. A template extensions file can be generated
1824    # using doxygen -e rtf extensionFile.
1825    # This tag requires that the tag GENERATE_RTF is set to YES.
1826    
1827  # Set optional variables used in the generation of an rtf document.  RTF_EXTENSIONS_FILE    =
1828  # Syntax is similar to doxygen's config file.  
1829    # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1830    # with syntax highlighting in the RTF output.
1831    #
1832    # Note that which sources are shown also depends on other settings such as
1833    # SOURCE_BROWSER.
1834    # The default value is: NO.
1835    # This tag requires that the tag GENERATE_RTF is set to YES.
1836    
1837  RTF_EXTENSIONS_FILE    =  RTF_SOURCE_CODE        = NO
1838    
1839  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1840  # configuration options related to the man page output  # Configuration options related to the man page output
1841  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1842    
1843  # If the GENERATE_MAN tag is set to YES (the default) Doxygen will  # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1844  # generate man pages  # classes and files.
1845    # The default value is: NO.
1846    
1847  GENERATE_MAN           = NO  GENERATE_MAN           = NO
1848    
1849  # 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. If a
1850  # If a relative path is entered the value of OUTPUT_DIRECTORY will be  # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1851  # put in front of it. If left blank `man' will be used as the default path.  # it. A directory man3 will be created inside the directory specified by
1852    # MAN_OUTPUT.
1853    # The default directory is: man.
1854    # This tag requires that the tag GENERATE_MAN is set to YES.
1855    
1856  MAN_OUTPUT             = man  MAN_OUTPUT             = man
1857    
1858  # The MAN_EXTENSION tag determines the extension that is added to  # The MAN_EXTENSION tag determines the extension that is added to the generated
1859  # the generated man pages (default is the subroutine's section .3)  # man pages. In case the manual section does not start with a number, the number
1860    # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1861    # optional.
1862    # The default value is: .3.
1863    # This tag requires that the tag GENERATE_MAN is set to YES.
1864    
1865  MAN_EXTENSION          = .3  MAN_EXTENSION          = .3
1866    
1867  # If the MAN_LINKS tag is set to YES and Doxygen generates man output,  # The MAN_SUBDIR tag determines the name of the directory created within
1868  # then it will generate one additional man file for each entity  # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1869  # documented in the real man page(s). These additional files  # MAN_EXTENSION with the initial . removed.
1870  # only source the real man page, but without them the man command  # This tag requires that the tag GENERATE_MAN is set to YES.
1871  # would be unable to find the correct page. The default is NO.  
1872    MAN_SUBDIR             =
1873    
1874    # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1875    # will generate one additional man file for each entity documented in the real
1876    # man page(s). These additional files only source the real man page, but without
1877    # them the man command would be unable to find the correct page.
1878    # The default value is: NO.
1879    # This tag requires that the tag GENERATE_MAN is set to YES.
1880    
1881  MAN_LINKS              = NO  MAN_LINKS              = NO
1882    
1883  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1884  # configuration options related to the XML output  # Configuration options related to the XML output
1885  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1886    
1887  # If the GENERATE_XML tag is set to YES Doxygen will  # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1888  # generate an XML file that captures the structure of  # captures the structure of the code including all documentation.
1889  # the code including all documentation.  # The default value is: NO.
1890    
1891  GENERATE_XML           = NO  GENERATE_XML           = NO
1892    
1893  # 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. If a
1894  # If a relative path is entered the value of OUTPUT_DIRECTORY will be  # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1895  # put in front of it. If left blank `xml' will be used as the default path.  # it.
1896    # The default directory is: xml.
1897    # This tag requires that the tag GENERATE_XML is set to YES.
1898    
1899  XML_OUTPUT             = xml  XML_OUTPUT             = xml
1900    
1901  # The XML_SCHEMA tag can be used to specify an XML schema,  # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1902  # which can be used by a validating XML parser to check the  # listings (including syntax highlighting and cross-referencing information) to
1903  # syntax of the XML files.  # the XML output. Note that enabling this will significantly increase the size
1904    # of the XML output.
1905  XML_SCHEMA             =  # The default value is: YES.
1906    # This tag requires that the tag GENERATE_XML is set to YES.
 # The XML_DTD tag can be used to specify an XML DTD,  
 # which can be used by a validating XML parser to check the  
 # syntax of the XML files.  
   
 XML_DTD                =  
   
 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will  
 # dump the program listings (including syntax highlighting  
 # and cross-referencing information) to the XML output. Note that  
 # enabling this will significantly increase the size of the XML output.  
1907    
1908  XML_PROGRAMLISTING     = YES  XML_PROGRAMLISTING     = YES
1909    
1910  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1911  # configuration options for the AutoGen Definitions output  # Configuration options related to the DOCBOOK output
1912  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1913    
1914  # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will  # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1915  # generate an AutoGen Definitions (see autogen.sf.net) file  # that can be used to generate PDF.
1916  # that captures the structure of the code including all  # The default value is: NO.
1917  # documentation. Note that this feature is still experimental  
1918  # and incomplete at the moment.  GENERATE_DOCBOOK       = NO
1919    
1920    # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1921    # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1922    # front of it.
1923    # The default directory is: docbook.
1924    # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1925    
1926    DOCBOOK_OUTPUT         = docbook
1927    
1928    # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1929    # program listings (including syntax highlighting and cross-referencing
1930    # information) to the DOCBOOK output. Note that enabling this will significantly
1931    # increase the size of the DOCBOOK output.
1932    # The default value is: NO.
1933    # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1934    
1935    DOCBOOK_PROGRAMLISTING = NO
1936    
1937    #---------------------------------------------------------------------------
1938    # Configuration options for the AutoGen Definitions output
1939    #---------------------------------------------------------------------------
1940    
1941    # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1942    # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1943    # structure of the code including all documentation. Note that this feature is
1944    # still experimental and incomplete at the moment.
1945    # The default value is: NO.
1946    
1947  GENERATE_AUTOGEN_DEF   = NO  GENERATE_AUTOGEN_DEF   = NO
1948    
1949  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1950  # configuration options related to the Perl module output  # Configuration options related to the Perl module output
1951  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1952    
1953  # If the GENERATE_PERLMOD tag is set to YES Doxygen will  # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1954  # generate a Perl module file that captures the structure of  # file that captures the structure of the code including all documentation.
1955  # the code including all documentation. Note that this  #
1956  # feature is still experimental and incomplete at the  # Note that this feature is still experimental and incomplete at the moment.
1957  # moment.  # The default value is: NO.
1958    
1959  GENERATE_PERLMOD       = NO  GENERATE_PERLMOD       = NO
1960    
1961  # If the PERLMOD_LATEX tag is set to YES Doxygen will generate  # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1962  # the necessary Makefile rules, Perl scripts and LaTeX code to be able  # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1963  # to generate PDF and DVI output from the Perl module output.  # output from the Perl module output.
1964    # The default value is: NO.
1965    # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1966    
1967  PERLMOD_LATEX          = NO  PERLMOD_LATEX          = NO
1968    
1969  # 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 nicely
1970  # nicely formatted so it can be parsed by a human reader.  This is useful  # formatted so it can be parsed by a human reader. This is useful if you want to
1971  # if you want to understand what is going on.  On the other hand, if this  # understand what is going on. On the other hand, if this tag is set to NO, the
1972  # tag is set to NO the size of the Perl module output will be much smaller  # size of the Perl module output will be much smaller and Perl will parse it
1973  # and Perl will parse it just the same.  # just the same.
1974    # The default value is: YES.
1975    # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1976    
1977  PERLMOD_PRETTY         = YES  PERLMOD_PRETTY         = YES
1978    
1979  # The names of the make variables in the generated doxyrules.make file  # The names of the make variables in the generated doxyrules.make file are
1980  # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.  # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1981  # This is useful so different doxyrules.make files included by the same  # so different doxyrules.make files included by the same Makefile don't
1982  # Makefile don't overwrite each other's variables.  # overwrite each other's variables.
1983    # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1984    
1985  PERLMOD_MAKEVAR_PREFIX =  PERLMOD_MAKEVAR_PREFIX =
1986    
1987  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1988  # Configuration options related to the preprocessor    # Configuration options related to the preprocessor
1989  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
1990    
1991  # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1992  # evaluate all C-preprocessor directives found in the sources and include  # C-preprocessor directives found in the sources and include files.
1993  # files.  # The default value is: YES.
1994    
1995  ENABLE_PREPROCESSING   = YES  ENABLE_PREPROCESSING   = YES
1996    
1997  # 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 names
1998  # names in the source code. If set to NO (the default) only conditional  # in the source code. If set to NO, only conditional compilation will be
1999  # compilation will be performed. Macro expansion can be done in a controlled  # performed. Macro expansion can be done in a controlled way by setting
2000  # way by setting EXPAND_ONLY_PREDEF to YES.  # EXPAND_ONLY_PREDEF to YES.
2001    # The default value is: NO.
2002    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2003    
2004  MACRO_EXPANSION        = NO  MACRO_EXPANSION        = NO
2005    
2006  # 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 then
2007  # then the macro expansion is limited to the macros specified with the  # the macro expansion is limited to the macros specified with the PREDEFINED and
2008  # PREDEFINED and EXPAND_AS_PREDEFINED tags.  # EXPAND_AS_DEFINED tags.
2009    # The default value is: NO.
2010    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2011    
2012  EXPAND_ONLY_PREDEF     = NO  EXPAND_ONLY_PREDEF     = NO
2013    
2014  # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2015  # in the INCLUDE_PATH (see below) will be search if a #include is found.  # INCLUDE_PATH will be searched if a #include is found.
2016    # The default value is: YES.
2017    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2018    
2019  SEARCH_INCLUDES        = YES  SEARCH_INCLUDES        = YES
2020    
2021  # 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
2022  # 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 the
2023  # the preprocessor.  # preprocessor.
2024    # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2025  INCLUDE_PATH           =  
2026    INCLUDE_PATH           =
2027  # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
2028  # patterns (like *.h and *.hpp) to filter out the header-files in the  # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2029  # directories. If left blank, the patterns specified with FILE_PATTERNS will  # patterns (like *.h and *.hpp) to filter out the header-files in the
2030  # be used.  # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2031    # used.
2032  INCLUDE_FILE_PATTERNS  =  # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2033    
2034  # The PREDEFINED tag can be used to specify one or more macro names that  INCLUDE_FILE_PATTERNS  =
2035  # are defined before the preprocessor is started (similar to the -D option of  
2036  # gcc). The argument of the tag is a list of macros of the form: name  # The PREDEFINED tag can be used to specify one or more macro names that are
2037  # or name=definition (no spaces). If the definition and the = are  # defined before the preprocessor is started (similar to the -D option of e.g.
2038  # omitted =1 is assumed.  # gcc). The argument of the tag is a list of macros of the form: name or
2039    # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2040  PREDEFINED             =  # is assumed. To prevent a macro definition from being undefined via #undef or
2041    # recursively expanded use the := operator instead of the = operator.
2042  # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2043  # this tag can be used to specify a list of macro names that should be expanded.  
2044  # The macro definition that is found in the sources will be used.  PREDEFINED             =
2045  # Use the PREDEFINED tag if you want to use a different macro definition.  
2046    # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2047  EXPAND_AS_DEFINED      =  # tag can be used to specify a list of macro names that should be expanded. The
2048    # macro definition that is found in the sources will be used. Use the PREDEFINED
2049  # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then  # tag if you want to use a different macro definition that overrules the
2050  # doxygen's preprocessor will remove all function-like macros that are alone  # definition found in the source code.
2051  # on a line, have an all uppercase name, and do not end with a semicolon. Such  # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2052  # function macros are typically used for boiler-plate code, and will confuse the  
2053  # parser if not removed.  EXPAND_AS_DEFINED      =
2054    
2055    # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2056    # remove all references to function-like macros that are alone on a line, have
2057    # an all uppercase name, and do not end with a semicolon. Such function macros
2058    # are typically used for boiler-plate code, and will confuse the parser if not
2059    # removed.
2060    # The default value is: YES.
2061    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2062    
2063  SKIP_FUNCTION_MACROS   = YES  SKIP_FUNCTION_MACROS   = YES
2064    
2065  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
2066  # Configuration::additions related to external references    # Configuration options related to external references
2067  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
2068    
2069  # The TAGFILES option can be used to specify one or more tagfiles.  # The TAGFILES tag can be used to specify one or more tag files. For each tag
2070  # Optionally an initial location of the external documentation  # file the location of the external documentation should be added. The format of
2071  # can be added for each tagfile. The format of a tag file without  # a tag file without this location is as follows:
2072  # this location is as follows:  # TAGFILES = file1 file2 ...
2073  #   TAGFILES = file1 file2 ...  # Adding location for the tag files is done as follows:
2074  # Adding location for the tag files is done as follows:  # TAGFILES = file1=loc1 "file2 = loc2" ...
2075  #   TAGFILES = file1=loc1 "file2 = loc2" ...  # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2076  # where "loc1" and "loc2" can be relative or absolute paths or  # section "Linking to external documentation" for more information about the use
2077  # URLs. If a location is present for each tag, the installdox tool  # of tag files.
2078  # does not have to be run to correct the links.  # Note: Each tag file must have a unique name (where the name does NOT include
2079  # Note that each tag file must have a unique name  # the path). If a tag file is not located in the directory in which doxygen is
2080  # (where the name does NOT include the path)  # run, you must also specify the path to the tagfile here.
2081  # If a tag file is not located in the directory in which doxygen  
2082  # is run, you must also specify the path to the tagfile here.  TAGFILES               =
2083    
2084  TAGFILES               =  # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2085    # tag file that is based on the input files it reads. See section "Linking to
2086  # When a file name is specified after GENERATE_TAGFILE, doxygen will create  # external documentation" for more information about the usage of tag files.
2087  # a tag file that is based on the input files it reads.  
2088    GENERATE_TAGFILE       =
2089  GENERATE_TAGFILE       =  
2090    # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2091  # If the ALLEXTERNALS tag is set to YES all external classes will be listed  # the class index. If set to NO, only the inherited external classes will be
2092  # in the class index. If set to NO only the inherited external classes  # listed.
2093  # will be listed.  # The default value is: NO.
2094    
2095  ALLEXTERNALS           = NO  ALLEXTERNALS           = NO
2096    
2097  # 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
2098  # 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 be
2099  # be listed.  # listed.
2100    # The default value is: YES.
2101    
2102  EXTERNAL_GROUPS        = YES  EXTERNAL_GROUPS        = YES
2103    
2104  # The PERL_PATH should be the absolute path and name of the perl script  # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2105  # interpreter (i.e. the result of `which perl').  # the related pages index. If set to NO, only the current project's pages will
2106    # be listed.
2107    # The default value is: YES.
2108    
2109    EXTERNAL_PAGES         = YES
2110    
2111    # The PERL_PATH should be the absolute path and name of the perl script
2112    # interpreter (i.e. the result of 'which perl').
2113    # The default file (with absolute path) is: /usr/bin/perl.
2114    
2115  PERL_PATH              = /usr/bin/perl  PERL_PATH              = /usr/bin/perl
2116    
2117  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
2118  # Configuration options related to the dot tool    # Configuration options related to the dot tool
2119  #---------------------------------------------------------------------------  #---------------------------------------------------------------------------
2120    
2121  # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2122  # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or  # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2123  # super classes. Setting the tag to NO turns the diagrams off. Note that this  # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2124  # option is superseded by the HAVE_DOT option below. This is only a fallback. It is  # disabled, but it is recommended to install and use dot, since it yields more
2125  # recommended to install and use dot, since it yields more powerful graphs.  # powerful graphs.
2126    # The default value is: YES.
2127    
2128  CLASS_DIAGRAMS         = YES  CLASS_DIAGRAMS         = YES
2129    
2130  # If set to YES, the inheritance and collaboration graphs will hide  # You can define message sequence charts within doxygen comments using the \msc
2131  # inheritance and usage relations if the target is undocumented  # command. Doxygen will then run the mscgen tool (see:
2132  # or is not a class.  # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2133    # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2134    # the mscgen tool resides. If left empty the tool is assumed to be found in the
2135    # default search path.
2136    
2137    MSCGEN_PATH            =
2138    
2139    # You can include diagrams made with dia in doxygen documentation. Doxygen will
2140    # then run dia to produce the diagram and insert it in the documentation. The
2141    # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2142    # If left empty dia is assumed to be found in the default search path.
2143    
2144    DIA_PATH               =
2145    
2146    # If set to YES the inheritance and collaboration graphs will hide inheritance
2147    # and usage relations if the target is undocumented or is not a class.
2148    # The default value is: YES.
2149    
2150  HIDE_UNDOC_RELATIONS   = YES  HIDE_UNDOC_RELATIONS   = YES
2151    
2152  # 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
2153  # available from the path. This tool is part of Graphviz, a graph visualization  # available from the path. This tool is part of Graphviz (see:
2154  # toolkit from AT&T and Lucent Bell Labs. The other options in this section  # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2155  # have no effect if this option is set to NO (the default)  # Bell Labs. The other options in this section have no effect if this option is
2156    # set to NO
2157    # The default value is: YES.
2158    
2159  HAVE_DOT               = NO  HAVE_DOT               = NO
2160    
2161  # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2162  # will generate a graph for each documented class showing the direct and  # to run in parallel. When set to 0 doxygen will base this on the number of
2163  # indirect inheritance relations. Setting this tag to YES will force the  # processors available in the system. You can set it explicitly to a value
2164  # the CLASS_DIAGRAMS tag to NO.  # larger than 0 to get control over the balance between CPU load and processing
2165    # speed.
2166    # Minimum value: 0, maximum value: 32, default value: 0.
2167    # This tag requires that the tag HAVE_DOT is set to YES.
2168    
2169    DOT_NUM_THREADS        = 0
2170    
2171    # When you want a differently looking font in the dot files that doxygen
2172    # generates you can specify the font name using DOT_FONTNAME. You need to make
2173    # sure dot is able to find the font, which can be done by putting it in a
2174    # standard location or by setting the DOTFONTPATH environment variable or by
2175    # setting DOT_FONTPATH to the directory containing the font.
2176    # The default value is: Helvetica.
2177    # This tag requires that the tag HAVE_DOT is set to YES.
2178    
2179    DOT_FONTNAME           = Helvetica
2180    
2181    # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2182    # dot graphs.
2183    # Minimum value: 4, maximum value: 24, default value: 10.
2184    # This tag requires that the tag HAVE_DOT is set to YES.
2185    
2186    DOT_FONTSIZE           = 10
2187    
2188    # By default doxygen will tell dot to use the default font as specified with
2189    # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2190    # the path where dot can find it using this tag.
2191    # This tag requires that the tag HAVE_DOT is set to YES.
2192    
2193    DOT_FONTPATH           =
2194    
2195    # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2196    # each documented class showing the direct and indirect inheritance relations.
2197    # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2198    # The default value is: YES.
2199    # This tag requires that the tag HAVE_DOT is set to YES.
2200    
2201  CLASS_GRAPH            = YES  CLASS_GRAPH            = YES
2202    
2203  # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2204  # will generate a graph for each documented class showing the direct and  # graph for each documented class showing the direct and indirect implementation
2205  # indirect implementation dependencies (inheritance, containment, and  # dependencies (inheritance, containment, and class references variables) of the
2206  # class references variables) of the class with other documented classes.  # class with other documented classes.
2207    # The default value is: YES.
2208    # This tag requires that the tag HAVE_DOT is set to YES.
2209    
2210  COLLABORATION_GRAPH    = YES  COLLABORATION_GRAPH    = YES
2211    
2212  # If the UML_LOOK tag is set to YES doxygen will generate inheritance and  # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2213  # collaboration diagrams in a style similar to the OMG's Unified Modeling  # groups, showing the direct groups dependencies.
2214    # The default value is: YES.
2215    # This tag requires that the tag HAVE_DOT is set to YES.
2216    
2217    GROUP_GRAPHS           = YES
2218    
2219    # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2220    # collaboration diagrams in a style similar to the OMG's Unified Modeling
2221  # Language.  # Language.
2222    # The default value is: NO.
2223    # This tag requires that the tag HAVE_DOT is set to YES.
2224    
2225  UML_LOOK               = NO  UML_LOOK               = NO
2226    
2227  # 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 the
2228  # relations between templates and their instances.  # class node. If there are many fields or methods and many nodes the graph may
2229    # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2230    # number of items for each type to make the size more manageable. Set this to 0
2231    # for no limit. Note that the threshold may be exceeded by 50% before the limit
2232    # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2233    # but if the number exceeds 15, the total amount of fields shown is limited to
2234    # 10.
2235    # Minimum value: 0, maximum value: 100, default value: 10.
2236    # This tag requires that the tag HAVE_DOT is set to YES.
2237    
2238    UML_LIMIT_NUM_FIELDS   = 10
2239    
2240    # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2241    # collaboration graphs will show the relations between templates and their
2242    # instances.
2243    # The default value is: NO.
2244    # This tag requires that the tag HAVE_DOT is set to YES.
2245    
2246  TEMPLATE_RELATIONS     = NO  TEMPLATE_RELATIONS     = NO
2247    
2248  # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT  # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2249  # tags are set to YES then doxygen will generate a graph for each documented  # YES then doxygen will generate a graph for each documented file showing the
2250  # file showing the direct and indirect include dependencies of the file with  # direct and indirect include dependencies of the file with other documented
2251  # other documented files.  # files.
2252    # The default value is: YES.
2253    # This tag requires that the tag HAVE_DOT is set to YES.
2254    
2255  INCLUDE_GRAPH          = YES  INCLUDE_GRAPH          = YES
2256    
2257  # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2258  # HAVE_DOT tags are set to YES then doxygen will generate a graph for each  # set to YES then doxygen will generate a graph for each documented file showing
2259  # documented header file showing the documented files that directly or  # the direct and indirect include dependencies of the file with other documented
2260  # indirectly include this file.  # files.
2261    # The default value is: YES.
2262    # This tag requires that the tag HAVE_DOT is set to YES.
2263    
2264  INCLUDED_BY_GRAPH      = YES  INCLUDED_BY_GRAPH      = YES
2265    
2266  # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2267  # generate a call dependency graph for every global function or class method.  # dependency graph for every global function or class method.
2268  # Note that enabling this option will significantly increase the time of a run.  #
2269  # So in most cases it will be better to enable call graphs for selected  # Note that enabling this option will significantly increase the time of a run.
2270  # functions only using the \callgraph command.  # So in most cases it will be better to enable call graphs for selected
2271    # functions only using the \callgraph command. Disabling a call graph can be
2272    # accomplished by means of the command \hidecallgraph.
2273    # The default value is: NO.
2274    # This tag requires that the tag HAVE_DOT is set to YES.
2275    
2276  CALL_GRAPH             = NO  CALL_GRAPH             = NO
2277    
2278  # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2279  # will graphical hierarchy of all classes instead of a textual one.  # dependency graph for every global function or class method.
2280    #
2281    # Note that enabling this option will significantly increase the time of a run.
2282    # So in most cases it will be better to enable caller graphs for selected
2283    # functions only using the \callergraph command. Disabling a caller graph can be
2284    # accomplished by means of the command \hidecallergraph.
2285    # The default value is: NO.
2286    # This tag requires that the tag HAVE_DOT is set to YES.
2287    
2288    CALLER_GRAPH           = NO
2289    
2290    # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2291    # hierarchy of all classes instead of a textual one.
2292    # The default value is: YES.
2293    # This tag requires that the tag HAVE_DOT is set to YES.
2294    
2295  GRAPHICAL_HIERARCHY    = YES  GRAPHICAL_HIERARCHY    = YES
2296    
2297  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2298  # generated by dot. Possible values are png, jpg, or gif  # dependencies a directory has on other directories in a graphical way. The
2299  # If left blank png will be used.  # dependency relations are determined by the #include relations between the
2300    # files in the directories.
2301    # The default value is: YES.
2302    # This tag requires that the tag HAVE_DOT is set to YES.
2303    
2304    DIRECTORY_GRAPH        = YES
2305    
2306    # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2307    # generated by dot. For an explanation of the image formats see the section
2308    # output formats in the documentation of the dot tool (Graphviz (see:
2309    # http://www.graphviz.org/)).
2310    # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2311    # to make the SVG files visible in IE 9+ (other browsers do not have this
2312    # requirement).
2313    # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2314    # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2315    # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2316    # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2317    # png:gdiplus:gdiplus.
2318    # The default value is: png.
2319    # This tag requires that the tag HAVE_DOT is set to YES.
2320    
2321  DOT_IMAGE_FORMAT       = png  DOT_IMAGE_FORMAT       = png
2322    
2323  # 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
2324  # found. If left blank, it is assumed the dot tool can be found on the path.  # enable generation of interactive SVG images that allow zooming and panning.
2325    #
2326  DOT_PATH               =  # Note that this requires a modern browser other than Internet Explorer. Tested
2327    # and working are Firefox, Chrome, Safari, and Opera.
2328  # The DOTFILE_DIRS tag can be used to specify one or more directories that  # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2329  # contain dot files that are included in the documentation (see the  # the SVG files visible. Older versions of IE do not have SVG support.
2330  # \dotfile command).  # The default value is: NO.
2331    # This tag requires that the tag HAVE_DOT is set to YES.
2332  DOTFILE_DIRS           =  
2333    INTERACTIVE_SVG        = NO
2334  # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  
2335  # (in pixels) of the graphs generated by dot. If a graph becomes larger than  # The DOT_PATH tag can be used to specify the path where the dot tool can be
2336  # this value, doxygen will try to truncate the graph, so that it fits within  # found. If left blank, it is assumed the dot tool can be found in the path.
2337  # the specified constraint. Beware that most browsers cannot cope with very  # This tag requires that the tag HAVE_DOT is set to YES.
2338  # large images.  
2339    DOT_PATH               =
2340  MAX_DOT_GRAPH_WIDTH    = 1024  
2341    # The DOTFILE_DIRS tag can be used to specify one or more directories that
2342  # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  # contain dot files that are included in the documentation (see the \dotfile
2343  # (in pixels) of the graphs generated by dot. If a graph becomes larger than  # command).
2344  # this value, doxygen will try to truncate the graph, so that it fits within  # This tag requires that the tag HAVE_DOT is set to YES.
2345  # the specified constraint. Beware that most browsers cannot cope with very  
2346  # large images.  DOTFILE_DIRS           =
2347    
2348  MAX_DOT_GRAPH_HEIGHT   = 1024  # The MSCFILE_DIRS tag can be used to specify one or more directories that
2349    # contain msc files that are included in the documentation (see the \mscfile
2350  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  # command).
2351  # graphs generated by dot. A depth value of 3 means that only nodes reachable  
2352  # from the root by following a path via at most 3 edges will be shown. Nodes that  MSCFILE_DIRS           =
2353  # lay further from the root node will be omitted. Note that setting this option to  
2354  # 1 or 2 may greatly reduce the computation time needed for large code bases. Also  # The DIAFILE_DIRS tag can be used to specify one or more directories that
2355  # note that a graph may be further truncated if the graph's image dimensions are  # contain dia files that are included in the documentation (see the \diafile
2356  # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).  # command).
2357  # If 0 is used for the depth value (the default), the graph is not depth-constrained.  
2358    DIAFILE_DIRS           =
2359    
2360    # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2361    # path where java can find the plantuml.jar file. If left blank, it is assumed
2362    # PlantUML is not used or called during a preprocessing step. Doxygen will
2363    # generate a warning when it encounters a \startuml command in this case and
2364    # will not generate output for the diagram.
2365    
2366    PLANTUML_JAR_PATH      =
2367    
2368    # When using plantuml, the specified paths are searched for files specified by
2369    # the !include statement in a plantuml block.
2370    
2371    PLANTUML_INCLUDE_PATH  =
2372    
2373    # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2374    # that will be shown in the graph. If the number of nodes in a graph becomes
2375    # larger than this value, doxygen will truncate the graph, which is visualized
2376    # by representing a node as a red box. Note that doxygen if the number of direct
2377    # children of the root node in a graph is already larger than
2378    # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2379    # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2380    # Minimum value: 0, maximum value: 10000, default value: 50.
2381    # This tag requires that the tag HAVE_DOT is set to YES.
2382    
2383    DOT_GRAPH_MAX_NODES    = 50
2384    
2385    # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2386    # generated by dot. A depth value of 3 means that only nodes reachable from the
2387    # root by following a path via at most 3 edges will be shown. Nodes that lay
2388    # further from the root node will be omitted. Note that setting this option to 1
2389    # or 2 may greatly reduce the computation time needed for large code bases. Also
2390    # note that the size of a graph can be further restricted by
2391    # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2392    # Minimum value: 0, maximum value: 1000, default value: 0.
2393    # This tag requires that the tag HAVE_DOT is set to YES.
2394    
2395  MAX_DOT_GRAPH_DEPTH    = 0  MAX_DOT_GRAPH_DEPTH    = 0
2396    
2397  # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2398  # generate a legend page explaining the meaning of the various boxes and  # background. This is disabled by default, because dot on Windows does not seem
2399  # arrows in the dot generated graphs.  # to support this out of the box.
2400    #
2401    # Warning: Depending on the platform used, enabling this option may lead to
2402    # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2403    # read).
2404    # The default value is: NO.
2405    # This tag requires that the tag HAVE_DOT is set to YES.
2406    
2407    DOT_TRANSPARENT        = NO
2408    
2409    # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2410    # files in one run (i.e. multiple -o and -T options on the command line). This
2411    # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2412    # this, this feature is disabled by default.
2413    # The default value is: NO.
2414    # This tag requires that the tag HAVE_DOT is set to YES.
2415    
2416    DOT_MULTI_TARGETS      = NO
2417    
2418    # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2419    # explaining the meaning of the various boxes and arrows in the dot generated
2420    # graphs.
2421    # The default value is: YES.
2422    # This tag requires that the tag HAVE_DOT is set to YES.
2423    
2424  GENERATE_LEGEND        = YES  GENERATE_LEGEND        = YES
2425    
2426  # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will  # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2427  # remove the intermediate dot files that are used to generate  # files that are used to generate the various graphs.
2428  # the various graphs.  # The default value is: YES.
2429    # This tag requires that the tag HAVE_DOT is set to YES.
2430    
2431  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.3518  
changed lines
  Added in v.3519

  ViewVC Help
Powered by ViewVC