*** empty log message ***
[m17n/m17n-docs.git] / doxyfile
1 # Doxyfile 1.2.9.1              -*- coding: euc-jp; -*-
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 # General 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 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
36 # documentation generated by doxygen is written. Doxygen will use this 
37 # information to generate all constant output in the proper language. 
38 # The default language is English, other supported languages are: 
39 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 
40 # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 
41 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43 OUTPUT_LANGUAGE        = %OUTPUT_LANGUAGE%
44
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
46 # documentation are documented, even if no documentation was available. 
47 # Private class members and static file members will be hidden unless 
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50 EXTRACT_ALL            = yes
51
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
53 # will be included in the documentation.
54
55 EXTRACT_PRIVATE        = no
56
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
58 # will be included in the documentation.
59
60 EXTRACT_STATIC         = no
61
62 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
63 # undocumented members of documented classes, files or namespaces. 
64 # If set to NO (the default) these members will be included in the 
65 # various overviews, but no documentation section is generated. 
66 # This option has no effect if EXTRACT_ALL is enabled.
67
68 HIDE_UNDOC_MEMBERS     = yes
69
70 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
71 # undocumented classes that are normally visible in the class hierarchy. 
72 # If set to NO (the default) these class will be included in the various 
73 # overviews. This option has no effect if EXTRACT_ALL is enabled.
74
75 HIDE_UNDOC_CLASSES     = NO
76
77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
78 # include brief member descriptions after the members that are listed in 
79 # the file and class documentation (similar to JavaDoc). 
80 # Set to NO to disable this.
81
82 BRIEF_MEMBER_DESC      = yes
83
84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
85 # the brief description of a member or function before the detailed description. 
86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
87 # brief descriptions will be completely suppressed.
88
89 REPEAT_BRIEF           = no
90
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
92 # Doxygen will generate a detailed section even if there is only a brief 
93 # description.
94
95 ALWAYS_DETAILED_SEC    = no
96
97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
98 # path before files name in the file list and in the header files. If set 
99 # to NO the shortest path that makes the file name unique will be used.
100
101 FULL_PATH_NAMES        = NO
102
103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
104 # can be used to strip a user defined part of the path. Stripping is 
105 # only done if one of the specified strings matches the left-hand part of 
106 # the path. It is allowed to use relative paths in the argument list.
107
108 STRIP_FROM_PATH        = 
109
110 # The INTERNAL_DOCS tag determines if documentation 
111 # that is typed after a \internal command is included. If the tag is set 
112 # to NO (the default) then the documentation will be excluded. 
113 # Set it to YES to include the internal documentation.
114
115 INTERNAL_DOCS          = no
116
117 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
118 # generate a class diagram (in Html and LaTeX) for classes with base or 
119 # super classes. Setting the tag to NO turns the diagrams off.
120
121 CLASS_DIAGRAMS         = YES
122
123 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
124 # be generated. Documented entities will be cross-referenced with these sources.
125 # with a discussion with Handa, decided to set to NO Jan/8/2002
126
127 SOURCE_BROWSER         = 
128
129 # Setting the INLINE_SOURCES tag to YES will include the body 
130 # of functions and classes directly in the documentation.
131
132 # This should be no 10/Jan
133
134 INLINE_SOURCES         = no
135
136 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
137 # doxygen to hide any special comment blocks from generated source code 
138 # fragments. Normal C and C++ comments will always remain visible.
139
140 STRIP_CODE_COMMENTS    = YES
141
142 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
143 # file names in lower case letters. If set to YES upper case letters are also 
144 # allowed. This is useful if you have classes or files whose names only differ 
145 # in case and if your file system supports case sensitive file names. Windows 
146 # users are adviced to set this option to NO.
147
148 CASE_SENSE_NAMES       = YES
149
150 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
151 # (but less readable) file names. This can be useful is your file systems 
152 # doesn't support long names like on DOS, Mac, or CD-ROM.
153
154 SHORT_NAMES            = NO
155
156 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
157 # will show members with their full class and namespace scopes in the 
158 # documentation. If set to YES the scope will be hidden.
159
160 HIDE_SCOPE_NAMES       = NO
161
162 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
163 # will generate a verbatim copy of the header file for each class for 
164 # which an include is specified. Set to NO to disable this.
165
166 VERBATIM_HEADERS       = yes
167
168 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
169 # will put list of the files that are included by a file in the documentation 
170 # of that file.
171
172 SHOW_INCLUDE_FILES     = yes
173
174 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
175 # will interpret the first line (until the first dot) of a JavaDoc-style 
176 # comment as the brief description. If set to NO, the JavaDoc 
177 # comments  will behave just like the Qt-style comments (thus requiring an 
178 # explict @brief command for a brief description.
179
180 JAVADOC_AUTOBRIEF      = NO
181
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 # reimplements.
185
186 INHERIT_DOCS           = YES
187
188 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
189 # is inserted in the documentation for inline members.
190
191 INLINE_INFO            = YES
192
193 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
194 # will sort the (detailed) documentation of file and class members 
195 # alphabetically by member name. If set to NO the members will appear in 
196 # declaration order.
197 ### # this seems to affect the order of module list. Dec14 Nishikimi
198
199 SORT_MEMBER_DOCS       = no
200
201 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
202 # tag is set to YES, then doxygen will reuse the documentation of the first 
203 # member in the group (if any) for the other members of the group. By default 
204 # all members of a group must be documented explicitly.
205
206 DISTRIBUTE_GROUP_DOC   = no
207
208 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
209 # Doxygen uses this value to replace tabs by spaces in code fragments.
210
211 TAB_SIZE               = 8
212
213 # The ENABLED_SECTIONS tag can be used to enable conditional 
214 # documentation sections, marked by \if sectionname ... \endif.
215
216 ENABLED_SECTIONS       = 
217
218 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
219 # disable (NO) the todo list. This list is created by putting \todo 
220 # commands in the documentation.
221
222 GENERATE_TODOLIST      = YES
223
224 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
225 # disable (NO) the test list. This list is created by putting \test 
226 # commands in the documentation.
227
228 GENERATE_TESTLIST      = YES
229
230 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
231 # disable (NO) the bug list. This list is created by putting \bug 
232 # commands in the documentation.
233
234 GENERATE_BUGLIST       = YES
235
236 # This tag can be used to specify a number of aliases that acts 
237 # as commands in the documentation. An alias has the form "name=value". 
238 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
239 # put the command \sideeffect (or @sideeffect) in the documentation, which 
240 # will result in a user defined paragraph with heading "Side Effects:". 
241 # You can put \n's in the value part of an alias to insert newlines.
242
243 ALIASES                = 
244
245 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
246 # the initial value of a variable or define consist of for it to appear in 
247 # the documentation. If the initializer consists of more lines than specified 
248 # here it will be hidden. Use a value of 0 to hide initializers completely. 
249 # The appearance of the initializer of individual variables and defines in the 
250 # documentation can be controlled using \showinitializer or \hideinitializer 
251 # command in the documentation regardless of this setting.
252
253 MAX_INITIALIZER_LINES  = 30
254
255 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
256 # only. Doxygen will then generate output that is more tailored for C. 
257 # For instance some of the names that are used will be different. The list 
258 # of all members will be omitted, etc.
259
260 OPTIMIZE_OUTPUT_FOR_C  = yes
261
262 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
263 # at the bottom of the documentation of classes and structs. If set to YES the 
264 # list will mention the files that were used to generate the documentation.
265
266 SHOW_USED_FILES        = no
267
268 #---------------------------------------------------------------------------
269 # configuration options related to warning and progress messages
270 #---------------------------------------------------------------------------
271
272 # The QUIET tag can be used to turn on/off the messages that are generated 
273 # by doxygen. Possible values are YES and NO. If left blank NO is used.
274
275 QUIET                  = NO
276
277 # The WARNINGS tag can be used to turn on/off the warning messages that are 
278 # generated by doxygen. Possible values are YES and NO. If left blank 
279 # NO is used.
280
281 WARNINGS               = YES
282
283 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
284 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
285 # automatically be disabled.
286
287 WARN_IF_UNDOCUMENTED   = YES
288
289 # The WARN_FORMAT tag determines the format of the warning messages that 
290 # doxygen can produce. The string should contain the $file, $line, and $text 
291 # tags, which will be replaced by the file and line number from which the 
292 # warning originated and the warning text.
293
294 WARN_FORMAT            = "$text in $file line $line"
295
296 # The WARN_LOGFILE tag can be used to specify a file to which warning 
297 # and error messages should be written. If left blank the output is written 
298 # to stderr.
299
300 WARN_LOGFILE           = warning
301
302 #---------------------------------------------------------------------------
303 # configuration options related to the input files
304 #---------------------------------------------------------------------------
305
306 # The INPUT tag can be used to specify the files and/or directories that contain 
307 # documented source files. You may enter file names like "myfile.cpp" or 
308 # directories like "/usr/src/myproject". Separate the files or directories 
309 # with spaces.
310
311 INPUT                  = "data-%USR_JA_DEV%/mainpage.txt"
312 INPUT                  += "%M17NLIB%/src/m17n-core.h"
313 INPUT                  += "%M17NLIB%/src/m17n.h"
314 INPUT                  += "%M17NLIB%/src/m17n-gui.h"
315 INPUT                  += "%M17NLIB%/src/m17n-X.h"
316 INPUT                  += "%M17NLIB%/src/m17n-err.h"
317 INPUT                  += "%M17NLIB%/src/"
318 INPUT                  += "data-%USR_JA_DEV%/dbformat.txt"
319 INPUT                  += "%M17NLIB%/example/README.txt"
320
321 # If the value of the INPUT tag contains directories, you can use the 
322 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
323 # and *.h) to filter out the source-files in the directories. If left 
324 # blank all files are included.
325
326 FILE_PATTERNS          = *.c
327
328
329 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
330 # should be searched for input files as well. Possible values are YES and NO. 
331 # If left blank NO is used.
332
333 RECURSIVE              = NO
334
335 # The EXCLUDE tag can be used to specify files and/or directories that should 
336 # excluded from the INPUT source files. This way you can easily exclude a 
337 # subdirectory from a directory tree whose root is specified with the INPUT tag.
338
339 EXCLUDE                = 
340
341 # If the value of the INPUT tag contains directories, you can use the 
342 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
343 # certain files from those directories.
344
345 EXCLUDE_PATTERNS       = font-flt.c font-ft.c link*.c
346
347 # The EXAMPLE_PATH tag can be used to specify one or more files or 
348 # directories that contain example code fragments that are included (see 
349 # the \include command).
350
351 EXAMPLE_PATH           = data-%USR_JA_DEV%
352
353 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
354 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
355 # and *.h) to filter out the source-files in the directories. If left 
356 # blank all files are included.
357
358 EXAMPLE_PATTERNS       = 
359
360 # The IMAGE_PATH tag can be used to specify one or more files or 
361 # directories that contain image that are included in the documentation (see 
362 # the \image command).
363
364 IMAGE_PATH             = /project/mule/m17n-lib/docs/doxygen/images
365
366 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
367 # invoke to filter for each input file. Doxygen will invoke the filter program 
368 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
369 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
370 # input file. Doxygen will then use the output that the filter program writes 
371 # to standard output.
372
373 INPUT_FILTER           = utils/%USR_JA_DEV%_filter.rb
374
375 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
376 # INPUT_FILTER) will be used to filter the input files when producing source 
377 # files to browse.
378
379 FILTER_SOURCE_FILES    = 
380
381 #---------------------------------------------------------------------------
382 # configuration options related to the alphabetical class index
383 #---------------------------------------------------------------------------
384
385 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
386 # of all compounds will be generated. Enable this if the project 
387 # contains a lot of classes, structs, unions or interfaces.
388
389 ALPHABETICAL_INDEX     = yes
390
391 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
392 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
393 # in which this list will be split (can be a number in the range [1..20])
394
395 COLS_IN_ALPHA_INDEX    = 5
396
397 # In case all classes in a project start with a common prefix, all 
398 # classes will be put under the same header in the alphabetical index. 
399 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
400 # should be ignored while generating the index headers.
401
402 IGNORE_PREFIX          = m M
403
404 #---------------------------------------------------------------------------
405 # configuration options related to the HTML output
406 #---------------------------------------------------------------------------
407
408 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
409 # generate HTML output.
410
411 GENERATE_HTML          = %GENERATE_HTML%
412
413 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
414 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
415 # put in front of it. If left blank `html' will be used as the default path.
416
417 HTML_OUTPUT            = 
418
419 # The HTML_HEADER tag can be used to specify a personal HTML header for 
420 # each generated HTML page. If it is left blank doxygen will generate a 
421 # standard header.
422
423 HTML_HEADER            = header.html
424
425 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
426 # each generated HTML page. If it is left blank doxygen will generate a 
427 # standard footer.
428
429 HTML_FOOTER            = footer.html
430
431 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
432 # style sheet that is used by each HTML page. It can be used to 
433 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
434 # will generate a default style sheet
435
436 HTML_STYLESHEET        = m17n-lib.css
437
438 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
439 # files or namespaces will be aligned in HTML using tables. If set to 
440 # NO a bullet list will be used.
441
442 HTML_ALIGN_MEMBERS     = yes
443
444 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
445 # will be generated that can be used as input for tools like the 
446 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
447 # of the generated HTML documentation.
448
449 GENERATE_HTMLHELP      = NO
450
451 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
452 # controls if a separate .chi index file is generated (YES) or that 
453 # it should be included in the master .chm file (NO).
454
455 GENERATE_CHI           = NO
456
457 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
458 # controls whether a binary table of contents is generated (YES) or a 
459 # normal table of contents (NO) in the .chm file.
460
461 BINARY_TOC             = NO
462
463 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
464 # to the contents of the Html help documentation and to the tree view.
465
466 TOC_EXPAND             = yes
467
468 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
469 # top of each HTML page. The value NO (the default) enables the index and 
470 # the value YES disables it.
471
472 DISABLE_INDEX          = no
473
474 # This tag can be used to set the number of enum values (range [1..20]) 
475 # that doxygen will group on one line in the generated HTML documentation.
476
477 ENUM_VALUES_PER_LINE   = 4
478
479 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
480 # generated containing a tree-like index structure (just like the one that 
481 # is generated for HTML Help). For this to work a browser that supports 
482 # JavaScript and frames is required (for instance Netscape 4.0+ 
483 # or Internet explorer 4.0+).
484
485 GENERATE_TREEVIEW      = no
486
487 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
488 # used to set the initial width (in pixels) of the frame in which the tree 
489 # is shown.
490
491 TREEVIEW_WIDTH         = 220
492
493 #---------------------------------------------------------------------------
494 # configuration options related to the LaTeX output
495 #---------------------------------------------------------------------------
496
497 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
498 # generate Latex output.
499
500 GENERATE_LATEX         = %GENERATE_LATEX%
501
502 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
503 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
504 # put in front of it. If left blank `latex' will be used as the default path.
505
506 LATEX_OUTPUT           = 
507
508 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
509 # LaTeX documents. This may be useful for small projects and may help to 
510 # save some trees in general.
511
512 COMPACT_LATEX          = yes
513
514 # The PAPER_TYPE tag can be used to set the paper type that is used 
515 # by the printer. Possible values are: a4, a4wide, letter, legal and 
516 # executive. If left blank a4wide will be used.
517
518 PAPER_TYPE             = a4
519
520 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
521 # packages that should be included in the LaTeX output.
522
523 EXTRA_PACKAGES         = m17n-lib times
524
525 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
526 # the generated latex document. The header should contain everything until 
527 # the first chapter. If it is left blank doxygen will generate a 
528 # standard header. Notice: only use this tag if you know what you are doing!
529
530 LATEX_HEADER           = 
531
532 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
533 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
534 # contain links (just like the HTML output) instead of page references 
535 # This makes the output suitable for online browsing using a pdf viewer.
536
537 PDF_HYPERLINKS         = no
538
539 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
540 # plain latex in the generated Makefile. Set this option to YES to get a 
541 # higher quality PDF documentation.
542
543 USE_PDFLATEX           = NO
544
545 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
546 # command to the generated LaTeX files. This will instruct LaTeX to keep 
547 # running if errors occur, instead of asking the user for help. 
548 # This option is also used when generating formulas in HTML.
549
550 LATEX_BATCHMODE        = NO
551
552 #---------------------------------------------------------------------------
553 # configuration options related to the RTF output
554 #---------------------------------------------------------------------------
555
556 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
557 # The RTF output is optimised for Word 97 and may not look very pretty with 
558 # other RTF readers or editors.
559
560 GENERATE_RTF           = no
561
562 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
563 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
564 # put in front of it. If left blank `rtf' will be used as the default path.
565
566 RTF_OUTPUT             = 
567
568 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
569 # RTF documents. This may be useful for small projects and may help to 
570 # save some trees in general.
571
572 COMPACT_RTF            = NO
573
574 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
575 # will contain hyperlink fields. The RTF file will 
576 # contain links (just like the HTML output) instead of page references. 
577 # This makes the output suitable for online browsing using WORD or other 
578 # programs which support those fields. 
579 # Note: wordpad (write) and others do not support links.
580
581 RTF_HYPERLINKS         = NO
582
583 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
584 # config file, i.e. a series of assigments. You only have to provide 
585 # replacements, missing definitions are set to their default value.
586
587 RTF_STYLESHEET_FILE    = 
588
589 # Set optional variables used in the generation of an rtf document. 
590 # Syntax is similar to doxygen's config file.
591
592 RTF_EXTENSIONS_FILE    = 
593
594 #---------------------------------------------------------------------------
595 # configuration options related to the man page output
596 #---------------------------------------------------------------------------
597
598 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
599 # generate man pages
600
601 GENERATE_MAN           = %GENERATE_MAN%
602
603 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
604 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
605 # put in front of it. If left blank `man' will be used as the default path.
606
607 MAN_OUTPUT             = 
608
609 # The MAN_EXTENSION tag determines the extension that is added to 
610 # the generated man pages (default is the subroutine's section .3)
611
612 MAN_EXTENSION          = .3m
613
614 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
615 # then it will generate one additional man file for each entity
616 # documented in the real man page(s). These additional files
617 # only source the real man page, but without them the man command
618 # would be unable to find the correct page. The default is NO.
619
620 MAN_LINKS              = NO
621
622 #---------------------------------------------------------------------------
623 # configuration options related to the XML output
624 #---------------------------------------------------------------------------
625
626 # If the GENERATE_XML tag is set to YES Doxygen will 
627 # generate an XML file that captures the structure of 
628 # the code including all documentation. Note that this 
629 # feature is still experimental and incomplete at the 
630 # moment.
631
632 GENERATE_XML           = no
633
634 #---------------------------------------------------------------------------
635 # Configuration options related to the preprocessor   
636 #---------------------------------------------------------------------------
637
638 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
639 # evaluate all C-preprocessor directives found in the sources and include 
640 # files.
641
642 ENABLE_PREPROCESSING   = YES
643
644 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
645 # names in the source code. If set to NO (the default) only conditional 
646 # compilation will be performed. Macro expansion can be done in a controlled 
647 # way by setting EXPAND_ONLY_PREDEF to YES.
648
649 MACRO_EXPANSION        = NO
650
651 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
652 # then the macro expansion is limited to the macros specified with the 
653 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
654
655 EXPAND_ONLY_PREDEF     = YES
656
657 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
658 # in the INCLUDE_PATH (see below) will be search if a #include is found.
659
660 SEARCH_INCLUDES        = YES
661
662 # The INCLUDE_PATH tag can be used to specify one or more directories that 
663 # contain include files that are not input files but should be processed by 
664 # the preprocessor.
665
666 INCLUDE_PATH           = 
667
668 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
669 # patterns (like *.h and *.hpp) to filter out the header-files in the 
670 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
671 # be used.
672
673 INCLUDE_FILE_PATTERNS  = 
674
675 # The PREDEFINED tag can be used to specify one or more macro names that 
676 # are defined before the preprocessor is started (similar to the -D option of 
677 # gcc). The argument of the tag is a list of macros of the form: name 
678 # or name=definition (no spaces). If the definition and the = are 
679 # omitted =1 is assumed.
680
681 PREDEFINED             = FOR_DOXYGEN
682 #PREDEFINED            += DOXYGEN_INTERNAL_MODULE
683
684 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
685 # this tag can be used to specify a list of macro names that should be expanded. 
686 # The macro definition that is found in the sources will be used. 
687 # Use the PREDEFINED tag if you want to use a different macro definition.
688
689 EXPAND_AS_DEFINED      = 
690
691 #---------------------------------------------------------------------------
692 # Configuration::addtions related to external references   
693 #---------------------------------------------------------------------------
694
695 # The TAGFILES tag can be used to specify one or more tagfiles.
696
697 TAGFILES               = 
698
699 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
700 # a tag file that is based on the input files it reads.
701
702 GENERATE_TAGFILE       = m17n.tag
703
704 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
705 # in the class index. If set to NO only the inherited external classes 
706 # will be listed.
707
708 ALLEXTERNALS           = NO
709
710 # The PERL_PATH should be the absolute path and name of the perl script 
711 # interpreter (i.e. the result of `which perl').
712
713 PERL_PATH              = 
714
715 #---------------------------------------------------------------------------
716 # Configuration options related to the dot tool   
717 #---------------------------------------------------------------------------
718
719 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
720 # available from the path. This tool is part of Graphviz, a graph visualization 
721 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
722 # have no effect if this option is set to NO (the default)
723
724 HAVE_DOT               = NO
725
726 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
727 # will generate a graph for each documented class showing the direct and 
728 # indirect inheritance relations. Setting this tag to YES will force the 
729 # the CLASS_DIAGRAMS tag to NO.
730
731 CLASS_GRAPH            = YES
732
733 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
734 # will generate a graph for each documented class showing the direct and 
735 # indirect implementation dependencies (inheritance, containment, and 
736 # class references variables) of the class with other documented classes.
737
738 COLLABORATION_GRAPH    = YES
739
740 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
741 # tags are set to YES then doxygen will generate a graph for each documented 
742 # file showing the direct and indirect include dependencies of the file with 
743 # other documented files.
744
745 INCLUDE_GRAPH          = YES
746
747 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
748 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
749 # documented header file showing the documented files that directly or 
750 # indirectly include this file.
751
752 INCLUDED_BY_GRAPH      = YES
753
754 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
755 # will graphical hierarchy of all classes instead of a textual one.
756
757 GRAPHICAL_HIERARCHY    = yes
758
759 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
760 # found. If left blank, it is assumed the dot tool can be found on the path.
761
762 DOT_PATH               = 
763
764 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
765 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
766 # this value, doxygen will try to truncate the graph, so that it fits within 
767 # the specified constraint. Beware that most browsers cannot cope with very 
768 # large images.
769
770 MAX_DOT_GRAPH_WIDTH    = 1024
771
772 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
773 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
774 # this value, doxygen will try to truncate the graph, so that it fits within 
775 # the specified constraint. Beware that most browsers cannot cope with very 
776 # large images.
777
778 MAX_DOT_GRAPH_HEIGHT   = 1024
779
780 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
781 # generate a legend page explaining the meaning of the various boxes and 
782 # arrows in the dot generated graphs.
783
784 GENERATE_LEGEND        = YES
785
786 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
787 # remove the intermedate dot files that are used to generate 
788 # the various graphs.
789
790 DOT_CLEANUP            = YES
791
792 #---------------------------------------------------------------------------
793 # Configuration::addtions related to the search engine   
794 #---------------------------------------------------------------------------
795
796 # The SEARCHENGINE tag specifies whether or not a search engine should be 
797 # used. If set to NO the values of all tags below this one will be ignored.
798
799 SEARCHENGINE           = no
800
801 # The CGI_NAME tag should be the name of the CGI script that 
802 # starts the search engine (doxysearch) with the correct parameters. 
803 # A script with this name will be generated by doxygen.
804
805 CGI_NAME               = m17n-lib-cgi
806
807 # The CGI_URL tag should be the absolute URL to the directory where the 
808 # cgi binaries are located. See the documentation of your http daemon for 
809 # details.
810
811 CGI_URL                = http://mule.m17n.org/cgi-bin
812
813 # The DOC_URL tag should be the absolute URL to the directory where the 
814 # documentation is located. If left blank the absolute path to the 
815 # documentation, with file:// prepended to it, will be used.
816
817 DOC_URL                = http://mule.m17n.org/m17n-lib/%USR_JA_DEV%/html/
818
819 # The DOC_ABSPATH tag should be the absolute path to the directory where the 
820 # documentation is located. If left blank the directory on the local machine 
821 # will be used.
822
823 DOC_ABSPATH            = %USR_JA_DEV%/html
824
825 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
826 # is installed.
827
828 BIN_ABSPATH            = /usr/local/bin
829
830 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
831 # documentation generated for other projects. This allows doxysearch to search 
832 # the documentation for these projects as well.
833
834 EXT_DOC_PATHS          =