/[svn]/ircd-hybrid-7.2/doc/doxygen.conf
ViewVC logotype

Diff of /ircd-hybrid-7.2/doc/doxygen.conf

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

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

svnadmin@ircd-hybrid.org
ViewVC Help
Powered by ViewVC 1.1.28