• R/O
  • HTTP
  • SSH
  • HTTPS

Commit

Tags
Aucun tag

Frequently used words (click to add to your profile)

javac++androidlinuxc#objective-cqt誰得cocoawindowspythonphprubygameguibathyscaphec翻訳omegat計画中(planning stage)frameworktwittertestdombtronvb.netdirectxarduinopreviewerゲームエンジン

An Objective-C wrapper for Mac OS X’s FSEvents C API.


Commit MetaInfo

Révisionc728faf60dd6f91943bdf818bd2ab971deb63db7 (tree)
l'heure2010-08-04 05:12:25
AuteurAron Cedercrantz <aron@cede...>
CommiterAron Cedercrantz

Message de Log

Merge branch 'release/1.1.1'

Change Summary

Modification

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