sl@0
|
1 |
# Doxyfile 1.2.2
|
sl@0
|
2 |
|
sl@0
|
3 |
# This file describes the settings to be used by doxygen for a project
|
sl@0
|
4 |
#
|
sl@0
|
5 |
# All text after a hash (#) is considered a comment and will be ignored
|
sl@0
|
6 |
# The format is:
|
sl@0
|
7 |
# TAG = value [value, ...]
|
sl@0
|
8 |
# For lists items can also be appended using:
|
sl@0
|
9 |
# TAG += value [value, ...]
|
sl@0
|
10 |
# Values that contain spaces should be placed between quotes (" ")
|
sl@0
|
11 |
|
sl@0
|
12 |
#---------------------------------------------------------------------------
|
sl@0
|
13 |
# General configuration options
|
sl@0
|
14 |
#---------------------------------------------------------------------------
|
sl@0
|
15 |
|
sl@0
|
16 |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
sl@0
|
17 |
# by quotes) that should identify the project.
|
sl@0
|
18 |
|
sl@0
|
19 |
PROJECT_NAME = "String Pool"
|
sl@0
|
20 |
|
sl@0
|
21 |
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
sl@0
|
22 |
# This could be handy for archiving the generated documentation or
|
sl@0
|
23 |
# if some version control system is used.
|
sl@0
|
24 |
|
sl@0
|
25 |
PROJECT_NUMBER =
|
sl@0
|
26 |
|
sl@0
|
27 |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
sl@0
|
28 |
# base path where the generated documentation will be put.
|
sl@0
|
29 |
# If a relative path is entered, it will be relative to the location
|
sl@0
|
30 |
# where doxygen was started. If left blank the current directory will be used.
|
sl@0
|
31 |
|
sl@0
|
32 |
OUTPUT_DIRECTORY = .
|
sl@0
|
33 |
|
sl@0
|
34 |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
sl@0
|
35 |
# documentation generated by doxygen is written. Doxygen will use this
|
sl@0
|
36 |
# information to generate all constant output in the proper language.
|
sl@0
|
37 |
# The default language is English, other supported languages are:
|
sl@0
|
38 |
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
|
sl@0
|
39 |
# Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, and
|
sl@0
|
40 |
# Portuguese.
|
sl@0
|
41 |
|
sl@0
|
42 |
OUTPUT_LANGUAGE = English
|
sl@0
|
43 |
|
sl@0
|
44 |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
sl@0
|
45 |
# documentation are documented, even if no documentation was available.
|
sl@0
|
46 |
# Private class members and static file members will be hidden unless
|
sl@0
|
47 |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
sl@0
|
48 |
|
sl@0
|
49 |
EXTRACT_ALL = NO
|
sl@0
|
50 |
|
sl@0
|
51 |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
sl@0
|
52 |
# will be included in the documentation.
|
sl@0
|
53 |
|
sl@0
|
54 |
EXTRACT_PRIVATE = NO
|
sl@0
|
55 |
|
sl@0
|
56 |
# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
sl@0
|
57 |
# will be included in the documentation.
|
sl@0
|
58 |
|
sl@0
|
59 |
EXTRACT_STATIC = YES
|
sl@0
|
60 |
|
sl@0
|
61 |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
sl@0
|
62 |
# undocumented members of documented classes, files or namespaces.
|
sl@0
|
63 |
# If set to NO (the default) these members will be included in the
|
sl@0
|
64 |
# various overviews, but no documentation section is generated.
|
sl@0
|
65 |
# This option has no effect if EXTRACT_ALL is enabled.
|
sl@0
|
66 |
|
sl@0
|
67 |
HIDE_UNDOC_MEMBERS = YES
|
sl@0
|
68 |
|
sl@0
|
69 |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
sl@0
|
70 |
# undocumented classes that are normally visible in the class hierarchy.
|
sl@0
|
71 |
# If set to NO (the default) these class will be included in the various
|
sl@0
|
72 |
# overviews. This option has no effect if EXTRACT_ALL is enabled.
|
sl@0
|
73 |
|
sl@0
|
74 |
HIDE_UNDOC_CLASSES = NO
|
sl@0
|
75 |
|
sl@0
|
76 |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
sl@0
|
77 |
# include brief member descriptions after the members that are listed in
|
sl@0
|
78 |
# the file and class documentation (similar to JavaDoc).
|
sl@0
|
79 |
# Set to NO to disable this.
|
sl@0
|
80 |
|
sl@0
|
81 |
BRIEF_MEMBER_DESC = YES
|
sl@0
|
82 |
|
sl@0
|
83 |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
sl@0
|
84 |
# the brief description of a member or function before the detailed description.
|
sl@0
|
85 |
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
sl@0
|
86 |
# brief descriptions will be completely suppressed.
|
sl@0
|
87 |
|
sl@0
|
88 |
REPEAT_BRIEF = YES
|
sl@0
|
89 |
|
sl@0
|
90 |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
sl@0
|
91 |
# Doxygen will generate a detailed section even if there is only a brief
|
sl@0
|
92 |
# description.
|
sl@0
|
93 |
|
sl@0
|
94 |
ALWAYS_DETAILED_SEC = YES
|
sl@0
|
95 |
|
sl@0
|
96 |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
sl@0
|
97 |
# path before files name in the file list and in the header files. If set
|
sl@0
|
98 |
# to NO the shortest path that makes the file name unique will be used.
|
sl@0
|
99 |
|
sl@0
|
100 |
FULL_PATH_NAMES = NO
|
sl@0
|
101 |
|
sl@0
|
102 |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
sl@0
|
103 |
# can be used to strip a user defined part of the path. Stripping is
|
sl@0
|
104 |
# only done if one of the specified strings matches the left-hand part of
|
sl@0
|
105 |
# the path. It is allowed to use relative paths in the argument list.
|
sl@0
|
106 |
|
sl@0
|
107 |
STRIP_FROM_PATH =
|
sl@0
|
108 |
|
sl@0
|
109 |
# The INTERNAL_DOCS tag determines if documentation
|
sl@0
|
110 |
# that is typed after a \internal command is included. If the tag is set
|
sl@0
|
111 |
# to NO (the default) then the documentation will be excluded.
|
sl@0
|
112 |
# Set it to YES to include the internal documentation.
|
sl@0
|
113 |
|
sl@0
|
114 |
INTERNAL_DOCS = NO
|
sl@0
|
115 |
|
sl@0
|
116 |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
sl@0
|
117 |
# generate a class diagram (in Html and LaTeX) for classes with base or
|
sl@0
|
118 |
# super classes. Setting the tag to NO turns the diagrams off.
|
sl@0
|
119 |
|
sl@0
|
120 |
CLASS_DIAGRAMS = YES
|
sl@0
|
121 |
|
sl@0
|
122 |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
sl@0
|
123 |
# be generated. Documented entities will be cross-referenced with these sources.
|
sl@0
|
124 |
|
sl@0
|
125 |
SOURCE_BROWSER = YES
|
sl@0
|
126 |
|
sl@0
|
127 |
# Setting the INLINE_SOURCES tag to YES will include the body
|
sl@0
|
128 |
# of functions and classes directly in the documentation.
|
sl@0
|
129 |
|
sl@0
|
130 |
INLINE_SOURCES = NO
|
sl@0
|
131 |
|
sl@0
|
132 |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
sl@0
|
133 |
# doxygen to hide any special comment blocks from generated source code
|
sl@0
|
134 |
# fragments. Normal C and C++ comments will always remain visible.
|
sl@0
|
135 |
|
sl@0
|
136 |
STRIP_CODE_COMMENTS = YES
|
sl@0
|
137 |
|
sl@0
|
138 |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
sl@0
|
139 |
# file names in lower case letters. If set to YES upper case letters are also
|
sl@0
|
140 |
# allowed. This is useful if you have classes or files whose names only differ
|
sl@0
|
141 |
# in case and if your file system supports case sensitive file names. Windows
|
sl@0
|
142 |
# users are adviced to set this option to NO.
|
sl@0
|
143 |
|
sl@0
|
144 |
CASE_SENSE_NAMES = YES
|
sl@0
|
145 |
|
sl@0
|
146 |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
sl@0
|
147 |
# will show members with their full class and namespace scopes in the
|
sl@0
|
148 |
# documentation. If set to YES the scope will be hidden.
|
sl@0
|
149 |
|
sl@0
|
150 |
HIDE_SCOPE_NAMES = NO
|
sl@0
|
151 |
|
sl@0
|
152 |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
sl@0
|
153 |
# will generate a verbatim copy of the header file for each class for
|
sl@0
|
154 |
# which an include is specified. Set to NO to disable this.
|
sl@0
|
155 |
|
sl@0
|
156 |
VERBATIM_HEADERS = YES
|
sl@0
|
157 |
|
sl@0
|
158 |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
sl@0
|
159 |
# will put list of the files that are included by a file in the documentation
|
sl@0
|
160 |
# of that file.
|
sl@0
|
161 |
|
sl@0
|
162 |
SHOW_INCLUDE_FILES = YES
|
sl@0
|
163 |
|
sl@0
|
164 |
# If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
|
sl@0
|
165 |
# will interpret the first line (until the first dot) of a JavaDoc-style
|
sl@0
|
166 |
# comment as the brief description. If set to NO, the Javadoc-style will
|
sl@0
|
167 |
# behave just like the Qt-style comments.
|
sl@0
|
168 |
|
sl@0
|
169 |
JAVADOC_AUTOBRIEF = YES
|
sl@0
|
170 |
|
sl@0
|
171 |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
sl@0
|
172 |
# member inherits the documentation from any documented member that it
|
sl@0
|
173 |
# reimplements.
|
sl@0
|
174 |
|
sl@0
|
175 |
INHERIT_DOCS = YES
|
sl@0
|
176 |
|
sl@0
|
177 |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
sl@0
|
178 |
# is inserted in the documentation for inline members.
|
sl@0
|
179 |
|
sl@0
|
180 |
INLINE_INFO = YES
|
sl@0
|
181 |
|
sl@0
|
182 |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
sl@0
|
183 |
# will sort the (detailed) documentation of file and class members
|
sl@0
|
184 |
# alphabetically by member name. If set to NO the members will appear in
|
sl@0
|
185 |
# declaration order.
|
sl@0
|
186 |
|
sl@0
|
187 |
SORT_MEMBER_DOCS = YES
|
sl@0
|
188 |
|
sl@0
|
189 |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
sl@0
|
190 |
# tag is set to YES, then doxygen will reuse the documentation of the first
|
sl@0
|
191 |
# member in the group (if any) for the other members of the group. By default
|
sl@0
|
192 |
# all members of a group must be documented explicitly.
|
sl@0
|
193 |
|
sl@0
|
194 |
DISTRIBUTE_GROUP_DOC = NO
|
sl@0
|
195 |
|
sl@0
|
196 |
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
sl@0
|
197 |
# Doxygen uses this value to replace tabs by spaces in code fragments.
|
sl@0
|
198 |
|
sl@0
|
199 |
TAB_SIZE = 4
|
sl@0
|
200 |
|
sl@0
|
201 |
# The ENABLE_SECTIONS tag can be used to enable conditional
|
sl@0
|
202 |
# documentation sections, marked by \if sectionname ... \endif.
|
sl@0
|
203 |
|
sl@0
|
204 |
ENABLED_SECTIONS =
|
sl@0
|
205 |
|
sl@0
|
206 |
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
sl@0
|
207 |
# disable (NO) the to-do list. This list is created by putting \todo
|
sl@0
|
208 |
# commands in the documentation.
|
sl@0
|
209 |
|
sl@0
|
210 |
GENERATE_TODOLIST = YES
|
sl@0
|
211 |
|
sl@0
|
212 |
# The GENERATE_TESTLIST tag can be used to enable (YES) or
|
sl@0
|
213 |
# disable (NO) the test list. This list is created by putting \test
|
sl@0
|
214 |
# commands in the documentation.
|
sl@0
|
215 |
|
sl@0
|
216 |
GENERATE_TESTLIST = YES
|
sl@0
|
217 |
|
sl@0
|
218 |
# This tag can be used to specify a number of aliases that acts
|
sl@0
|
219 |
# as commands in the documentation. An alias has the form "name=value".
|
sl@0
|
220 |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
sl@0
|
221 |
# put the command \sideeffect (or @sideeffect) in the documentation, which
|
sl@0
|
222 |
# will result in a user defined paragraph with heading "Side Effects:".
|
sl@0
|
223 |
# You can put \n's in the value part of an alias to insert newlines.
|
sl@0
|
224 |
|
sl@0
|
225 |
ALIASES =
|
sl@0
|
226 |
|
sl@0
|
227 |
#---------------------------------------------------------------------------
|
sl@0
|
228 |
# configuration options related to warning and progress messages
|
sl@0
|
229 |
#---------------------------------------------------------------------------
|
sl@0
|
230 |
|
sl@0
|
231 |
# The QUIET tag can be used to turn on/off the messages that are generated
|
sl@0
|
232 |
# by doxygen. Possible values are YES and NO. If left blank NO is used.
|
sl@0
|
233 |
|
sl@0
|
234 |
QUIET = NO
|
sl@0
|
235 |
|
sl@0
|
236 |
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
sl@0
|
237 |
# generated by doxygen. Possible values are YES and NO. If left blank
|
sl@0
|
238 |
# NO is used.
|
sl@0
|
239 |
|
sl@0
|
240 |
WARNINGS = YES
|
sl@0
|
241 |
|
sl@0
|
242 |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
sl@0
|
243 |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
sl@0
|
244 |
# automatically be disabled.
|
sl@0
|
245 |
|
sl@0
|
246 |
WARN_IF_UNDOCUMENTED = YES
|
sl@0
|
247 |
|
sl@0
|
248 |
# The WARN_FORMAT tag determines the format of the warning messages that
|
sl@0
|
249 |
# doxygen can produce. The string should contain the $file, $line, and $text
|
sl@0
|
250 |
# tags, which will be replaced by the file and line number from which the
|
sl@0
|
251 |
# warning originated and the warning text.
|
sl@0
|
252 |
|
sl@0
|
253 |
WARN_FORMAT = "$file:$line: $text"
|
sl@0
|
254 |
|
sl@0
|
255 |
#---------------------------------------------------------------------------
|
sl@0
|
256 |
# configuration options related to the input files
|
sl@0
|
257 |
#---------------------------------------------------------------------------
|
sl@0
|
258 |
|
sl@0
|
259 |
# The INPUT tag can be used to specify the files and/or directories that contain
|
sl@0
|
260 |
# documented source files. You may enter file names like "myfile.cpp" or
|
sl@0
|
261 |
# directories like "/usr/src/myproject". Separate the files or directories
|
sl@0
|
262 |
# with spaces.
|
sl@0
|
263 |
|
sl@0
|
264 |
INPUT = ../inc/stringpool.h ../inc/stringpool.inl ../docs/StringPool.dox ../src/StringPoolAPI.cpp
|
sl@0
|
265 |
|
sl@0
|
266 |
# If the value of the INPUT tag contains directories, you can use the
|
sl@0
|
267 |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
sl@0
|
268 |
# and *.h) to filter out the source-files in the directories. If left
|
sl@0
|
269 |
# blank all files are included.
|
sl@0
|
270 |
|
sl@0
|
271 |
FILE_PATTERNS =
|
sl@0
|
272 |
|
sl@0
|
273 |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
sl@0
|
274 |
# should be searched for input files as well. Possible values are YES and NO.
|
sl@0
|
275 |
# If left blank NO is used.
|
sl@0
|
276 |
|
sl@0
|
277 |
RECURSIVE = NO
|
sl@0
|
278 |
|
sl@0
|
279 |
# The EXCLUDE tag can be used to specify files and/or directories that should
|
sl@0
|
280 |
# excluded from the INPUT source files. This way you can easily exclude a
|
sl@0
|
281 |
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
sl@0
|
282 |
|
sl@0
|
283 |
EXCLUDE =
|
sl@0
|
284 |
|
sl@0
|
285 |
# If the value of the INPUT tag contains directories, you can use the
|
sl@0
|
286 |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
sl@0
|
287 |
# certain files from those directories.
|
sl@0
|
288 |
|
sl@0
|
289 |
EXCLUDE_PATTERNS =
|
sl@0
|
290 |
|
sl@0
|
291 |
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
sl@0
|
292 |
# directories that contain example code fragments that are included (see
|
sl@0
|
293 |
# the \include command).
|
sl@0
|
294 |
|
sl@0
|
295 |
EXAMPLE_PATH =
|
sl@0
|
296 |
|
sl@0
|
297 |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
sl@0
|
298 |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
sl@0
|
299 |
# and *.h) to filter out the source-files in the directories. If left
|
sl@0
|
300 |
# blank all files are included.
|
sl@0
|
301 |
|
sl@0
|
302 |
EXAMPLE_PATTERNS =
|
sl@0
|
303 |
|
sl@0
|
304 |
# The IMAGE_PATH tag can be used to specify one or more files or
|
sl@0
|
305 |
# directories that contain image that are included in the documentation (see
|
sl@0
|
306 |
# the \image command).
|
sl@0
|
307 |
|
sl@0
|
308 |
IMAGE_PATH =
|
sl@0
|
309 |
|
sl@0
|
310 |
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
sl@0
|
311 |
# invoke to filter for each input file. Doxygen will invoke the filter program
|
sl@0
|
312 |
# by executing (via popen()) the command <filter> <input-file>, where <filter>
|
sl@0
|
313 |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
sl@0
|
314 |
# input file. Doxygen will then use the output that the filter program writes
|
sl@0
|
315 |
# to standard output.
|
sl@0
|
316 |
|
sl@0
|
317 |
INPUT_FILTER =
|
sl@0
|
318 |
|
sl@0
|
319 |
#---------------------------------------------------------------------------
|
sl@0
|
320 |
# configuration options related to the alphabetical class index
|
sl@0
|
321 |
#---------------------------------------------------------------------------
|
sl@0
|
322 |
|
sl@0
|
323 |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
sl@0
|
324 |
# of all compounds will be generated. Enable this if the project
|
sl@0
|
325 |
# contains a lot of classes, structs, unions or interfaces.
|
sl@0
|
326 |
|
sl@0
|
327 |
ALPHABETICAL_INDEX = YES
|
sl@0
|
328 |
|
sl@0
|
329 |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
sl@0
|
330 |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
sl@0
|
331 |
# in which this list will be split (can be a number in the range [1..20])
|
sl@0
|
332 |
|
sl@0
|
333 |
COLS_IN_ALPHA_INDEX = 5
|
sl@0
|
334 |
|
sl@0
|
335 |
# In case all classes in a project start with a common prefix, all
|
sl@0
|
336 |
# classes will be put under the same header in the alphabetical index.
|
sl@0
|
337 |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
sl@0
|
338 |
# should be ignored while generating the index headers.
|
sl@0
|
339 |
|
sl@0
|
340 |
IGNORE_PREFIX = CHTTP MHTTP RHTTP THTTP R C T M
|
sl@0
|
341 |
|
sl@0
|
342 |
#---------------------------------------------------------------------------
|
sl@0
|
343 |
# configuration options related to the HTML output
|
sl@0
|
344 |
#---------------------------------------------------------------------------
|
sl@0
|
345 |
|
sl@0
|
346 |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
sl@0
|
347 |
# generate HTML output.
|
sl@0
|
348 |
|
sl@0
|
349 |
GENERATE_HTML = YES
|
sl@0
|
350 |
|
sl@0
|
351 |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
sl@0
|
352 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
sl@0
|
353 |
# put in front of it. If left blank `html' will be used as the default path.
|
sl@0
|
354 |
|
sl@0
|
355 |
HTML_OUTPUT = .
|
sl@0
|
356 |
|
sl@0
|
357 |
# The HTML_HEADER tag can be used to specify a personal HTML header for
|
sl@0
|
358 |
# each generated HTML page. If it is left blank doxygen will generate a
|
sl@0
|
359 |
# standard header.
|
sl@0
|
360 |
|
sl@0
|
361 |
HTML_HEADER =
|
sl@0
|
362 |
|
sl@0
|
363 |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
sl@0
|
364 |
# each generated HTML page. If it is left blank doxygen will generate a
|
sl@0
|
365 |
# standard footer.
|
sl@0
|
366 |
|
sl@0
|
367 |
HTML_FOOTER = footer.tpl
|
sl@0
|
368 |
|
sl@0
|
369 |
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
|
sl@0
|
370 |
# style sheet that is used by each HTML page. It can be used to
|
sl@0
|
371 |
# fine-tune the look of the HTML output. If the tag is left blank doxygen
|
sl@0
|
372 |
# will generate a default style sheet
|
sl@0
|
373 |
|
sl@0
|
374 |
HTML_STYLESHEET =
|
sl@0
|
375 |
|
sl@0
|
376 |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
sl@0
|
377 |
# files or namespaces will be aligned in HTML using tables. If set to
|
sl@0
|
378 |
# NO a bullet list will be used.
|
sl@0
|
379 |
|
sl@0
|
380 |
HTML_ALIGN_MEMBERS = YES
|
sl@0
|
381 |
|
sl@0
|
382 |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
sl@0
|
383 |
# will be generated that can be used as input for tools like the
|
sl@0
|
384 |
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
sl@0
|
385 |
# of the generated HTML documentation.
|
sl@0
|
386 |
|
sl@0
|
387 |
GENERATE_HTMLHELP = YES
|
sl@0
|
388 |
|
sl@0
|
389 |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
sl@0
|
390 |
# top of each HTML page. The value NO (the default) enables the index and
|
sl@0
|
391 |
# the value YES disables it.
|
sl@0
|
392 |
|
sl@0
|
393 |
DISABLE_INDEX = NO
|
sl@0
|
394 |
|
sl@0
|
395 |
GENERATE_TREEVIEW = YES
|
sl@0
|
396 |
|
sl@0
|
397 |
#---------------------------------------------------------------------------
|
sl@0
|
398 |
# configuration options related to the LaTeX output
|
sl@0
|
399 |
#---------------------------------------------------------------------------
|
sl@0
|
400 |
|
sl@0
|
401 |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
sl@0
|
402 |
# generate Latex output.
|
sl@0
|
403 |
|
sl@0
|
404 |
GENERATE_LATEX = NO
|
sl@0
|
405 |
|
sl@0
|
406 |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
sl@0
|
407 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
sl@0
|
408 |
# put in front of it. If left blank `latex' will be used as the default path.
|
sl@0
|
409 |
|
sl@0
|
410 |
LATEX_OUTPUT = latex
|
sl@0
|
411 |
|
sl@0
|
412 |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
sl@0
|
413 |
# LaTeX documents. This may be useful for small projects and may help to
|
sl@0
|
414 |
# save some trees in general.
|
sl@0
|
415 |
|
sl@0
|
416 |
COMPACT_LATEX = NO
|
sl@0
|
417 |
|
sl@0
|
418 |
# The PAPER_TYPE tag can be used to set the paper type that is used
|
sl@0
|
419 |
# by the printer. Possible values are: a4, a4wide, letter, legal and
|
sl@0
|
420 |
# executive. If left blank a4wide will be used.
|
sl@0
|
421 |
|
sl@0
|
422 |
PAPER_TYPE = a4wide
|
sl@0
|
423 |
|
sl@0
|
424 |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
sl@0
|
425 |
# packages that should be included in the LaTeX output.
|
sl@0
|
426 |
|
sl@0
|
427 |
EXTRA_PACKAGES =
|
sl@0
|
428 |
|
sl@0
|
429 |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
sl@0
|
430 |
# the generated latex document. The header should contain everything until
|
sl@0
|
431 |
# the first chapter. If it is left blank doxygen will generate a
|
sl@0
|
432 |
# standard header. Notice: only use this tag if you know what you are doing!
|
sl@0
|
433 |
|
sl@0
|
434 |
LATEX_HEADER =
|
sl@0
|
435 |
|
sl@0
|
436 |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
sl@0
|
437 |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
sl@0
|
438 |
# contain links (just like the HTML output) instead of page references
|
sl@0
|
439 |
# This makes the output suitable for online browsing using a pdf viewer.
|
sl@0
|
440 |
|
sl@0
|
441 |
PDF_HYPERLINKS = NO
|
sl@0
|
442 |
|
sl@0
|
443 |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
sl@0
|
444 |
# plain latex in the generated Makefile. Set this option to YES to get a
|
sl@0
|
445 |
# higher quality PDF documentation.
|
sl@0
|
446 |
|
sl@0
|
447 |
USE_PDFLATEX = NO
|
sl@0
|
448 |
|
sl@0
|
449 |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
sl@0
|
450 |
# command to the generated LaTeX files. This will instruct LaTeX to keep
|
sl@0
|
451 |
# running if errors occur, instead of asking the user for help.
|
sl@0
|
452 |
# This option is also used when generating formulas in HTML.
|
sl@0
|
453 |
|
sl@0
|
454 |
LATEX_BATCHMODE = NO
|
sl@0
|
455 |
|
sl@0
|
456 |
#---------------------------------------------------------------------------
|
sl@0
|
457 |
# configuration options related to the RTF output
|
sl@0
|
458 |
#---------------------------------------------------------------------------
|
sl@0
|
459 |
|
sl@0
|
460 |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
sl@0
|
461 |
# The RTF output is optimised for Word 97 and may not look very pretty with
|
sl@0
|
462 |
# other RTF readers or editors.
|
sl@0
|
463 |
|
sl@0
|
464 |
GENERATE_RTF = NO
|
sl@0
|
465 |
|
sl@0
|
466 |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
sl@0
|
467 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
sl@0
|
468 |
# put in front of it. If left blank `rtf' will be used as the default path.
|
sl@0
|
469 |
|
sl@0
|
470 |
RTF_OUTPUT = rtf
|
sl@0
|
471 |
|
sl@0
|
472 |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
sl@0
|
473 |
# RTF documents. This may be useful for small projects and may help to
|
sl@0
|
474 |
# save some trees in general.
|
sl@0
|
475 |
|
sl@0
|
476 |
COMPACT_RTF = NO
|
sl@0
|
477 |
|
sl@0
|
478 |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
sl@0
|
479 |
# will contain hyperlink fields. The RTF file will
|
sl@0
|
480 |
# contain links (just like the HTML output) instead of page references.
|
sl@0
|
481 |
# This makes the output suitable for online browsing using a WORD or other.
|
sl@0
|
482 |
# programs which support those fields.
|
sl@0
|
483 |
# Note: wordpad (write) and others do not support links.
|
sl@0
|
484 |
|
sl@0
|
485 |
RTF_HYPERLINKS = NO
|
sl@0
|
486 |
|
sl@0
|
487 |
# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
sl@0
|
488 |
# config file, i.e. a series of assigments. You only have to provide
|
sl@0
|
489 |
# replacements, missing definitions are set to their default value.
|
sl@0
|
490 |
|
sl@0
|
491 |
RTF_STYLESHEET_FILE =
|
sl@0
|
492 |
|
sl@0
|
493 |
#---------------------------------------------------------------------------
|
sl@0
|
494 |
# configuration options related to the man page output
|
sl@0
|
495 |
#---------------------------------------------------------------------------
|
sl@0
|
496 |
|
sl@0
|
497 |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
sl@0
|
498 |
# generate man pages
|
sl@0
|
499 |
|
sl@0
|
500 |
GENERATE_MAN = NO
|
sl@0
|
501 |
|
sl@0
|
502 |
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
sl@0
|
503 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
sl@0
|
504 |
# put in front of it. If left blank `man' will be used as the default path.
|
sl@0
|
505 |
|
sl@0
|
506 |
MAN_OUTPUT = man
|
sl@0
|
507 |
|
sl@0
|
508 |
# The MAN_EXTENSION tag determines the extension that is added to
|
sl@0
|
509 |
# the generated man pages (default is the subroutine's section .3)
|
sl@0
|
510 |
|
sl@0
|
511 |
MAN_EXTENSION = .3
|
sl@0
|
512 |
|
sl@0
|
513 |
#---------------------------------------------------------------------------
|
sl@0
|
514 |
# configuration options related to the XML output
|
sl@0
|
515 |
#---------------------------------------------------------------------------
|
sl@0
|
516 |
|
sl@0
|
517 |
# If the GENERATE_XML tag is set to YES Doxygen will
|
sl@0
|
518 |
# generate an XML file that captures the structure of
|
sl@0
|
519 |
# the code including all documentation. Warning: This feature
|
sl@0
|
520 |
# is still experimental and not complete.
|
sl@0
|
521 |
|
sl@0
|
522 |
GENERATE_XML = NO
|
sl@0
|
523 |
|
sl@0
|
524 |
#---------------------------------------------------------------------------
|
sl@0
|
525 |
# Configuration options related to the preprocessor
|
sl@0
|
526 |
#---------------------------------------------------------------------------
|
sl@0
|
527 |
|
sl@0
|
528 |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
sl@0
|
529 |
# evaluate all C-preprocessor directives found in the sources and include
|
sl@0
|
530 |
# files.
|
sl@0
|
531 |
|
sl@0
|
532 |
ENABLE_PREPROCESSING = YES
|
sl@0
|
533 |
|
sl@0
|
534 |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
sl@0
|
535 |
# names in the source code. If set to NO (the default) only conditional
|
sl@0
|
536 |
# compilation will be performed. Macro expansion can be done in a controlled
|
sl@0
|
537 |
# way by setting EXPAND_ONLY_PREDEF to YES.
|
sl@0
|
538 |
|
sl@0
|
539 |
MACRO_EXPANSION = NO
|
sl@0
|
540 |
|
sl@0
|
541 |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
sl@0
|
542 |
# then the macro expansion is limited to the macros specified with the
|
sl@0
|
543 |
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
sl@0
|
544 |
|
sl@0
|
545 |
EXPAND_ONLY_PREDEF = NO
|
sl@0
|
546 |
|
sl@0
|
547 |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
sl@0
|
548 |
# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
sl@0
|
549 |
|
sl@0
|
550 |
SEARCH_INCLUDES = YES
|
sl@0
|
551 |
|
sl@0
|
552 |
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
sl@0
|
553 |
# contain include files that are not input files but should be processed by
|
sl@0
|
554 |
# the preprocessor.
|
sl@0
|
555 |
|
sl@0
|
556 |
INCLUDE_PATH =
|
sl@0
|
557 |
|
sl@0
|
558 |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
sl@0
|
559 |
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
sl@0
|
560 |
# directories. If left blank, the patterns specified with FILE_PATTERNS will
|
sl@0
|
561 |
# be used.
|
sl@0
|
562 |
|
sl@0
|
563 |
INCLUDE_FILE_PATTERNS =
|
sl@0
|
564 |
|
sl@0
|
565 |
# The PREDEFINED tag can be used to specify one or more macro names that
|
sl@0
|
566 |
# are defined before the preprocessor is started (similar to the -D option of
|
sl@0
|
567 |
# gcc). The argument of the tag is a list of macros of the form: name
|
sl@0
|
568 |
# or name=definition (no spaces). If the definition and the = are
|
sl@0
|
569 |
# omitted =1 is assumed.
|
sl@0
|
570 |
|
sl@0
|
571 |
PREDEFINED =
|
sl@0
|
572 |
|
sl@0
|
573 |
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
|
sl@0
|
574 |
# this tag can be used to specify a list of macro names that should be expanded.
|
sl@0
|
575 |
# The macro definition that is found in the sources will be used.
|
sl@0
|
576 |
# Use the PREDEFINED tag if you want to use a different macro definition.
|
sl@0
|
577 |
|
sl@0
|
578 |
EXPAND_AS_DEFINED =
|
sl@0
|
579 |
|
sl@0
|
580 |
#---------------------------------------------------------------------------
|
sl@0
|
581 |
# Configuration::addtions related to external references
|
sl@0
|
582 |
#---------------------------------------------------------------------------
|
sl@0
|
583 |
|
sl@0
|
584 |
# The TAGFILES tag can be used to specify one or more tagfiles.
|
sl@0
|
585 |
|
sl@0
|
586 |
TAGFILES =
|
sl@0
|
587 |
|
sl@0
|
588 |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
sl@0
|
589 |
# a tag file that is based on the input files it reads.
|
sl@0
|
590 |
|
sl@0
|
591 |
GENERATE_TAGFILE =
|
sl@0
|
592 |
|
sl@0
|
593 |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
sl@0
|
594 |
# in the class index. If set to NO only the inherited external classes
|
sl@0
|
595 |
# will be listed.
|
sl@0
|
596 |
|
sl@0
|
597 |
ALLEXTERNALS = NO
|
sl@0
|
598 |
|
sl@0
|
599 |
# The PERL_PATH should be the absolute path and name of the perl script
|
sl@0
|
600 |
# interpreter (i.e. the result of `which perl').
|
sl@0
|
601 |
|
sl@0
|
602 |
PERL_PATH = /usr/bin/perl
|
sl@0
|
603 |
|
sl@0
|
604 |
#---------------------------------------------------------------------------
|
sl@0
|
605 |
# Configuration options related to the dot tool
|
sl@0
|
606 |
#---------------------------------------------------------------------------
|
sl@0
|
607 |
|
sl@0
|
608 |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
sl@0
|
609 |
# available from the path. This tool is part of Graphviz, a graph visualization
|
sl@0
|
610 |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
sl@0
|
611 |
# have no effect if this option is set to NO (the default)
|
sl@0
|
612 |
|
sl@0
|
613 |
HAVE_DOT = YES
|
sl@0
|
614 |
|
sl@0
|
615 |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
sl@0
|
616 |
# will generate a graph for each documented class showing the direct and
|
sl@0
|
617 |
# indirect inheritance relations. Setting this tag to YES will force the
|
sl@0
|
618 |
# the CLASS_DIAGRAMS tag to NO.
|
sl@0
|
619 |
|
sl@0
|
620 |
CLASS_GRAPH = YES
|
sl@0
|
621 |
|
sl@0
|
622 |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
sl@0
|
623 |
# will generate a graph for each documented class showing the direct and
|
sl@0
|
624 |
# indirect implementation dependencies (inheritance, containment, and
|
sl@0
|
625 |
# class references variables) of the class with other documented classes.
|
sl@0
|
626 |
|
sl@0
|
627 |
COLLABORATION_GRAPH = YES
|
sl@0
|
628 |
|
sl@0
|
629 |
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
|
sl@0
|
630 |
# YES then doxygen will generate a graph for each documented file showing
|
sl@0
|
631 |
# the direct and indirect include dependencies of the file with other
|
sl@0
|
632 |
# documented files.
|
sl@0
|
633 |
|
sl@0
|
634 |
INCLUDE_GRAPH = YES
|
sl@0
|
635 |
|
sl@0
|
636 |
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
|
sl@0
|
637 |
# YES then doxygen will generate a graph for each documented header file showing
|
sl@0
|
638 |
# the documented files that directly or indirectly include this file
|
sl@0
|
639 |
|
sl@0
|
640 |
INCLUDED_BY_GRAPH = YES
|
sl@0
|
641 |
|
sl@0
|
642 |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
sl@0
|
643 |
# will graphical hierarchy of all classes instead of a textual one.
|
sl@0
|
644 |
|
sl@0
|
645 |
GRAPHICAL_HIERARCHY = YES
|
sl@0
|
646 |
|
sl@0
|
647 |
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
sl@0
|
648 |
# found. If left blank, it is assumed the dot tool can be found on the path.
|
sl@0
|
649 |
|
sl@0
|
650 |
DOT_PATH = c:/apps/graphviz/bin/
|
sl@0
|
651 |
|
sl@0
|
652 |
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
sl@0
|
653 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
sl@0
|
654 |
# this value, doxygen will try to truncate the graph, so that it fits within
|
sl@0
|
655 |
# the specified constraint. Beware that most browsers cannot cope with very
|
sl@0
|
656 |
# large images.
|
sl@0
|
657 |
|
sl@0
|
658 |
MAX_DOT_GRAPH_WIDTH = 1024
|
sl@0
|
659 |
|
sl@0
|
660 |
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
sl@0
|
661 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
sl@0
|
662 |
# this value, doxygen will try to truncate the graph, so that it fits within
|
sl@0
|
663 |
# the specified constraint. Beware that most browsers cannot cope with very
|
sl@0
|
664 |
# large images.
|
sl@0
|
665 |
|
sl@0
|
666 |
MAX_DOT_GRAPH_HEIGHT = 1024
|
sl@0
|
667 |
|
sl@0
|
668 |
#---------------------------------------------------------------------------
|
sl@0
|
669 |
# Configuration::addtions related to the search engine
|
sl@0
|
670 |
#---------------------------------------------------------------------------
|
sl@0
|
671 |
|
sl@0
|
672 |
# The SEARCHENGINE tag specifies whether or not a search engine should be
|
sl@0
|
673 |
# used. If set to NO the values of all tags below this one will be ignored.
|
sl@0
|
674 |
|
sl@0
|
675 |
SEARCHENGINE = NO
|
sl@0
|
676 |
|
sl@0
|
677 |
# The CGI_NAME tag should be the name of the CGI script that
|
sl@0
|
678 |
# starts the search engine (doxysearch) with the correct parameters.
|
sl@0
|
679 |
# A script with this name will be generated by doxygen.
|
sl@0
|
680 |
|
sl@0
|
681 |
CGI_NAME = search.cgi
|
sl@0
|
682 |
|
sl@0
|
683 |
# The CGI_URL tag should be the absolute URL to the directory where the
|
sl@0
|
684 |
# cgi binaries are located. See the documentation of your http daemon for
|
sl@0
|
685 |
# details.
|
sl@0
|
686 |
|
sl@0
|
687 |
CGI_URL =
|
sl@0
|
688 |
|
sl@0
|
689 |
# The DOC_URL tag should be the absolute URL to the directory where the
|
sl@0
|
690 |
# documentation is located. If left blank the absolute path to the
|
sl@0
|
691 |
# documentation, with file:// prepended to it, will be used.
|
sl@0
|
692 |
|
sl@0
|
693 |
DOC_URL =
|
sl@0
|
694 |
|
sl@0
|
695 |
# The DOC_ABSPATH tag should be the absolute path to the directory where the
|
sl@0
|
696 |
# documentation is located. If left blank the directory on the local machine
|
sl@0
|
697 |
# will be used.
|
sl@0
|
698 |
|
sl@0
|
699 |
DOC_ABSPATH =
|
sl@0
|
700 |
|
sl@0
|
701 |
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
|
sl@0
|
702 |
# is installed.
|
sl@0
|
703 |
|
sl@0
|
704 |
BIN_ABSPATH = /usr/local/bin/
|
sl@0
|
705 |
|
sl@0
|
706 |
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
|
sl@0
|
707 |
# documentation generated for other projects. This allows doxysearch to search
|
sl@0
|
708 |
# the documentation for these projects as well.
|
sl@0
|
709 |
|
sl@0
|
710 |
EXT_DOC_PATHS =
|