diff options
-rw-r--r-- | Doxyfile | 1608 | ||||
-rw-r--r-- | src/experimental/debugmutex.cpp | 78 | ||||
-rw-r--r-- | src/experimental/debugmutex.h | 102 | ||||
-rw-r--r-- | src/stable/mutex.h | 8 | ||||
-rw-r--r-- | src/stable/myriad.cpp | 34 | ||||
-rw-r--r-- | src/stable/myriad.h | 49 | ||||
-rw-r--r-- | src/tests/myriadfs.cpp | 2 | ||||
-rw-r--r-- | src/unstable/myriadcache.h | 4 | ||||
-rw-r--r-- | src/unstable/myriadfs.cpp | 30 | ||||
-rw-r--r-- | src/unstable/myriadfs.h | 14 |
10 files changed, 365 insertions, 1564 deletions
@@ -1,105 +1,20 @@ | |||
1 | # Doxyfile 1.8.1 | 1 | # Doxyfile 1.9.4 |
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 | 2 | ||
13 | #--------------------------------------------------------------------------- | 3 | #--------------------------------------------------------------------------- |
14 | # Project related configuration options | 4 | # Project related configuration options |
15 | #--------------------------------------------------------------------------- | 5 | #--------------------------------------------------------------------------- |
16 | |||
17 | # This tag specifies the encoding used for all characters in the config file | ||
18 | # that follow. The default is UTF-8 which is also the encoding used for all | ||
19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | ||
20 | # iconv built into libc) for the transcoding. See | ||
21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. | ||
22 | |||
23 | DOXYFILE_ENCODING = UTF-8 | 6 | DOXYFILE_ENCODING = UTF-8 |
24 | |||
25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should | ||
26 | # identify the project. Note that if you do not use Doxywizard you need | ||
27 | # to put quotes around the project name if it contains spaces. | ||
28 | |||
29 | PROJECT_NAME = libbu++ | 7 | PROJECT_NAME = libbu++ |
30 | |||
31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. | ||
32 | # This could be handy for archiving the generated documentation or | ||
33 | # if some version control system is used. | ||
34 | |||
35 | PROJECT_NUMBER = $VERSION$ | 8 | PROJECT_NUMBER = $VERSION$ |
36 | |||
37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description | ||
38 | # for a project that appears at the top of each page and should give viewer | ||
39 | # a quick idea about the purpose of the project. Keep the description short. | ||
40 | |||
41 | PROJECT_BRIEF = | 9 | PROJECT_BRIEF = |
42 | |||
43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is | ||
44 | # included in the documentation. The maximum height of the logo should not | ||
45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels. | ||
46 | # Doxygen will copy the logo to the output directory. | ||
47 | |||
48 | PROJECT_LOGO = | 10 | PROJECT_LOGO = |
49 | |||
50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | ||
51 | # base path where the generated documentation will be put. | ||
52 | # If a relative path is entered, it will be relative to the location | ||
53 | # where doxygen was started. If left blank the current directory will be used. | ||
54 | |||
55 | OUTPUT_DIRECTORY = api | 11 | OUTPUT_DIRECTORY = api |
56 | |||
57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | ||
58 | # 4096 sub-directories (in 2 levels) under the output directory of each output | ||
59 | # format and will distribute the generated files over these directories. | ||
60 | # Enabling this option can be useful when feeding doxygen a huge amount of | ||
61 | # source files, where putting all generated files in the same directory would | ||
62 | # otherwise cause performance problems for the file system. | ||
63 | |||
64 | CREATE_SUBDIRS = NO | 12 | CREATE_SUBDIRS = NO |
65 | 13 | CREATE_SUBDIRS_LEVEL = 8 | |
66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 14 | ALLOW_UNICODE_NAMES = NO |
67 | # documentation generated by doxygen is written. Doxygen will use this | ||
68 | # information to generate all constant output in the proper language. | ||
69 | # The default language is English, other supported languages are: | ||
70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | ||
71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, | ||
72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | ||
73 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | ||
74 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, | ||
75 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | ||
76 | |||
77 | OUTPUT_LANGUAGE = English | 15 | OUTPUT_LANGUAGE = English |
78 | |||
79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | ||
80 | # include brief member descriptions after the members that are listed in | ||
81 | # the file and class documentation (similar to JavaDoc). | ||
82 | # Set to NO to disable this. | ||
83 | |||
84 | BRIEF_MEMBER_DESC = YES | 16 | BRIEF_MEMBER_DESC = YES |
85 | |||
86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | ||
87 | # the brief description of a member or function before the detailed description. | ||
88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||
89 | # brief descriptions will be completely suppressed. | ||
90 | |||
91 | REPEAT_BRIEF = YES | 17 | REPEAT_BRIEF = YES |
92 | |||
93 | # This tag implements a quasi-intelligent brief description abbreviator | ||
94 | # that is used to form the text in various listings. Each string | ||
95 | # in this list, if found as the leading text of the brief description, will be | ||
96 | # stripped from the text and the result after processing the whole list, is | ||
97 | # used as the annotated text. Otherwise, the brief description is used as-is. | ||
98 | # If left blank, the following values are used ("$name" is automatically | ||
99 | # replaced with the name of the entity): "The $name class" "The $name widget" | ||
100 | # "The $name file" "is" "provides" "specifies" "contains" | ||
101 | # "represents" "a" "an" "the" | ||
102 | |||
103 | ABBREVIATE_BRIEF = "The $name class" \ | 18 | ABBREVIATE_BRIEF = "The $name class" \ |
104 | "The $name widget" \ | 19 | "The $name widget" \ |
105 | "The $name file" \ | 20 | "The $name file" \ |
@@ -111,582 +26,107 @@ ABBREVIATE_BRIEF = "The $name class" \ | |||
111 | a \ | 26 | a \ |
112 | an \ | 27 | an \ |
113 | the | 28 | the |
114 | |||
115 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
116 | # Doxygen will generate a detailed section even if there is only a brief | ||
117 | # description. | ||
118 | |||
119 | ALWAYS_DETAILED_SEC = NO | 29 | ALWAYS_DETAILED_SEC = NO |
120 | |||
121 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | ||
122 | # inherited members of a class in the documentation of that class as if those | ||
123 | # members were ordinary class members. Constructors, destructors and assignment | ||
124 | # operators of the base classes will not be shown. | ||
125 | |||
126 | INLINE_INHERITED_MEMB = NO | 30 | INLINE_INHERITED_MEMB = NO |
127 | |||
128 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | ||
129 | # path before files name in the file list and in the header files. If set | ||
130 | # to NO the shortest path that makes the file name unique will be used. | ||
131 | |||
132 | FULL_PATH_NAMES = NO | 31 | FULL_PATH_NAMES = NO |
133 | |||
134 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | ||
135 | # can be used to strip a user-defined part of the path. Stripping is | ||
136 | # only done if one of the specified strings matches the left-hand part of | ||
137 | # the path. The tag can be used to show relative paths in the file list. | ||
138 | # If left blank the directory from which doxygen is run is used as the | ||
139 | # path to strip. | ||
140 | |||
141 | STRIP_FROM_PATH = | 32 | STRIP_FROM_PATH = |
142 | |||
143 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | ||
144 | # the path mentioned in the documentation of a class, which tells | ||
145 | # the reader which header file to include in order to use a class. | ||
146 | # If left blank only the name of the header file containing the class | ||
147 | # definition is used. Otherwise one should specify the include paths that | ||
148 | # are normally passed to the compiler using the -I flag. | ||
149 | |||
150 | STRIP_FROM_INC_PATH = | 33 | STRIP_FROM_INC_PATH = |
151 | |||
152 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | ||
153 | # (but less readable) file names. This can be useful if your file system | ||
154 | # doesn't support long names like on DOS, Mac, or CD-ROM. | ||
155 | |||
156 | SHORT_NAMES = NO | 34 | SHORT_NAMES = NO |
157 | |||
158 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | ||
159 | # will interpret the first line (until the first dot) of a JavaDoc-style | ||
160 | # comment as the brief description. If set to NO, the JavaDoc | ||
161 | # comments will behave just like regular Qt-style comments | ||
162 | # (thus requiring an explicit @brief command for a brief description.) | ||
163 | |||
164 | JAVADOC_AUTOBRIEF = YES | 35 | JAVADOC_AUTOBRIEF = YES |
165 | 36 | JAVADOC_BANNER = NO | |
166 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will | ||
167 | # interpret the first line (until the first dot) of a Qt-style | ||
168 | # comment as the brief description. If set to NO, the comments | ||
169 | # will behave just like regular Qt-style comments (thus requiring | ||
170 | # an explicit \brief command for a brief description.) | ||
171 | |||
172 | QT_AUTOBRIEF = NO | 37 | QT_AUTOBRIEF = NO |
173 | |||
174 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | ||
175 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | ||
176 | # comments) as a brief description. This used to be the default behaviour. | ||
177 | # The new default is to treat a multi-line C++ comment block as a detailed | ||
178 | # description. Set this tag to YES if you prefer the old behaviour instead. | ||
179 | |||
180 | MULTILINE_CPP_IS_BRIEF = NO | 38 | MULTILINE_CPP_IS_BRIEF = NO |
181 | 39 | PYTHON_DOCSTRING = YES | |
182 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | ||
183 | # member inherits the documentation from any documented member that it | ||
184 | # re-implements. | ||
185 | |||
186 | INHERIT_DOCS = YES | 40 | INHERIT_DOCS = YES |
187 | |||
188 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | ||
189 | # a new page for each member. If set to NO, the documentation of a member will | ||
190 | # be part of the file/class/namespace that contains it. | ||
191 | |||
192 | SEPARATE_MEMBER_PAGES = NO | 41 | SEPARATE_MEMBER_PAGES = NO |
193 | |||
194 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | ||
195 | # Doxygen uses this value to replace tabs by spaces in code fragments. | ||
196 | |||
197 | TAB_SIZE = 4 | 42 | TAB_SIZE = 4 |
198 | |||
199 | # This tag can be used to specify a number of aliases that acts | ||
200 | # as commands in the documentation. An alias has the form "name=value". | ||
201 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | ||
202 | # put the command \sideeffect (or @sideeffect) in the documentation, which | ||
203 | # will result in a user-defined paragraph with heading "Side Effects:". | ||
204 | # You can put \n's in the value part of an alias to insert newlines. | ||
205 | |||
206 | ALIASES = | 43 | ALIASES = |
207 | |||
208 | # This tag can be used to specify a number of word-keyword mappings (TCL only). | ||
209 | # A mapping has the form "name=value". For example adding | ||
210 | # "class=itcl::class" will allow you to use the command class in the | ||
211 | # itcl::class meaning. | ||
212 | |||
213 | TCL_SUBST = | ||
214 | |||
215 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C | ||
216 | # sources only. Doxygen will then generate output that is more tailored for C. | ||
217 | # For instance, some of the names that are used will be different. The list | ||
218 | # of all members will be omitted, etc. | ||
219 | |||
220 | OPTIMIZE_OUTPUT_FOR_C = NO | 44 | OPTIMIZE_OUTPUT_FOR_C = NO |
221 | |||
222 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java | ||
223 | # sources only. Doxygen will then generate output that is more tailored for | ||
224 | # Java. For instance, namespaces will be presented as packages, qualified | ||
225 | # scopes will look different, etc. | ||
226 | |||
227 | OPTIMIZE_OUTPUT_JAVA = NO | 45 | OPTIMIZE_OUTPUT_JAVA = NO |
228 | |||
229 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | ||
230 | # sources only. Doxygen will then generate output that is more tailored for | ||
231 | # Fortran. | ||
232 | |||
233 | OPTIMIZE_FOR_FORTRAN = NO | 46 | OPTIMIZE_FOR_FORTRAN = NO |
234 | |||
235 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | ||
236 | # sources. Doxygen will then generate output that is tailored for | ||
237 | # VHDL. | ||
238 | |||
239 | OPTIMIZE_OUTPUT_VHDL = NO | 47 | OPTIMIZE_OUTPUT_VHDL = NO |
240 | 48 | OPTIMIZE_OUTPUT_SLICE = NO | |
241 | # Doxygen selects the parser to use depending on the extension of the files it | ||
242 | # parses. With this tag you can assign which parser to use for a given extension. | ||
243 | # Doxygen has a built-in mapping, but you can override or extend it using this | ||
244 | # tag. The format is ext=language, where ext is a file extension, and language | ||
245 | # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, | ||
246 | # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make | ||
247 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C | ||
248 | # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions | ||
249 | # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. | ||
250 | |||
251 | EXTENSION_MAPPING = | 49 | EXTENSION_MAPPING = |
252 | |||
253 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all | ||
254 | # comments according to the Markdown format, which allows for more readable | ||
255 | # documentation. See http://daringfireball.net/projects/markdown/ for details. | ||
256 | # The output of markdown processing is further processed by doxygen, so you | ||
257 | # can mix doxygen, HTML, and XML commands with Markdown formatting. | ||
258 | # Disable only in case of backward compatibilities issues. | ||
259 | |||
260 | MARKDOWN_SUPPORT = YES | 50 | MARKDOWN_SUPPORT = YES |
261 | 51 | TOC_INCLUDE_HEADINGS = 5 | |
262 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | 52 | AUTOLINK_SUPPORT = YES |
263 | # to include (a tag file for) the STL sources as input, then you should | ||
264 | # set this tag to YES in order to let doxygen match functions declarations and | ||
265 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | ||
266 | # func(std::string) {}). This also makes the inheritance and collaboration | ||
267 | # diagrams that involve STL classes more complete and accurate. | ||
268 | |||
269 | BUILTIN_STL_SUPPORT = NO | 53 | BUILTIN_STL_SUPPORT = NO |
270 | |||
271 | # If you use Microsoft's C++/CLI language, you should set this option to YES to | ||
272 | # enable parsing support. | ||
273 | |||
274 | CPP_CLI_SUPPORT = NO | 54 | CPP_CLI_SUPPORT = NO |
275 | |||
276 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | ||
277 | # Doxygen will parse them like normal C++ but will assume all classes use public | ||
278 | # instead of private inheritance when no explicit protection keyword is present. | ||
279 | |||
280 | SIP_SUPPORT = NO | 55 | SIP_SUPPORT = NO |
281 | |||
282 | # For Microsoft's IDL there are propget and propput attributes to indicate getter | ||
283 | # and setter methods for a property. Setting this option to YES (the default) | ||
284 | # will make doxygen replace the get and set methods by a property in the | ||
285 | # documentation. This will only work if the methods are indeed getting or | ||
286 | # setting a simple type. If this is not the case, or you want to show the | ||
287 | # methods anyway, you should set this option to NO. | ||
288 | |||
289 | IDL_PROPERTY_SUPPORT = YES | 56 | IDL_PROPERTY_SUPPORT = YES |
290 | |||
291 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
292 | # tag is set to YES, then doxygen will reuse the documentation of the first | ||
293 | # member in the group (if any) for the other members of the group. By default | ||
294 | # all members of a group must be documented explicitly. | ||
295 | |||
296 | DISTRIBUTE_GROUP_DOC = NO | 57 | DISTRIBUTE_GROUP_DOC = NO |
297 | 58 | GROUP_NESTED_COMPOUNDS = NO | |
298 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | ||
299 | # the same type (for instance a group of public functions) to be put as a | ||
300 | # subgroup of that type (e.g. under the Public Functions section). Set it to | ||
301 | # NO to prevent subgrouping. Alternatively, this can be done per class using | ||
302 | # the \nosubgrouping command. | ||
303 | |||
304 | SUBGROUPING = YES | 59 | SUBGROUPING = YES |
305 | |||
306 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and | ||
307 | # unions are shown inside the group in which they are included (e.g. using | ||
308 | # @ingroup) instead of on a separate page (for HTML and Man pages) or | ||
309 | # section (for LaTeX and RTF). | ||
310 | |||
311 | INLINE_GROUPED_CLASSES = NO | 60 | INLINE_GROUPED_CLASSES = NO |
312 | |||
313 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and | ||
314 | # unions with only public data fields will be shown inline in the documentation | ||
315 | # of the scope in which they are defined (i.e. file, namespace, or group | ||
316 | # documentation), provided this scope is documented. If set to NO (the default), | ||
317 | # structs, classes, and unions are shown on a separate page (for HTML and Man | ||
318 | # pages) or section (for LaTeX and RTF). | ||
319 | |||
320 | INLINE_SIMPLE_STRUCTS = NO | 61 | INLINE_SIMPLE_STRUCTS = NO |
321 | |||
322 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | ||
323 | # is documented as struct, union, or enum with the name of the typedef. So | ||
324 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
325 | # with name TypeT. When disabled the typedef will appear as a member of a file, | ||
326 | # namespace, or class. And the struct will be named TypeS. This can typically | ||
327 | # be useful for C code in case the coding convention dictates that all compound | ||
328 | # types are typedef'ed and only the typedef is referenced, never the tag name. | ||
329 | |||
330 | TYPEDEF_HIDES_STRUCT = NO | 62 | TYPEDEF_HIDES_STRUCT = NO |
331 | |||
332 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | ||
333 | # determine which symbols to keep in memory and which to flush to disk. | ||
334 | # When the cache is full, less often used symbols will be written to disk. | ||
335 | # For small to medium size projects (<1000 input files) the default value is | ||
336 | # probably good enough. For larger projects a too small cache size can cause | ||
337 | # doxygen to be busy swapping symbols to and from disk most of the time | ||
338 | # causing a significant performance penalty. | ||
339 | # If the system has enough physical memory increasing the cache will improve the | ||
340 | # performance by keeping more symbols in memory. Note that the value works on | ||
341 | # a logarithmic scale so increasing the size by one will roughly double the | ||
342 | # memory usage. The cache size is given by this formula: | ||
343 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||
344 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||
345 | |||
346 | SYMBOL_CACHE_SIZE = 0 | ||
347 | |||
348 | # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be | ||
349 | # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given | ||
350 | # their name and scope. Since this can be an expensive process and often the | ||
351 | # same symbol appear multiple times in the code, doxygen keeps a cache of | ||
352 | # pre-resolved symbols. If the cache is too small doxygen will become slower. | ||
353 | # If the cache is too large, memory is wasted. The cache size is given by this | ||
354 | # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||
355 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||
356 | |||
357 | LOOKUP_CACHE_SIZE = 0 | 63 | LOOKUP_CACHE_SIZE = 0 |
358 | 64 | NUM_PROC_THREADS = 1 | |
359 | #--------------------------------------------------------------------------- | 65 | #--------------------------------------------------------------------------- |
360 | # Build related configuration options | 66 | # Build related configuration options |
361 | #--------------------------------------------------------------------------- | 67 | #--------------------------------------------------------------------------- |
362 | |||
363 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | ||
364 | # documentation are documented, even if no documentation was available. | ||
365 | # Private class members and static file members will be hidden unless | ||
366 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | ||
367 | |||
368 | EXTRACT_ALL = YES | 68 | EXTRACT_ALL = YES |
369 | |||
370 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | ||
371 | # will be included in the documentation. | ||
372 | |||
373 | EXTRACT_PRIVATE = YES | 69 | EXTRACT_PRIVATE = YES |
374 | 70 | EXTRACT_PRIV_VIRTUAL = YES | |
375 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. | 71 | EXTRACT_PACKAGE = YES |
376 | |||
377 | EXTRACT_PACKAGE = NO | ||
378 | |||
379 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | ||
380 | # will be included in the documentation. | ||
381 | |||
382 | EXTRACT_STATIC = YES | 72 | EXTRACT_STATIC = YES |
383 | |||
384 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | ||
385 | # defined locally in source files will be included in the documentation. | ||
386 | # If set to NO only classes defined in header files are included. | ||
387 | |||
388 | EXTRACT_LOCAL_CLASSES = YES | 73 | EXTRACT_LOCAL_CLASSES = YES |
389 | |||
390 | # This flag is only useful for Objective-C code. When set to YES local | ||
391 | # methods, which are defined in the implementation section but not in | ||
392 | # the interface are included in the documentation. | ||
393 | # If set to NO (the default) only methods in the interface are included. | ||
394 | |||
395 | EXTRACT_LOCAL_METHODS = YES | 74 | EXTRACT_LOCAL_METHODS = YES |
396 | 75 | EXTRACT_ANON_NSPACES = YES | |
397 | # If this flag is set to YES, the members of anonymous namespaces will be | 76 | RESOLVE_UNNAMED_PARAMS = YES |
398 | # extracted and appear in the documentation as a namespace called | ||
399 | # 'anonymous_namespace{file}', where file will be replaced with the base | ||
400 | # name of the file that contains the anonymous namespace. By default | ||
401 | # anonymous namespaces are hidden. | ||
402 | |||
403 | EXTRACT_ANON_NSPACES = NO | ||
404 | |||
405 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | ||
406 | # undocumented members of documented classes, files or namespaces. | ||
407 | # If set to NO (the default) these members will be included in the | ||
408 | # various overviews, but no documentation section is generated. | ||
409 | # This option has no effect if EXTRACT_ALL is enabled. | ||
410 | |||
411 | HIDE_UNDOC_MEMBERS = NO | 77 | HIDE_UNDOC_MEMBERS = NO |
412 | |||
413 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | ||
414 | # undocumented classes that are normally visible in the class hierarchy. | ||
415 | # If set to NO (the default) these classes will be included in the various | ||
416 | # overviews. This option has no effect if EXTRACT_ALL is enabled. | ||
417 | |||
418 | HIDE_UNDOC_CLASSES = NO | 78 | HIDE_UNDOC_CLASSES = NO |
419 | |||
420 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | ||
421 | # friend (class|struct|union) declarations. | ||
422 | # If set to NO (the default) these declarations will be included in the | ||
423 | # documentation. | ||
424 | |||
425 | HIDE_FRIEND_COMPOUNDS = NO | 79 | HIDE_FRIEND_COMPOUNDS = NO |
426 | |||
427 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | ||
428 | # documentation blocks found inside the body of a function. | ||
429 | # If set to NO (the default) these blocks will be appended to the | ||
430 | # function's detailed documentation block. | ||
431 | |||
432 | HIDE_IN_BODY_DOCS = NO | 80 | HIDE_IN_BODY_DOCS = NO |
433 | |||
434 | # The INTERNAL_DOCS tag determines if documentation | ||
435 | # that is typed after a \internal command is included. If the tag is set | ||
436 | # to NO (the default) then the documentation will be excluded. | ||
437 | # Set it to YES to include the internal documentation. | ||
438 | |||
439 | INTERNAL_DOCS = YES | 81 | INTERNAL_DOCS = YES |
440 | |||
441 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | ||
442 | # file names in lower-case letters. If set to YES upper-case letters are also | ||
443 | # allowed. This is useful if you have classes or files whose names only differ | ||
444 | # in case and if your file system supports case sensitive file names. Windows | ||
445 | # and Mac users are advised to set this option to NO. | ||
446 | |||
447 | CASE_SENSE_NAMES = YES | 82 | CASE_SENSE_NAMES = YES |
448 | |||
449 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | ||
450 | # will show members with their full class and namespace scopes in the | ||
451 | # documentation. If set to YES the scope will be hidden. | ||
452 | |||
453 | HIDE_SCOPE_NAMES = NO | 83 | HIDE_SCOPE_NAMES = NO |
454 | 84 | HIDE_COMPOUND_REFERENCE= NO | |
455 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | 85 | SHOW_HEADERFILE = YES |
456 | # will put a list of the files that are included by a file in the documentation | ||
457 | # of that file. | ||
458 | |||
459 | SHOW_INCLUDE_FILES = YES | 86 | SHOW_INCLUDE_FILES = YES |
460 | 87 | SHOW_GROUPED_MEMB_INC = NO | |
461 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen | ||
462 | # will list include files with double quotes in the documentation | ||
463 | # rather than with sharp brackets. | ||
464 | |||
465 | FORCE_LOCAL_INCLUDES = NO | 88 | FORCE_LOCAL_INCLUDES = NO |
466 | |||
467 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | ||
468 | # is inserted in the documentation for inline members. | ||
469 | |||
470 | INLINE_INFO = YES | 89 | INLINE_INFO = YES |
471 | |||
472 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | ||
473 | # will sort the (detailed) documentation of file and class members | ||
474 | # alphabetically by member name. If set to NO the members will appear in | ||
475 | # declaration order. | ||
476 | |||
477 | SORT_MEMBER_DOCS = YES | 90 | SORT_MEMBER_DOCS = YES |
478 | |||
479 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | ||
480 | # brief documentation of file, namespace and class members alphabetically | ||
481 | # by member name. If set to NO (the default) the members will appear in | ||
482 | # declaration order. | ||
483 | |||
484 | SORT_BRIEF_DOCS = NO | 91 | SORT_BRIEF_DOCS = NO |
485 | |||
486 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen | ||
487 | # will sort the (brief and detailed) documentation of class members so that | ||
488 | # constructors and destructors are listed first. If set to NO (the default) | ||
489 | # the constructors will appear in the respective orders defined by | ||
490 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. | ||
491 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO | ||
492 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. | ||
493 | |||
494 | SORT_MEMBERS_CTORS_1ST = NO | 92 | SORT_MEMBERS_CTORS_1ST = NO |
495 | |||
496 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | ||
497 | # hierarchy of group names into alphabetical order. If set to NO (the default) | ||
498 | # the group names will appear in their defined order. | ||
499 | |||
500 | SORT_GROUP_NAMES = NO | 93 | SORT_GROUP_NAMES = NO |
501 | |||
502 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | ||
503 | # sorted by fully-qualified names, including namespaces. If set to | ||
504 | # NO (the default), the class list will be sorted only by class name, | ||
505 | # not including the namespace part. | ||
506 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | ||
507 | # Note: This option applies only to the class list, not to the | ||
508 | # alphabetical list. | ||
509 | |||
510 | SORT_BY_SCOPE_NAME = NO | 94 | SORT_BY_SCOPE_NAME = NO |
511 | |||
512 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to | ||
513 | # do proper type resolution of all parameters of a function it will reject a | ||
514 | # match between the prototype and the implementation of a member function even | ||
515 | # if there is only one candidate or it is obvious which candidate to choose | ||
516 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen | ||
517 | # will still accept a match between prototype and implementation in such cases. | ||
518 | |||
519 | STRICT_PROTO_MATCHING = NO | 95 | STRICT_PROTO_MATCHING = NO |
520 | |||
521 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | ||
522 | # disable (NO) the todo list. This list is created by putting \todo | ||
523 | # commands in the documentation. | ||
524 | |||
525 | GENERATE_TODOLIST = YES | 96 | GENERATE_TODOLIST = YES |
526 | |||
527 | # The GENERATE_TESTLIST tag can be used to enable (YES) or | ||
528 | # disable (NO) the test list. This list is created by putting \test | ||
529 | # commands in the documentation. | ||
530 | |||
531 | GENERATE_TESTLIST = YES | 97 | GENERATE_TESTLIST = YES |
532 | |||
533 | # The GENERATE_BUGLIST tag can be used to enable (YES) or | ||
534 | # disable (NO) the bug list. This list is created by putting \bug | ||
535 | # commands in the documentation. | ||
536 | |||
537 | GENERATE_BUGLIST = YES | 98 | GENERATE_BUGLIST = YES |
538 | |||
539 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | ||
540 | # disable (NO) the deprecated list. This list is created by putting | ||
541 | # \deprecated commands in the documentation. | ||
542 | |||
543 | GENERATE_DEPRECATEDLIST= YES | 99 | GENERATE_DEPRECATEDLIST= YES |
544 | |||
545 | # The ENABLED_SECTIONS tag can be used to enable conditional | ||
546 | # documentation sections, marked by \if sectionname ... \endif. | ||
547 | |||
548 | ENABLED_SECTIONS = | 100 | ENABLED_SECTIONS = |
549 | |||
550 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | ||
551 | # the initial value of a variable or macro consists of for it to appear in | ||
552 | # the documentation. If the initializer consists of more lines than specified | ||
553 | # here it will be hidden. Use a value of 0 to hide initializers completely. | ||
554 | # The appearance of the initializer of individual variables and macros in the | ||
555 | # documentation can be controlled using \showinitializer or \hideinitializer | ||
556 | # command in the documentation regardless of this setting. | ||
557 | |||
558 | MAX_INITIALIZER_LINES = 30 | 101 | MAX_INITIALIZER_LINES = 30 |
559 | |||
560 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | ||
561 | # at the bottom of the documentation of classes and structs. If set to YES the | ||
562 | # list will mention the files that were used to generate the documentation. | ||
563 | |||
564 | SHOW_USED_FILES = YES | 102 | SHOW_USED_FILES = YES |
565 | |||
566 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | ||
567 | # This will remove the Files entry from the Quick Index and from the | ||
568 | # Folder Tree View (if specified). The default is YES. | ||
569 | |||
570 | SHOW_FILES = YES | 103 | SHOW_FILES = YES |
571 | |||
572 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | ||
573 | # Namespaces page. | ||
574 | # This will remove the Namespaces entry from the Quick Index | ||
575 | # and from the Folder Tree View (if specified). The default is YES. | ||
576 | |||
577 | SHOW_NAMESPACES = YES | 104 | SHOW_NAMESPACES = YES |
578 | |||
579 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | ||
580 | # doxygen should invoke to get the current version for each file (typically from | ||
581 | # the version control system). Doxygen will invoke the program by executing (via | ||
582 | # popen()) the command <command> <input-file>, where <command> is the value of | ||
583 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | ||
584 | # provided by doxygen. Whatever the program writes to standard output | ||
585 | # is used as the file version. See the manual for examples. | ||
586 | |||
587 | FILE_VERSION_FILTER = | 105 | FILE_VERSION_FILTER = |
588 | |||
589 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | ||
590 | # by doxygen. The layout file controls the global structure of the generated | ||
591 | # output files in an output format independent way. The create the layout file | ||
592 | # that represents doxygen's defaults, run doxygen with the -l option. | ||
593 | # You can optionally specify a file name after the option, if omitted | ||
594 | # DoxygenLayout.xml will be used as the name of the layout file. | ||
595 | |||
596 | LAYOUT_FILE = | 106 | LAYOUT_FILE = |
597 | |||
598 | # The CITE_BIB_FILES tag can be used to specify one or more bib files | ||
599 | # containing the references data. This must be a list of .bib files. The | ||
600 | # .bib extension is automatically appended if omitted. Using this command | ||
601 | # requires the bibtex tool to be installed. See also | ||
602 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style | ||
603 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this | ||
604 | # feature you need bibtex and perl available in the search path. | ||
605 | |||
606 | CITE_BIB_FILES = | 107 | CITE_BIB_FILES = |
607 | |||
608 | #--------------------------------------------------------------------------- | 108 | #--------------------------------------------------------------------------- |
609 | # configuration options related to warning and progress messages | 109 | # Configuration options related to warning and progress messages |
610 | #--------------------------------------------------------------------------- | 110 | #--------------------------------------------------------------------------- |
611 | |||
612 | # The QUIET tag can be used to turn on/off the messages that are generated | ||
613 | # by doxygen. Possible values are YES and NO. If left blank NO is used. | ||
614 | |||
615 | QUIET = NO | 111 | QUIET = NO |
616 | |||
617 | # The WARNINGS tag can be used to turn on/off the warning messages that are | ||
618 | # generated by doxygen. Possible values are YES and NO. If left blank | ||
619 | # NO is used. | ||
620 | |||
621 | WARNINGS = YES | 112 | WARNINGS = YES |
622 | |||
623 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | ||
624 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | ||
625 | # automatically be disabled. | ||
626 | |||
627 | WARN_IF_UNDOCUMENTED = YES | 113 | WARN_IF_UNDOCUMENTED = YES |
628 | |||
629 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | ||
630 | # potential errors in the documentation, such as not documenting some | ||
631 | # parameters in a documented function, or documenting parameters that | ||
632 | # don't exist or using markup commands wrongly. | ||
633 | |||
634 | WARN_IF_DOC_ERROR = YES | 114 | WARN_IF_DOC_ERROR = YES |
635 | 115 | WARN_IF_INCOMPLETE_DOC = YES | |
636 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for | ||
637 | # functions that are documented, but have no documentation for their parameters | ||
638 | # or return value. If set to NO (the default) doxygen will only warn about | ||
639 | # wrong or incomplete parameter documentation, but not about the absence of | ||
640 | # documentation. | ||
641 | |||
642 | WARN_NO_PARAMDOC = YES | 116 | WARN_NO_PARAMDOC = YES |
643 | 117 | WARN_AS_ERROR = NO | |
644 | # The WARN_FORMAT tag determines the format of the warning messages that | ||
645 | # doxygen can produce. The string should contain the $file, $line, and $text | ||
646 | # tags, which will be replaced by the file and line number from which the | ||
647 | # warning originated and the warning text. Optionally the format may contain | ||
648 | # $version, which will be replaced by the version of the file (if it could | ||
649 | # be obtained via FILE_VERSION_FILTER) | ||
650 | |||
651 | WARN_FORMAT = "$file:$line: $text" | 118 | WARN_FORMAT = "$file:$line: $text" |
652 | 119 | WARN_LINE_FORMAT = "at line $line of file $file" | |
653 | # The WARN_LOGFILE tag can be used to specify a file to which warning | ||
654 | # and error messages should be written. If left blank the output is written | ||
655 | # to stderr. | ||
656 | |||
657 | WARN_LOGFILE = Doxywarn | 120 | WARN_LOGFILE = Doxywarn |
658 | |||
659 | #--------------------------------------------------------------------------- | 121 | #--------------------------------------------------------------------------- |
660 | # configuration options related to the input files | 122 | # Configuration options related to the input files |
661 | #--------------------------------------------------------------------------- | 123 | #--------------------------------------------------------------------------- |
662 | |||
663 | # The INPUT tag can be used to specify the files and/or directories that contain | ||
664 | # documented source files. You may enter file names like "myfile.cpp" or | ||
665 | # directories like "/usr/src/myproject". Separate the files or directories | ||
666 | # with spaces. | ||
667 | |||
668 | INPUT = src \ | 124 | INPUT = src \ |
669 | src/doxy \ | 125 | src/doxy \ |
670 | src/stable \ | 126 | src/stable \ |
671 | src/unstable \ | 127 | src/unstable \ |
672 | src/experimental | 128 | src/experimental |
673 | |||
674 | # This tag can be used to specify the character encoding of the source files | ||
675 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | ||
676 | # also the default input encoding. Doxygen uses libiconv (or the iconv built | ||
677 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | ||
678 | # the list of possible encodings. | ||
679 | |||
680 | INPUT_ENCODING = UTF-8 | 129 | INPUT_ENCODING = UTF-8 |
681 | |||
682 | # If the value of the INPUT tag contains directories, you can use the | ||
683 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
684 | # and *.h) to filter out the source-files in the directories. If left | ||
685 | # blank the following patterns are tested: | ||
686 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | ||
687 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | ||
688 | # *.f90 *.f *.for *.vhd *.vhdl | ||
689 | |||
690 | FILE_PATTERNS = *.c \ | 130 | FILE_PATTERNS = *.c \ |
691 | *.cc \ | 131 | *.cc \ |
692 | *.cxx \ | 132 | *.cxx \ |
@@ -733,1119 +173,225 @@ FILE_PATTERNS = *.c \ | |||
733 | *.moc \ | 173 | *.moc \ |
734 | *.xpm \ | 174 | *.xpm \ |
735 | *.dox | 175 | *.dox |
736 | |||
737 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | ||
738 | # should be searched for input files as well. Possible values are YES and NO. | ||
739 | # If left blank NO is used. | ||
740 | |||
741 | RECURSIVE = NO | 176 | RECURSIVE = NO |
742 | |||
743 | # The EXCLUDE tag can be used to specify files and/or directories that should be | ||
744 | # excluded from the INPUT source files. This way you can easily exclude a | ||
745 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | ||
746 | # Note that relative paths are relative to the directory from which doxygen is | ||
747 | # run. | ||
748 | |||
749 | EXCLUDE = | 177 | EXCLUDE = |
750 | |||
751 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or | ||
752 | # directories that are symbolic links (a Unix file system feature) are excluded | ||
753 | # from the input. | ||
754 | |||
755 | EXCLUDE_SYMLINKS = NO | 178 | EXCLUDE_SYMLINKS = NO |
756 | |||
757 | # If the value of the INPUT tag contains directories, you can use the | ||
758 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | ||
759 | # certain files from those directories. Note that the wildcards are matched | ||
760 | # against the file with absolute path, so to exclude all test directories | ||
761 | # for example use the pattern */test/* | ||
762 | |||
763 | EXCLUDE_PATTERNS = | 179 | EXCLUDE_PATTERNS = |
764 | |||
765 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | ||
766 | # (namespaces, classes, functions, etc.) that should be excluded from the | ||
767 | # output. The symbol name can be a fully qualified name, a word, or if the | ||
768 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | ||
769 | # AClass::ANamespace, ANamespace::*Test | ||
770 | |||
771 | EXCLUDE_SYMBOLS = | 180 | EXCLUDE_SYMBOLS = |
772 | |||
773 | # The EXAMPLE_PATH tag can be used to specify one or more files or | ||
774 | # directories that contain example code fragments that are included (see | ||
775 | # the \include command). | ||
776 | |||
777 | EXAMPLE_PATH = | 181 | EXAMPLE_PATH = |
778 | |||
779 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | ||
780 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
781 | # and *.h) to filter out the source-files in the directories. If left | ||
782 | # blank all files are included. | ||
783 | |||
784 | EXAMPLE_PATTERNS = * | 182 | EXAMPLE_PATTERNS = * |
785 | |||
786 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | ||
787 | # searched for input files to be used with the \include or \dontinclude | ||
788 | # commands irrespective of the value of the RECURSIVE tag. | ||
789 | # Possible values are YES and NO. If left blank NO is used. | ||
790 | |||
791 | EXAMPLE_RECURSIVE = NO | 183 | EXAMPLE_RECURSIVE = NO |
792 | |||
793 | # The IMAGE_PATH tag can be used to specify one or more files or | ||
794 | # directories that contain image that are included in the documentation (see | ||
795 | # the \image command). | ||
796 | |||
797 | IMAGE_PATH = | 184 | IMAGE_PATH = |
798 | |||
799 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | ||
800 | # invoke to filter for each input file. Doxygen will invoke the filter program | ||
801 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | ||
802 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | ||
803 | # input file. Doxygen will then use the output that the filter program writes | ||
804 | # to standard output. | ||
805 | # If FILTER_PATTERNS is specified, this tag will be | ||
806 | # ignored. | ||
807 | |||
808 | INPUT_FILTER = | 185 | INPUT_FILTER = |
809 | |||
810 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | ||
811 | # basis. | ||
812 | # Doxygen will compare the file name with each pattern and apply the | ||
813 | # filter if there is a match. | ||
814 | # The filters are a list of the form: | ||
815 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | ||
816 | # info on how filters are used. If FILTER_PATTERNS is empty or if | ||
817 | # non of the patterns match the file name, INPUT_FILTER is applied. | ||
818 | |||
819 | FILTER_PATTERNS = | 186 | FILTER_PATTERNS = |
820 | |||
821 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
822 | # INPUT_FILTER) will be used to filter the input files when producing source | ||
823 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
824 | |||
825 | FILTER_SOURCE_FILES = NO | 187 | FILTER_SOURCE_FILES = NO |
826 | |||
827 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
828 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) | ||
829 | # and it is also possible to disable source filtering for a specific pattern | ||
830 | # using *.ext= (so without naming a filter). This option only has effect when | ||
831 | # FILTER_SOURCE_FILES is enabled. | ||
832 | |||
833 | FILTER_SOURCE_PATTERNS = | 188 | FILTER_SOURCE_PATTERNS = |
834 | 189 | USE_MDFILE_AS_MAINPAGE = | |
835 | #--------------------------------------------------------------------------- | 190 | #--------------------------------------------------------------------------- |
836 | # configuration options related to source browsing | 191 | # Configuration options related to source browsing |
837 | #--------------------------------------------------------------------------- | 192 | #--------------------------------------------------------------------------- |
838 | |||
839 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | ||
840 | # be generated. Documented entities will be cross-referenced with these sources. | ||
841 | # Note: To get rid of all source code in the generated output, make sure also | ||
842 | # VERBATIM_HEADERS is set to NO. | ||
843 | |||
844 | SOURCE_BROWSER = YES | 193 | SOURCE_BROWSER = YES |
845 | |||
846 | # Setting the INLINE_SOURCES tag to YES will include the body | ||
847 | # of functions and classes directly in the documentation. | ||
848 | |||
849 | INLINE_SOURCES = NO | 194 | INLINE_SOURCES = NO |
850 | |||
851 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | ||
852 | # doxygen to hide any special comment blocks from generated source code | ||
853 | # fragments. Normal C and C++ comments will always remain visible. | ||
854 | |||
855 | STRIP_CODE_COMMENTS = YES | 195 | STRIP_CODE_COMMENTS = YES |
856 | |||
857 | # If the REFERENCED_BY_RELATION tag is set to YES | ||
858 | # then for each documented function all documented | ||
859 | # functions referencing it will be listed. | ||
860 | |||
861 | REFERENCED_BY_RELATION = YES | 196 | REFERENCED_BY_RELATION = YES |
862 | |||
863 | # If the REFERENCES_RELATION tag is set to YES | ||
864 | # then for each documented function all documented entities | ||
865 | # called/used by that function will be listed. | ||
866 | |||
867 | REFERENCES_RELATION = YES | 197 | REFERENCES_RELATION = YES |
868 | |||
869 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | ||
870 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | ||
871 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | ||
872 | # link to the source code. | ||
873 | # Otherwise they will link to the documentation. | ||
874 | |||
875 | REFERENCES_LINK_SOURCE = YES | 198 | REFERENCES_LINK_SOURCE = YES |
876 | 199 | SOURCE_TOOLTIPS = YES | |
877 | # If the USE_HTAGS tag is set to YES then the references to source code | ||
878 | # will point to the HTML generated by the htags(1) tool instead of doxygen | ||
879 | # built-in source browser. The htags tool is part of GNU's global source | ||
880 | # tagging system (see http://www.gnu.org/software/global/global.html). You | ||
881 | # will need version 4.8.6 or higher. | ||
882 | |||
883 | USE_HTAGS = NO | 200 | USE_HTAGS = NO |
884 | |||
885 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | ||
886 | # will generate a verbatim copy of the header file for each class for | ||
887 | # which an include is specified. Set to NO to disable this. | ||
888 | |||
889 | VERBATIM_HEADERS = YES | 201 | VERBATIM_HEADERS = YES |
890 | 202 | CLANG_ASSISTED_PARSING = YES | |
203 | CLANG_ADD_INC_PATHS = YES | ||
204 | CLANG_OPTIONS = | ||
205 | CLANG_DATABASE_PATH = | ||
891 | #--------------------------------------------------------------------------- | 206 | #--------------------------------------------------------------------------- |
892 | # configuration options related to the alphabetical class index | 207 | # Configuration options related to the alphabetical class index |
893 | #--------------------------------------------------------------------------- | 208 | #--------------------------------------------------------------------------- |
894 | |||
895 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | ||
896 | # of all compounds will be generated. Enable this if the project | ||
897 | # contains a lot of classes, structs, unions or interfaces. | ||
898 | |||
899 | ALPHABETICAL_INDEX = YES | 209 | ALPHABETICAL_INDEX = YES |
900 | |||
901 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | ||
902 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | ||
903 | # in which this list will be split (can be a number in the range [1..20]) | ||
904 | |||
905 | COLS_IN_ALPHA_INDEX = 4 | ||
906 | |||
907 | # In case all classes in a project start with a common prefix, all | ||
908 | # classes will be put under the same header in the alphabetical index. | ||
909 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | ||
910 | # should be ignored while generating the index headers. | ||
911 | |||
912 | IGNORE_PREFIX = | 210 | IGNORE_PREFIX = |
913 | |||
914 | #--------------------------------------------------------------------------- | 211 | #--------------------------------------------------------------------------- |
915 | # configuration options related to the HTML output | 212 | # Configuration options related to the HTML output |
916 | #--------------------------------------------------------------------------- | 213 | #--------------------------------------------------------------------------- |
917 | |||
918 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | ||
919 | # generate HTML output. | ||
920 | |||
921 | GENERATE_HTML = YES | 214 | GENERATE_HTML = YES |
922 | |||
923 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | ||
924 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
925 | # put in front of it. If left blank `html' will be used as the default path. | ||
926 | |||
927 | HTML_OUTPUT = html | 215 | HTML_OUTPUT = html |
928 | |||
929 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | ||
930 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | ||
931 | # doxygen will generate files with .html extension. | ||
932 | |||
933 | HTML_FILE_EXTENSION = .html | 216 | HTML_FILE_EXTENSION = .html |
934 | |||
935 | # The HTML_HEADER tag can be used to specify a personal HTML header for | ||
936 | # each generated HTML page. If it is left blank doxygen will generate a | ||
937 | # standard header. Note that when using a custom header you are responsible | ||
938 | # for the proper inclusion of any scripts and style sheets that doxygen | ||
939 | # needs, which is dependent on the configuration options used. | ||
940 | # It is advised to generate a default header using "doxygen -w html | ||
941 | # header.html footer.html stylesheet.css YourConfigFile" and then modify | ||
942 | # that header. Note that the header is subject to change so you typically | ||
943 | # have to redo this when upgrading to a newer version of doxygen or when | ||
944 | # changing the value of configuration settings such as GENERATE_TREEVIEW! | ||
945 | |||
946 | HTML_HEADER = | 217 | HTML_HEADER = |
947 | |||
948 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | ||
949 | # each generated HTML page. If it is left blank doxygen will generate a | ||
950 | # standard footer. | ||
951 | |||
952 | HTML_FOOTER = | 218 | HTML_FOOTER = |
953 | |||
954 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | ||
955 | # style sheet that is used by each HTML page. It can be used to | ||
956 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | ||
957 | # will generate a default style sheet. Note that doxygen will try to copy | ||
958 | # the style sheet file to the HTML output directory, so don't put your own | ||
959 | # style sheet in the HTML output directory as well, or it will be erased! | ||
960 | |||
961 | HTML_STYLESHEET = | 219 | HTML_STYLESHEET = |
962 | 220 | HTML_EXTRA_STYLESHEET = | |
963 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | ||
964 | # other source files which should be copied to the HTML output directory. Note | ||
965 | # that these files will be copied to the base HTML output directory. Use the | ||
966 | # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | ||
967 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that | ||
968 | # the files will be copied as-is; there are no commands or markers available. | ||
969 | |||
970 | HTML_EXTRA_FILES = | 221 | HTML_EXTRA_FILES = |
971 | |||
972 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | ||
973 | # Doxygen will adjust the colors in the style sheet and background images | ||
974 | # according to this color. Hue is specified as an angle on a colorwheel, | ||
975 | # see http://en.wikipedia.org/wiki/Hue for more information. | ||
976 | # For instance the value 0 represents red, 60 is yellow, 120 is green, | ||
977 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | ||
978 | # The allowed range is 0 to 359. | ||
979 | |||
980 | HTML_COLORSTYLE_HUE = 220 | 222 | HTML_COLORSTYLE_HUE = 220 |
981 | |||
982 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of | ||
983 | # the colors in the HTML output. For a value of 0 the output will use | ||
984 | # grayscales only. A value of 255 will produce the most vivid colors. | ||
985 | |||
986 | HTML_COLORSTYLE_SAT = 100 | 223 | HTML_COLORSTYLE_SAT = 100 |
987 | |||
988 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to | ||
989 | # the luminance component of the colors in the HTML output. Values below | ||
990 | # 100 gradually make the output lighter, whereas values above 100 make | ||
991 | # the output darker. The value divided by 100 is the actual gamma applied, | ||
992 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, | ||
993 | # and 100 does not change the gamma. | ||
994 | |||
995 | HTML_COLORSTYLE_GAMMA = 80 | 224 | HTML_COLORSTYLE_GAMMA = 80 |
996 | |||
997 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | ||
998 | # page will contain the date and time when the page was generated. Setting | ||
999 | # this to NO can help when comparing the output of multiple runs. | ||
1000 | |||
1001 | HTML_TIMESTAMP = YES | 225 | HTML_TIMESTAMP = YES |
1002 | 226 | HTML_DYNAMIC_MENUS = YES | |
1003 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
1004 | # documentation will contain sections that can be hidden and shown after the | ||
1005 | # page has loaded. | ||
1006 | |||
1007 | HTML_DYNAMIC_SECTIONS = YES | 227 | HTML_DYNAMIC_SECTIONS = YES |
1008 | |||
1009 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of | ||
1010 | # entries shown in the various tree structured indices initially; the user | ||
1011 | # can expand and collapse entries dynamically later on. Doxygen will expand | ||
1012 | # the tree to such a level that at most the specified number of entries are | ||
1013 | # visible (unless a fully collapsed tree already exceeds this amount). | ||
1014 | # So setting the number of entries 1 will produce a full collapsed tree by | ||
1015 | # default. 0 is a special value representing an infinite number of entries | ||
1016 | # and will result in a full expanded tree by default. | ||
1017 | |||
1018 | HTML_INDEX_NUM_ENTRIES = 100 | 228 | HTML_INDEX_NUM_ENTRIES = 100 |
1019 | |||
1020 | # If the GENERATE_DOCSET tag is set to YES, additional index files | ||
1021 | # will be generated that can be used as input for Apple's Xcode 3 | ||
1022 | # integrated development environment, introduced with OSX 10.5 (Leopard). | ||
1023 | # To create a documentation set, doxygen will generate a Makefile in the | ||
1024 | # HTML output directory. Running make will produce the docset in that | ||
1025 | # directory and running "make install" will install the docset in | ||
1026 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
1027 | # it at startup. | ||
1028 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | ||
1029 | # for more information. | ||
1030 | |||
1031 | GENERATE_DOCSET = NO | 229 | GENERATE_DOCSET = NO |
1032 | |||
1033 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | ||
1034 | # feed. A documentation feed provides an umbrella under which multiple | ||
1035 | # documentation sets from a single provider (such as a company or product suite) | ||
1036 | # can be grouped. | ||
1037 | |||
1038 | DOCSET_FEEDNAME = "Doxygen generated docs" | 230 | DOCSET_FEEDNAME = "Doxygen generated docs" |
1039 | 231 | DOCSET_FEEDURL = | |
1040 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | ||
1041 | # should uniquely identify the documentation set bundle. This should be a | ||
1042 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | ||
1043 | # will append .docset to the name. | ||
1044 | |||
1045 | DOCSET_BUNDLE_ID = org.doxygen.Project | 232 | DOCSET_BUNDLE_ID = org.doxygen.Project |
1046 | |||
1047 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify | ||
1048 | # the documentation publisher. This should be a reverse domain-name style | ||
1049 | # string, e.g. com.mycompany.MyDocSet.documentation. | ||
1050 | |||
1051 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | 233 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
1052 | |||
1053 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | ||
1054 | |||
1055 | DOCSET_PUBLISHER_NAME = Publisher | 234 | DOCSET_PUBLISHER_NAME = Publisher |
1056 | |||
1057 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | ||
1058 | # will be generated that can be used as input for tools like the | ||
1059 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | ||
1060 | # of the generated HTML documentation. | ||
1061 | |||
1062 | GENERATE_HTMLHELP = NO | 235 | GENERATE_HTMLHELP = NO |
1063 | |||
1064 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | ||
1065 | # be used to specify the file name of the resulting .chm file. You | ||
1066 | # can add a path in front of the file if the result should not be | ||
1067 | # written to the html output directory. | ||
1068 | |||
1069 | CHM_FILE = | 236 | CHM_FILE = |
1070 | |||
1071 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | ||
1072 | # be used to specify the location (absolute path including file name) of | ||
1073 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | ||
1074 | # the HTML help compiler on the generated index.hhp. | ||
1075 | |||
1076 | HHC_LOCATION = | 237 | HHC_LOCATION = |
1077 | |||
1078 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | ||
1079 | # controls if a separate .chi index file is generated (YES) or that | ||
1080 | # it should be included in the master .chm file (NO). | ||
1081 | |||
1082 | GENERATE_CHI = NO | 238 | GENERATE_CHI = NO |
1083 | |||
1084 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | ||
1085 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | ||
1086 | # content. | ||
1087 | |||
1088 | CHM_INDEX_ENCODING = | 239 | CHM_INDEX_ENCODING = |
1089 | |||
1090 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | ||
1091 | # controls whether a binary table of contents is generated (YES) or a | ||
1092 | # normal table of contents (NO) in the .chm file. | ||
1093 | |||
1094 | BINARY_TOC = NO | 240 | BINARY_TOC = NO |
1095 | |||
1096 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | ||
1097 | # to the contents of the HTML help documentation and to the tree view. | ||
1098 | |||
1099 | TOC_EXPAND = NO | 241 | TOC_EXPAND = NO |
1100 | |||
1101 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | ||
1102 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated | ||
1103 | # that can be used as input for Qt's qhelpgenerator to generate a | ||
1104 | # Qt Compressed Help (.qch) of the generated HTML documentation. | ||
1105 | |||
1106 | GENERATE_QHP = NO | 242 | GENERATE_QHP = NO |
1107 | |||
1108 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can | ||
1109 | # be used to specify the file name of the resulting .qch file. | ||
1110 | # The path specified is relative to the HTML output folder. | ||
1111 | |||
1112 | QCH_FILE = | 243 | QCH_FILE = |
1113 | |||
1114 | # The QHP_NAMESPACE tag specifies the namespace to use when generating | ||
1115 | # Qt Help Project output. For more information please see | ||
1116 | # http://doc.trolltech.com/qthelpproject.html#namespace | ||
1117 | |||
1118 | QHP_NAMESPACE = | 244 | QHP_NAMESPACE = |
1119 | |||
1120 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | ||
1121 | # Qt Help Project output. For more information please see | ||
1122 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders | ||
1123 | |||
1124 | QHP_VIRTUAL_FOLDER = doc | 245 | QHP_VIRTUAL_FOLDER = doc |
1125 | |||
1126 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to | ||
1127 | # add. For more information please see | ||
1128 | # http://doc.trolltech.com/qthelpproject.html#custom-filters | ||
1129 | |||
1130 | QHP_CUST_FILTER_NAME = | 246 | QHP_CUST_FILTER_NAME = |
1131 | |||
1132 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the | ||
1133 | # custom filter to add. For more information please see | ||
1134 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> | ||
1135 | # Qt Help Project / Custom Filters</a>. | ||
1136 | |||
1137 | QHP_CUST_FILTER_ATTRS = | 247 | QHP_CUST_FILTER_ATTRS = |
1138 | |||
1139 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | ||
1140 | # project's | ||
1141 | # filter section matches. | ||
1142 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> | ||
1143 | # Qt Help Project / Filter Attributes</a>. | ||
1144 | |||
1145 | QHP_SECT_FILTER_ATTRS = | 248 | QHP_SECT_FILTER_ATTRS = |
1146 | |||
1147 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | ||
1148 | # be used to specify the location of Qt's qhelpgenerator. | ||
1149 | # If non-empty doxygen will try to run qhelpgenerator on the generated | ||
1150 | # .qhp file. | ||
1151 | |||
1152 | QHG_LOCATION = | 249 | QHG_LOCATION = |
1153 | |||
1154 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files | ||
1155 | # will be generated, which together with the HTML files, form an Eclipse help | ||
1156 | # plugin. To install this plugin and make it available under the help contents | ||
1157 | # menu in Eclipse, the contents of the directory containing the HTML and XML | ||
1158 | # files needs to be copied into the plugins directory of eclipse. The name of | ||
1159 | # the directory within the plugins directory should be the same as | ||
1160 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before | ||
1161 | # the help appears. | ||
1162 | |||
1163 | GENERATE_ECLIPSEHELP = NO | 250 | GENERATE_ECLIPSEHELP = NO |
1164 | |||
1165 | # A unique identifier for the eclipse help plugin. When installing the plugin | ||
1166 | # the directory name containing the HTML and XML files should also have | ||
1167 | # this name. | ||
1168 | |||
1169 | ECLIPSE_DOC_ID = org.doxygen.Project | 251 | ECLIPSE_DOC_ID = org.doxygen.Project |
1170 | |||
1171 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) | ||
1172 | # at top of each HTML page. The value NO (the default) enables the index and | ||
1173 | # the value YES disables it. Since the tabs have the same information as the | ||
1174 | # navigation tree you can set this option to NO if you already set | ||
1175 | # GENERATE_TREEVIEW to YES. | ||
1176 | |||
1177 | DISABLE_INDEX = NO | 252 | DISABLE_INDEX = NO |
1178 | |||
1179 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | ||
1180 | # structure should be generated to display hierarchical information. | ||
1181 | # If the tag value is set to YES, a side panel will be generated | ||
1182 | # containing a tree-like index structure (just like the one that | ||
1183 | # is generated for HTML Help). For this to work a browser that supports | ||
1184 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | ||
1185 | # Windows users are probably better off using the HTML help feature. | ||
1186 | # Since the tree basically has the same information as the tab index you | ||
1187 | # could consider to set DISABLE_INDEX to NO when enabling this option. | ||
1188 | |||
1189 | GENERATE_TREEVIEW = NO | 253 | GENERATE_TREEVIEW = NO |
1190 | 254 | FULL_SIDEBAR = NO | |
1191 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values | ||
1192 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML | ||
1193 | # documentation. Note that a value of 0 will completely suppress the enum | ||
1194 | # values from appearing in the overview section. | ||
1195 | |||
1196 | ENUM_VALUES_PER_LINE = 4 | 255 | ENUM_VALUES_PER_LINE = 4 |
1197 | |||
1198 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | ||
1199 | # used to set the initial width (in pixels) of the frame in which the tree | ||
1200 | # is shown. | ||
1201 | |||
1202 | TREEVIEW_WIDTH = 250 | 256 | TREEVIEW_WIDTH = 250 |
1203 | |||
1204 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open | ||
1205 | # links to external symbols imported via tag files in a separate window. | ||
1206 | |||
1207 | EXT_LINKS_IN_WINDOW = NO | 257 | EXT_LINKS_IN_WINDOW = NO |
1208 | 258 | OBFUSCATE_EMAILS = YES | |
1209 | # Use this tag to change the font size of Latex formulas included | 259 | HTML_FORMULA_FORMAT = png |
1210 | # as images in the HTML documentation. The default is 10. Note that | ||
1211 | # when you change the font size after a successful doxygen run you need | ||
1212 | # to manually remove any form_*.png images from the HTML output directory | ||
1213 | # to force them to be regenerated. | ||
1214 | |||
1215 | FORMULA_FONTSIZE = 10 | 260 | FORMULA_FONTSIZE = 10 |
1216 | |||
1217 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | ||
1218 | # generated for formulas are transparent PNGs. Transparent PNGs are | ||
1219 | # not supported properly for IE 6.0, but are supported on all modern browsers. | ||
1220 | # Note that when changing this option you need to delete any form_*.png files | ||
1221 | # in the HTML output before the changes have effect. | ||
1222 | |||
1223 | FORMULA_TRANSPARENT = YES | 261 | FORMULA_TRANSPARENT = YES |
1224 | 262 | FORMULA_MACROFILE = | |
1225 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax | ||
1226 | # (see http://www.mathjax.org) which uses client side Javascript for the | ||
1227 | # rendering instead of using prerendered bitmaps. Use this if you do not | ||
1228 | # have LaTeX installed or if you want to formulas look prettier in the HTML | ||
1229 | # output. When enabled you may also need to install MathJax separately and | ||
1230 | # configure the path to it using the MATHJAX_RELPATH option. | ||
1231 | |||
1232 | USE_MATHJAX = NO | 263 | USE_MATHJAX = NO |
1233 | 264 | MATHJAX_VERSION = MathJax_2 | |
1234 | # When MathJax is enabled you need to specify the location relative to the | 265 | MATHJAX_FORMAT = HTML-CSS |
1235 | # HTML output directory using the MATHJAX_RELPATH option. The destination | ||
1236 | # directory should contain the MathJax.js script. For instance, if the mathjax | ||
1237 | # directory is located at the same level as the HTML output directory, then | ||
1238 | # MATHJAX_RELPATH should be ../mathjax. The default value points to | ||
1239 | # the MathJax Content Delivery Network so you can quickly see the result without | ||
1240 | # installing MathJax. | ||
1241 | # However, it is strongly recommended to install a local | ||
1242 | # copy of MathJax from http://www.mathjax.org before deployment. | ||
1243 | |||
1244 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | 266 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
1245 | |||
1246 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension | ||
1247 | # names that should be enabled during MathJax rendering. | ||
1248 | |||
1249 | MATHJAX_EXTENSIONS = | 267 | MATHJAX_EXTENSIONS = |
1250 | 268 | MATHJAX_CODEFILE = | |
1251 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box | ||
1252 | # for the HTML output. The underlying search engine uses javascript | ||
1253 | # and DHTML and should work on any modern browser. Note that when using | ||
1254 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | ||
1255 | # (GENERATE_DOCSET) there is already a search function so this one should | ||
1256 | # typically be disabled. For large projects the javascript based search engine | ||
1257 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. | ||
1258 | |||
1259 | SEARCHENGINE = NO | 269 | SEARCHENGINE = NO |
1260 | |||
1261 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||
1262 | # implemented using a PHP enabled web server instead of at the web client | ||
1263 | # using Javascript. Doxygen will generate the search PHP script and index | ||
1264 | # file to put on the web server. The advantage of the server | ||
1265 | # based approach is that it scales better to large projects and allows | ||
1266 | # full text search. The disadvantages are that it is more difficult to setup | ||
1267 | # and does not have live searching capabilities. | ||
1268 | |||
1269 | SERVER_BASED_SEARCH = NO | 270 | SERVER_BASED_SEARCH = NO |
1270 | 271 | EXTERNAL_SEARCH = NO | |
272 | SEARCHENGINE_URL = | ||
273 | SEARCHDATA_FILE = searchdata.xml | ||
274 | EXTERNAL_SEARCH_ID = | ||
275 | EXTRA_SEARCH_MAPPINGS = | ||
1271 | #--------------------------------------------------------------------------- | 276 | #--------------------------------------------------------------------------- |
1272 | # configuration options related to the LaTeX output | 277 | # Configuration options related to the LaTeX output |
1273 | #--------------------------------------------------------------------------- | 278 | #--------------------------------------------------------------------------- |
1274 | |||
1275 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | ||
1276 | # generate Latex output. | ||
1277 | |||
1278 | GENERATE_LATEX = yes | 279 | GENERATE_LATEX = yes |
1279 | |||
1280 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | ||
1281 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1282 | # put in front of it. If left blank `latex' will be used as the default path. | ||
1283 | |||
1284 | LATEX_OUTPUT = latex | 280 | LATEX_OUTPUT = latex |
1285 | |||
1286 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
1287 | # invoked. If left blank `latex' will be used as the default command name. | ||
1288 | # Note that when enabling USE_PDFLATEX this option is only used for | ||
1289 | # generating bitmaps for formulas in the HTML output, but not in the | ||
1290 | # Makefile that is written to the output directory. | ||
1291 | |||
1292 | LATEX_CMD_NAME = latex | 281 | LATEX_CMD_NAME = latex |
1293 | |||
1294 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | ||
1295 | # generate index for LaTeX. If left blank `makeindex' will be used as the | ||
1296 | # default command name. | ||
1297 | |||
1298 | MAKEINDEX_CMD_NAME = makeindex | 282 | MAKEINDEX_CMD_NAME = makeindex |
1299 | 283 | LATEX_MAKEINDEX_CMD = makeindex | |
1300 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | ||
1301 | # LaTeX documents. This may be useful for small projects and may help to | ||
1302 | # save some trees in general. | ||
1303 | |||
1304 | COMPACT_LATEX = NO | 284 | COMPACT_LATEX = NO |
1305 | |||
1306 | # The PAPER_TYPE tag can be used to set the paper type that is used | ||
1307 | # by the printer. Possible values are: a4, letter, legal and | ||
1308 | # executive. If left blank a4wide will be used. | ||
1309 | |||
1310 | PAPER_TYPE = letter | 285 | PAPER_TYPE = letter |
1311 | |||
1312 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | ||
1313 | # packages that should be included in the LaTeX output. | ||
1314 | |||
1315 | EXTRA_PACKAGES = | 286 | EXTRA_PACKAGES = |
1316 | |||
1317 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | ||
1318 | # the generated latex document. The header should contain everything until | ||
1319 | # the first chapter. If it is left blank doxygen will generate a | ||
1320 | # standard header. Notice: only use this tag if you know what you are doing! | ||
1321 | |||
1322 | LATEX_HEADER = | 287 | LATEX_HEADER = |
1323 | |||
1324 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | ||
1325 | # the generated latex document. The footer should contain everything after | ||
1326 | # the last chapter. If it is left blank doxygen will generate a | ||
1327 | # standard footer. Notice: only use this tag if you know what you are doing! | ||
1328 | |||
1329 | LATEX_FOOTER = | 288 | LATEX_FOOTER = |
1330 | 289 | LATEX_EXTRA_STYLESHEET = | |
1331 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | 290 | LATEX_EXTRA_FILES = |
1332 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | ||
1333 | # contain links (just like the HTML output) instead of page references | ||
1334 | # This makes the output suitable for online browsing using a pdf viewer. | ||
1335 | |||
1336 | PDF_HYPERLINKS = YES | 291 | PDF_HYPERLINKS = YES |
1337 | |||
1338 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | ||
1339 | # plain latex in the generated Makefile. Set this option to YES to get a | ||
1340 | # higher quality PDF documentation. | ||
1341 | |||
1342 | USE_PDFLATEX = YES | 292 | USE_PDFLATEX = YES |
1343 | |||
1344 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | ||
1345 | # command to the generated LaTeX files. This will instruct LaTeX to keep | ||
1346 | # running if errors occur, instead of asking the user for help. | ||
1347 | # This option is also used when generating formulas in HTML. | ||
1348 | |||
1349 | LATEX_BATCHMODE = YES | 293 | LATEX_BATCHMODE = YES |
1350 | |||
1351 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not | ||
1352 | # include the index chapters (such as File Index, Compound Index, etc.) | ||
1353 | # in the output. | ||
1354 | |||
1355 | LATEX_HIDE_INDICES = NO | 294 | LATEX_HIDE_INDICES = NO |
1356 | |||
1357 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include | ||
1358 | # source code with syntax highlighting in the LaTeX output. | ||
1359 | # Note that which sources are shown also depends on other settings | ||
1360 | # such as SOURCE_BROWSER. | ||
1361 | |||
1362 | LATEX_SOURCE_CODE = NO | ||
1363 | |||
1364 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||
1365 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See | ||
1366 | # http://en.wikipedia.org/wiki/BibTeX for more info. | ||
1367 | |||
1368 | LATEX_BIB_STYLE = plain | 295 | LATEX_BIB_STYLE = plain |
1369 | 296 | LATEX_TIMESTAMP = NO | |
297 | LATEX_EMOJI_DIRECTORY = | ||
1370 | #--------------------------------------------------------------------------- | 298 | #--------------------------------------------------------------------------- |
1371 | # configuration options related to the RTF output | 299 | # Configuration options related to the RTF output |
1372 | #--------------------------------------------------------------------------- | 300 | #--------------------------------------------------------------------------- |
1373 | |||
1374 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | ||
1375 | # The RTF output is optimized for Word 97 and may not look very pretty with | ||
1376 | # other RTF readers or editors. | ||
1377 | |||
1378 | GENERATE_RTF = NO | 301 | GENERATE_RTF = NO |
1379 | |||
1380 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | ||
1381 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1382 | # put in front of it. If left blank `rtf' will be used as the default path. | ||
1383 | |||
1384 | RTF_OUTPUT = rtf | 302 | RTF_OUTPUT = rtf |
1385 | |||
1386 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | ||
1387 | # RTF documents. This may be useful for small projects and may help to | ||
1388 | # save some trees in general. | ||
1389 | |||
1390 | COMPACT_RTF = NO | 303 | COMPACT_RTF = NO |
1391 | |||
1392 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | ||
1393 | # will contain hyperlink fields. The RTF file will | ||
1394 | # contain links (just like the HTML output) instead of page references. | ||
1395 | # This makes the output suitable for online browsing using WORD or other | ||
1396 | # programs which support those fields. | ||
1397 | # Note: wordpad (write) and others do not support links. | ||
1398 | |||
1399 | RTF_HYPERLINKS = YES | 304 | RTF_HYPERLINKS = YES |
1400 | |||
1401 | # Load style sheet definitions from file. Syntax is similar to doxygen's | ||
1402 | # config file, i.e. a series of assignments. You only have to provide | ||
1403 | # replacements, missing definitions are set to their default value. | ||
1404 | |||
1405 | RTF_STYLESHEET_FILE = | 305 | RTF_STYLESHEET_FILE = |
1406 | |||
1407 | # Set optional variables used in the generation of an rtf document. | ||
1408 | # Syntax is similar to doxygen's config file. | ||
1409 | |||
1410 | RTF_EXTENSIONS_FILE = | 306 | RTF_EXTENSIONS_FILE = |
1411 | |||
1412 | #--------------------------------------------------------------------------- | 307 | #--------------------------------------------------------------------------- |
1413 | # configuration options related to the man page output | 308 | # Configuration options related to the man page output |
1414 | #--------------------------------------------------------------------------- | 309 | #--------------------------------------------------------------------------- |
1415 | |||
1416 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | ||
1417 | # generate man pages | ||
1418 | |||
1419 | GENERATE_MAN = NO | 310 | GENERATE_MAN = NO |
1420 | |||
1421 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | ||
1422 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1423 | # put in front of it. If left blank `man' will be used as the default path. | ||
1424 | |||
1425 | MAN_OUTPUT = man | 311 | MAN_OUTPUT = man |
1426 | |||
1427 | # The MAN_EXTENSION tag determines the extension that is added to | ||
1428 | # the generated man pages (default is the subroutine's section .3) | ||
1429 | |||
1430 | MAN_EXTENSION = .3 | 312 | MAN_EXTENSION = .3 |
1431 | 313 | MAN_SUBDIR = | |
1432 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | ||
1433 | # then it will generate one additional man file for each entity | ||
1434 | # documented in the real man page(s). These additional files | ||
1435 | # only source the real man page, but without them the man command | ||
1436 | # would be unable to find the correct page. The default is NO. | ||
1437 | |||
1438 | MAN_LINKS = NO | 314 | MAN_LINKS = NO |
1439 | |||
1440 | #--------------------------------------------------------------------------- | 315 | #--------------------------------------------------------------------------- |
1441 | # configuration options related to the XML output | 316 | # Configuration options related to the XML output |
1442 | #--------------------------------------------------------------------------- | 317 | #--------------------------------------------------------------------------- |
1443 | |||
1444 | # If the GENERATE_XML tag is set to YES Doxygen will | ||
1445 | # generate an XML file that captures the structure of | ||
1446 | # the code including all documentation. | ||
1447 | |||
1448 | GENERATE_XML = NO | 318 | GENERATE_XML = NO |
1449 | |||
1450 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. | ||
1451 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1452 | # put in front of it. If left blank `xml' will be used as the default path. | ||
1453 | |||
1454 | XML_OUTPUT = xml | 319 | XML_OUTPUT = xml |
1455 | |||
1456 | # The XML_SCHEMA tag can be used to specify an XML schema, | ||
1457 | # which can be used by a validating XML parser to check the | ||
1458 | # syntax of the XML files. | ||
1459 | |||
1460 | XML_SCHEMA = | ||
1461 | |||
1462 | # The XML_DTD tag can be used to specify an XML DTD, | ||
1463 | # which can be used by a validating XML parser to check the | ||
1464 | # syntax of the XML files. | ||
1465 | |||
1466 | XML_DTD = | ||
1467 | |||
1468 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | ||
1469 | # dump the program listings (including syntax highlighting | ||
1470 | # and cross-referencing information) to the XML output. Note that | ||
1471 | # enabling this will significantly increase the size of the XML output. | ||
1472 | |||
1473 | XML_PROGRAMLISTING = YES | 320 | XML_PROGRAMLISTING = YES |
1474 | 321 | XML_NS_MEMB_FILE_SCOPE = NO | |
1475 | #--------------------------------------------------------------------------- | 322 | #--------------------------------------------------------------------------- |
1476 | # configuration options for the AutoGen Definitions output | 323 | # Configuration options related to the DOCBOOK output |
324 | #--------------------------------------------------------------------------- | ||
325 | GENERATE_DOCBOOK = NO | ||
326 | DOCBOOK_OUTPUT = docbook | ||
327 | #--------------------------------------------------------------------------- | ||
328 | # Configuration options for the AutoGen Definitions output | ||
1477 | #--------------------------------------------------------------------------- | 329 | #--------------------------------------------------------------------------- |
1478 | |||
1479 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | ||
1480 | # generate an AutoGen Definitions (see autogen.sf.net) file | ||
1481 | # that captures the structure of the code including all | ||
1482 | # documentation. Note that this feature is still experimental | ||
1483 | # and incomplete at the moment. | ||
1484 | |||
1485 | GENERATE_AUTOGEN_DEF = NO | 330 | GENERATE_AUTOGEN_DEF = NO |
1486 | |||
1487 | #--------------------------------------------------------------------------- | 331 | #--------------------------------------------------------------------------- |
1488 | # configuration options related to the Perl module output | 332 | # Configuration options related to the Perl module output |
1489 | #--------------------------------------------------------------------------- | 333 | #--------------------------------------------------------------------------- |
1490 | |||
1491 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | ||
1492 | # generate a Perl module file that captures the structure of | ||
1493 | # the code including all documentation. Note that this | ||
1494 | # feature is still experimental and incomplete at the | ||
1495 | # moment. | ||
1496 | |||
1497 | GENERATE_PERLMOD = NO | 334 | GENERATE_PERLMOD = NO |
1498 | |||
1499 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | ||
1500 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | ||
1501 | # to generate PDF and DVI output from the Perl module output. | ||
1502 | |||
1503 | PERLMOD_LATEX = YES | 335 | PERLMOD_LATEX = YES |
1504 | |||
1505 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | ||
1506 | # nicely formatted so it can be parsed by a human reader. | ||
1507 | # This is useful | ||
1508 | # if you want to understand what is going on. | ||
1509 | # On the other hand, if this | ||
1510 | # tag is set to NO the size of the Perl module output will be much smaller | ||
1511 | # and Perl will parse it just the same. | ||
1512 | |||
1513 | PERLMOD_PRETTY = YES | 336 | PERLMOD_PRETTY = YES |
1514 | |||
1515 | # The names of the make variables in the generated doxyrules.make file | ||
1516 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | ||
1517 | # This is useful so different doxyrules.make files included by the same | ||
1518 | # Makefile don't overwrite each other's variables. | ||
1519 | |||
1520 | PERLMOD_MAKEVAR_PREFIX = | 337 | PERLMOD_MAKEVAR_PREFIX = |
1521 | |||
1522 | #--------------------------------------------------------------------------- | 338 | #--------------------------------------------------------------------------- |
1523 | # Configuration options related to the preprocessor | 339 | # Configuration options related to the preprocessor |
1524 | #--------------------------------------------------------------------------- | 340 | #--------------------------------------------------------------------------- |
1525 | |||
1526 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | ||
1527 | # evaluate all C-preprocessor directives found in the sources and include | ||
1528 | # files. | ||
1529 | |||
1530 | ENABLE_PREPROCESSING = YES | 341 | ENABLE_PREPROCESSING = YES |
1531 | |||
1532 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | ||
1533 | # names in the source code. If set to NO (the default) only conditional | ||
1534 | # compilation will be performed. Macro expansion can be done in a controlled | ||
1535 | # way by setting EXPAND_ONLY_PREDEF to YES. | ||
1536 | |||
1537 | MACRO_EXPANSION = YES | 342 | MACRO_EXPANSION = YES |
1538 | |||
1539 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | ||
1540 | # then the macro expansion is limited to the macros specified with the | ||
1541 | # PREDEFINED and EXPAND_AS_DEFINED tags. | ||
1542 | |||
1543 | EXPAND_ONLY_PREDEF = NO | 343 | EXPAND_ONLY_PREDEF = NO |
1544 | |||
1545 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | ||
1546 | # pointed to by INCLUDE_PATH will be searched when a #include is found. | ||
1547 | |||
1548 | SEARCH_INCLUDES = YES | 344 | SEARCH_INCLUDES = YES |
1549 | |||
1550 | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||
1551 | # contain include files that are not input files but should be processed by | ||
1552 | # the preprocessor. | ||
1553 | |||
1554 | INCLUDE_PATH = | 345 | INCLUDE_PATH = |
1555 | |||
1556 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||
1557 | # patterns (like *.h and *.hpp) to filter out the header-files in the | ||
1558 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | ||
1559 | # be used. | ||
1560 | |||
1561 | INCLUDE_FILE_PATTERNS = | 346 | INCLUDE_FILE_PATTERNS = |
1562 | |||
1563 | # The PREDEFINED tag can be used to specify one or more macro names that | ||
1564 | # are defined before the preprocessor is started (similar to the -D option of | ||
1565 | # gcc). The argument of the tag is a list of macros of the form: name | ||
1566 | # or name=definition (no spaces). If the definition and the = are | ||
1567 | # omitted =1 is assumed. To prevent a macro definition from being | ||
1568 | # undefined via #undef or recursively expanded use the := operator | ||
1569 | # instead of the = operator. | ||
1570 | |||
1571 | PREDEFINED = | 347 | PREDEFINED = |
1572 | |||
1573 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | ||
1574 | # this tag can be used to specify a list of macro names that should be expanded. | ||
1575 | # The macro definition that is found in the sources will be used. | ||
1576 | # Use the PREDEFINED tag if you want to use a different macro definition that | ||
1577 | # overrules the definition found in the source code. | ||
1578 | |||
1579 | EXPAND_AS_DEFINED = | 348 | EXPAND_AS_DEFINED = |
1580 | |||
1581 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | ||
1582 | # doxygen's preprocessor will remove all references to function-like macros | ||
1583 | # that are alone on a line, have an all uppercase name, and do not end with a | ||
1584 | # semicolon, because these will confuse the parser if not removed. | ||
1585 | |||
1586 | SKIP_FUNCTION_MACROS = YES | 349 | SKIP_FUNCTION_MACROS = YES |
1587 | |||
1588 | #--------------------------------------------------------------------------- | 350 | #--------------------------------------------------------------------------- |
1589 | # Configuration::additions related to external references | 351 | # Configuration options related to external references |
1590 | #--------------------------------------------------------------------------- | 352 | #--------------------------------------------------------------------------- |
1591 | |||
1592 | # The TAGFILES option can be used to specify one or more tagfiles. For each | ||
1593 | # tag file the location of the external documentation should be added. The | ||
1594 | # format of a tag file without this location is as follows: | ||
1595 | # | ||
1596 | # TAGFILES = file1 file2 ... | ||
1597 | # Adding location for the tag files is done as follows: | ||
1598 | # | ||
1599 | # TAGFILES = file1=loc1 "file2 = loc2" ... | ||
1600 | # where "loc1" and "loc2" can be relative or absolute paths | ||
1601 | # or URLs. Note that each tag file must have a unique name (where the name does | ||
1602 | # NOT include the path). If a tag file is not located in the directory in which | ||
1603 | # doxygen is run, you must also specify the path to the tagfile here. | ||
1604 | |||
1605 | TAGFILES = | 353 | TAGFILES = |
1606 | |||
1607 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | ||
1608 | # a tag file that is based on the input files it reads. | ||
1609 | |||
1610 | GENERATE_TAGFILE = | 354 | GENERATE_TAGFILE = |
1611 | |||
1612 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | ||
1613 | # in the class index. If set to NO only the inherited external classes | ||
1614 | # will be listed. | ||
1615 | |||
1616 | ALLEXTERNALS = NO | 355 | ALLEXTERNALS = NO |
1617 | |||
1618 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | ||
1619 | # in the modules index. If set to NO, only the current project's groups will | ||
1620 | # be listed. | ||
1621 | |||
1622 | EXTERNAL_GROUPS = YES | 356 | EXTERNAL_GROUPS = YES |
1623 | 357 | EXTERNAL_PAGES = YES | |
1624 | # The PERL_PATH should be the absolute path and name of the perl script | ||
1625 | # interpreter (i.e. the result of `which perl'). | ||
1626 | |||
1627 | PERL_PATH = /usr/bin/perl | ||
1628 | |||
1629 | #--------------------------------------------------------------------------- | 358 | #--------------------------------------------------------------------------- |
1630 | # Configuration options related to the dot tool | 359 | # Configuration options related to the dot tool |
1631 | #--------------------------------------------------------------------------- | 360 | #--------------------------------------------------------------------------- |
1632 | 361 | DIA_PATH = | |
1633 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | ||
1634 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | ||
1635 | # or super classes. Setting the tag to NO turns the diagrams off. Note that | ||
1636 | # this option also works with HAVE_DOT disabled, but it is recommended to | ||
1637 | # install and use dot, since it yields more powerful graphs. | ||
1638 | |||
1639 | CLASS_DIAGRAMS = YES | ||
1640 | |||
1641 | # You can define message sequence charts within doxygen comments using the \msc | ||
1642 | # command. Doxygen will then run the mscgen tool (see | ||
1643 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | ||
1644 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | ||
1645 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | ||
1646 | # default search path. | ||
1647 | |||
1648 | MSCGEN_PATH = | ||
1649 | |||
1650 | # If set to YES, the inheritance and collaboration graphs will hide | ||
1651 | # inheritance and usage relations if the target is undocumented | ||
1652 | # or is not a class. | ||
1653 | |||
1654 | HIDE_UNDOC_RELATIONS = YES | 362 | HIDE_UNDOC_RELATIONS = YES |
1655 | |||
1656 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | ||
1657 | # available from the path. This tool is part of Graphviz, a graph visualization | ||
1658 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | ||
1659 | # have no effect if this option is set to NO (the default) | ||
1660 | |||
1661 | HAVE_DOT = YES | 363 | HAVE_DOT = YES |
1662 | |||
1663 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | ||
1664 | # allowed to run in parallel. When set to 0 (the default) doxygen will | ||
1665 | # base this on the number of processors available in the system. You can set it | ||
1666 | # explicitly to a value larger than 0 to get control over the balance | ||
1667 | # between CPU load and processing speed. | ||
1668 | |||
1669 | DOT_NUM_THREADS = 0 | 364 | DOT_NUM_THREADS = 0 |
1670 | |||
1671 | # By default doxygen will use the Helvetica font for all dot files that | ||
1672 | # doxygen generates. When you want a differently looking font you can specify | ||
1673 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find | ||
1674 | # the font, which can be done by putting it in a standard location or by setting | ||
1675 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | ||
1676 | # directory containing the font. | ||
1677 | |||
1678 | DOT_FONTNAME = FreeSans | 365 | DOT_FONTNAME = FreeSans |
1679 | |||
1680 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | ||
1681 | # The default size is 10pt. | ||
1682 | |||
1683 | DOT_FONTSIZE = 10 | 366 | DOT_FONTSIZE = 10 |
1684 | |||
1685 | # By default doxygen will tell dot to use the Helvetica font. | ||
1686 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to | ||
1687 | # set the path where dot can find it. | ||
1688 | |||
1689 | DOT_FONTPATH = | 367 | DOT_FONTPATH = |
1690 | |||
1691 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1692 | # will generate a graph for each documented class showing the direct and | ||
1693 | # indirect inheritance relations. Setting this tag to YES will force the | ||
1694 | # CLASS_DIAGRAMS tag to NO. | ||
1695 | |||
1696 | CLASS_GRAPH = YES | 368 | CLASS_GRAPH = YES |
1697 | |||
1698 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1699 | # will generate a graph for each documented class showing the direct and | ||
1700 | # indirect implementation dependencies (inheritance, containment, and | ||
1701 | # class references variables) of the class with other documented classes. | ||
1702 | |||
1703 | COLLABORATION_GRAPH = YES | 369 | COLLABORATION_GRAPH = YES |
1704 | |||
1705 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | ||
1706 | # will generate a graph for groups, showing the direct groups dependencies | ||
1707 | |||
1708 | GROUP_GRAPHS = YES | 370 | GROUP_GRAPHS = YES |
1709 | |||
1710 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | ||
1711 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | ||
1712 | # Language. | ||
1713 | |||
1714 | UML_LOOK = NO | 371 | UML_LOOK = NO |
1715 | |||
1716 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside | ||
1717 | # the class node. If there are many fields or methods and many nodes the | ||
1718 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS | ||
1719 | # threshold limits the number of items for each type to make the size more | ||
1720 | # managable. Set this to 0 for no limit. Note that the threshold may be | ||
1721 | # exceeded by 50% before the limit is enforced. | ||
1722 | |||
1723 | UML_LIMIT_NUM_FIELDS = 10 | 372 | UML_LIMIT_NUM_FIELDS = 10 |
1724 | 373 | DOT_UML_DETAILS = NO | |
1725 | # If set to YES, the inheritance and collaboration graphs will show the | 374 | DOT_WRAP_THRESHOLD = 17 |
1726 | # relations between templates and their instances. | ||
1727 | |||
1728 | TEMPLATE_RELATIONS = NO | 375 | TEMPLATE_RELATIONS = NO |
1729 | |||
1730 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | ||
1731 | # tags are set to YES then doxygen will generate a graph for each documented | ||
1732 | # file showing the direct and indirect include dependencies of the file with | ||
1733 | # other documented files. | ||
1734 | |||
1735 | INCLUDE_GRAPH = YES | 376 | INCLUDE_GRAPH = YES |
1736 | |||
1737 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | ||
1738 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | ||
1739 | # documented header file showing the documented files that directly or | ||
1740 | # indirectly include this file. | ||
1741 | |||
1742 | INCLUDED_BY_GRAPH = YES | 377 | INCLUDED_BY_GRAPH = YES |
1743 | 378 | CALL_GRAPH = YES | |
1744 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then | 379 | CALLER_GRAPH = YES |
1745 | # doxygen will generate a call dependency graph for every global function | ||
1746 | # or class method. Note that enabling this option will significantly increase | ||
1747 | # the time of a run. So in most cases it will be better to enable call graphs | ||
1748 | # for selected functions only using the \callgraph command. | ||
1749 | |||
1750 | CALL_GRAPH = NO | ||
1751 | |||
1752 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | ||
1753 | # doxygen will generate a caller dependency graph for every global function | ||
1754 | # or class method. Note that enabling this option will significantly increase | ||
1755 | # the time of a run. So in most cases it will be better to enable caller | ||
1756 | # graphs for selected functions only using the \callergraph command. | ||
1757 | |||
1758 | CALLER_GRAPH = NO | ||
1759 | |||
1760 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | ||
1761 | # will generate a graphical hierarchy of all classes instead of a textual one. | ||
1762 | |||
1763 | GRAPHICAL_HIERARCHY = YES | 380 | GRAPHICAL_HIERARCHY = YES |
1764 | |||
1765 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES | ||
1766 | # then doxygen will show the dependencies a directory has on other directories | ||
1767 | # in a graphical way. The dependency relations are determined by the #include | ||
1768 | # relations between the files in the directories. | ||
1769 | |||
1770 | DIRECTORY_GRAPH = NO | 381 | DIRECTORY_GRAPH = NO |
1771 | 382 | DIR_GRAPH_MAX_DEPTH = 1 | |
1772 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
1773 | # generated by dot. Possible values are svg, png, jpg, or gif. | ||
1774 | # If left blank png will be used. If you choose svg you need to set | ||
1775 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1776 | # visible in IE 9+ (other browsers do not have this requirement). | ||
1777 | |||
1778 | DOT_IMAGE_FORMAT = png | 383 | DOT_IMAGE_FORMAT = png |
1779 | 384 | INTERACTIVE_SVG = YES | |
1780 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to | ||
1781 | # enable generation of interactive SVG images that allow zooming and panning. | ||
1782 | # Note that this requires a modern browser other than Internet Explorer. | ||
1783 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you | ||
1784 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1785 | # visible. Older versions of IE do not have SVG support. | ||
1786 | |||
1787 | INTERACTIVE_SVG = NO | ||
1788 | |||
1789 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | ||
1790 | # found. If left blank, it is assumed the dot tool can be found in the path. | ||
1791 | |||
1792 | DOT_PATH = | 385 | DOT_PATH = |
1793 | |||
1794 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
1795 | # contain dot files that are included in the documentation (see the | ||
1796 | # \dotfile command). | ||
1797 | |||
1798 | DOTFILE_DIRS = | 386 | DOTFILE_DIRS = |
1799 | |||
1800 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
1801 | # contain msc files that are included in the documentation (see the | ||
1802 | # \mscfile command). | ||
1803 | |||
1804 | MSCFILE_DIRS = | 387 | MSCFILE_DIRS = |
1805 | 388 | DIAFILE_DIRS = | |
1806 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | 389 | PLANTUML_JAR_PATH = |
1807 | # nodes that will be shown in the graph. If the number of nodes in a graph | 390 | PLANTUML_CFG_FILE = |
1808 | # becomes larger than this value, doxygen will truncate the graph, which is | 391 | PLANTUML_INCLUDE_PATH = |
1809 | # visualized by representing a node as a red box. Note that doxygen if the | ||
1810 | # number of direct children of the root node in a graph is already larger than | ||
1811 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | ||
1812 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
1813 | |||
1814 | DOT_GRAPH_MAX_NODES = 50 | 392 | DOT_GRAPH_MAX_NODES = 50 |
1815 | |||
1816 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | ||
1817 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | ||
1818 | # from the root by following a path via at most 3 edges will be shown. Nodes | ||
1819 | # that lay further from the root node will be omitted. Note that setting this | ||
1820 | # option to 1 or 2 may greatly reduce the computation time needed for large | ||
1821 | # code bases. Also note that the size of a graph can be further restricted by | ||
1822 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
1823 | |||
1824 | MAX_DOT_GRAPH_DEPTH = 1000 | 393 | MAX_DOT_GRAPH_DEPTH = 1000 |
1825 | |||
1826 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
1827 | # background. This is disabled by default, because dot on Windows does not | ||
1828 | # seem to support this out of the box. Warning: Depending on the platform used, | ||
1829 | # enabling this option may lead to badly anti-aliased labels on the edges of | ||
1830 | # a graph (i.e. they become hard to read). | ||
1831 | |||
1832 | DOT_TRANSPARENT = NO | 394 | DOT_TRANSPARENT = NO |
1833 | |||
1834 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | ||
1835 | # files in one run (i.e. multiple -o and -T options on the command line). This | ||
1836 | # makes dot run faster, but since only newer versions of dot (>1.8.10) | ||
1837 | # support this, this feature is disabled by default. | ||
1838 | |||
1839 | DOT_MULTI_TARGETS = NO | 395 | DOT_MULTI_TARGETS = NO |
1840 | |||
1841 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | ||
1842 | # generate a legend page explaining the meaning of the various boxes and | ||
1843 | # arrows in the dot generated graphs. | ||
1844 | |||
1845 | GENERATE_LEGEND = YES | 396 | GENERATE_LEGEND = YES |
1846 | |||
1847 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | ||
1848 | # remove the intermediate dot files that are used to generate | ||
1849 | # the various graphs. | ||
1850 | |||
1851 | DOT_CLEANUP = YES | 397 | DOT_CLEANUP = YES |
diff --git a/src/experimental/debugmutex.cpp b/src/experimental/debugmutex.cpp new file mode 100644 index 0000000..2b61ae2 --- /dev/null +++ b/src/experimental/debugmutex.cpp | |||
@@ -0,0 +1,78 @@ | |||
1 | #include "bu/debugmutex.h" | ||
2 | |||
3 | #include "bu/exceptionbase.h" | ||
4 | |||
5 | Bu::DebugMutex::DebugMutex() | ||
6 | { | ||
7 | } | ||
8 | |||
9 | Bu::DebugMutex::~DebugMutex() | ||
10 | { | ||
11 | } | ||
12 | |||
13 | int Bu::DebugMutex::lock() | ||
14 | { | ||
15 | pthread_t self = pthread_self(); | ||
16 | mState.lock(); | ||
17 | bool bFound = false; | ||
18 | for( ThreadList::iterator i = lThreads.begin(); i; i++ ) | ||
19 | { | ||
20 | if( (*i) == self ) | ||
21 | { | ||
22 | bFound = true; | ||
23 | if( (*i).bLocked == true ) | ||
24 | { | ||
25 | throw Bu::ExceptionBase( Bu::String("Double lock in thread: %1").arg( (*i).sName ).end().getStr() ); | ||
26 | |||
27 | } | ||
28 | else | ||
29 | { | ||
30 | (*i).bLocked = true; | ||
31 | } | ||
32 | break; | ||
33 | } | ||
34 | } | ||
35 | if( bFound == false ) | ||
36 | { | ||
37 | lThreads.append( ThreadInfo( true ) ); | ||
38 | } | ||
39 | mState.unlock(); | ||
40 | return Bu::Mutex::lock(); | ||
41 | } | ||
42 | |||
43 | int Bu::DebugMutex::unlock() | ||
44 | { | ||
45 | pthread_t self = pthread_self(); | ||
46 | mState.lock(); | ||
47 | bool bFound = false; | ||
48 | for( ThreadList::iterator i = lThreads.begin(); i; i++ ) | ||
49 | { | ||
50 | if( (*i) == self ) | ||
51 | { | ||
52 | bFound = true; | ||
53 | if( (*i).bLocked == false ) | ||
54 | { | ||
55 | throw Bu::ExceptionBase( Bu::String("Unlock in thread that did not lock: %1").arg( (*i).sName ).end().getStr() ); | ||
56 | |||
57 | } | ||
58 | else | ||
59 | { | ||
60 | (*i).bLocked = false; | ||
61 | } | ||
62 | break; | ||
63 | } | ||
64 | } | ||
65 | if( bFound == false ) | ||
66 | { | ||
67 | ThreadInfo info( false ); | ||
68 | throw Bu::ExceptionBase( Bu::String("Unlock in thread that never locked mutex: %1").arg( info.sName ).end().getStr() ); | ||
69 | } | ||
70 | mState.unlock(); | ||
71 | return Bu::Mutex::unlock(); | ||
72 | } | ||
73 | |||
74 | int Bu::DebugMutex::trylock() | ||
75 | { | ||
76 | return Bu::Mutex::trylock(); | ||
77 | } | ||
78 | |||
diff --git a/src/experimental/debugmutex.h b/src/experimental/debugmutex.h new file mode 100644 index 0000000..ca8ef9f --- /dev/null +++ b/src/experimental/debugmutex.h | |||
@@ -0,0 +1,102 @@ | |||
1 | /* | ||
2 | * Copyright (C) 2007-2023 Xagasoft, All rights reserved. | ||
3 | * | ||
4 | * This file is part of the libbu++ library and is released under the | ||
5 | * terms of the license contained in the file LICENSE. | ||
6 | */ | ||
7 | |||
8 | #ifndef BU_DEBUG_MUTEX_H | ||
9 | #define BU_DEBUG_MUTEX_H | ||
10 | |||
11 | #include "bu/mutex.h" | ||
12 | #include "bu/list.h" | ||
13 | #include "bu/string.h" | ||
14 | |||
15 | namespace Bu | ||
16 | { | ||
17 | /** | ||
18 | * Simple mutex wrapper. Currently this doesn't do anything extra for you | ||
19 | * except keep all of the functionality together in an OO sorta' way and | ||
20 | * keep you from having to worry about cleaning up your mutexes properly, | ||
21 | * or initing them. | ||
22 | *@ingroup Threading | ||
23 | */ | ||
24 | class DebugMutex : public Mutex | ||
25 | { | ||
26 | public: | ||
27 | /** | ||
28 | * Create an unlocked mutex. | ||
29 | */ | ||
30 | DebugMutex(); | ||
31 | |||
32 | /** | ||
33 | * Destroy a mutex. This can only be done when a mutex is unlocked. | ||
34 | * Failure to unlock before destroying a mutex object could cause it to | ||
35 | * wait for the mutex to unlock, the odds of which are usually farily | ||
36 | * low at deconstruction time. | ||
37 | */ | ||
38 | virtual ~DebugMutex(); | ||
39 | |||
40 | /** | ||
41 | * Lock the mutex. This causes all future calls to lock on this | ||
42 | * instance of mutex to block until the first thread that called mutex | ||
43 | * unlocks it. At that point the next thread that called lock will get | ||
44 | * a chance to go to work. Because of the nature of a mutex lock it is | ||
45 | * a very bad idea to do any kind of serious or rather time consuming | ||
46 | * computation within a locked section. This can cause thread-deadlock | ||
47 | * and your program may hang. | ||
48 | */ | ||
49 | virtual int lock(); | ||
50 | |||
51 | /** | ||
52 | * Unlock the mutex. This allows the next thread that asked for a lock | ||
53 | * to lock the mutex and continue with execution. | ||
54 | */ | ||
55 | virtual int unlock(); | ||
56 | |||
57 | /** | ||
58 | * Try to lock the mutex. This is the option to go with if you cannot | ||
59 | * avoid putting lengthy operations within a locked section. trylock | ||
60 | * will attempt to lock the mutex, if the mutex is already locked this | ||
61 | * function returns immediately with an error code. | ||
62 | */ | ||
63 | virtual int trylock(); | ||
64 | |||
65 | private: | ||
66 | Bu::Mutex mState; | ||
67 | |||
68 | class ThreadInfo | ||
69 | { | ||
70 | public: | ||
71 | ThreadInfo( bool bLocked=false ) : | ||
72 | idThread( pthread_self() ), | ||
73 | bLocked( bLocked ) | ||
74 | { | ||
75 | char buf[64]; | ||
76 | if( pthread_getname_np( idThread, buf, 64 ) == 0 ) | ||
77 | sName = buf; | ||
78 | } | ||
79 | ~ThreadInfo() {} | ||
80 | |||
81 | bool operator==( const ThreadInfo &rhs ) | ||
82 | { | ||
83 | return pthread_equal( idThread, rhs.idThread ); | ||
84 | } | ||
85 | |||
86 | bool operator==( const pthread_t &rhs ) | ||
87 | { | ||
88 | return pthread_equal( idThread, rhs ); | ||
89 | } | ||
90 | |||
91 | pthread_t idThread; | ||
92 | Bu::String sName; | ||
93 | bool bLocked; | ||
94 | }; | ||
95 | typedef Bu::List<ThreadInfo> ThreadList; | ||
96 | ThreadList lThreads; | ||
97 | }; | ||
98 | } | ||
99 | |||
100 | #endif | ||
101 | |||
102 | |||
diff --git a/src/stable/mutex.h b/src/stable/mutex.h index d9e8910..8034974 100644 --- a/src/stable/mutex.h +++ b/src/stable/mutex.h | |||
@@ -33,7 +33,7 @@ namespace Bu | |||
33 | * wait for the mutex to unlock, the odds of which are usually farily | 33 | * wait for the mutex to unlock, the odds of which are usually farily |
34 | * low at deconstruction time. | 34 | * low at deconstruction time. |
35 | */ | 35 | */ |
36 | ~Mutex(); | 36 | virtual ~Mutex(); |
37 | 37 | ||
38 | /** | 38 | /** |
39 | * Lock the mutex. This causes all future calls to lock on this | 39 | * Lock the mutex. This causes all future calls to lock on this |
@@ -44,13 +44,13 @@ namespace Bu | |||
44 | * computation within a locked section. This can cause thread-deadlock | 44 | * computation within a locked section. This can cause thread-deadlock |
45 | * and your program may hang. | 45 | * and your program may hang. |
46 | */ | 46 | */ |
47 | int lock(); | 47 | virtual int lock(); |
48 | 48 | ||
49 | /** | 49 | /** |
50 | * Unlock the mutex. This allows the next thread that asked for a lock | 50 | * Unlock the mutex. This allows the next thread that asked for a lock |
51 | * to lock the mutex and continue with execution. | 51 | * to lock the mutex and continue with execution. |
52 | */ | 52 | */ |
53 | int unlock(); | 53 | virtual int unlock(); |
54 | 54 | ||
55 | /** | 55 | /** |
56 | * Try to lock the mutex. This is the option to go with if you cannot | 56 | * Try to lock the mutex. This is the option to go with if you cannot |
@@ -58,7 +58,7 @@ namespace Bu | |||
58 | * will attempt to lock the mutex, if the mutex is already locked this | 58 | * will attempt to lock the mutex, if the mutex is already locked this |
59 | * function returns immediately with an error code. | 59 | * function returns immediately with an error code. |
60 | */ | 60 | */ |
61 | int trylock(); | 61 | virtual int trylock(); |
62 | 62 | ||
63 | protected: | 63 | protected: |
64 | pthread_mutex_t mutex; /**< The internal mutex reference. */ | 64 | pthread_mutex_t mutex; /**< The internal mutex reference. */ |
diff --git a/src/stable/myriad.cpp b/src/stable/myriad.cpp index 03cffa9..492676e 100644 --- a/src/stable/myriad.cpp +++ b/src/stable/myriad.cpp | |||
@@ -129,6 +129,19 @@ Bu::MyriadStream Bu::Myriad::open( Bu::Myriad::StreamId iStream, | |||
129 | return Bu::MyriadStream( *this, pStream, eMode ); | 129 | return Bu::MyriadStream( *this, pStream, eMode ); |
130 | } | 130 | } |
131 | 131 | ||
132 | Bu::Myriad::StreamId Bu::Myriad::allocate() | ||
133 | { | ||
134 | Bu::MutexLocker l( mAccess ); | ||
135 | |||
136 | Stream *pStream = new Stream( *this, ++iLastUsedIndex, 0 ); | ||
137 | mhStream.lock(); | ||
138 | hStream.insert( pStream->iStream, pStream ); | ||
139 | mhStream.unlock(); | ||
140 | bStructureChanged = true; | ||
141 | |||
142 | return pStream->iStream; | ||
143 | } | ||
144 | |||
132 | void Bu::Myriad::erase( Bu::Myriad::StreamId iStream ) | 145 | void Bu::Myriad::erase( Bu::Myriad::StreamId iStream ) |
133 | { | 146 | { |
134 | // For now, let's prevent you from erasing a stream if it's open. | 147 | // For now, let's prevent you from erasing a stream if it's open. |
@@ -252,6 +265,19 @@ int32_t Bu::Myriad::getTotalUnusedBytes(int32_t iAssumeBlockSize ) const | |||
252 | return iTotal; | 265 | return iTotal; |
253 | } | 266 | } |
254 | 267 | ||
268 | Bu::Myriad::StreamIdList Bu::Myriad::getStreamList() const | ||
269 | { | ||
270 | mhStream.lock(); | ||
271 | StreamIdList lIds = hStream.getKeys(); | ||
272 | mhStream.unlock(); | ||
273 | lIds.sort(); | ||
274 | if( lIds.first() == 0 ) | ||
275 | { | ||
276 | lIds.eraseFirst(); | ||
277 | } | ||
278 | return lIds; | ||
279 | } | ||
280 | |||
255 | Bu::BitString Bu::Myriad::buildBlockUseMap() const | 281 | Bu::BitString Bu::Myriad::buildBlockUseMap() const |
256 | { | 282 | { |
257 | Bu::MutexLocker l( mAccess ); | 283 | Bu::MutexLocker l( mAccess ); |
@@ -264,10 +290,10 @@ Bu::BitString Bu::Myriad::buildBlockUseMap() const | |||
264 | return bsMap; | 290 | return bsMap; |
265 | } | 291 | } |
266 | 292 | ||
267 | Bu::Array<int32_t> Bu::Myriad::buildBlockMap() const | 293 | Bu::Myriad::StreamIdArray Bu::Myriad::buildBlockMap() const |
268 | { | 294 | { |
269 | Bu::MutexLocker l( mAccess ); | 295 | Bu::MutexLocker l( mAccess ); |
270 | Bu::Array<int32_t> bm( iBlockCount ); | 296 | StreamIdArray bm( iBlockCount ); |
271 | for( int j = 0; j < iBlockCount; j++ ) | 297 | for( int j = 0; j < iBlockCount; j++ ) |
272 | { | 298 | { |
273 | bm.append( -1 ); | 299 | bm.append( -1 ); |
@@ -768,9 +794,7 @@ int32_t Bu::Myriad::Stream::read( int32_t iStart, void *pTarget, | |||
768 | 794 | ||
769 | if( iStart+iSize >= this->iSize ) | 795 | if( iStart+iSize >= this->iSize ) |
770 | { | 796 | { |
771 | int32_t iDiff = (iStart+iSize)-this->iSize; | 797 | iSize = this->iSize-iStart; |
772 | iSize -= iDiff; | ||
773 | iStart += iDiff; | ||
774 | } | 798 | } |
775 | 799 | ||
776 | while( iSize > 0 ) | 800 | while( iSize > 0 ) |
diff --git a/src/stable/myriad.h b/src/stable/myriad.h index 6168aa2..5accd1e 100644 --- a/src/stable/myriad.h +++ b/src/stable/myriad.h | |||
@@ -31,10 +31,20 @@ namespace Bu | |||
31 | }; | 31 | }; |
32 | subExceptionDeclEnd(); | 32 | subExceptionDeclEnd(); |
33 | 33 | ||
34 | /** | ||
35 | * Myriad Stream Multiplexer. This is a system that allows you to store | ||
36 | * many streams within a single backing stream. This is great for databases, | ||
37 | * caching, etc. It's fairly lightweight, and allows all streams to grow | ||
38 | * dynamically using a block-allocation scheme. This is used extensively | ||
39 | * by the caching system and MyriadFs as well as other systems within | ||
40 | * libbu++. | ||
41 | */ | ||
34 | class Myriad | 42 | class Myriad |
35 | { | 43 | { |
36 | public: | 44 | public: |
37 | typedef int32_t StreamId; | 45 | typedef int32_t StreamId; |
46 | typedef Bu::Array<StreamId> StreamIdArray; | ||
47 | typedef Bu::List<StreamId> StreamIdList; | ||
38 | enum Mode : int32_t { | 48 | enum Mode : int32_t { |
39 | None = 0x00, | 49 | None = 0x00, |
40 | 50 | ||
@@ -55,8 +65,9 @@ namespace Bu | |||
55 | 65 | ||
56 | public: | 66 | public: |
57 | /** | 67 | /** |
58 | * Open existing Myriad stream, or initialize a new one if it doesn't | 68 | * Open existing Myriad container, or initialize a new one if the |
59 | * exist. | 69 | * backing stream is empty. If other data is already in the provided |
70 | * backing stream an error is thrown. | ||
60 | * | 71 | * |
61 | * Myriad format V0 | 72 | * Myriad format V0 |
62 | * 0 - 3: Myriad_MAGIC_CODE (0ad3fa84) | 73 | * 0 - 3: Myriad_MAGIC_CODE (0ad3fa84) |
@@ -75,8 +86,32 @@ namespace Bu | |||
75 | int32_t iPreallocateBlocks=-1 ); | 86 | int32_t iPreallocateBlocks=-1 ); |
76 | virtual ~Myriad(); | 87 | virtual ~Myriad(); |
77 | 88 | ||
89 | /** | ||
90 | * Creates a new stream open in the specified eMode and, optionally, | ||
91 | * preallocates the specificed amount of space. The stream is zero | ||
92 | * bytes even if space is preallocated. The open stream is returned, | ||
93 | * ready for use. Use this if you don't care what the id is of the | ||
94 | * newly created stream. | ||
95 | */ | ||
78 | MyriadStream create( Mode eMode, int32_t iPreallocateBytes=-1 ); | 96 | MyriadStream create( Mode eMode, int32_t iPreallocateBytes=-1 ); |
97 | |||
98 | /** | ||
99 | * Open an existing stream or create a new stream with the specified | ||
100 | * id (iStream) with the specified eMode. This respects the normal file | ||
101 | * modes, see Bu::Myriad::Mode for details. | ||
102 | */ | ||
79 | MyriadStream open( StreamId iStream, Mode eMode ); | 103 | MyriadStream open( StreamId iStream, Mode eMode ); |
104 | |||
105 | /** | ||
106 | * Allocate a new stream but do not open it, just ensure it exists and | ||
107 | * return the id of the newly allocated stream. | ||
108 | */ | ||
109 | StreamId allocate(); | ||
110 | |||
111 | /** | ||
112 | * Erase the stream specified by iStream. This only can work when the | ||
113 | * stream is not open at the moment. | ||
114 | */ | ||
80 | void erase( StreamId iStream ); | 115 | void erase( StreamId iStream ); |
81 | void setSize( StreamId iStream, int32_t iNewSize ); | 116 | void setSize( StreamId iStream, int32_t iNewSize ); |
82 | int32_t getSize( StreamId iStream ) const; | 117 | int32_t getSize( StreamId iStream ) const; |
@@ -90,7 +125,15 @@ namespace Bu | |||
90 | int32_t getTotalUsedBytes() const; | 125 | int32_t getTotalUsedBytes() const; |
91 | int32_t getTotalUnusedBytes( int32_t iAssumeBlockSize=-1 ) const; | 126 | int32_t getTotalUnusedBytes( int32_t iAssumeBlockSize=-1 ) const; |
92 | Bu::BitString buildBlockUseMap() const; | 127 | Bu::BitString buildBlockUseMap() const; |
93 | Bu::Array<int32_t> buildBlockMap() const; | 128 | StreamIdArray buildBlockMap() const; |
129 | |||
130 | /** | ||
131 | * Lists all stream ids that you are allowed to open. Technically there | ||
132 | * is always a zero stream, but it is used by Myriad for stream/block | ||
133 | * accounting. It works like a normal stream but you should not open | ||
134 | * it. | ||
135 | */ | ||
136 | StreamIdList getStreamList() const; | ||
94 | 137 | ||
95 | /** | 138 | /** |
96 | * Flush all caches to the backing stream, write all structural and | 139 | * Flush all caches to the backing stream, write all structural and |
diff --git a/src/tests/myriadfs.cpp b/src/tests/myriadfs.cpp index 1266e4b..29ac3d9 100644 --- a/src/tests/myriadfs.cpp +++ b/src/tests/myriadfs.cpp | |||
@@ -9,7 +9,7 @@ using namespace Bu; | |||
9 | int main() | 9 | int main() |
10 | { | 10 | { |
11 | // Bu::MemBuf mb; | 11 | // Bu::MemBuf mb; |
12 | Bu::File mb("store.myr", File::Read|File::Write|File::Create ); | 12 | Bu::File mb("store.mfs", File::Read|File::Write|File::Create ); |
13 | Bu::MyriadFs mfs( mb, 512 ); | 13 | Bu::MyriadFs mfs( mb, 512 ); |
14 | 14 | ||
15 | sio << "Creating dirs..." << sio.nl; | 15 | sio << "Creating dirs..." << sio.nl; |
diff --git a/src/unstable/myriadcache.h b/src/unstable/myriadcache.h index d6842a5..f71f9b5 100644 --- a/src/unstable/myriadcache.h +++ b/src/unstable/myriadcache.h | |||
@@ -86,8 +86,8 @@ namespace Bu | |||
86 | { | 86 | { |
87 | Bu::ReadWriteMutex::WriteLocker wl( rwStore ); | 87 | Bu::ReadWriteMutex::WriteLocker wl( rwStore ); |
88 | { | 88 | { |
89 | Bu::MyriadStream ms = mStore.create( Bu::Myriad::Create ); | 89 | Bu::Myriad::StreamId id = mStore.allocate(); |
90 | hIndex.insert( o->getKey(), ms.getId() ); | 90 | hIndex.insert( o->getKey(), id ); |
91 | } | 91 | } |
92 | _save( o ); | 92 | _save( o ); |
93 | 93 | ||
diff --git a/src/unstable/myriadfs.cpp b/src/unstable/myriadfs.cpp index ab9ca74..f748a53 100644 --- a/src/unstable/myriadfs.cpp +++ b/src/unstable/myriadfs.cpp | |||
@@ -8,6 +8,7 @@ | |||
8 | #include "bu/config.h" | 8 | #include "bu/config.h" |
9 | #include "bu/myriadfs.h" | 9 | #include "bu/myriadfs.h" |
10 | #include "bu/myriadstream.h" | 10 | #include "bu/myriadstream.h" |
11 | #include "bu/mutexlocker.h" | ||
11 | 12 | ||
12 | #include <string.h> | 13 | #include <string.h> |
13 | #include <unistd.h> | 14 | #include <unistd.h> |
@@ -107,6 +108,7 @@ Bu::MyriadFs::~MyriadFs() | |||
107 | 108 | ||
108 | void Bu::MyriadFs::stat( const Bu::String &sPath, Bu::MyriadFs::Stat &rBuf ) | 109 | void Bu::MyriadFs::stat( const Bu::String &sPath, Bu::MyriadFs::Stat &rBuf ) |
109 | { | 110 | { |
111 | Bu::MutexLocker lLock( mAccess ); | ||
110 | int32_t iParent; | 112 | int32_t iParent; |
111 | int32_t iNode = lookupInode( sPath, iParent ); | 113 | int32_t iNode = lookupInode( sPath, iParent ); |
112 | Bu::MyriadStream is = mStore.open( 2, Bu::Myriad::Read ); | 114 | Bu::MyriadStream is = mStore.open( 2, Bu::Myriad::Read ); |
@@ -116,6 +118,7 @@ void Bu::MyriadFs::stat( const Bu::String &sPath, Bu::MyriadFs::Stat &rBuf ) | |||
116 | Bu::MyriadStream Bu::MyriadFs::open( const Bu::String &sPath, int iMode, | 118 | Bu::MyriadStream Bu::MyriadFs::open( const Bu::String &sPath, int iMode, |
117 | uint16_t uPerms ) | 119 | uint16_t uPerms ) |
118 | { | 120 | { |
121 | Bu::MutexLocker lLock( mAccess ); | ||
119 | int32_t iParent = -1; | 122 | int32_t iParent = -1; |
120 | int32_t iNode; | 123 | int32_t iNode; |
121 | try | 124 | try |
@@ -164,6 +167,7 @@ void Bu::MyriadFs::create( const Bu::String &sPath, uint16_t iPerms, | |||
164 | void Bu::MyriadFs::create( const Bu::String &sPath, uint16_t iPerms, | 167 | void Bu::MyriadFs::create( const Bu::String &sPath, uint16_t iPerms, |
165 | uint32_t uSpecial ) | 168 | uint32_t uSpecial ) |
166 | { | 169 | { |
170 | Bu::MutexLocker lLock( mAccess ); | ||
167 | int32_t iParent = -1; | 171 | int32_t iParent = -1; |
168 | // int32_t iNode; | 172 | // int32_t iNode; |
169 | try | 173 | try |
@@ -200,6 +204,7 @@ void Bu::MyriadFs::mkDir( const Bu::String &sPath, uint16_t iPerms ) | |||
200 | void Bu::MyriadFs::mkSymLink( const Bu::String &sTarget, | 204 | void Bu::MyriadFs::mkSymLink( const Bu::String &sTarget, |
201 | const Bu::String &sPath ) | 205 | const Bu::String &sPath ) |
202 | { | 206 | { |
207 | Bu::MutexLocker lLock( mAccess ); | ||
203 | int32_t iParent = -1; | 208 | int32_t iParent = -1; |
204 | int32_t iNode; | 209 | int32_t iNode; |
205 | try | 210 | try |
@@ -232,6 +237,7 @@ void Bu::MyriadFs::mkSymLink( const Bu::String &sTarget, | |||
232 | void Bu::MyriadFs::mkHardLink( const Bu::String &sTarget, | 237 | void Bu::MyriadFs::mkHardLink( const Bu::String &sTarget, |
233 | const Bu::String &sPath ) | 238 | const Bu::String &sPath ) |
234 | { | 239 | { |
240 | Bu::MutexLocker lLock( mAccess ); | ||
235 | int32_t iParent = -1; | 241 | int32_t iParent = -1; |
236 | int32_t iNode; | 242 | int32_t iNode; |
237 | 243 | ||
@@ -267,6 +273,7 @@ void Bu::MyriadFs::mkHardLink( const Bu::String &sTarget, | |||
267 | 273 | ||
268 | Bu::String Bu::MyriadFs::readSymLink( const Bu::String &sPath ) | 274 | Bu::String Bu::MyriadFs::readSymLink( const Bu::String &sPath ) |
269 | { | 275 | { |
276 | Bu::MutexLocker lLock( mAccess ); | ||
270 | int32_t iParent = -1; | 277 | int32_t iParent = -1; |
271 | int32_t iNode; | 278 | int32_t iNode; |
272 | iNode = lookupInode( sPath, iParent ); | 279 | iNode = lookupInode( sPath, iParent ); |
@@ -279,6 +286,7 @@ Bu::String Bu::MyriadFs::readSymLink( const Bu::String &sPath ) | |||
279 | 286 | ||
280 | Bu::MyriadFs::Dir Bu::MyriadFs::readDir( const Bu::String &sPath ) | 287 | Bu::MyriadFs::Dir Bu::MyriadFs::readDir( const Bu::String &sPath ) |
281 | { | 288 | { |
289 | Bu::MutexLocker lLock( mAccess ); | ||
282 | int32_t iParent = -1; | 290 | int32_t iParent = -1; |
283 | int32_t iNode = lookupInode( sPath, iParent ); | 291 | int32_t iNode = lookupInode( sPath, iParent ); |
284 | return readDir( iNode ); | 292 | return readDir( iNode ); |
@@ -287,6 +295,7 @@ Bu::MyriadFs::Dir Bu::MyriadFs::readDir( const Bu::String &sPath ) | |||
287 | void Bu::MyriadFs::setTimes( const Bu::String &sPath, int64_t iATime, | 295 | void Bu::MyriadFs::setTimes( const Bu::String &sPath, int64_t iATime, |
288 | int64_t iMTime ) | 296 | int64_t iMTime ) |
289 | { | 297 | { |
298 | Bu::MutexLocker lLock( mAccess ); | ||
290 | int32_t iParent = -1; | 299 | int32_t iParent = -1; |
291 | int32_t iNode; | 300 | int32_t iNode; |
292 | 301 | ||
@@ -297,6 +306,7 @@ void Bu::MyriadFs::setTimes( const Bu::String &sPath, int64_t iATime, | |||
297 | 306 | ||
298 | void Bu::MyriadFs::unlink( const Bu::String &sPath ) | 307 | void Bu::MyriadFs::unlink( const Bu::String &sPath ) |
299 | { | 308 | { |
309 | Bu::MutexLocker lLock( mAccess ); | ||
300 | int32_t iParent = -1; | 310 | int32_t iParent = -1; |
301 | // int32_t iNode; | 311 | // int32_t iNode; |
302 | 312 | ||
@@ -352,6 +362,7 @@ void Bu::MyriadFs::unlink( const Bu::String &sPath ) | |||
352 | 362 | ||
353 | void Bu::MyriadFs::setFileSize( const Bu::String &sPath, int32_t iSize ) | 363 | void Bu::MyriadFs::setFileSize( const Bu::String &sPath, int32_t iSize ) |
354 | { | 364 | { |
365 | Bu::MutexLocker lLock( mAccess ); | ||
355 | int32_t iParent = -1; | 366 | int32_t iParent = -1; |
356 | int32_t iNode; | 367 | int32_t iNode; |
357 | iNode = lookupInode( sPath, iParent ); | 368 | iNode = lookupInode( sPath, iParent ); |
@@ -361,6 +372,7 @@ void Bu::MyriadFs::setFileSize( const Bu::String &sPath, int32_t iSize ) | |||
361 | 372 | ||
362 | void Bu::MyriadFs::rename( const Bu::String &sFrom, const Bu::String &sTo ) | 373 | void Bu::MyriadFs::rename( const Bu::String &sFrom, const Bu::String &sTo ) |
363 | { | 374 | { |
375 | Bu::MutexLocker lLock( mAccess ); | ||
364 | mkHardLink( sFrom, sTo ); | 376 | mkHardLink( sFrom, sTo ); |
365 | unlink( sFrom ); | 377 | unlink( sFrom ); |
366 | } | 378 | } |
@@ -572,27 +584,17 @@ int32_t Bu::MyriadFs::allocInode( uint16_t uPerms, uint32_t uSpecial ) | |||
572 | { | 584 | { |
573 | case typeRegFile: | 585 | case typeRegFile: |
574 | case typeSymLink: | 586 | case typeSymLink: |
575 | { | 587 | rs.uStreamIndex = mStore.allocate(); |
576 | Bu::MyriadStream ms = mStore.create( | ||
577 | Bu::Myriad::Create | ||
578 | ); | ||
579 | rs.uStreamIndex = ms.getId(); | ||
580 | } | ||
581 | break; | 588 | break; |
582 | 589 | ||
583 | case typeDir: | 590 | case typeDir: |
584 | { | ||
585 | Bu::MyriadStream ms = mStore.create( | ||
586 | Bu::Myriad::Create | ||
587 | ); | ||
588 | rs.uStreamIndex = ms.getId(); | ||
589 | } | ||
590 | // sio << "Creating directory node, storage: " | 591 | // sio << "Creating directory node, storage: " |
591 | // << rs.uStreamIndex << sio.nl; | 592 | // << rs.uStreamIndex << sio.nl; |
592 | { | 593 | { |
593 | Bu::MyriadStream msDir = mStore.open( | 594 | Bu::MyriadStream msDir = mStore.create( |
594 | rs.uStreamIndex, Bu::Myriad::Write | 595 | Bu::Myriad::Write |
595 | ); | 596 | ); |
597 | rs.uStreamIndex = msDir.getId(); | ||
596 | uint32_t uSize = 0; | 598 | uint32_t uSize = 0; |
597 | msDir.write( &uSize, 4 ); | 599 | msDir.write( &uSize, 4 ); |
598 | } | 600 | } |
diff --git a/src/unstable/myriadfs.h b/src/unstable/myriadfs.h index ff14292..e3008bc 100644 --- a/src/unstable/myriadfs.h +++ b/src/unstable/myriadfs.h | |||
@@ -11,7 +11,7 @@ | |||
11 | #include <sys/types.h> | 11 | #include <sys/types.h> |
12 | 12 | ||
13 | #include "bu/myriad.h" | 13 | #include "bu/myriad.h" |
14 | #include "bu/readwritemutex.h" | 14 | #include "bu/debugmutex.h" |
15 | 15 | ||
16 | namespace Bu | 16 | namespace Bu |
17 | { | 17 | { |
@@ -108,7 +108,7 @@ namespace Bu | |||
108 | Truncate = 0x08, ///< Truncate file if it does exist | 108 | Truncate = 0x08, ///< Truncate file if it does exist |
109 | Append = 0x10, ///< Always append on every write | 109 | Append = 0x10, ///< Always append on every write |
110 | NonBlock = 0x20, ///< Open file in non-blocking mode | 110 | NonBlock = 0x20, ///< Open file in non-blocking mode |
111 | Exclusive = 0x44, ///< Create file, if it exists then fail | 111 | Exclusive = 0x40, ///< Create file, if it exists then fail |
112 | 112 | ||
113 | // Helpful mixes | 113 | // Helpful mixes |
114 | ReadWrite = 0x03, ///< Open for reading and writing | 114 | ReadWrite = 0x03, ///< Open for reading and writing |
@@ -172,7 +172,13 @@ namespace Bu | |||
172 | typedef Bu::Hash<int32_t, int32_t> NodeIndex; | 172 | typedef Bu::Hash<int32_t, int32_t> NodeIndex; |
173 | 173 | ||
174 | private: | 174 | private: |
175 | /** | ||
176 | * Lookup inode. | ||
177 | */ | ||
175 | int32_t lookupInode( const Bu::String &sPath, int32_t &iParent ); | 178 | int32_t lookupInode( const Bu::String &sPath, int32_t &iParent ); |
179 | /** | ||
180 | * Lookup inode. | ||
181 | */ | ||
176 | int32_t lookupInode( Bu::String::const_iterator iStart, | 182 | int32_t lookupInode( Bu::String::const_iterator iStart, |
177 | int32_t iNode, int32_t &iParent ); | 183 | int32_t iNode, int32_t &iParent ); |
178 | void readInode( int32_t iNode, RawStat &rs, MyriadStream &rIs ); | 184 | void readInode( int32_t iNode, RawStat &rs, MyriadStream &rIs ); |
@@ -190,12 +196,12 @@ namespace Bu | |||
190 | void setTimes( int32_t iNode, int64_t iATime, int64_t iMTime ); | 196 | void setTimes( int32_t iNode, int64_t iATime, int64_t iMTime ); |
191 | void destroyNode( int32_t iNode ); | 197 | void destroyNode( int32_t iNode ); |
192 | 198 | ||
193 | Bu::String filePart( const Bu::String &sPath ); | 199 | static Bu::String filePart( const Bu::String &sPath ); |
194 | 200 | ||
195 | private: | 201 | private: |
196 | Bu::Stream &rStore; | 202 | Bu::Stream &rStore; |
197 | Bu::Myriad mStore; | 203 | Bu::Myriad mStore; |
198 | Bu::ReadWriteMutex mNodeIndex; | 204 | Bu::DebugMutex mAccess; |
199 | NodeIndex hNodeIndex; | 205 | NodeIndex hNodeIndex; |
200 | int32_t iUser; | 206 | int32_t iUser; |
201 | int32_t iGroup; | 207 | int32_t iGroup; |