Mercurial > pytave
annotate Doxyfile @ 369:540b36e797c8
Reduce number of function calls, clean up formatting in subasgn and subsref
* @pyobject/subsasgn.m: Reduce number of pycalls.
* @pyobject/subsref.m: Reduce number of pycalls. Clean up code formatting.
Add type checks for '()' indexing, explicit error message about slice indexing.
author | Mike Miller <mtmiller@octave.org> |
---|---|
date | Thu, 25 Aug 2016 23:20:02 -0700 |
parents | 673b59ae60a3 |
children |
rev | line source |
---|---|
175
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1 # Doxyfile 1.8.9.1 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
3 # This file describes the settings to be used by the documentation system |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
4 # doxygen (www.doxygen.org) for a project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
5 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
6 # All text after a double hash (##) is considered a comment and is placed in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
7 # front of the TAG it is preceding. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
8 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
9 # All text after a single hash (#) is considered a comment and will be ignored. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
10 # The format is: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
11 # TAG = value [value, ...] |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
12 # For lists, items can also be appended using: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
13 # TAG += value [value, ...] |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
14 # Values that contain spaces should be placed between quotes (\" \"). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
15 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
16 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
17 # Project related configuration options |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
18 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
19 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
20 # This tag specifies the encoding used for all characters in the config file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
21 # that follow. The default is UTF-8 which is also the encoding used for all text |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
24 # for the list of possible encodings. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
25 # The default value is: UTF-8. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
26 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
27 DOXYFILE_ENCODING = UTF-8 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
28 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
30 # double-quotes, unless you are using Doxywizard) that should identify the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
31 # project for which the documentation is generated. This name is used in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
32 # title of most generated pages and in a few other places. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
33 # The default value is: My Project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
34 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
35 PROJECT_NAME = Pytave |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
36 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
38 # could be handy for archiving the generated documentation or if some version |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
39 # control system is used. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
40 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
41 PROJECT_NUMBER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
42 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
44 # for a project that appears at the top of each page and should give viewer a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
45 # quick idea about the purpose of the project. Keep the description short. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
46 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
47 PROJECT_BRIEF = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
48 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
50 # in the documentation. The maximum height of the logo should not exceed 55 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
52 # the logo to the output directory. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
53 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
54 PROJECT_LOGO = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
55 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
57 # into which the generated documentation will be written. If a relative path is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
58 # entered, it will be relative to the location where doxygen was started. If |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
59 # left blank the current directory will be used. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
60 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
61 OUTPUT_DIRECTORY = ./doc |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
62 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
64 # directories (in 2 levels) under the output directory of each output format and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
65 # will distribute the generated files over these directories. Enabling this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
66 # option can be useful when feeding doxygen a huge amount of source files, where |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
67 # putting all generated files in the same directory would otherwise causes |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
68 # performance problems for the file system. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
69 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
70 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
71 CREATE_SUBDIRS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
72 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
74 # characters to appear in the names of generated files. If set to NO, non-ASCII |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
76 # U+3044. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
77 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
78 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
79 ALLOW_UNICODE_NAMES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
80 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
82 # documentation generated by doxygen is written. Doxygen will use this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
83 # information to generate all constant output in the proper language. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
91 # Ukrainian and Vietnamese. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
92 # The default value is: English. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
93 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
94 OUTPUT_LANGUAGE = English |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
95 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
97 # descriptions after the members that are listed in the file and class |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
98 # documentation (similar to Javadoc). Set to NO to disable this. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
99 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
100 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
101 BRIEF_MEMBER_DESC = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
102 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
104 # description of a member or function before the detailed description |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
105 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
107 # brief descriptions will be completely suppressed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
108 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
109 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
110 REPEAT_BRIEF = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
111 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
112 # This tag implements a quasi-intelligent brief description abbreviator that is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
113 # used to form the text in various listings. Each string in this list, if found |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
114 # as the leading text of the brief description, will be stripped from the text |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
115 # and the result, after processing the whole list, is used as the annotated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
116 # text. Otherwise, the brief description is used as-is. If left blank, the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
117 # following values are used ($name is automatically replaced with the name of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
118 # the entity):The $name class, The $name widget, The $name file, is, provides, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
119 # specifies, contains, represents, a, an and the. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
120 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
121 ABBREVIATE_BRIEF = "The $name class" \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
122 "The $name widget" \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
123 "The $name file" \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
124 is \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
125 provides \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
126 specifies \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
127 contains \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
128 represents \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
129 a \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
130 an \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
131 the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
132 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
134 # doxygen will generate a detailed section even if there is only a brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
135 # description. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
136 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
137 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
138 ALWAYS_DETAILED_SEC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
139 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
141 # inherited members of a class in the documentation of that class as if those |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
142 # members were ordinary class members. Constructors, destructors and assignment |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
143 # operators of the base classes will not be shown. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
144 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
145 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
146 INLINE_INHERITED_MEMB = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
147 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
149 # before files name in the file list and in the header files. If set to NO the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
150 # shortest path that makes the file name unique will be used |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
151 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
152 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
153 FULL_PATH_NAMES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
154 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
156 # Stripping is only done if one of the specified strings matches the left-hand |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
157 # part of the path. The tag can be used to show relative paths in the file list. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
158 # If left blank the directory from which doxygen is run is used as the path to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
159 # strip. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
160 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
161 # Note that you can specify absolute paths here, but also relative paths, which |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
162 # will be relative from the directory where doxygen is started. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
163 # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
164 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
165 STRIP_FROM_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
166 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
168 # path mentioned in the documentation of a class, which tells the reader which |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
169 # header file to include in order to use a class. If left blank only the name of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
170 # the header file containing the class definition is used. Otherwise one should |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
171 # specify the list of include paths that are normally passed to the compiler |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
172 # using the -I flag. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
173 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
174 STRIP_FROM_INC_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
175 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
177 # less readable) file names. This can be useful is your file systems doesn't |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
178 # support long names like on DOS, Mac, or CD-ROM. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
179 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
180 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
181 SHORT_NAMES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
182 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
184 # first line (until the first dot) of a Javadoc-style comment as the brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
185 # description. If set to NO, the Javadoc-style will behave just like regular Qt- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
186 # style comments (thus requiring an explicit @brief command for a brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
187 # description.) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
188 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
189 |
338
673b59ae60a3
* Doxyfile: enable JAVADOC_AUTOBRIEF.
Mike Miller <mtmiller@octave.org>
parents:
175
diff
changeset
|
190 JAVADOC_AUTOBRIEF = YES |
175
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
191 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
193 # line (until the first dot) of a Qt-style comment as the brief description. If |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
195 # requiring an explicit \brief command for a brief description.) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
196 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
197 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
198 QT_AUTOBRIEF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
199 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
201 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
202 # a brief description. This used to be the default behavior. The new default is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
203 # to treat a multi-line C++ comment block as a detailed description. Set this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
204 # tag to YES if you prefer the old behavior instead. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
205 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
206 # Note that setting this tag to YES also means that rational rose comments are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
207 # not recognized any more. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
208 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
209 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
210 MULTILINE_CPP_IS_BRIEF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
211 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
213 # documentation from any documented member that it re-implements. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
214 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
215 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
216 INHERIT_DOCS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
217 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
219 # page for each member. If set to NO, the documentation of a member will be part |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
220 # of the file/class/namespace that contains it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
221 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
222 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
223 SEPARATE_MEMBER_PAGES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
224 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
226 # uses this value to replace tabs by spaces in code fragments. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
227 # Minimum value: 1, maximum value: 16, default value: 4. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
228 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
229 TAB_SIZE = 4 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
230 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
231 # This tag can be used to specify a number of aliases that act as commands in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
232 # the documentation. An alias has the form: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
233 # name=value |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
234 # For example adding |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
235 # "sideeffect=@par Side Effects:\n" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
236 # will allow you to put the command \sideeffect (or @sideeffect) in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
237 # documentation, which will result in a user-defined paragraph with heading |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
238 # "Side Effects:". You can put \n's in the value part of an alias to insert |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
239 # newlines. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
240 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
241 ALIASES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
242 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
243 # This tag can be used to specify a number of word-keyword mappings (TCL only). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
244 # A mapping has the form "name=value". For example adding "class=itcl::class" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
245 # will allow you to use the command class in the itcl::class meaning. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
246 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
247 TCL_SUBST = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
248 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
250 # only. Doxygen will then generate output that is more tailored for C. For |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
251 # instance, some of the names that are used will be different. The list of all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
252 # members will be omitted, etc. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
253 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
254 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
255 OPTIMIZE_OUTPUT_FOR_C = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
256 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
258 # Python sources only. Doxygen will then generate output that is more tailored |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
259 # for that language. For instance, namespaces will be presented as packages, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
260 # qualified scopes will look different, etc. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
261 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
262 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
263 OPTIMIZE_OUTPUT_JAVA = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
264 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
266 # sources. Doxygen will then generate output that is tailored for Fortran. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
267 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
268 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
269 OPTIMIZE_FOR_FORTRAN = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
270 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
272 # sources. Doxygen will then generate output that is tailored for VHDL. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
273 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
274 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
275 OPTIMIZE_OUTPUT_VHDL = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
276 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
277 # Doxygen selects the parser to use depending on the extension of the files it |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
278 # parses. With this tag you can assign which parser to use for a given |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
279 # extension. Doxygen has a built-in mapping, but you can override or extend it |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
280 # using this tag. The format is ext=language, where ext is a file extension, and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
281 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
282 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
283 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
284 # Fortran. In the later case the parser tries to guess whether the code is fixed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
285 # or free formatted code, this is the default for Fortran type files), VHDL. For |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
286 # instance to make doxygen treat .inc files as Fortran files (default is PHP), |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
287 # and .f files as C (default is Fortran), use: inc=Fortran f=C. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
288 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
289 # Note: For files without extension you can use no_extension as a placeholder. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
290 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
291 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
292 # the files are not read by doxygen. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
293 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
294 EXTENSION_MAPPING = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
295 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
296 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
297 # according to the Markdown format, which allows for more readable |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
298 # documentation. See http://daringfireball.net/projects/markdown/ for details. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
299 # The output of markdown processing is further processed by doxygen, so you can |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
300 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
301 # case of backward compatibilities issues. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
302 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
303 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
304 MARKDOWN_SUPPORT = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
305 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
306 # When enabled doxygen tries to link words that correspond to documented |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
307 # classes, or namespaces to their corresponding documentation. Such a link can |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
308 # be prevented in individual cases by putting a % sign in front of the word or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
309 # globally by setting AUTOLINK_SUPPORT to NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
310 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
311 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
312 AUTOLINK_SUPPORT = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
313 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
314 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
315 # to include (a tag file for) the STL sources as input, then you should set this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
316 # tag to YES in order to let doxygen match functions declarations and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
317 # definitions whose arguments contain STL classes (e.g. func(std::string); |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
318 # versus func(std::string) {}). This also make the inheritance and collaboration |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
319 # diagrams that involve STL classes more complete and accurate. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
320 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
321 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
322 BUILTIN_STL_SUPPORT = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
323 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
324 # If you use Microsoft's C++/CLI language, you should set this option to YES to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
325 # enable parsing support. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
326 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
327 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
328 CPP_CLI_SUPPORT = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
329 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
331 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
332 # will parse them like normal C++ but will assume all classes use public instead |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
333 # of private inheritance when no explicit protection keyword is present. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
334 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
335 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
336 SIP_SUPPORT = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
337 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
338 # For Microsoft's IDL there are propget and propput attributes to indicate |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
339 # getter and setter methods for a property. Setting this option to YES will make |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
340 # doxygen to replace the get and set methods by a property in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
341 # This will only work if the methods are indeed getting or setting a simple |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
342 # type. If this is not the case, or you want to show the methods anyway, you |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
343 # should set this option to NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
344 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
345 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
346 IDL_PROPERTY_SUPPORT = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
347 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
348 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
349 # tag is set to YES then doxygen will reuse the documentation of the first |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
350 # member in the group (if any) for the other members of the group. By default |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
351 # all members of a group must be documented explicitly. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
352 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
353 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
354 DISTRIBUTE_GROUP_DOC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
355 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
356 # Set the SUBGROUPING tag to YES to allow class member groups of the same type |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
357 # (for instance a group of public functions) to be put as a subgroup of that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
358 # type (e.g. under the Public Functions section). Set it to NO to prevent |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
359 # subgrouping. Alternatively, this can be done per class using the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
360 # \nosubgrouping command. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
361 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
362 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
363 SUBGROUPING = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
364 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
365 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
366 # are shown inside the group in which they are included (e.g. using \ingroup) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
367 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
368 # and RTF). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
369 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
370 # Note that this feature does not work in combination with |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
371 # SEPARATE_MEMBER_PAGES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
372 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
373 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
374 INLINE_GROUPED_CLASSES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
375 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
376 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
377 # with only public data fields or simple typedef fields will be shown inline in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
378 # the documentation of the scope in which they are defined (i.e. file, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
379 # namespace, or group documentation), provided this scope is documented. If set |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
380 # to NO, structs, classes, and unions are shown on a separate page (for HTML and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
381 # Man pages) or section (for LaTeX and RTF). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
382 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
383 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
384 INLINE_SIMPLE_STRUCTS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
385 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
386 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
387 # enum is documented as struct, union, or enum with the name of the typedef. So |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
388 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
389 # with name TypeT. When disabled the typedef will appear as a member of a file, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
390 # namespace, or class. And the struct will be named TypeS. This can typically be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
391 # useful for C code in case the coding convention dictates that all compound |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
392 # types are typedef'ed and only the typedef is referenced, never the tag name. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
393 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
394 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
395 TYPEDEF_HIDES_STRUCT = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
396 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
397 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
398 # cache is used to resolve symbols given their name and scope. Since this can be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
399 # an expensive process and often the same symbol appears multiple times in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
400 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
401 # doxygen will become slower. If the cache is too large, memory is wasted. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
402 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
403 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
404 # symbols. At the end of a run doxygen will report the cache usage and suggest |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
405 # the optimal cache size from a speed point of view. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
406 # Minimum value: 0, maximum value: 9, default value: 0. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
407 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
408 LOOKUP_CACHE_SIZE = 0 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
409 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
410 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
411 # Build related configuration options |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
412 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
413 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
414 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
415 # documentation are documented, even if no documentation was available. Private |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
416 # class members and static file members will be hidden unless the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
417 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
418 # Note: This will also disable the warnings about undocumented members that are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
419 # normally produced when WARNINGS is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
420 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
421 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
422 EXTRACT_ALL = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
423 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
424 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
425 # be included in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
426 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
427 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
428 EXTRACT_PRIVATE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
429 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
430 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
431 # scope will be included in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
432 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
433 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
434 EXTRACT_PACKAGE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
435 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
436 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
437 # included in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
438 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
439 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
440 EXTRACT_STATIC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
441 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
442 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
443 # locally in source files will be included in the documentation. If set to NO, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
444 # only classes defined in header files are included. Does not have any effect |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
445 # for Java sources. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
446 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
447 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
448 EXTRACT_LOCAL_CLASSES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
449 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
450 # This flag is only useful for Objective-C code. If set to YES, local methods, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
451 # which are defined in the implementation section but not in the interface are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
452 # included in the documentation. If set to NO, only methods in the interface are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
453 # included. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
454 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
455 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
456 EXTRACT_LOCAL_METHODS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
457 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
458 # If this flag is set to YES, the members of anonymous namespaces will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
459 # extracted and appear in the documentation as a namespace called |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
460 # 'anonymous_namespace{file}', where file will be replaced with the base name of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
461 # the file that contains the anonymous namespace. By default anonymous namespace |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
462 # are hidden. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
463 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
464 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
465 EXTRACT_ANON_NSPACES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
466 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
467 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
468 # undocumented members inside documented classes or files. If set to NO these |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
469 # members will be included in the various overviews, but no documentation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
470 # section is generated. This option has no effect if EXTRACT_ALL is enabled. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
471 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
472 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
473 HIDE_UNDOC_MEMBERS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
474 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
475 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
476 # undocumented classes that are normally visible in the class hierarchy. If set |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
477 # to NO, these classes will be included in the various overviews. This option |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
478 # has no effect if EXTRACT_ALL is enabled. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
479 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
480 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
481 HIDE_UNDOC_CLASSES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
482 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
483 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
484 # (class|struct|union) declarations. If set to NO, these declarations will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
485 # included in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
486 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
487 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
488 HIDE_FRIEND_COMPOUNDS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
489 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
490 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
491 # documentation blocks found inside the body of a function. If set to NO, these |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
492 # blocks will be appended to the function's detailed documentation block. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
493 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
494 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
495 HIDE_IN_BODY_DOCS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
496 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
497 # The INTERNAL_DOCS tag determines if documentation that is typed after a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
498 # \internal command is included. If the tag is set to NO then the documentation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
499 # will be excluded. Set it to YES to include the internal documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
500 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
501 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
502 INTERNAL_DOCS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
503 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
504 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
505 # names in lower-case letters. If set to YES, upper-case letters are also |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
506 # allowed. This is useful if you have classes or files whose names only differ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
507 # in case and if your file system supports case sensitive file names. Windows |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
508 # and Mac users are advised to set this option to NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
509 # The default value is: system dependent. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
510 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
511 CASE_SENSE_NAMES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
512 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
513 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
514 # their full class and namespace scopes in the documentation. If set to YES, the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
515 # scope will be hidden. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
516 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
517 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
518 HIDE_SCOPE_NAMES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
519 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
520 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
521 # append additional text to a page's title, such as Class Reference. If set to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
522 # YES the compound reference will be hidden. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
523 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
524 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
525 HIDE_COMPOUND_REFERENCE= NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
526 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
527 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
528 # the files that are included by a file in the documentation of that file. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
529 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
530 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
531 SHOW_INCLUDE_FILES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
532 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
533 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
534 # grouped member an include statement to the documentation, telling the reader |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
535 # which file to include in order to use the member. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
536 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
537 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
538 SHOW_GROUPED_MEMB_INC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
539 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
540 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
541 # files with double quotes in the documentation rather than with sharp brackets. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
542 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
543 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
544 FORCE_LOCAL_INCLUDES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
545 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
546 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
547 # documentation for inline members. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
548 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
549 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
550 INLINE_INFO = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
551 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
552 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
553 # (detailed) documentation of file and class members alphabetically by member |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
554 # name. If set to NO, the members will appear in declaration order. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
555 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
556 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
557 SORT_MEMBER_DOCS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
558 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
559 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
560 # descriptions of file, namespace and class members alphabetically by member |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
561 # name. If set to NO, the members will appear in declaration order. Note that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
562 # this will also influence the order of the classes in the class list. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
563 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
564 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
565 SORT_BRIEF_DOCS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
566 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
567 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
568 # (brief and detailed) documentation of class members so that constructors and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
569 # destructors are listed first. If set to NO the constructors will appear in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
570 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
571 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
572 # member documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
573 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
574 # detailed member documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
575 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
576 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
577 SORT_MEMBERS_CTORS_1ST = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
578 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
579 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
580 # of group names into alphabetical order. If set to NO the group names will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
581 # appear in their defined order. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
582 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
583 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
584 SORT_GROUP_NAMES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
585 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
586 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
587 # fully-qualified names, including namespaces. If set to NO, the class list will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
588 # be sorted only by class name, not including the namespace part. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
589 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
590 # Note: This option applies only to the class list, not to the alphabetical |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
591 # list. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
592 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
593 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
594 SORT_BY_SCOPE_NAME = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
595 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
596 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
597 # type resolution of all parameters of a function it will reject a match between |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
598 # the prototype and the implementation of a member function even if there is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
599 # only one candidate or it is obvious which candidate to choose by doing a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
600 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
601 # accept a match between prototype and implementation in such cases. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
602 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
603 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
604 STRICT_PROTO_MATCHING = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
605 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
606 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
607 # list. This list is created by putting \todo commands in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
608 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
609 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
610 GENERATE_TODOLIST = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
611 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
612 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
613 # list. This list is created by putting \test commands in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
614 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
615 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
616 GENERATE_TESTLIST = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
617 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
618 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
619 # list. This list is created by putting \bug commands in the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
620 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
621 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
622 GENERATE_BUGLIST = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
623 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
624 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
625 # the deprecated list. This list is created by putting \deprecated commands in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
626 # the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
627 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
628 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
629 GENERATE_DEPRECATEDLIST= YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
630 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
631 # The ENABLED_SECTIONS tag can be used to enable conditional documentation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
632 # sections, marked by \if <section_label> ... \endif and \cond <section_label> |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
633 # ... \endcond blocks. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
634 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
635 ENABLED_SECTIONS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
636 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
637 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
638 # initial value of a variable or macro / define can have for it to appear in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
639 # documentation. If the initializer consists of more lines than specified here |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
640 # it will be hidden. Use a value of 0 to hide initializers completely. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
641 # appearance of the value of individual variables and macros / defines can be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
642 # controlled using \showinitializer or \hideinitializer command in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
643 # documentation regardless of this setting. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
644 # Minimum value: 0, maximum value: 10000, default value: 30. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
645 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
646 MAX_INITIALIZER_LINES = 30 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
647 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
648 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
649 # the bottom of the documentation of classes and structs. If set to YES, the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
650 # list will mention the files that were used to generate the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
651 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
652 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
653 SHOW_USED_FILES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
654 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
655 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
656 # will remove the Files entry from the Quick Index and from the Folder Tree View |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
657 # (if specified). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
658 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
659 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
660 SHOW_FILES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
661 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
662 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
663 # page. This will remove the Namespaces entry from the Quick Index and from the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
664 # Folder Tree View (if specified). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
665 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
666 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
667 SHOW_NAMESPACES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
668 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
669 # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
670 # doxygen should invoke to get the current version for each file (typically from |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
671 # the version control system). Doxygen will invoke the program by executing (via |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
672 # popen()) the command command input-file, where command is the value of the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
673 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
674 # by doxygen. Whatever the program writes to standard output is used as the file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
675 # version. For an example see the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
676 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
677 FILE_VERSION_FILTER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
678 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
679 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
680 # by doxygen. The layout file controls the global structure of the generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
681 # output files in an output format independent way. To create the layout file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
682 # that represents doxygen's defaults, run doxygen with the -l option. You can |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
683 # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
684 # will be used as the name of the layout file. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
685 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
686 # Note that if you run doxygen from a directory containing a file called |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
687 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
688 # tag is left empty. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
689 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
690 LAYOUT_FILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
691 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
692 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
693 # the reference definitions. This must be a list of .bib files. The .bib |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
694 # extension is automatically appended if omitted. This requires the bibtex tool |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
695 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
696 # For LaTeX the style of the bibliography can be controlled using |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
697 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
698 # search path. See also \cite for info how to create references. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
699 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
700 CITE_BIB_FILES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
701 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
702 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
703 # Configuration options related to warning and progress messages |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
704 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
705 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
706 # The QUIET tag can be used to turn on/off the messages that are generated to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
707 # standard output by doxygen. If QUIET is set to YES this implies that the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
708 # messages are off. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
709 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
710 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
711 QUIET = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
712 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
713 # The WARNINGS tag can be used to turn on/off the warning messages that are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
714 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
715 # this implies that the warnings are on. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
716 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
717 # Tip: Turn warnings on while writing the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
718 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
719 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
720 WARNINGS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
721 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
722 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
723 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
724 # will automatically be disabled. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
725 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
726 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
727 WARN_IF_UNDOCUMENTED = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
728 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
729 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
730 # potential errors in the documentation, such as not documenting some parameters |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
731 # in a documented function, or documenting parameters that don't exist or using |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
732 # markup commands wrongly. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
733 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
734 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
735 WARN_IF_DOC_ERROR = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
736 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
737 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
738 # are documented, but have no documentation for their parameters or return |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
739 # value. If set to NO, doxygen will only warn about wrong or incomplete |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
740 # parameter documentation, but not about the absence of documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
741 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
742 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
743 WARN_NO_PARAMDOC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
744 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
745 # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
746 # can produce. The string should contain the $file, $line, and $text tags, which |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
747 # will be replaced by the file and line number from which the warning originated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
748 # and the warning text. Optionally the format may contain $version, which will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
749 # be replaced by the version of the file (if it could be obtained via |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
750 # FILE_VERSION_FILTER) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
751 # The default value is: $file:$line: $text. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
752 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
753 WARN_FORMAT = "$file:$line: $text" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
754 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
755 # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
756 # messages should be written. If left blank the output is written to standard |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
757 # error (stderr). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
758 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
759 WARN_LOGFILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
760 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
761 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
762 # Configuration options related to the input files |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
763 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
764 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
765 # The INPUT tag is used to specify the files and/or directories that contain |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
766 # documented source files. You may enter file names like myfile.cpp or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
767 # directories like /usr/src/myproject. Separate the files or directories with |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
768 # spaces. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
769 # Note: If this tag is empty the current directory is searched. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
770 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
771 INPUT = . |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
772 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
773 # This tag can be used to specify the character encoding of the source files |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
774 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
775 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
776 # documentation (see: http://www.gnu.org/software/libiconv) for the list of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
777 # possible encodings. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
778 # The default value is: UTF-8. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
779 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
780 INPUT_ENCODING = UTF-8 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
781 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
782 # If the value of the INPUT tag contains directories, you can use the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
783 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
784 # *.h) to filter out the source-files in the directories. If left blank the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
785 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
786 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
787 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
788 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
789 # *.qsf, *.as and *.js. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
790 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
791 FILE_PATTERNS = *.c \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
792 *.cc \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
793 *.cxx \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
794 *.cpp \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
795 *.c++ \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
796 *.java \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
797 *.ii \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
798 *.ixx \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
799 *.ipp \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
800 *.i++ \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
801 *.inl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
802 *.idl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
803 *.ddl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
804 *.odl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
805 *.h \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
806 *.hh \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
807 *.hxx \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
808 *.hpp \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
809 *.h++ \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
810 *.cs \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
811 *.d \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
812 *.php \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
813 *.php4 \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
814 *.php5 \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
815 *.phtml \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
816 *.inc \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
817 *.m \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
818 *.markdown \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
819 *.md \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
820 *.mm \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
821 *.dox \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
822 *.py \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
823 *.f90 \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
824 *.f \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
825 *.for \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
826 *.tcl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
827 *.vhd \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
828 *.vhdl \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
829 *.ucf \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
830 *.qsf \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
831 *.as \ |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
832 *.js |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
833 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
834 # The RECURSIVE tag can be used to specify whether or not subdirectories should |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
835 # be searched for input files as well. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
836 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
837 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
838 RECURSIVE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
839 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
840 # The EXCLUDE tag can be used to specify files and/or directories that should be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
841 # excluded from the INPUT source files. This way you can easily exclude a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
842 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
843 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
844 # Note that relative paths are relative to the directory from which doxygen is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
845 # run. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
846 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
847 EXCLUDE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
848 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
849 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
850 # directories that are symbolic links (a Unix file system feature) are excluded |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
851 # from the input. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
852 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
853 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
854 EXCLUDE_SYMLINKS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
855 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
856 # If the value of the INPUT tag contains directories, you can use the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
857 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
858 # certain files from those directories. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
859 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
860 # Note that the wildcards are matched against the file with absolute path, so to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
861 # exclude all test directories for example use the pattern */test/* |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
862 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
863 EXCLUDE_PATTERNS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
864 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
865 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
866 # (namespaces, classes, functions, etc.) that should be excluded from the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
867 # output. The symbol name can be a fully qualified name, a word, or if the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
868 # wildcard * is used, a substring. Examples: ANamespace, AClass, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
869 # AClass::ANamespace, ANamespace::*Test |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
870 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
871 # Note that the wildcards are matched against the file with absolute path, so to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
872 # exclude all test directories use the pattern */test/* |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
873 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
874 EXCLUDE_SYMBOLS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
875 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
876 # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
877 # that contain example code fragments that are included (see the \include |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
878 # command). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
879 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
880 EXAMPLE_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
881 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
882 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
883 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
884 # *.h) to filter out the source-files in the directories. If left blank all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
885 # files are included. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
886 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
887 EXAMPLE_PATTERNS = * |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
888 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
889 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
890 # searched for input files to be used with the \include or \dontinclude commands |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
891 # irrespective of the value of the RECURSIVE tag. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
892 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
893 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
894 EXAMPLE_RECURSIVE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
895 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
896 # The IMAGE_PATH tag can be used to specify one or more files or directories |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
897 # that contain images that are to be included in the documentation (see the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
898 # \image command). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
899 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
900 IMAGE_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
901 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
902 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
903 # invoke to filter for each input file. Doxygen will invoke the filter program |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
904 # by executing (via popen()) the command: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
905 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
906 # <filter> <input-file> |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
907 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
908 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
909 # name of an input file. Doxygen will then use the output that the filter |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
910 # program writes to standard output. If FILTER_PATTERNS is specified, this tag |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
911 # will be ignored. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
912 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
913 # Note that the filter must not add or remove lines; it is applied before the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
914 # code is scanned, but not when the output code is generated. If lines are added |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
915 # or removed, the anchors will not be placed correctly. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
916 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
917 INPUT_FILTER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
918 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
919 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
920 # basis. Doxygen will compare the file name with each pattern and apply the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
921 # filter if there is a match. The filters are a list of the form: pattern=filter |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
922 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
923 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
924 # patterns match the file name, INPUT_FILTER is applied. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
925 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
926 FILTER_PATTERNS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
927 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
928 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
929 # INPUT_FILTER) will also be used to filter the input files that are used for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
930 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
931 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
932 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
933 FILTER_SOURCE_FILES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
934 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
935 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
936 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
937 # it is also possible to disable source filtering for a specific pattern using |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
938 # *.ext= (so without naming a filter). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
939 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
940 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
941 FILTER_SOURCE_PATTERNS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
942 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
943 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
944 # is part of the input, its contents will be placed on the main page |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
945 # (index.html). This can be useful if you have a project on for instance GitHub |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
946 # and want to reuse the introduction page also for the doxygen output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
947 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
948 USE_MDFILE_AS_MAINPAGE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
949 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
950 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
951 # Configuration options related to source browsing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
952 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
953 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
954 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
955 # generated. Documented entities will be cross-referenced with these sources. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
956 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
957 # Note: To get rid of all source code in the generated output, make sure that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
958 # also VERBATIM_HEADERS is set to NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
959 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
960 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
961 SOURCE_BROWSER = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
962 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
963 # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
964 # classes and enums directly into the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
965 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
966 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
967 INLINE_SOURCES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
968 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
969 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
970 # special comment blocks from generated source code fragments. Normal C, C++ and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
971 # Fortran comments will always remain visible. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
972 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
973 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
974 STRIP_CODE_COMMENTS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
975 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
976 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
977 # function all documented functions referencing it will be listed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
978 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
979 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
980 REFERENCED_BY_RELATION = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
981 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
982 # If the REFERENCES_RELATION tag is set to YES then for each documented function |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
983 # all documented entities called/used by that function will be listed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
984 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
985 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
986 REFERENCES_RELATION = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
987 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
988 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
989 # to YES then the hyperlinks from functions in REFERENCES_RELATION and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
990 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
991 # link to the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
992 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
993 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
994 REFERENCES_LINK_SOURCE = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
995 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
996 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
997 # source code will show a tooltip with additional information such as prototype, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
998 # brief description and links to the definition and documentation. Since this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
999 # will make the HTML file larger and loading of large files a bit slower, you |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1000 # can opt to disable this feature. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1001 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1002 # This tag requires that the tag SOURCE_BROWSER is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1003 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1004 SOURCE_TOOLTIPS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1005 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1006 # If the USE_HTAGS tag is set to YES then the references to source code will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1007 # point to the HTML generated by the htags(1) tool instead of doxygen built-in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1008 # source browser. The htags tool is part of GNU's global source tagging system |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1009 # (see http://www.gnu.org/software/global/global.html). You will need version |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1010 # 4.8.6 or higher. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1011 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1012 # To use it do the following: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1013 # - Install the latest version of global |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1014 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1015 # - Make sure the INPUT points to the root of the source tree |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1016 # - Run doxygen as normal |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1017 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1018 # Doxygen will invoke htags (and that will in turn invoke gtags), so these |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1019 # tools must be available from the command line (i.e. in the search path). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1020 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1021 # The result: instead of the source browser generated by doxygen, the links to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1022 # source code will now point to the output of htags. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1023 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1024 # This tag requires that the tag SOURCE_BROWSER is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1025 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1026 USE_HTAGS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1027 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1028 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1029 # verbatim copy of the header file for each class for which an include is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1030 # specified. Set to NO to disable this. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1031 # See also: Section \class. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1032 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1033 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1034 VERBATIM_HEADERS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1035 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1036 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1037 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1038 # cost of reduced performance. This can be particularly helpful with template |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1039 # rich C++ code for which doxygen's built-in parser lacks the necessary type |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1040 # information. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1041 # Note: The availability of this option depends on whether or not doxygen was |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1042 # compiled with the --with-libclang option. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1043 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1044 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1045 CLANG_ASSISTED_PARSING = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1046 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1047 # If clang assisted parsing is enabled you can provide the compiler with command |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1048 # line options that you would normally use when invoking the compiler. Note that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1049 # the include paths will already be set by doxygen for the files and directories |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1050 # specified with INPUT and INCLUDE_PATH. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1051 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1052 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1053 CLANG_OPTIONS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1054 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1055 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1056 # Configuration options related to the alphabetical class index |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1057 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1058 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1059 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1060 # compounds will be generated. Enable this if the project contains a lot of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1061 # classes, structs, unions or interfaces. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1062 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1063 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1064 ALPHABETICAL_INDEX = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1065 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1066 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1067 # which the alphabetical index list will be split. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1068 # Minimum value: 1, maximum value: 20, default value: 5. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1069 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1070 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1071 COLS_IN_ALPHA_INDEX = 5 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1072 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1073 # In case all classes in a project start with a common prefix, all classes will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1074 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1075 # can be used to specify a prefix (or a list of prefixes) that should be ignored |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1076 # while generating the index headers. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1077 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1078 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1079 IGNORE_PREFIX = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1080 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1081 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1082 # Configuration options related to the HTML output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1083 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1084 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1085 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1086 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1087 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1088 GENERATE_HTML = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1089 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1090 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1091 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1092 # it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1093 # The default directory is: html. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1094 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1095 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1096 HTML_OUTPUT = html |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1097 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1098 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1099 # generated HTML page (for example: .htm, .php, .asp). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1100 # The default value is: .html. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1101 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1102 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1103 HTML_FILE_EXTENSION = .html |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1104 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1105 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1106 # each generated HTML page. If the tag is left blank doxygen will generate a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1107 # standard header. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1108 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1109 # To get valid HTML the header file that includes any scripts and style sheets |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1110 # that doxygen needs, which is dependent on the configuration options used (e.g. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1111 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1112 # default header using |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1113 # doxygen -w html new_header.html new_footer.html new_stylesheet.css |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1114 # YourConfigFile |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1115 # and then modify the file new_header.html. See also section "Doxygen usage" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1116 # for information on how to generate the default header that doxygen normally |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1117 # uses. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1118 # Note: The header is subject to change so you typically have to regenerate the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1119 # default header when upgrading to a newer version of doxygen. For a description |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1120 # of the possible markers and block names see the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1121 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1122 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1123 HTML_HEADER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1124 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1125 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1126 # generated HTML page. If the tag is left blank doxygen will generate a standard |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1127 # footer. See HTML_HEADER for more information on how to generate a default |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1128 # footer and what special commands can be used inside the footer. See also |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1129 # section "Doxygen usage" for information on how to generate the default footer |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1130 # that doxygen normally uses. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1131 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1132 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1133 HTML_FOOTER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1134 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1135 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1136 # sheet that is used by each HTML page. It can be used to fine-tune the look of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1137 # the HTML output. If left blank doxygen will generate a default style sheet. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1138 # See also section "Doxygen usage" for information on how to generate the style |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1139 # sheet that doxygen normally uses. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1140 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1141 # it is more robust and this tag (HTML_STYLESHEET) will in the future become |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1142 # obsolete. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1143 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1144 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1145 HTML_STYLESHEET = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1146 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1147 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1148 # cascading style sheets that are included after the standard style sheets |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1149 # created by doxygen. Using this option one can overrule certain style aspects. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1150 # This is preferred over using HTML_STYLESHEET since it does not replace the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1151 # standard style sheet and is therefore more robust against future updates. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1152 # Doxygen will copy the style sheet files to the output directory. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1153 # Note: The order of the extra style sheet files is of importance (e.g. the last |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1154 # style sheet in the list overrules the setting of the previous ones in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1155 # list). For an example see the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1156 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1157 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1158 HTML_EXTRA_STYLESHEET = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1159 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1160 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1161 # other source files which should be copied to the HTML output directory. Note |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1162 # that these files will be copied to the base HTML output directory. Use the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1163 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1164 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1165 # files will be copied as-is; there are no commands or markers available. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1166 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1167 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1168 HTML_EXTRA_FILES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1169 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1170 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1171 # will adjust the colors in the style sheet and background images according to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1172 # this color. Hue is specified as an angle on a colorwheel, see |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1173 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1174 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1175 # purple, and 360 is red again. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1176 # Minimum value: 0, maximum value: 359, default value: 220. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1177 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1178 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1179 HTML_COLORSTYLE_HUE = 220 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1180 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1181 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1182 # in the HTML output. For a value of 0 the output will use grayscales only. A |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1183 # value of 255 will produce the most vivid colors. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1184 # Minimum value: 0, maximum value: 255, default value: 100. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1185 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1186 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1187 HTML_COLORSTYLE_SAT = 100 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1188 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1189 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1190 # luminance component of the colors in the HTML output. Values below 100 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1191 # gradually make the output lighter, whereas values above 100 make the output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1192 # darker. The value divided by 100 is the actual gamma applied, so 80 represents |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1193 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1194 # change the gamma. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1195 # Minimum value: 40, maximum value: 240, default value: 80. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1196 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1197 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1198 HTML_COLORSTYLE_GAMMA = 80 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1199 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1200 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1201 # page will contain the date and time when the page was generated. Setting this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1202 # to NO can help when comparing the output of multiple runs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1203 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1204 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1205 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1206 HTML_TIMESTAMP = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1207 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1208 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1209 # documentation will contain sections that can be hidden and shown after the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1210 # page has loaded. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1211 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1212 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1213 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1214 HTML_DYNAMIC_SECTIONS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1215 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1216 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1217 # shown in the various tree structured indices initially; the user can expand |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1218 # and collapse entries dynamically later on. Doxygen will expand the tree to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1219 # such a level that at most the specified number of entries are visible (unless |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1220 # a fully collapsed tree already exceeds this amount). So setting the number of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1221 # entries 1 will produce a full collapsed tree by default. 0 is a special value |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1222 # representing an infinite number of entries and will result in a full expanded |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1223 # tree by default. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1224 # Minimum value: 0, maximum value: 9999, default value: 100. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1225 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1226 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1227 HTML_INDEX_NUM_ENTRIES = 100 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1228 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1229 # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1230 # generated that can be used as input for Apple's Xcode 3 integrated development |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1231 # environment (see: http://developer.apple.com/tools/xcode/), introduced with |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1232 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1233 # Makefile in the HTML output directory. Running make will produce the docset in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1234 # that directory and running make install will install the docset in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1235 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1236 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1237 # for more information. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1238 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1239 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1240 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1241 GENERATE_DOCSET = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1242 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1243 # This tag determines the name of the docset feed. A documentation feed provides |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1244 # an umbrella under which multiple documentation sets from a single provider |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1245 # (such as a company or product suite) can be grouped. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1246 # The default value is: Doxygen generated docs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1247 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1248 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1249 DOCSET_FEEDNAME = "Doxygen generated docs" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1250 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1251 # This tag specifies a string that should uniquely identify the documentation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1252 # set bundle. This should be a reverse domain-name style string, e.g. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1253 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1254 # The default value is: org.doxygen.Project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1255 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1256 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1257 DOCSET_BUNDLE_ID = org.doxygen.Project |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1258 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1259 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1260 # the documentation publisher. This should be a reverse domain-name style |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1261 # string, e.g. com.mycompany.MyDocSet.documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1262 # The default value is: org.doxygen.Publisher. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1263 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1264 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1265 DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1266 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1267 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1268 # The default value is: Publisher. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1269 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1270 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1271 DOCSET_PUBLISHER_NAME = Publisher |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1272 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1273 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1274 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1275 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1276 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1277 # Windows. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1278 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1279 # The HTML Help Workshop contains a compiler that can convert all HTML output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1280 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1281 # files are now used as the Windows 98 help format, and will replace the old |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1282 # Windows help format (.hlp) on all Windows platforms in the future. Compressed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1283 # HTML files also contain an index, a table of contents, and you can search for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1284 # words in the documentation. The HTML workshop also contains a viewer for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1285 # compressed HTML files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1286 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1287 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1288 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1289 GENERATE_HTMLHELP = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1290 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1291 # The CHM_FILE tag can be used to specify the file name of the resulting .chm |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1292 # file. You can add a path in front of the file if the result should not be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1293 # written to the html output directory. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1294 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1295 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1296 CHM_FILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1297 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1298 # The HHC_LOCATION tag can be used to specify the location (absolute path |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1299 # including file name) of the HTML help compiler (hhc.exe). If non-empty, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1300 # doxygen will try to run the HTML help compiler on the generated index.hhp. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1301 # The file has to be specified with full path. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1302 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1303 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1304 HHC_LOCATION = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1305 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1306 # The GENERATE_CHI flag controls if a separate .chi index file is generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1307 # (YES) or that it should be included in the master .chm file (NO). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1308 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1309 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1310 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1311 GENERATE_CHI = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1312 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1313 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1314 # and project file content. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1315 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1316 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1317 CHM_INDEX_ENCODING = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1318 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1319 # The BINARY_TOC flag controls whether a binary table of contents is generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1320 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1321 # enables the Previous and Next buttons. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1322 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1323 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1324 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1325 BINARY_TOC = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1326 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1327 # The TOC_EXPAND flag can be set to YES to add extra items for group members to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1328 # the table of contents of the HTML help documentation and to the tree view. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1329 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1330 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1331 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1332 TOC_EXPAND = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1333 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1334 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1335 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1336 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1337 # (.qch) of the generated HTML documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1338 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1339 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1340 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1341 GENERATE_QHP = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1342 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1343 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1344 # the file name of the resulting .qch file. The path specified is relative to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1345 # the HTML output folder. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1346 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1347 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1348 QCH_FILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1349 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1350 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1351 # Project output. For more information please see Qt Help Project / Namespace |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1352 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1353 # The default value is: org.doxygen.Project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1354 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1355 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1356 QHP_NAMESPACE = org.doxygen.Project |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1357 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1358 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1359 # Help Project output. For more information please see Qt Help Project / Virtual |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1360 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1361 # folders). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1362 # The default value is: doc. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1363 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1364 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1365 QHP_VIRTUAL_FOLDER = doc |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1366 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1367 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1368 # filter to add. For more information please see Qt Help Project / Custom |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1369 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1370 # filters). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1371 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1372 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1373 QHP_CUST_FILTER_NAME = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1374 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1375 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1376 # custom filter to add. For more information please see Qt Help Project / Custom |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1377 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1378 # filters). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1379 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1380 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1381 QHP_CUST_FILTER_ATTRS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1382 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1383 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1384 # project's filter section matches. Qt Help Project / Filter Attributes (see: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1385 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1386 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1387 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1388 QHP_SECT_FILTER_ATTRS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1389 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1390 # The QHG_LOCATION tag can be used to specify the location of Qt's |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1391 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1392 # generated .qhp file. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1393 # This tag requires that the tag GENERATE_QHP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1394 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1395 QHG_LOCATION = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1396 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1397 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1398 # generated, together with the HTML files, they form an Eclipse help plugin. To |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1399 # install this plugin and make it available under the help contents menu in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1400 # Eclipse, the contents of the directory containing the HTML and XML files needs |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1401 # to be copied into the plugins directory of eclipse. The name of the directory |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1402 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1403 # After copying Eclipse needs to be restarted before the help appears. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1404 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1405 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1406 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1407 GENERATE_ECLIPSEHELP = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1408 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1409 # A unique identifier for the Eclipse help plugin. When installing the plugin |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1410 # the directory name containing the HTML and XML files should also have this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1411 # name. Each documentation set should have its own identifier. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1412 # The default value is: org.doxygen.Project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1413 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1414 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1415 ECLIPSE_DOC_ID = org.doxygen.Project |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1416 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1417 # If you want full control over the layout of the generated HTML pages it might |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1418 # be necessary to disable the index and replace it with your own. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1419 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1420 # of each HTML page. A value of NO enables the index and the value YES disables |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1421 # it. Since the tabs in the index contain the same information as the navigation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1422 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1423 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1424 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1425 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1426 DISABLE_INDEX = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1427 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1428 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1429 # structure should be generated to display hierarchical information. If the tag |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1430 # value is set to YES, a side panel will be generated containing a tree-like |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1431 # index structure (just like the one that is generated for HTML Help). For this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1432 # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1433 # (i.e. any modern browser). Windows users are probably better off using the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1434 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1435 # further fine-tune the look of the index. As an example, the default style |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1436 # sheet generated by doxygen has an example that shows how to put an image at |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1437 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1438 # the same information as the tab index, you could consider setting |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1439 # DISABLE_INDEX to YES when enabling this option. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1440 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1441 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1442 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1443 GENERATE_TREEVIEW = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1444 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1445 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1446 # doxygen will group on one line in the generated HTML documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1447 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1448 # Note that a value of 0 will completely suppress the enum values from appearing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1449 # in the overview section. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1450 # Minimum value: 0, maximum value: 20, default value: 4. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1451 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1452 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1453 ENUM_VALUES_PER_LINE = 4 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1454 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1455 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1456 # to set the initial width (in pixels) of the frame in which the tree is shown. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1457 # Minimum value: 0, maximum value: 1500, default value: 250. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1458 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1459 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1460 TREEVIEW_WIDTH = 250 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1461 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1462 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1463 # external symbols imported via tag files in a separate window. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1464 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1465 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1466 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1467 EXT_LINKS_IN_WINDOW = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1468 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1469 # Use this tag to change the font size of LaTeX formulas included as images in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1470 # the HTML documentation. When you change the font size after a successful |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1471 # doxygen run you need to manually remove any form_*.png images from the HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1472 # output directory to force them to be regenerated. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1473 # Minimum value: 8, maximum value: 50, default value: 10. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1474 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1475 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1476 FORMULA_FONTSIZE = 10 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1477 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1478 # Use the FORMULA_TRANPARENT tag to determine whether or not the images |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1479 # generated for formulas are transparent PNGs. Transparent PNGs are not |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1480 # supported properly for IE 6.0, but are supported on all modern browsers. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1481 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1482 # Note that when changing this option you need to delete any form_*.png files in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1483 # the HTML output directory before the changes have effect. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1484 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1485 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1486 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1487 FORMULA_TRANSPARENT = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1488 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1489 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1490 # http://www.mathjax.org) which uses client side Javascript for the rendering |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1491 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1492 # installed or if you want to formulas look prettier in the HTML output. When |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1493 # enabled you may also need to install MathJax separately and configure the path |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1494 # to it using the MATHJAX_RELPATH option. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1495 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1496 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1497 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1498 USE_MATHJAX = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1499 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1500 # When MathJax is enabled you can set the default output format to be used for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1501 # the MathJax output. See the MathJax site (see: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1502 # http://docs.mathjax.org/en/latest/output.html) for more details. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1503 # Possible values are: HTML-CSS (which is slower, but has the best |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1504 # compatibility), NativeMML (i.e. MathML) and SVG. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1505 # The default value is: HTML-CSS. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1506 # This tag requires that the tag USE_MATHJAX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1507 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1508 MATHJAX_FORMAT = HTML-CSS |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1509 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1510 # When MathJax is enabled you need to specify the location relative to the HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1511 # output directory using the MATHJAX_RELPATH option. The destination directory |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1512 # should contain the MathJax.js script. For instance, if the mathjax directory |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1513 # is located at the same level as the HTML output directory, then |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1514 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1515 # Content Delivery Network so you can quickly see the result without installing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1516 # MathJax. However, it is strongly recommended to install a local copy of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1517 # MathJax from http://www.mathjax.org before deployment. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1518 # The default value is: http://cdn.mathjax.org/mathjax/latest. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1519 # This tag requires that the tag USE_MATHJAX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1520 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1521 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1522 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1523 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1524 # extension names that should be enabled during MathJax rendering. For example |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1525 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1526 # This tag requires that the tag USE_MATHJAX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1527 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1528 MATHJAX_EXTENSIONS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1529 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1530 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1531 # of code that will be used on startup of the MathJax code. See the MathJax site |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1532 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1533 # example see the documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1534 # This tag requires that the tag USE_MATHJAX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1535 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1536 MATHJAX_CODEFILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1537 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1538 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1539 # the HTML output. The underlying search engine uses javascript and DHTML and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1540 # should work on any modern browser. Note that when using HTML help |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1541 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1542 # there is already a search function so this one should typically be disabled. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1543 # For large projects the javascript based search engine can be slow, then |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1544 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1545 # search using the keyboard; to jump to the search box use <access key> + S |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1546 # (what the <access key> is depends on the OS and browser, but it is typically |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1547 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1548 # key> to jump into the search results window, the results can be navigated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1549 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1550 # the search. The filter options can be selected when the cursor is inside the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1551 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1552 # to select a filter and <Enter> or <escape> to activate or cancel the filter |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1553 # option. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1554 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1555 # This tag requires that the tag GENERATE_HTML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1556 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1557 SEARCHENGINE = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1558 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1559 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1560 # implemented using a web server instead of a web client using Javascript. There |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1561 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1562 # setting. When disabled, doxygen will generate a PHP script for searching and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1563 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1564 # and searching needs to be provided by external tools. See the section |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1565 # "External Indexing and Searching" for details. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1566 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1567 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1568 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1569 SERVER_BASED_SEARCH = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1570 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1571 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1572 # script for searching. Instead the search results are written to an XML file |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1573 # which needs to be processed by an external indexer. Doxygen will invoke an |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1574 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1575 # search results. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1576 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1577 # Doxygen ships with an example indexer (doxyindexer) and search engine |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1578 # (doxysearch.cgi) which are based on the open source search engine library |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1579 # Xapian (see: http://xapian.org/). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1580 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1581 # See the section "External Indexing and Searching" for details. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1582 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1583 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1584 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1585 EXTERNAL_SEARCH = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1586 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1587 # The SEARCHENGINE_URL should point to a search engine hosted by a web server |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1588 # which will return the search results when EXTERNAL_SEARCH is enabled. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1589 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1590 # Doxygen ships with an example indexer (doxyindexer) and search engine |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1591 # (doxysearch.cgi) which are based on the open source search engine library |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1592 # Xapian (see: http://xapian.org/). See the section "External Indexing and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1593 # Searching" for details. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1594 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1595 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1596 SEARCHENGINE_URL = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1597 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1598 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1599 # search data is written to a file for indexing by an external tool. With the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1600 # SEARCHDATA_FILE tag the name of this file can be specified. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1601 # The default file is: searchdata.xml. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1602 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1603 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1604 SEARCHDATA_FILE = searchdata.xml |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1605 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1606 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1607 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1608 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1609 # projects and redirect the results back to the right project. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1610 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1611 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1612 EXTERNAL_SEARCH_ID = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1613 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1614 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1615 # projects other than the one defined by this configuration file, but that are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1616 # all added to the same external search index. Each project needs to have a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1617 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1618 # to a relative location where the documentation can be found. The format is: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1619 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1620 # This tag requires that the tag SEARCHENGINE is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1621 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1622 EXTRA_SEARCH_MAPPINGS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1623 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1624 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1625 # Configuration options related to the LaTeX output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1626 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1627 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1628 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1629 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1630 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1631 GENERATE_LATEX = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1632 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1633 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1634 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1635 # it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1636 # The default directory is: latex. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1637 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1638 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1639 LATEX_OUTPUT = latex |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1640 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1641 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1642 # invoked. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1643 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1644 # Note that when enabling USE_PDFLATEX this option is only used for generating |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1645 # bitmaps for formulas in the HTML output, but not in the Makefile that is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1646 # written to the output directory. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1647 # The default file is: latex. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1648 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1649 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1650 LATEX_CMD_NAME = latex |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1651 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1652 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1653 # index for LaTeX. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1654 # The default file is: makeindex. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1655 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1656 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1657 MAKEINDEX_CMD_NAME = makeindex |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1658 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1659 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1660 # documents. This may be useful for small projects and may help to save some |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1661 # trees in general. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1662 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1663 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1664 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1665 COMPACT_LATEX = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1666 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1667 # The PAPER_TYPE tag can be used to set the paper type that is used by the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1668 # printer. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1669 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1670 # 14 inches) and executive (7.25 x 10.5 inches). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1671 # The default value is: a4. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1672 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1673 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1674 PAPER_TYPE = a4 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1675 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1676 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1677 # that should be included in the LaTeX output. To get the times font for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1678 # instance you can specify |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1679 # EXTRA_PACKAGES=times |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1680 # If left blank no extra packages will be included. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1681 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1682 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1683 EXTRA_PACKAGES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1684 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1685 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1686 # generated LaTeX document. The header should contain everything until the first |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1687 # chapter. If it is left blank doxygen will generate a standard header. See |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1688 # section "Doxygen usage" for information on how to let doxygen write the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1689 # default header to a separate file. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1690 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1691 # Note: Only use a user-defined header if you know what you are doing! The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1692 # following commands have a special meaning inside the header: $title, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1693 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1694 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1695 # string, for the replacement values of the other commands the user is referred |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1696 # to HTML_HEADER. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1697 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1698 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1699 LATEX_HEADER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1700 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1701 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1702 # generated LaTeX document. The footer should contain everything after the last |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1703 # chapter. If it is left blank doxygen will generate a standard footer. See |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1704 # LATEX_HEADER for more information on how to generate a default footer and what |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1705 # special commands can be used inside the footer. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1706 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1707 # Note: Only use a user-defined footer if you know what you are doing! |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1708 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1709 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1710 LATEX_FOOTER = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1711 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1712 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1713 # LaTeX style sheets that are included after the standard style sheets created |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1714 # by doxygen. Using this option one can overrule certain style aspects. Doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1715 # will copy the style sheet files to the output directory. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1716 # Note: The order of the extra style sheet files is of importance (e.g. the last |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1717 # style sheet in the list overrules the setting of the previous ones in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1718 # list). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1719 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1720 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1721 LATEX_EXTRA_STYLESHEET = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1722 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1723 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1724 # other source files which should be copied to the LATEX_OUTPUT output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1725 # directory. Note that the files will be copied as-is; there are no commands or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1726 # markers available. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1727 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1728 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1729 LATEX_EXTRA_FILES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1730 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1731 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1732 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1733 # contain links (just like the HTML output) instead of page references. This |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1734 # makes the output suitable for online browsing using a PDF viewer. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1735 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1736 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1737 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1738 PDF_HYPERLINKS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1739 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1740 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1741 # the PDF file directly from the LaTeX files. Set this option to YES, to get a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1742 # higher quality PDF documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1743 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1744 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1745 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1746 USE_PDFLATEX = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1747 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1748 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1749 # command to the generated LaTeX files. This will instruct LaTeX to keep running |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1750 # if errors occur, instead of asking the user for help. This option is also used |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1751 # when generating formulas in HTML. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1752 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1753 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1754 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1755 LATEX_BATCHMODE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1756 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1757 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1758 # index chapters (such as File Index, Compound Index, etc.) in the output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1759 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1760 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1761 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1762 LATEX_HIDE_INDICES = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1763 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1764 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1765 # code with syntax highlighting in the LaTeX output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1766 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1767 # Note that which sources are shown also depends on other settings such as |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1768 # SOURCE_BROWSER. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1769 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1770 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1771 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1772 LATEX_SOURCE_CODE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1773 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1774 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1775 # bibliography, e.g. plainnat, or ieeetr. See |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1776 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1777 # The default value is: plain. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1778 # This tag requires that the tag GENERATE_LATEX is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1779 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1780 LATEX_BIB_STYLE = plain |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1781 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1782 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1783 # Configuration options related to the RTF output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1784 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1785 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1786 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1787 # RTF output is optimized for Word 97 and may not look too pretty with other RTF |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1788 # readers/editors. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1789 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1790 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1791 GENERATE_RTF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1792 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1793 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1794 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1795 # it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1796 # The default directory is: rtf. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1797 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1798 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1799 RTF_OUTPUT = rtf |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1800 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1801 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1802 # documents. This may be useful for small projects and may help to save some |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1803 # trees in general. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1804 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1805 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1806 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1807 COMPACT_RTF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1808 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1809 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1810 # contain hyperlink fields. The RTF file will contain links (just like the HTML |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1811 # output) instead of page references. This makes the output suitable for online |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1812 # browsing using Word or some other Word compatible readers that support those |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1813 # fields. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1814 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1815 # Note: WordPad (write) and others do not support links. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1816 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1817 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1818 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1819 RTF_HYPERLINKS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1820 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1821 # Load stylesheet definitions from file. Syntax is similar to doxygen's config |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1822 # file, i.e. a series of assignments. You only have to provide replacements, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1823 # missing definitions are set to their default value. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1824 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1825 # See also section "Doxygen usage" for information on how to generate the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1826 # default style sheet that doxygen normally uses. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1827 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1828 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1829 RTF_STYLESHEET_FILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1830 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1831 # Set optional variables used in the generation of an RTF document. Syntax is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1832 # similar to doxygen's config file. A template extensions file can be generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1833 # using doxygen -e rtf extensionFile. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1834 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1835 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1836 RTF_EXTENSIONS_FILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1837 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1838 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1839 # with syntax highlighting in the RTF output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1840 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1841 # Note that which sources are shown also depends on other settings such as |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1842 # SOURCE_BROWSER. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1843 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1844 # This tag requires that the tag GENERATE_RTF is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1845 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1846 RTF_SOURCE_CODE = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1847 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1848 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1849 # Configuration options related to the man page output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1850 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1851 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1852 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1853 # classes and files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1854 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1855 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1856 GENERATE_MAN = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1857 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1858 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1859 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1860 # it. A directory man3 will be created inside the directory specified by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1861 # MAN_OUTPUT. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1862 # The default directory is: man. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1863 # This tag requires that the tag GENERATE_MAN is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1864 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1865 MAN_OUTPUT = man |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1866 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1867 # The MAN_EXTENSION tag determines the extension that is added to the generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1868 # man pages. In case the manual section does not start with a number, the number |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1869 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1870 # optional. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1871 # The default value is: .3. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1872 # This tag requires that the tag GENERATE_MAN is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1873 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1874 MAN_EXTENSION = .3 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1875 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1876 # The MAN_SUBDIR tag determines the name of the directory created within |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1877 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1878 # MAN_EXTENSION with the initial . removed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1879 # This tag requires that the tag GENERATE_MAN is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1880 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1881 MAN_SUBDIR = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1882 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1883 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1884 # will generate one additional man file for each entity documented in the real |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1885 # man page(s). These additional files only source the real man page, but without |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1886 # them the man command would be unable to find the correct page. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1887 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1888 # This tag requires that the tag GENERATE_MAN is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1889 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1890 MAN_LINKS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1891 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1892 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1893 # Configuration options related to the XML output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1894 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1895 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1896 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1897 # captures the structure of the code including all documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1898 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1899 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1900 GENERATE_XML = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1901 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1902 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1903 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1904 # it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1905 # The default directory is: xml. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1906 # This tag requires that the tag GENERATE_XML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1907 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1908 XML_OUTPUT = xml |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1909 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1910 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1911 # listings (including syntax highlighting and cross-referencing information) to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1912 # the XML output. Note that enabling this will significantly increase the size |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1913 # of the XML output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1914 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1915 # This tag requires that the tag GENERATE_XML is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1916 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1917 XML_PROGRAMLISTING = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1918 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1919 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1920 # Configuration options related to the DOCBOOK output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1921 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1922 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1923 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1924 # that can be used to generate PDF. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1925 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1926 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1927 GENERATE_DOCBOOK = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1928 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1929 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1930 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1931 # front of it. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1932 # The default directory is: docbook. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1933 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1934 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1935 DOCBOOK_OUTPUT = docbook |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1936 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1937 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1938 # program listings (including syntax highlighting and cross-referencing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1939 # information) to the DOCBOOK output. Note that enabling this will significantly |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1940 # increase the size of the DOCBOOK output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1941 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1942 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1943 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1944 DOCBOOK_PROGRAMLISTING = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1945 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1946 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1947 # Configuration options for the AutoGen Definitions output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1948 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1949 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1950 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1951 # AutoGen Definitions (see http://autogen.sf.net) file that captures the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1952 # structure of the code including all documentation. Note that this feature is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1953 # still experimental and incomplete at the moment. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1954 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1955 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1956 GENERATE_AUTOGEN_DEF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1957 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1958 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1959 # Configuration options related to the Perl module output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1960 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1961 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1962 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1963 # file that captures the structure of the code including all documentation. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1964 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1965 # Note that this feature is still experimental and incomplete at the moment. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1966 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1967 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1968 GENERATE_PERLMOD = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1969 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1970 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1971 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1972 # output from the Perl module output. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1973 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1974 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1975 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1976 PERLMOD_LATEX = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1977 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1978 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1979 # formatted so it can be parsed by a human reader. This is useful if you want to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1980 # understand what is going on. On the other hand, if this tag is set to NO, the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1981 # size of the Perl module output will be much smaller and Perl will parse it |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1982 # just the same. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1983 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1984 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1985 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1986 PERLMOD_PRETTY = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1987 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1988 # The names of the make variables in the generated doxyrules.make file are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1989 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1990 # so different doxyrules.make files included by the same Makefile don't |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1991 # overwrite each other's variables. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1992 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1993 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1994 PERLMOD_MAKEVAR_PREFIX = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1995 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1996 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1997 # Configuration options related to the preprocessor |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1998 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
1999 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2000 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2001 # C-preprocessor directives found in the sources and include files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2002 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2003 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2004 ENABLE_PREPROCESSING = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2005 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2006 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2007 # in the source code. If set to NO, only conditional compilation will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2008 # performed. Macro expansion can be done in a controlled way by setting |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2009 # EXPAND_ONLY_PREDEF to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2010 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2011 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2012 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2013 MACRO_EXPANSION = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2014 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2015 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2016 # the macro expansion is limited to the macros specified with the PREDEFINED and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2017 # EXPAND_AS_DEFINED tags. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2018 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2019 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2020 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2021 EXPAND_ONLY_PREDEF = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2022 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2023 # If the SEARCH_INCLUDES tag is set to YES, the include files in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2024 # INCLUDE_PATH will be searched if a #include is found. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2025 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2026 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2027 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2028 SEARCH_INCLUDES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2029 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2030 # The INCLUDE_PATH tag can be used to specify one or more directories that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2031 # contain include files that are not input files but should be processed by the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2032 # preprocessor. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2033 # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2034 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2035 INCLUDE_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2036 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2037 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2038 # patterns (like *.h and *.hpp) to filter out the header-files in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2039 # directories. If left blank, the patterns specified with FILE_PATTERNS will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2040 # used. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2041 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2042 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2043 INCLUDE_FILE_PATTERNS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2044 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2045 # The PREDEFINED tag can be used to specify one or more macro names that are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2046 # defined before the preprocessor is started (similar to the -D option of e.g. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2047 # gcc). The argument of the tag is a list of macros of the form: name or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2048 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2049 # is assumed. To prevent a macro definition from being undefined via #undef or |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2050 # recursively expanded use the := operator instead of the = operator. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2051 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2052 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2053 PREDEFINED = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2054 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2055 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2056 # tag can be used to specify a list of macro names that should be expanded. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2057 # macro definition that is found in the sources will be used. Use the PREDEFINED |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2058 # tag if you want to use a different macro definition that overrules the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2059 # definition found in the source code. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2060 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2061 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2062 EXPAND_AS_DEFINED = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2063 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2064 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2065 # remove all references to function-like macros that are alone on a line, have |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2066 # an all uppercase name, and do not end with a semicolon. Such function macros |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2067 # are typically used for boiler-plate code, and will confuse the parser if not |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2068 # removed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2069 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2070 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2071 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2072 SKIP_FUNCTION_MACROS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2073 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2074 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2075 # Configuration options related to external references |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2076 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2077 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2078 # The TAGFILES tag can be used to specify one or more tag files. For each tag |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2079 # file the location of the external documentation should be added. The format of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2080 # a tag file without this location is as follows: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2081 # TAGFILES = file1 file2 ... |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2082 # Adding location for the tag files is done as follows: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2083 # TAGFILES = file1=loc1 "file2 = loc2" ... |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2084 # where loc1 and loc2 can be relative or absolute paths or URLs. See the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2085 # section "Linking to external documentation" for more information about the use |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2086 # of tag files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2087 # Note: Each tag file must have a unique name (where the name does NOT include |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2088 # the path). If a tag file is not located in the directory in which doxygen is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2089 # run, you must also specify the path to the tagfile here. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2090 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2091 TAGFILES = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2092 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2093 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2094 # tag file that is based on the input files it reads. See section "Linking to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2095 # external documentation" for more information about the usage of tag files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2096 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2097 GENERATE_TAGFILE = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2098 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2099 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2100 # the class index. If set to NO, only the inherited external classes will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2101 # listed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2102 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2103 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2104 ALLEXTERNALS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2105 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2106 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2107 # in the modules index. If set to NO, only the current project's groups will be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2108 # listed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2109 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2110 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2111 EXTERNAL_GROUPS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2112 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2113 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2114 # the related pages index. If set to NO, only the current project's pages will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2115 # be listed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2116 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2117 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2118 EXTERNAL_PAGES = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2119 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2120 # The PERL_PATH should be the absolute path and name of the perl script |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2121 # interpreter (i.e. the result of 'which perl'). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2122 # The default file (with absolute path) is: /usr/bin/perl. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2123 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2124 PERL_PATH = /usr/bin/perl |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2125 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2126 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2127 # Configuration options related to the dot tool |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2128 #--------------------------------------------------------------------------- |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2129 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2130 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2131 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2132 # NO turns the diagrams off. Note that this option also works with HAVE_DOT |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2133 # disabled, but it is recommended to install and use dot, since it yields more |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2134 # powerful graphs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2135 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2136 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2137 CLASS_DIAGRAMS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2138 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2139 # You can define message sequence charts within doxygen comments using the \msc |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2140 # command. Doxygen will then run the mscgen tool (see: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2141 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2142 # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2143 # the mscgen tool resides. If left empty the tool is assumed to be found in the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2144 # default search path. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2145 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2146 MSCGEN_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2147 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2148 # You can include diagrams made with dia in doxygen documentation. Doxygen will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2149 # then run dia to produce the diagram and insert it in the documentation. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2150 # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2151 # If left empty dia is assumed to be found in the default search path. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2152 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2153 DIA_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2154 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2155 # If set to YES the inheritance and collaboration graphs will hide inheritance |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2156 # and usage relations if the target is undocumented or is not a class. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2157 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2158 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2159 HIDE_UNDOC_RELATIONS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2160 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2161 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2162 # available from the path. This tool is part of Graphviz (see: |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2163 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2164 # Bell Labs. The other options in this section have no effect if this option is |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2165 # set to NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2166 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2167 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2168 HAVE_DOT = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2169 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2170 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2171 # to run in parallel. When set to 0 doxygen will base this on the number of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2172 # processors available in the system. You can set it explicitly to a value |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2173 # larger than 0 to get control over the balance between CPU load and processing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2174 # speed. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2175 # Minimum value: 0, maximum value: 32, default value: 0. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2176 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2177 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2178 DOT_NUM_THREADS = 0 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2179 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2180 # When you want a differently looking font in the dot files that doxygen |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2181 # generates you can specify the font name using DOT_FONTNAME. You need to make |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2182 # sure dot is able to find the font, which can be done by putting it in a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2183 # standard location or by setting the DOTFONTPATH environment variable or by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2184 # setting DOT_FONTPATH to the directory containing the font. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2185 # The default value is: Helvetica. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2186 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2187 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2188 DOT_FONTNAME = Helvetica |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2189 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2190 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2191 # dot graphs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2192 # Minimum value: 4, maximum value: 24, default value: 10. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2193 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2194 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2195 DOT_FONTSIZE = 10 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2196 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2197 # By default doxygen will tell dot to use the default font as specified with |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2198 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2199 # the path where dot can find it using this tag. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2200 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2201 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2202 DOT_FONTPATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2203 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2204 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2205 # each documented class showing the direct and indirect inheritance relations. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2206 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2207 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2208 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2209 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2210 CLASS_GRAPH = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2211 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2212 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2213 # graph for each documented class showing the direct and indirect implementation |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2214 # dependencies (inheritance, containment, and class references variables) of the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2215 # class with other documented classes. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2216 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2217 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2218 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2219 COLLABORATION_GRAPH = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2220 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2221 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2222 # groups, showing the direct groups dependencies. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2223 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2224 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2225 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2226 GROUP_GRAPHS = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2227 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2228 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2229 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2230 # Language. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2231 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2232 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2233 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2234 UML_LOOK = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2235 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2236 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2237 # class node. If there are many fields or methods and many nodes the graph may |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2238 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2239 # number of items for each type to make the size more manageable. Set this to 0 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2240 # for no limit. Note that the threshold may be exceeded by 50% before the limit |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2241 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2242 # but if the number exceeds 15, the total amount of fields shown is limited to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2243 # 10. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2244 # Minimum value: 0, maximum value: 100, default value: 10. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2245 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2246 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2247 UML_LIMIT_NUM_FIELDS = 10 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2248 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2249 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2250 # collaboration graphs will show the relations between templates and their |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2251 # instances. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2252 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2253 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2254 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2255 TEMPLATE_RELATIONS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2256 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2257 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2258 # YES then doxygen will generate a graph for each documented file showing the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2259 # direct and indirect include dependencies of the file with other documented |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2260 # files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2261 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2262 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2263 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2264 INCLUDE_GRAPH = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2265 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2266 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2267 # set to YES then doxygen will generate a graph for each documented file showing |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2268 # the direct and indirect include dependencies of the file with other documented |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2269 # files. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2270 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2271 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2272 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2273 INCLUDED_BY_GRAPH = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2274 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2275 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2276 # dependency graph for every global function or class method. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2277 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2278 # Note that enabling this option will significantly increase the time of a run. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2279 # So in most cases it will be better to enable call graphs for selected |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2280 # functions only using the \callgraph command. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2281 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2282 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2283 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2284 CALL_GRAPH = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2285 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2286 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2287 # dependency graph for every global function or class method. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2288 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2289 # Note that enabling this option will significantly increase the time of a run. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2290 # So in most cases it will be better to enable caller graphs for selected |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2291 # functions only using the \callergraph command. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2292 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2293 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2294 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2295 CALLER_GRAPH = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2296 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2297 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2298 # hierarchy of all classes instead of a textual one. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2299 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2300 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2301 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2302 GRAPHICAL_HIERARCHY = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2303 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2304 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2305 # dependencies a directory has on other directories in a graphical way. The |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2306 # dependency relations are determined by the #include relations between the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2307 # files in the directories. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2308 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2309 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2310 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2311 DIRECTORY_GRAPH = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2312 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2313 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2314 # generated by dot. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2315 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2316 # to make the SVG files visible in IE 9+ (other browsers do not have this |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2317 # requirement). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2318 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2319 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2320 # gif:cairo:gd, gif:gd, gif:gd:gd and svg. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2321 # The default value is: png. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2322 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2323 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2324 DOT_IMAGE_FORMAT = png |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2325 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2326 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2327 # enable generation of interactive SVG images that allow zooming and panning. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2328 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2329 # Note that this requires a modern browser other than Internet Explorer. Tested |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2330 # and working are Firefox, Chrome, Safari, and Opera. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2331 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2332 # the SVG files visible. Older versions of IE do not have SVG support. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2333 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2334 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2335 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2336 INTERACTIVE_SVG = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2337 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2338 # The DOT_PATH tag can be used to specify the path where the dot tool can be |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2339 # found. If left blank, it is assumed the dot tool can be found in the path. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2340 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2341 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2342 DOT_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2343 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2344 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2345 # contain dot files that are included in the documentation (see the \dotfile |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2346 # command). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2347 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2348 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2349 DOTFILE_DIRS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2350 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2351 # The MSCFILE_DIRS tag can be used to specify one or more directories that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2352 # contain msc files that are included in the documentation (see the \mscfile |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2353 # command). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2354 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2355 MSCFILE_DIRS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2356 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2357 # The DIAFILE_DIRS tag can be used to specify one or more directories that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2358 # contain dia files that are included in the documentation (see the \diafile |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2359 # command). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2360 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2361 DIAFILE_DIRS = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2362 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2363 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2364 # path where java can find the plantuml.jar file. If left blank, it is assumed |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2365 # PlantUML is not used or called during a preprocessing step. Doxygen will |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2366 # generate a warning when it encounters a \startuml command in this case and |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2367 # will not generate output for the diagram. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2368 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2369 PLANTUML_JAR_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2370 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2371 # When using plantuml, the specified paths are searched for files specified by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2372 # the !include statement in a plantuml block. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2373 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2374 PLANTUML_INCLUDE_PATH = |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2375 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2376 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2377 # that will be shown in the graph. If the number of nodes in a graph becomes |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2378 # larger than this value, doxygen will truncate the graph, which is visualized |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2379 # by representing a node as a red box. Note that doxygen if the number of direct |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2380 # children of the root node in a graph is already larger than |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2381 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2382 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2383 # Minimum value: 0, maximum value: 10000, default value: 50. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2384 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2385 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2386 DOT_GRAPH_MAX_NODES = 50 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2387 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2388 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2389 # generated by dot. A depth value of 3 means that only nodes reachable from the |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2390 # root by following a path via at most 3 edges will be shown. Nodes that lay |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2391 # further from the root node will be omitted. Note that setting this option to 1 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2392 # or 2 may greatly reduce the computation time needed for large code bases. Also |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2393 # note that the size of a graph can be further restricted by |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2394 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2395 # Minimum value: 0, maximum value: 1000, default value: 0. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2396 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2397 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2398 MAX_DOT_GRAPH_DEPTH = 0 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2399 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2400 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2401 # background. This is disabled by default, because dot on Windows does not seem |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2402 # to support this out of the box. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2403 # |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2404 # Warning: Depending on the platform used, enabling this option may lead to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2405 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2406 # read). |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2407 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2408 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2409 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2410 DOT_TRANSPARENT = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2411 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2412 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2413 # files in one run (i.e. multiple -o and -T options on the command line). This |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2414 # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2415 # this, this feature is disabled by default. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2416 # The default value is: NO. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2417 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2418 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2419 DOT_MULTI_TARGETS = NO |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2420 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2421 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2422 # explaining the meaning of the various boxes and arrows in the dot generated |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2423 # graphs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2424 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2425 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2426 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2427 GENERATE_LEGEND = YES |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2428 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2429 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2430 # files that are used to generate the various graphs. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2431 # The default value is: YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2432 # This tag requires that the tag HAVE_DOT is set to YES. |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2433 |
a7d597726985
doc: doxygen config file and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff
changeset
|
2434 DOT_CLEANUP = YES |