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