Skip to content

Commit a2747f8

Browse files
committed
Merge branch 'master' of github.com:doxygen/doxygen
2 parents 4be478c + be52e91 commit a2747f8

18 files changed

Lines changed: 36 additions & 51 deletions

addon/doxywizard/expert.cpp

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -856,16 +856,9 @@ QString Expert::getDocsForNode(const QDomElement &child) const
856856
{
857857
if (!docs.endsWith(SA("<br/>"))) docs += SA("<br/>");
858858
docs+=SA("<br/>");
859-
if (child.hasAttribute(SA("altdefval")))
860-
{
861-
docs+=SA(" ")+m_messages[SA("defsysdep")];
862-
}
863-
else
864-
{
865-
QString defval = child.attribute(SA("defval"));
866-
QString valStr = (defval==SA("1")?SA("YES"):SA("NO"));
867-
docs+=SA(" ")+m_messages[SA("defvalcode")].arg(valStr);
868-
}
859+
QString defval = child.attribute(SA("defval"));
860+
QString valStr = (defval==SA("1")?SA("YES"):SA("NO"));
861+
docs+=SA(" ")+m_messages[SA("defvalcode")].arg(valStr);
869862
}
870863
else if (type==SA("list"))
871864
{

doc/CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,11 @@ set(DOC_FILES
7676
doxygen_manual_chm.css
7777
doxygen_usage.dox
7878
doxywizard_expert.png
79+
doxywizard_expert_search.png
7980
doxywizard_main.png
8081
doxywizard_menu_file.png
8182
doxywizard_menu_settings.png
83+
doxywizard_language.png
8284
doxywizard_menu_help.png
8385
doxywizard_page1.png
8486
doxywizard_page2.png

doc/doxywizard_expert.png

11.6 KB
Loading

doc/doxywizard_expert_search.png

968 Bytes
Loading

doc/doxywizard_language.png

9.31 KB
Loading

doc/doxywizard_menu_settings.png

-101 KB
Loading

doc/doxywizard_usage.dox

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,21 +130,34 @@ is needed. This needs to be installed separately.
130130

131131
The Expert tab is divided into a number of panes:
132132
<dl>
133-
<dt>Top left pane<dd>The Topics pane (i.e. sections in the
133+
<dt>Top pane<dd>The search input field
134+
<dt>Bottom left pane<dd>The Topics pane (i.e. sections in the
134135
configuration file) that are available. By clicking on a topic the
135-
corresponding settings will appear in the Right pane.
136-
<dt>Bottom left pane<dd>The help pane, this will be updated when one
137-
hovers over the name of a setting in the Right pane.
138-
<dt>Right pane<dd>The Settings pane, in this pane you will find the
139-
settings that are available for the selected topic. In case the name for a setting is colored
140-
red, the setting has a non-default value.
136+
corresponding settings will appear in the Bottom right pane. Each topic has a small tooltip
137+
with a small description.
138+
<dt>Bottom right pane<dd>The Settings pane, in this pane you will find the
139+
settings that are available for the selected topic / selected search. In case the name
140+
for a setting is colored red, the setting has a non-default value.
141141
In case a setting is grayed out, the setting is depending on another setting that is disabled.
142-
Which setting it depends on is indicated in the help pane on the bottom left.
142+
Which setting it depends on is indicated in the help information (below the setting or in case
143+
when "Hide documentation" s set in the tooltip of the settingo).
143144
</dl>
144145

146+
147+
Overview:
145148
\image html doxywizard_expert.png "Some options from the Expert tab"
146149
\image latex doxywizard_expert.png "Some options from the Expert tab" width=15cm
147150

151+
The search field:
152+
\image html doxywizard_expert_search.png "Search input field"
153+
\image latex doxywizard_expert_search.png "Search input field" width=15cm
154+
155+
The text entered in this field is searched in the name of the settings and in the documentation
156+
of the settings, only the settings that match the search text will will be shown in the bottom left pane
157+
and in the bottom right pane. In the bottom right pane the found text will be highlighted (in case of
158+
"Hide documentation" set the highlighting will take place in the tooltip.
159+
160+
148161
The representation of the input field depends on the type of the configuration option.
149162
<ul>
150163
<li>For each boolean option (those options that are answered with `YES` or
@@ -278,6 +291,13 @@ The file menu with a couple of useful items for loading and saving settings.
278291
<dt>Use current settings at startup<dd>Stores the current configuration settings as the
279292
default to use next time the GUI is started. You will be asked to
280293
confirm the action.
294+
<dt>Hide documentation<dd>When set a check-mark appears in front of the setting and in the bottom right panel
295+
of the expert tab the documentation is not shown but shown as a toltip.
296+
<dt>Language<dd>Select the language in which the items in the doxywizard will be shown. A new window will appear
297+
with the supported languages:<br>
298+
\image html doxywizard_menu_settings.png "Language selection window"
299+
\image latex doxywizard_language.png "Language selection window" width=6.7cm
300+
Note: changing the language will automatically restart the application.
281301
<dt>Clear recent list<dd>Clears the "Open recent" list in the \ref dw_menu_file. This menu
282302
item is only accessible when there are recent files in the "Open recent" list.
283303
<dt>Run Doxygen<dd>Selecting this item is identical to switching to the \ref dw_run "Run" tab,

src/config.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4434,8 +4434,6 @@ This setting is not only used for dot files but also for msc temporary files.
44344434
<message name='possible'><![CDATA[Possible values are: ]]></message>
44354435
<message name='defvaltxt'><![CDATA[The default value is: {0}.]]></message>
44364436
<message name='defvalcode'><![CDATA[The default value is: <code>{0}</code>.]]></message>
4437-
<message name='defsysdep'><![CDATA[The default value is: system dependent]]></message>
4438-
<message name='sysdep'><![CDATA[system dependent]]></message>
44394437
<message name='defdir'><![CDATA[The default directory is: <code>{0}</code>.]]></message>
44404438
<message name='deffile'><![CDATA[The default file is: <code>{0}</code>.]]></message>
44414439
<message name='deffileabs'><![CDATA[The default file (with absolute path) is <code>{0}</code>]]></message>

src/configgen.py

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,6 @@ def prepCDocs(node):
165165
type = node.getAttribute('type')
166166
format = node.getAttribute('format')
167167
defval = node.getAttribute('defval')
168-
#adefval = node.getAttribute('altdefval')
169168
doc = ""
170169
if (type != 'obsolete'):
171170
for n in node.childNodes:
@@ -192,10 +191,7 @@ def prepCDocs(node):
192191
maxval = node.getAttribute('maxval')
193192
doc += "<br/>" + messages['minmaxdef'].format(minval, maxval, defval)
194193
elif (type == 'bool'):
195-
if (node.hasAttribute('altdefval')):
196-
doc += "<br/>" + messages['defvaltxt'].format(messages['sysdep'])
197-
else:
198-
doc += "<br/>" + messages['defvaltxt'].format("YES" if (defval == "1") else "NO")
194+
doc += "<br/>" + messages['defvaltxt'].format("YES" if (defval == "1") else "NO")
199195
elif (type == 'list'):
200196
if format == 'string':
201197
values = collectValues(node)
@@ -252,7 +248,6 @@ def parseOption(node):
252248
type = node.getAttribute('type')
253249
format = node.getAttribute('format')
254250
defval = node.getAttribute('defval')
255-
adefval = node.getAttribute('altdefval')
256251
depends = node.getAttribute('depends')
257252
setting = node.getAttribute('setting')
258253
orgtype = node.getAttribute('orgtype')
@@ -261,9 +256,7 @@ def parseOption(node):
261256
print("#if %s" % (setting))
262257
print(" //----")
263258
if type == 'bool':
264-
if len(adefval) > 0:
265-
enabled = adefval
266-
elif defval == '1':
259+
if defval == '1':
267260
enabled = "TRUE"
268261
else:
269262
enabled = "FALSE"
@@ -559,7 +552,6 @@ def parseOptionDoc(node, first):
559552
type = node.getAttribute('type')
560553
format = node.getAttribute('format')
561554
defval = node.getAttribute('defval')
562-
#adefval = node.getAttribute('altdefval')
563555
depends = node.getAttribute('depends')
564556
#setting = node.getAttribute('setting')
565557
doc = ""
@@ -607,10 +599,7 @@ def parseOptionDoc(node, first):
607599
elif (type == 'bool'):
608600
print("")
609601
print("")
610-
if (node.hasAttribute('altdefval')):
611-
print(messages['defvaltxt'].format(messages['sysdep']))
612-
else:
613-
print(messages['defvalcode'].format("YES" if (defval == "1") else "NO"))
602+
print(messages['defvalcode'].format("YES" if (defval == "1") else "NO"))
614603
print("")
615604
elif (type == 'list'):
616605
if format == 'string':

src/i18n/config_de.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1830,8 +1830,6 @@
18301830
<message name="possible"><![CDATA[Mögliche Werte sind: ]]></message>
18311831
<message name="defvaltxt"><![CDATA[Der Standardwert ist: {0}.]]></message>
18321832
<message name="defvalcode"><![CDATA[Der Standardwert ist: <code>{0}</code>.]]></message>
1833-
<message name="defsysdep"><![CDATA[Der Standardwert ist: systemabhängig.]]></message>
1834-
<message name="sysdep"><![CDATA[systemabhängig]]></message>
18351833
<message name="defdir"><![CDATA[Das Standardverzeichnis ist: <code>{0}</code>.]]></message>
18361834
<message name="deffile"><![CDATA[Die Standarddatei ist: <code>{0}</code>.]]></message>
18371835
<message name="deffileabs"><![CDATA[Die Standarddatei (mit absolutem Pfad) ist: <code>{0}</code>.]]></message>

0 commit comments

Comments
 (0)