Skip to content

Commit afa5849

Browse files
committed
Doxywizard documentation update
Small update of the doxywizard documentation in respect to the new possibilities - updating existing images - adding new images for the new features - adjusting / adding documentation
1 parent bc44814 commit afa5849

6 files changed

Lines changed: 30 additions & 8 deletions

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 Botom right pane. Each topic has a small tooltip
137+
with a smal 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 setings that match the search text will will be shown in the botom left pane
157+
and in the botytom 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,

0 commit comments

Comments
 (0)