annotate Doxyfile @ 318:b08fd8813ffe

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