*** empty log message ***
[m17n/m17n-docs.git] / doxyfile
1 # Doxyfile 1.3.7
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18 # by quotes) that should identify the project.
19
20 PROJECT_NAME           = %PROJECT_NAME%
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23 # This could be handy for archiving the generated documentation or 
24 # if some version control system is used.
25
26 PROJECT_NUMBER         = %PROJECT_NUMBER%
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29 # base path where the generated documentation will be put. 
30 # If a relative path is entered, it will be relative to the location 
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY       = %USR_JA_DEV%
34
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
36 # 2 levels of 10 sub-directories under the output directory of each output 
37 # format and will distribute the generated files over these directories. 
38 # Enabling this option can be useful when feeding doxygen a huge amount of source 
39 # files, where putting all generated files in the same directory would otherwise 
40 # cause performance problems for the file system.
41
42 CREATE_SUBDIRS         = NO
43
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
45 # documentation generated by doxygen is written. Doxygen will use this 
46 # information to generate all constant output in the proper language. 
47 # The default language is English, other supported languages are: 
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
49 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
50 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 
51 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
52
53 OUTPUT_LANGUAGE        = %OUTPUT_LANGUAGE%
54
55 # This tag can be used to specify the encoding used in the generated output. 
56 # The encoding is not always determined by the language that is chosen, 
57 # but also whether or not the output is meant for Windows or non-Windows users. 
58 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
59 # forces the Windows encoding (this is the default for the Windows binary), 
60 # whereas setting the tag to NO uses a Unix-style encoding (the default for 
61 # all platforms other than Windows).
62
63 USE_WINDOWS_ENCODING   = NO
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
66 # include brief member descriptions after the members that are listed in 
67 # the file and class documentation (similar to JavaDoc). 
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC      = yes
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
73 # the brief description of a member or function before the detailed description. 
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF           = no
78
79 # This tag implements a quasi-intelligent brief description abbreviator 
80 # that is used to form the text in various listings. Each string 
81 # in this list, if found as the leading text of the brief description, will be 
82 # stripped from the text and the result after processing the whole list, is used 
83 # as the annotated text. Otherwise, the brief description is used as-is. If left 
84 # blank, the following values are used ("$name" is automatically replaced with the 
85 # name of the entity): "The $name class" "The $name widget" "The $name file" 
86 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
87
88 ABBREVIATE_BRIEF       = 
89
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
91 # Doxygen will generate a detailed section even if there is only a brief 
92 # description.
93
94 ALWAYS_DETAILED_SEC    = no
95
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
97 # members of a class in the documentation of that class as if those members were 
98 # ordinary class members. Constructors, destructors and assignment operators of 
99 # the base classes will not be shown.
100
101 INLINE_INHERITED_MEMB  = NO
102
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
104 # path before files name in the file list and in the header files. If set 
105 # to NO the shortest path that makes the file name unique will be used.
106
107 FULL_PATH_NAMES        = NO
108
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
110 # can be used to strip a user-defined part of the path. Stripping is 
111 # only done if one of the specified strings matches the left-hand part of 
112 # the path. The tag can be used to show relative paths in the file list. 
113 # If left blank the directory from which doxygen is run is used as the 
114 # path to strip.
115
116 STRIP_FROM_PATH        = 
117
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
119 # the path mentioned in the documentation of a class, which tells 
120 # the reader which header file to include in order to use a class. 
121 # If left blank only the name of the header file containing the class 
122 # definition is used. Otherwise one should specify the include paths that 
123 # are normally passed to the compiler using the -I flag.
124
125 STRIP_FROM_INC_PATH    = 
126
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
128 # (but less readable) file names. This can be useful is your file systems 
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
130
131 SHORT_NAMES            = NO
132
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
134 # will interpret the first line (until the first dot) of a JavaDoc-style 
135 # comment as the brief description. If set to NO, the JavaDoc 
136 # comments will behave just like the Qt-style comments (thus requiring an 
137 # explicit @brief command for a brief description.
138
139 JAVADOC_AUTOBRIEF      = NO
140
141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
142 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
143 # comments) as a brief description. This used to be the default behaviour. 
144 # The new default is to treat a multi-line C++ comment block as a detailed 
145 # description. Set this tag to YES if you prefer the old behaviour instead.
146
147 MULTILINE_CPP_IS_BRIEF = NO
148
149 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
150 # will output the detailed description near the top, like JavaDoc.
151 # If set to NO, the detailed description appears after the member 
152 # documentation.
153
154 DETAILS_AT_TOP         = NO
155
156 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
157 # member inherits the documentation from any documented member that it 
158 # re-implements.
159
160 INHERIT_DOCS           = YES
161
162 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
163 # tag is set to YES, then doxygen will reuse the documentation of the first 
164 # member in the group (if any) for the other members of the group. By default 
165 # all members of a group must be documented explicitly.
166
167 DISTRIBUTE_GROUP_DOC   = yes
168
169 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
170 # Doxygen uses this value to replace tabs by spaces in code fragments.
171
172 TAB_SIZE               = 8
173
174 # This tag can be used to specify a number of aliases that acts 
175 # as commands in the documentation. An alias has the form "name=value". 
176 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
177 # put the command \sideeffect (or @sideeffect) in the documentation, which 
178 # will result in a user-defined paragraph with heading "Side Effects:". 
179 # You can put \n's in the value part of an alias to insert newlines.
180
181 ALIASES                = 
182
183 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
184 # only. Doxygen will then generate output that is more tailored for C. 
185 # For instance, some of the names that are used will be different. The list 
186 # of all members will be omitted, etc.
187
188 OPTIMIZE_OUTPUT_FOR_C  = yes
189
190 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
191 # only. Doxygen will then generate output that is more tailored for Java. 
192 # For instance, namespaces will be presented as packages, qualified scopes 
193 # will look different, etc.
194
195 OPTIMIZE_OUTPUT_JAVA   = NO
196
197 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
198 # the same type (for instance a group of public functions) to be put as a 
199 # subgroup of that type (e.g. under the Public Functions section). Set it to 
200 # NO to prevent subgrouping. Alternatively, this can be done per class using 
201 # the \nosubgrouping command.
202
203 SUBGROUPING            = YES
204
205 #---------------------------------------------------------------------------
206 # Build related configuration options
207 #---------------------------------------------------------------------------
208
209 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
210 # documentation are documented, even if no documentation was available. 
211 # Private class members and static file members will be hidden unless 
212 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
213
214 EXTRACT_ALL            = yes
215
216 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
217 # will be included in the documentation.
218
219 EXTRACT_PRIVATE        = no
220
221 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
222 # will be included in the documentation.
223
224 EXTRACT_STATIC         = no
225
226 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
227 # defined locally in source files will be included in the documentation. 
228 # If set to NO only classes defined in header files are included.
229
230 EXTRACT_LOCAL_CLASSES  = YES
231
232 # This flag is only useful for Objective-C code. When set to YES local 
233 # methods, which are defined in the implementation section but not in 
234 # the interface are included in the documentation. 
235 # If set to NO (the default) only methods in the interface are included.
236
237 EXTRACT_LOCAL_METHODS  = NO
238
239 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
240 # undocumented members of documented classes, files or namespaces. 
241 # If set to NO (the default) these members will be included in the 
242 # various overviews, but no documentation section is generated. 
243 # This option has no effect if EXTRACT_ALL is enabled.
244
245 HIDE_UNDOC_MEMBERS     = yes
246
247 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
248 # undocumented classes that are normally visible in the class hierarchy. 
249 # If set to NO (the default) these classes will be included in the various 
250 # overviews. This option has no effect if EXTRACT_ALL is enabled.
251
252 HIDE_UNDOC_CLASSES     = NO
253
254 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
255 # friend (class|struct|union) declarations. 
256 # If set to NO (the default) these declarations will be included in the 
257 # documentation.
258
259 HIDE_FRIEND_COMPOUNDS  = NO
260
261 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
262 # documentation blocks found inside the body of a function. 
263 # If set to NO (the default) these blocks will be appended to the 
264 # function's detailed documentation block.
265
266 HIDE_IN_BODY_DOCS      = NO
267
268 # The INTERNAL_DOCS tag determines if documentation 
269 # that is typed after a \internal command is included. If the tag is set 
270 # to NO (the default) then the documentation will be excluded. 
271 # Set it to YES to include the internal documentation.
272
273 INTERNAL_DOCS          = no
274
275 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
276 # file names in lower-case letters. If set to YES upper-case letters are also 
277 # allowed. This is useful if you have classes or files whose names only differ 
278 # in case and if your file system supports case sensitive file names. Windows 
279 # users are advised to set this option to NO.
280
281 CASE_SENSE_NAMES       = YES
282
283 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
284 # will show members with their full class and namespace scopes in the 
285 # documentation. If set to YES the scope will be hidden.
286
287 HIDE_SCOPE_NAMES       = NO
288
289 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
290 # will put a list of the files that are included by a file in the documentation 
291 # of that file.
292
293 SHOW_INCLUDE_FILES     = no
294
295 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
296 # is inserted in the documentation for inline members.
297
298 INLINE_INFO            = YES
299
300 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
301 # will sort the (detailed) documentation of file and class members 
302 # alphabetically by member name. If set to NO the members will appear in 
303 # declaration order.
304
305 SORT_MEMBER_DOCS       = no
306
307 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
308 # brief documentation of file, namespace and class members alphabetically 
309 # by member name. If set to NO (the default) the members will appear in 
310 # declaration order.
311
312 SORT_BRIEF_DOCS        = NO
313
314 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
315 # sorted by fully-qualified names, including namespaces. If set to 
316 # NO (the default), the class list will be sorted only by class name, 
317 # not including the namespace part. 
318 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
319 # Note: This option applies only to the class list, not to the 
320 # alphabetical list.
321
322 SORT_BY_SCOPE_NAME     = NO
323
324 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
325 # disable (NO) the todo list. This list is created by putting \todo 
326 # commands in the documentation.
327
328 GENERATE_TODOLIST      = YES
329
330 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
331 # disable (NO) the test list. This list is created by putting \test 
332 # commands in the documentation.
333
334 GENERATE_TESTLIST      = YES
335
336 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
337 # disable (NO) the bug list. This list is created by putting \bug 
338 # commands in the documentation.
339
340 GENERATE_BUGLIST       = YES
341
342 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
343 # disable (NO) the deprecated list. This list is created by putting 
344 # \deprecated commands in the documentation.
345
346 GENERATE_DEPRECATEDLIST= YES
347
348 # The ENABLED_SECTIONS tag can be used to enable conditional 
349 # documentation sections, marked by \if sectionname ... \endif.
350
351 ENABLED_SECTIONS       = %ENABLED_SECTIONS%
352
353 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
354 # the initial value of a variable or define consists of for it to appear in 
355 # the documentation. If the initializer consists of more lines than specified 
356 # here it will be hidden. Use a value of 0 to hide initializers completely. 
357 # The appearance of the initializer of individual variables and defines in the 
358 # documentation can be controlled using \showinitializer or \hideinitializer 
359 # command in the documentation regardless of this setting.
360
361 MAX_INITIALIZER_LINES  = 30
362
363 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
364 # at the bottom of the documentation of classes and structs. If set to YES the 
365 # list will mention the files that were used to generate the documentation.
366
367 SHOW_USED_FILES        = no
368
369 #---------------------------------------------------------------------------
370 # configuration options related to warning and progress messages
371 #---------------------------------------------------------------------------
372
373 # The QUIET tag can be used to turn on/off the messages that are generated 
374 # by doxygen. Possible values are YES and NO. If left blank NO is used.
375
376 QUIET                  = NO
377
378 # The WARNINGS tag can be used to turn on/off the warning messages that are 
379 # generated by doxygen. Possible values are YES and NO. If left blank 
380 # NO is used.
381
382 WARNINGS               = YES
383
384 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
385 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
386 # automatically be disabled.
387
388 WARN_IF_UNDOCUMENTED   = YES
389
390 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
391 # potential errors in the documentation, such as not documenting some 
392 # parameters in a documented function, or documenting parameters that 
393 # don't exist or using markup commands wrongly.
394
395 WARN_IF_DOC_ERROR      = YES
396
397 # The WARN_FORMAT tag determines the format of the warning messages that 
398 # doxygen can produce. The string should contain the $file, $line, and $text 
399 # tags, which will be replaced by the file and line number from which the 
400 # warning originated and the warning text.
401
402 WARN_FORMAT            = "$text in $file line $line"
403
404 # The WARN_LOGFILE tag can be used to specify a file to which warning 
405 # and error messages should be written. If left blank the output is written 
406 # to stderr.
407
408 WARN_LOGFILE           = warning
409
410 #---------------------------------------------------------------------------
411 # configuration options related to the input files
412 #---------------------------------------------------------------------------
413
414 # The INPUT tag can be used to specify the files and/or directories that contain 
415 # documented source files. You may enter file names like "myfile.cpp" or 
416 # directories like "/usr/src/myproject". Separate the files or directories 
417 # with spaces.
418
419 INPUT                  = %INPUT%
420
421 # If the value of the INPUT tag contains directories, you can use the 
422 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
423 # and *.h) to filter out the source-files in the directories. If left 
424 # blank the following patterns are tested: 
425 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
426 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
427
428 FILE_PATTERNS          = *.c \
429                          *.txt
430
431 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
432 # should be searched for input files as well. Possible values are YES and NO. 
433 # If left blank NO is used.
434
435 RECURSIVE              = NO
436
437 # The EXCLUDE tag can be used to specify files and/or directories that should 
438 # excluded from the INPUT source files. This way you can easily exclude a 
439 # subdirectory from a directory tree whose root is specified with the INPUT tag.
440
441 EXCLUDE                = 
442
443 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
444 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
445
446 EXCLUDE_SYMLINKS       = NO
447
448 # If the value of the INPUT tag contains directories, you can use the 
449 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
450 # certain files from those directories.
451
452 EXCLUDE_PATTERNS       = font-flt.c \
453                          font-ft.c \
454                          link*.c
455
456 # The EXAMPLE_PATH tag can be used to specify one or more files or 
457 # directories that contain example code fragments that are included (see 
458 # the \include command).
459
460 EXAMPLE_PATH           = data-%USR_JA_DEV%
461
462 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
463 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
464 # and *.h) to filter out the source-files in the directories. If left 
465 # blank all files are included.
466
467 EXAMPLE_PATTERNS       = 
468
469 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
470 # searched for input files to be used with the \include or \dontinclude 
471 # commands irrespective of the value of the RECURSIVE tag. 
472 # Possible values are YES and NO. If left blank NO is used.
473
474 EXAMPLE_RECURSIVE      = NO
475
476 # The IMAGE_PATH tag can be used to specify one or more files or 
477 # directories that contain image that are included in the documentation (see 
478 # the \image command).
479
480 IMAGE_PATH             = images
481
482 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
483 # invoke to filter for each input file. Doxygen will invoke the filter program 
484 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
485 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
486 # input file. Doxygen will then use the output that the filter program writes 
487 # to standard output.
488
489 INPUT_FILTER           = utils/%USR_JA_DEV%_filter.rb
490
491 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
492 # INPUT_FILTER) will be used to filter the input files when producing source 
493 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
494
495 FILTER_SOURCE_FILES    = NO
496
497 #---------------------------------------------------------------------------
498 # configuration options related to source browsing
499 #---------------------------------------------------------------------------
500
501 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
502 # be generated. Documented entities will be cross-referenced with these sources. 
503 # Note: To get rid of all source code in the generated output, make sure also 
504 # VERBATIM_HEADERS is set to NO.
505
506 SOURCE_BROWSER         = no
507
508 # Setting the INLINE_SOURCES tag to YES will include the body 
509 # of functions and classes directly in the documentation.
510
511 INLINE_SOURCES         = no
512
513 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
514 # doxygen to hide any special comment blocks from generated source code 
515 # fragments. Normal C and C++ comments will always remain visible.
516
517 STRIP_CODE_COMMENTS    = YES
518
519 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
520 # then for each documented function all documented 
521 # functions referencing it will be listed.
522
523 REFERENCED_BY_RELATION = YES
524
525 # If the REFERENCES_RELATION tag is set to YES (the default) 
526 # then for each documented function all documented entities 
527 # called/used by that function will be listed.
528
529 REFERENCES_RELATION    = YES
530
531 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
532 # will generate a verbatim copy of the header file for each class for 
533 # which an include is specified. Set to NO to disable this.
534
535 VERBATIM_HEADERS       = no
536
537 #---------------------------------------------------------------------------
538 # configuration options related to the alphabetical class index
539 #---------------------------------------------------------------------------
540
541 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
542 # of all compounds will be generated. Enable this if the project 
543 # contains a lot of classes, structs, unions or interfaces.
544
545 ALPHABETICAL_INDEX     = yes
546
547 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
548 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
549 # in which this list will be split (can be a number in the range [1..20])
550
551 COLS_IN_ALPHA_INDEX    = 5
552
553 # In case all classes in a project start with a common prefix, all 
554 # classes will be put under the same header in the alphabetical index. 
555 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
556 # should be ignored while generating the index headers.
557
558 IGNORE_PREFIX          = m \
559                          M
560
561 #---------------------------------------------------------------------------
562 # configuration options related to the HTML output
563 #---------------------------------------------------------------------------
564
565 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
566 # generate HTML output.
567
568 GENERATE_HTML          = %GENERATE_HTML%
569
570 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
571 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
572 # put in front of it. If left blank `html' will be used as the default path.
573
574 HTML_OUTPUT            = 
575
576 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
577 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
578 # doxygen will generate files with .html extension.
579
580 HTML_FILE_EXTENSION    = .html
581
582 # The HTML_HEADER tag can be used to specify a personal HTML header for 
583 # each generated HTML page. If it is left blank doxygen will generate a 
584 # standard header.
585
586 HTML_HEADER            = header.%USR_JA_DEV%.html
587
588 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
589 # each generated HTML page. If it is left blank doxygen will generate a 
590 # standard footer.
591
592 HTML_FOOTER            = footer.%USR_JA_DEV%.html
593
594 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
595 # style sheet that is used by each HTML page. It can be used to 
596 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
597 # will generate a default style sheet. Note that doxygen will try to copy 
598 # the style sheet file to the HTML output directory, so don't put your own 
599 # stylesheet in the HTML output directory as well, or it will be erased!
600
601 HTML_STYLESHEET        = 
602
603 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
604 # files or namespaces will be aligned in HTML using tables. If set to 
605 # NO a bullet list will be used.
606
607 HTML_ALIGN_MEMBERS     = yes
608
609 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
610 # will be generated that can be used as input for tools like the 
611 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
612 # of the generated HTML documentation.
613
614 GENERATE_HTMLHELP      = NO
615
616 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
617 # be used to specify the file name of the resulting .chm file. You 
618 # can add a path in front of the file if the result should not be 
619 # written to the html output directory.
620
621 CHM_FILE               = 
622
623 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
624 # be used to specify the location (absolute path including file name) of 
625 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
626 # the HTML help compiler on the generated index.hhp.
627
628 HHC_LOCATION           = 
629
630 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
631 # controls if a separate .chi index file is generated (YES) or that 
632 # it should be included in the master .chm file (NO).
633
634 GENERATE_CHI           = NO
635
636 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
637 # controls whether a binary table of contents is generated (YES) or a 
638 # normal table of contents (NO) in the .chm file.
639
640 BINARY_TOC             = NO
641
642 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
643 # to the contents of the HTML help documentation and to the tree view.
644
645 TOC_EXPAND             = yes
646
647 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
648 # top of each HTML page. The value NO (the default) enables the index and 
649 # the value YES disables it.
650
651 DISABLE_INDEX          = yes
652
653 # This tag can be used to set the number of enum values (range [1..20]) 
654 # that doxygen will group on one line in the generated HTML documentation.
655
656 ENUM_VALUES_PER_LINE   = 1
657
658 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
659 # generated containing a tree-like index structure (just like the one that 
660 # is generated for HTML Help). For this to work a browser that supports 
661 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
662 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
663 # probably better off using the HTML help feature.
664
665 GENERATE_TREEVIEW      = no
666
667 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
668 # used to set the initial width (in pixels) of the frame in which the tree 
669 # is shown.
670
671 TREEVIEW_WIDTH         = 220
672
673 #---------------------------------------------------------------------------
674 # configuration options related to the LaTeX output
675 #---------------------------------------------------------------------------
676
677 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
678 # generate Latex output.
679
680 GENERATE_LATEX         = %GENERATE_LATEX%
681
682 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
683 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
684 # put in front of it. If left blank `latex' will be used as the default path.
685
686 LATEX_OUTPUT           = 
687
688 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
689 # invoked. If left blank `latex' will be used as the default command name.
690
691 LATEX_CMD_NAME         = latex
692
693 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
694 # generate index for LaTeX. If left blank `makeindex' will be used as the 
695 # default command name.
696
697 MAKEINDEX_CMD_NAME     = makeindex
698
699 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
700 # LaTeX documents. This may be useful for small projects and may help to 
701 # save some trees in general.
702
703 COMPACT_LATEX          = no
704
705 # The PAPER_TYPE tag can be used to set the paper type that is used 
706 # by the printer. Possible values are: a4, a4wide, letter, legal and 
707 # executive. If left blank a4wide will be used.
708
709 PAPER_TYPE             = a4wide
710
711 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
712 # packages that should be included in the LaTeX output.
713
714 EXTRA_PACKAGES         = m17n-lib \
715                          times
716
717 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
718 # the generated latex document. The header should contain everything until 
719 # the first chapter. If it is left blank doxygen will generate a 
720 # standard header. Notice: only use this tag if you know what you are doing!
721
722 LATEX_HEADER           = 
723
724 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
725 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
726 # contain links (just like the HTML output) instead of page references 
727 # This makes the output suitable for online browsing using a pdf viewer.
728
729 PDF_HYPERLINKS         = no
730
731 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
732 # plain latex in the generated Makefile. Set this option to YES to get a 
733 # higher quality PDF documentation.
734
735 USE_PDFLATEX           = NO
736
737 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
738 # command to the generated LaTeX files. This will instruct LaTeX to keep 
739 # running if errors occur, instead of asking the user for help. 
740 # This option is also used when generating formulas in HTML.
741
742 LATEX_BATCHMODE        = NO
743
744 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
745 # include the index chapters (such as File Index, Compound Index, etc.) 
746 # in the output.
747
748 LATEX_HIDE_INDICES     = NO
749
750 #---------------------------------------------------------------------------
751 # configuration options related to the RTF output
752 #---------------------------------------------------------------------------
753
754 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
755 # The RTF output is optimized for Word 97 and may not look very pretty with 
756 # other RTF readers or editors.
757
758 GENERATE_RTF           = no
759
760 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
761 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
762 # put in front of it. If left blank `rtf' will be used as the default path.
763
764 RTF_OUTPUT             = 
765
766 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
767 # RTF documents. This may be useful for small projects and may help to 
768 # save some trees in general.
769
770 COMPACT_RTF            = NO
771
772 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
773 # will contain hyperlink fields. The RTF file will 
774 # contain links (just like the HTML output) instead of page references. 
775 # This makes the output suitable for online browsing using WORD or other 
776 # programs which support those fields. 
777 # Note: wordpad (write) and others do not support links.
778
779 RTF_HYPERLINKS         = NO
780
781 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
782 # config file, i.e. a series of assignments. You only have to provide 
783 # replacements, missing definitions are set to their default value.
784
785 RTF_STYLESHEET_FILE    = 
786
787 # Set optional variables used in the generation of an rtf document. 
788 # Syntax is similar to doxygen's config file.
789
790 RTF_EXTENSIONS_FILE    = 
791
792 #---------------------------------------------------------------------------
793 # configuration options related to the man page output
794 #---------------------------------------------------------------------------
795
796 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
797 # generate man pages
798
799 GENERATE_MAN           = %GENERATE_MAN%
800
801 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
802 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
803 # put in front of it. If left blank `man' will be used as the default path.
804
805 MAN_OUTPUT             = 
806
807 # The MAN_EXTENSION tag determines the extension that is added to 
808 # the generated man pages (default is the subroutine's section .3)
809
810 MAN_EXTENSION          = %MAN_EXTENSION%
811
812 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
813 # then it will generate one additional man file for each entity 
814 # documented in the real man page(s). These additional files 
815 # only source the real man page, but without them the man command 
816 # would be unable to find the correct page. The default is NO.
817
818 MAN_LINKS              = NO
819
820 #---------------------------------------------------------------------------
821 # configuration options related to the XML output
822 #---------------------------------------------------------------------------
823
824 # If the GENERATE_XML tag is set to YES Doxygen will 
825 # generate an XML file that captures the structure of 
826 # the code including all documentation.
827
828 GENERATE_XML           = no
829
830 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
831 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
832 # put in front of it. If left blank `xml' will be used as the default path.
833
834 XML_OUTPUT             = xml
835
836 # The XML_SCHEMA tag can be used to specify an XML schema, 
837 # which can be used by a validating XML parser to check the 
838 # syntax of the XML files.
839
840 XML_SCHEMA             = 
841
842 # The XML_DTD tag can be used to specify an XML DTD, 
843 # which can be used by a validating XML parser to check the 
844 # syntax of the XML files.
845
846 XML_DTD                = 
847
848 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
849 # dump the program listings (including syntax highlighting 
850 # and cross-referencing information) to the XML output. Note that 
851 # enabling this will significantly increase the size of the XML output.
852
853 XML_PROGRAMLISTING     = YES
854
855 #---------------------------------------------------------------------------
856 # configuration options for the AutoGen Definitions output
857 #---------------------------------------------------------------------------
858
859 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
860 # generate an AutoGen Definitions (see autogen.sf.net) file 
861 # that captures the structure of the code including all 
862 # documentation. Note that this feature is still experimental 
863 # and incomplete at the moment.
864
865 GENERATE_AUTOGEN_DEF   = NO
866
867 #---------------------------------------------------------------------------
868 # configuration options related to the Perl module output
869 #---------------------------------------------------------------------------
870
871 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
872 # generate a Perl module file that captures the structure of 
873 # the code including all documentation. Note that this 
874 # feature is still experimental and incomplete at the 
875 # moment.
876
877 GENERATE_PERLMOD       = NO
878
879 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
880 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
881 # to generate PDF and DVI output from the Perl module output.
882
883 PERLMOD_LATEX          = NO
884
885 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
886 # nicely formatted so it can be parsed by a human reader.  This is useful 
887 # if you want to understand what is going on.  On the other hand, if this 
888 # tag is set to NO the size of the Perl module output will be much smaller 
889 # and Perl will parse it just the same.
890
891 PERLMOD_PRETTY         = YES
892
893 # The names of the make variables in the generated doxyrules.make file 
894 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
895 # This is useful so different doxyrules.make files included by the same 
896 # Makefile don't overwrite each other's variables.
897
898 PERLMOD_MAKEVAR_PREFIX = 
899
900 #---------------------------------------------------------------------------
901 # Configuration options related to the preprocessor   
902 #---------------------------------------------------------------------------
903
904 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
905 # evaluate all C-preprocessor directives found in the sources and include 
906 # files.
907
908 ENABLE_PREPROCESSING   = YES
909
910 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
911 # names in the source code. If set to NO (the default) only conditional 
912 # compilation will be performed. Macro expansion can be done in a controlled 
913 # way by setting EXPAND_ONLY_PREDEF to YES.
914
915 MACRO_EXPANSION        = NO
916
917 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
918 # then the macro expansion is limited to the macros specified with the 
919 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
920
921 EXPAND_ONLY_PREDEF     = YES
922
923 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
924 # in the INCLUDE_PATH (see below) will be search if a #include is found.
925
926 SEARCH_INCLUDES        = YES
927
928 # The INCLUDE_PATH tag can be used to specify one or more directories that 
929 # contain include files that are not input files but should be processed by 
930 # the preprocessor.
931
932 INCLUDE_PATH           = 
933
934 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
935 # patterns (like *.h and *.hpp) to filter out the header-files in the 
936 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
937 # be used.
938
939 INCLUDE_FILE_PATTERNS  = 
940
941 # The PREDEFINED tag can be used to specify one or more macro names that 
942 # are defined before the preprocessor is started (similar to the -D option of 
943 # gcc). The argument of the tag is a list of macros of the form: name 
944 # or name=definition (no spaces). If the definition and the = are 
945 # omitted =1 is assumed.
946
947 PREDEFINED             = FOR_DOXYGEN
948
949 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
950 # this tag can be used to specify a list of macro names that should be expanded. 
951 # The macro definition that is found in the sources will be used. 
952 # Use the PREDEFINED tag if you want to use a different macro definition.
953
954 EXPAND_AS_DEFINED      = 
955
956 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
957 # doxygen's preprocessor will remove all function-like macros that are alone 
958 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
959 # function macros are typically used for boiler-plate code, and will confuse the 
960 # parser if not removed.
961
962 SKIP_FUNCTION_MACROS   = YES
963
964 #---------------------------------------------------------------------------
965 # Configuration::additions related to external references   
966 #---------------------------------------------------------------------------
967
968 # The TAGFILES option can be used to specify one or more tagfiles. 
969 # Optionally an initial location of the external documentation 
970 # can be added for each tagfile. The format of a tag file without 
971 # this location is as follows: 
972 #   TAGFILES = file1 file2 ... 
973 # Adding location for the tag files is done as follows: 
974 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
975 # where "loc1" and "loc2" can be relative or absolute paths or 
976 # URLs. If a location is present for each tag, the installdox tool 
977 # does not have to be run to correct the links.
978 # Note that each tag file must have a unique name
979 # (where the name does NOT include the path)
980 # If a tag file is not located in the directory in which doxygen 
981 # is run, you must also specify the path to the tagfile here.
982
983 TAGFILES               = 
984
985 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
986 # a tag file that is based on the input files it reads.
987
988 GENERATE_TAGFILE       = m17n.tag
989
990 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
991 # in the class index. If set to NO only the inherited external classes 
992 # will be listed.
993
994 ALLEXTERNALS           = NO
995
996 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
997 # in the modules index. If set to NO, only the current project's groups will 
998 # be listed.
999
1000 EXTERNAL_GROUPS        = YES
1001
1002 # The PERL_PATH should be the absolute path and name of the perl script 
1003 # interpreter (i.e. the result of `which perl').
1004
1005 PERL_PATH              = 
1006
1007 #---------------------------------------------------------------------------
1008 # Configuration options related to the dot tool   
1009 #---------------------------------------------------------------------------
1010
1011 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1012 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
1013 # super classes. Setting the tag to NO turns the diagrams off. Note that this 
1014 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is 
1015 # recommended to install and use dot, since it yields more powerful graphs.
1016
1017 CLASS_DIAGRAMS         = YES
1018
1019 # If set to YES, the inheritance and collaboration graphs will hide 
1020 # inheritance and usage relations if the target is undocumented 
1021 # or is not a class.
1022
1023 HIDE_UNDOC_RELATIONS   = YES
1024
1025 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1026 # available from the path. This tool is part of Graphviz, a graph visualization 
1027 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1028 # have no effect if this option is set to NO (the default)
1029
1030 HAVE_DOT               = NO
1031
1032 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1033 # will generate a graph for each documented class showing the direct and 
1034 # indirect inheritance relations. Setting this tag to YES will force the 
1035 # the CLASS_DIAGRAMS tag to NO.
1036
1037 CLASS_GRAPH            = YES
1038
1039 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1040 # will generate a graph for each documented class showing the direct and 
1041 # indirect implementation dependencies (inheritance, containment, and 
1042 # class references variables) of the class with other documented classes.
1043
1044 COLLABORATION_GRAPH    = YES
1045
1046 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1047 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1048 # Language.
1049
1050 UML_LOOK               = NO
1051
1052 # If set to YES, the inheritance and collaboration graphs will show the 
1053 # relations between templates and their instances.
1054
1055 TEMPLATE_RELATIONS     = NO
1056
1057 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1058 # tags are set to YES then doxygen will generate a graph for each documented 
1059 # file showing the direct and indirect include dependencies of the file with 
1060 # other documented files.
1061
1062 INCLUDE_GRAPH          = YES
1063
1064 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1065 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1066 # documented header file showing the documented files that directly or 
1067 # indirectly include this file.
1068
1069 INCLUDED_BY_GRAPH      = YES
1070
1071 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1072 # generate a call dependency graph for every global function or class method. 
1073 # Note that enabling this option will significantly increase the time of a run. 
1074 # So in most cases it will be better to enable call graphs for selected 
1075 # functions only using the \callgraph command.
1076
1077 CALL_GRAPH             = NO
1078
1079 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1080 # will graphical hierarchy of all classes instead of a textual one.
1081
1082 GRAPHICAL_HIERARCHY    = yes
1083
1084 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1085 # generated by dot. Possible values are png, jpg, or gif
1086 # If left blank png will be used.
1087
1088 DOT_IMAGE_FORMAT       = png
1089
1090 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1091 # found. If left blank, it is assumed the dot tool can be found on the path.
1092
1093 DOT_PATH               = 
1094
1095 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1096 # contain dot files that are included in the documentation (see the 
1097 # \dotfile command).
1098
1099 DOTFILE_DIRS           = 
1100
1101 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
1102 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1103 # this value, doxygen will try to truncate the graph, so that it fits within 
1104 # the specified constraint. Beware that most browsers cannot cope with very 
1105 # large images.
1106
1107 MAX_DOT_GRAPH_WIDTH    = 1024
1108
1109 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
1110 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1111 # this value, doxygen will try to truncate the graph, so that it fits within 
1112 # the specified constraint. Beware that most browsers cannot cope with very 
1113 # large images.
1114
1115 MAX_DOT_GRAPH_HEIGHT   = 1024
1116
1117 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1118 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1119 # from the root by following a path via at most 3 edges will be shown. Nodes that 
1120 # lay further from the root node will be omitted. Note that setting this option to 
1121 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
1122 # note that a graph may be further truncated if the graph's image dimensions are 
1123 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
1124 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1125
1126 MAX_DOT_GRAPH_DEPTH    = 0
1127
1128 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1129 # generate a legend page explaining the meaning of the various boxes and 
1130 # arrows in the dot generated graphs.
1131
1132 GENERATE_LEGEND        = YES
1133
1134 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1135 # remove the intermediate dot files that are used to generate 
1136 # the various graphs.
1137
1138 DOT_CLEANUP            = YES
1139
1140 #---------------------------------------------------------------------------
1141 # Configuration::additions related to the search engine   
1142 #---------------------------------------------------------------------------
1143
1144 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1145 # used. If set to NO the values of all tags below this one will be ignored.
1146
1147 SEARCHENGINE           = no