summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/CMakeLists.txt37
-rw-r--r--doc/Doxyfile3
-rw-r--r--[-rwxr-xr-x]doc/changelog.doc0
-rw-r--r--doc/doxywizard.gifbin18928 -> 0 bytes
-rw-r--r--doc/doxywizard_expert.pngbin24299 -> 38516 bytes
-rw-r--r--doc/doxywizard_main.pngbin39432 -> 24624 bytes
-rw-r--r--doc/doxywizard_menu.pngbin46176 -> 0 bytes
-rw-r--r--doc/doxywizard_menu_file.pngbin0 -> 5242 bytes
-rw-r--r--doc/doxywizard_menu_help.pngbin0 -> 2035 bytes
-rw-r--r--doc/doxywizard_menu_settings.pngbin0 -> 2903 bytes
-rw-r--r--doc/doxywizard_page1.pngbin29943 -> 23796 bytes
-rw-r--r--doc/doxywizard_page2.pngbin29907 -> 26879 bytes
-rw-r--r--doc/doxywizard_page3.pngbin38861 -> 25940 bytes
-rw-r--r--doc/doxywizard_page4.pngbin33348 -> 24864 bytes
-rw-r--r--doc/doxywizard_run.pngbin0 -> 16756 bytes
-rw-r--r--doc/doxywizard_usage.doc318
-rw-r--r--doc/expert_bool.pngbin0 -> 753 bytes
-rw-r--r--doc/expert_enum.pngbin0 -> 1126 bytes
-rw-r--r--doc/expert_int.pngbin0 -> 988 bytes
-rw-r--r--doc/expert_list_dir.pngbin0 -> 3674 bytes
-rw-r--r--doc/expert_list_file.pngbin0 -> 3956 bytes
-rw-r--r--doc/expert_list_filedir.pngbin0 -> 4295 bytes
-rw-r--r--doc/expert_list_string.pngbin0 -> 4585 bytes
-rw-r--r--doc/expert_string_dir.pngbin0 -> 2196 bytes
-rw-r--r--doc/expert_string_file.pngbin0 -> 2167 bytes
-rw-r--r--doc/expert_string_image.pngbin0 -> 3193 bytes
-rw-r--r--doc/expert_string_string.pngbin0 -> 1458 bytes
-rw-r--r--doc/manual.sty8
28 files changed, 271 insertions, 95 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index adde05e..f2d177e 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -44,14 +44,27 @@ set(DOC_FILES
doxygen_manual.css
doxygen_usage.doc
doxywizard_expert.png
- doxywizard.gif
doxywizard_main.png
- doxywizard_menu.png
+ doxywizard_menu_file.png
+ doxywizard_menu_settings.png
+ doxywizard_menu_help.png
doxywizard_page1.png
doxywizard_page2.png
doxywizard_page3.png
doxywizard_page4.png
+ doxywizard_run.png
doxywizard_usage.doc
+ expert_bool.png
+ expert_enum.png
+ expert_int.png
+ expert_list_dir.png
+ expert_list_file.png
+ expert_list_filedir.png
+ expert_list_string.png
+ expert_string_dir.png
+ expert_string_file.png
+ expert_string_image.png
+ expert_string_string.png
external.doc
extsearch.doc
extsearch_flow.dot
@@ -88,6 +101,14 @@ set(DOC_FILES
doxygen_logo.svg
)
+set(DOC_FILES_IMAGES
+ add.png
+ del.png
+ file.png
+ folder.png
+ refresh.png
+)
+
if (build_doc_chm)
set(DOC_FILES_CHM
Doxyfile_chm
@@ -103,7 +124,8 @@ endif()
file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/man
${PROJECT_BINARY_DIR}/src
- ${PROJECT_BINARY_DIR}/doc)
+ ${PROJECT_BINARY_DIR}/doc
+ ${PROJECT_BINARY_DIR}/doc/images)
foreach (f ${DOC_FILES})
add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/doc/${f}
@@ -114,6 +136,15 @@ set_source_files_properties(${PROJECT_BINARY_DIR}/doc/${f} PROPERTIES GENERATED
list(APPEND OUT_DOC_FILES "${PROJECT_BINARY_DIR}/doc/${f}")
endforeach()
+foreach (f ${DOC_FILES_IMAGES})
+add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/doc/images/${f}
+ COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/addon/doxywizard/images/${f} ${PROJECT_BINARY_DIR}/doc/images/
+ DEPENDS ${PROJECT_SOURCE_DIR}/addon/doxywizard/images/${f}
+ )
+set_source_files_properties(${PROJECT_BINARY_DIR}/doc/images/${f} PROPERTIES GENERATED 1)
+list(APPEND OUT_DOC_FILES "${PROJECT_BINARY_DIR}/doc/images/${f}")
+endforeach()
+
foreach (f ${DOC_FILES_CHM})
add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/doc/${f}
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/doc/${f} ${PROJECT_BINARY_DIR}/doc/
diff --git a/doc/Doxyfile b/doc/Doxyfile
index dd67958..bd4a11f 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -32,7 +32,7 @@ HTML_COLORSTYLE_SAT = 0
ENABLED_SECTIONS = logo_on
ENABLE_PREPROCESSING = NO
CASE_SENSE_NAMES = NO
-IMAGE_PATH = .
+IMAGE_PATH = . images
INPUT = index.doc install.doc starting.doc docblocks.doc markdown.doc \
lists.doc grouping.doc formulas.doc tables.doc diagrams.doc preprocessing.doc \
autolink.doc output.doc searching.doc extsearch.doc customize.doc custcmd.doc \
@@ -53,6 +53,7 @@ HTML_STYLESHEET = doxygen_manual.css
HTML_EXTRA_FILES = doxygen_logo.svg
ALIASES = LaTeX="\f$\mbox{\LaTeX}\f$"
ALIASES += TeX="\f$\mbox{\TeX}\f$"
+ALIASES += forceNewPage="\latexonly \newpage \endlatexonly"
LATEX_BATCHMODE = YES
LATEX_EXTRA_STYLESHEET = manual.sty
LATEX_EMOJI_DIRECTORY = ../doc
diff --git a/doc/changelog.doc b/doc/changelog.doc
index b5ea41a..b5ea41a 100755..100644
--- a/doc/changelog.doc
+++ b/doc/changelog.doc
diff --git a/doc/doxywizard.gif b/doc/doxywizard.gif
deleted file mode 100644
index 80bb636..0000000
--- a/doc/doxywizard.gif
+++ /dev/null
Binary files differ
diff --git a/doc/doxywizard_expert.png b/doc/doxywizard_expert.png
index 5eb14d4..d07152f 100644
--- a/doc/doxywizard_expert.png
+++ b/doc/doxywizard_expert.png
Binary files differ
diff --git a/doc/doxywizard_main.png b/doc/doxywizard_main.png
index b170e15..1c4ee1b 100644
--- a/doc/doxywizard_main.png
+++ b/doc/doxywizard_main.png
Binary files differ
diff --git a/doc/doxywizard_menu.png b/doc/doxywizard_menu.png
deleted file mode 100644
index 7f37192..0000000
--- a/doc/doxywizard_menu.png
+++ /dev/null
Binary files differ
diff --git a/doc/doxywizard_menu_file.png b/doc/doxywizard_menu_file.png
new file mode 100644
index 0000000..e3c6092
--- /dev/null
+++ b/doc/doxywizard_menu_file.png
Binary files differ
diff --git a/doc/doxywizard_menu_help.png b/doc/doxywizard_menu_help.png
new file mode 100644
index 0000000..4d6812b
--- /dev/null
+++ b/doc/doxywizard_menu_help.png
Binary files differ
diff --git a/doc/doxywizard_menu_settings.png b/doc/doxywizard_menu_settings.png
new file mode 100644
index 0000000..c22e361
--- /dev/null
+++ b/doc/doxywizard_menu_settings.png
Binary files differ
diff --git a/doc/doxywizard_page1.png b/doc/doxywizard_page1.png
index 3e008d0..7834573 100644
--- a/doc/doxywizard_page1.png
+++ b/doc/doxywizard_page1.png
Binary files differ
diff --git a/doc/doxywizard_page2.png b/doc/doxywizard_page2.png
index 8343902..ec5ce51 100644
--- a/doc/doxywizard_page2.png
+++ b/doc/doxywizard_page2.png
Binary files differ
diff --git a/doc/doxywizard_page3.png b/doc/doxywizard_page3.png
index 0201981..dff15e7 100644
--- a/doc/doxywizard_page3.png
+++ b/doc/doxywizard_page3.png
Binary files differ
diff --git a/doc/doxywizard_page4.png b/doc/doxywizard_page4.png
index 1068e6c..8378a5c 100644
--- a/doc/doxywizard_page4.png
+++ b/doc/doxywizard_page4.png
Binary files differ
diff --git a/doc/doxywizard_run.png b/doc/doxywizard_run.png
new file mode 100644
index 0000000..156fc9d
--- /dev/null
+++ b/doc/doxywizard_run.png
Binary files differ
diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc
index 310c358..8b9e428 100644
--- a/doc/doxywizard_usage.doc
+++ b/doc/doxywizard_usage.doc
@@ -1,12 +1,10 @@
/******************************************************************************
*
- *
- *
- * Copyright (C) 1997-2015 by Dimitri van Heesch.
+ * Copyright (C) 1997-2020 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -16,134 +14,272 @@
*/
/*! \page doxywizard_usage Doxywizard usage
-Doxywizard is a GUI front-end for configuring and running doxygen.
+Doxywizard is a GUI front-end for configuring and running doxygen.
-Note it is possible to start the doxywizard with as argument the configuration file to be used.
+When starting doxywizard one can specify an existing configuration file to use as argument,
+otherwise the default settings will be used as a starting point.
-When you start doxywizard it will display the main window
-(the actual look depends on the OS used).
+When you start doxywizard it will display the main window
+(the actual look depends on the platform used).
\image html doxywizard_main.png "Main window"
\image latex doxywizard_main.png "Main window" width=15cm
-The windows shows the steps to take to configure and run doxygen.
-The first step is to choose one of the ways to configure doxygen.
+The user interface consists of the following sections:
<dl>
-<dt>Wizard<dd>Click this button to quickly configure the most important
- settings and leave the rest of the options to their defaults.
-<dt>Expert<dd>Click this button to gain access to the
- \ref config "full range of configuration options".
-<dt>Load<dd>Click this button to load an existing configuration file
- from disk.
+<dt>\ref dw_menu
+<dd> In the menu bar the following parts are available:
+\ref dw_menu_file, \ref dw_menu_settings and \ref dw_menu_help.
+
+<dt>Specify the working directory from which doxygen will run
+<dd>
+Using the <tt>Select...</tt> button a directory can be selected.
+When doxywizard is started with a configuration file or one is loaded using the open command
+(see: \ref dw_menu_file) the directory of this settings file used as the working directory.
+
+<dt>Configure doxygen using the Wizard and/or Expert tab...
+<dd>
+ <dl>
+ <dt>\ref dw_wizard <dd>with this tab it is possible to quickly configure the most
+ important settings and leave the rest of the options to
+ their defaults.
+ <dt>\ref dw_expert <dd>with this tab one gains access to the \ref config
+ "full set of configuration options".
+ <dt>\ref dw_run <dd>with this tab it is possible to run doxygen and view the used settings.
+ </dl>
+
+Switching between these tabs is possible, e.g you could start with the wizard tab
+and then fine tune some settings by switching to the expert tab.
+
</dl>
-Note that you can select multiple buttons in a row, for instance to first
-configure doxygen using the Wizard and then fine tune the settings via
-the Expert.
-After doxygen is configured you need to save the configuration as a file
-to disk. This second step allows doxygen to use the configuration
-and has the additional advantage that the configuration can be reused
-to run doxygen with the same settings at a later point in time.
+After doxygen is configured you need to save (see: \ref dw_menu_file) the configuration as a file
+to disk. This allows doxygen to use the configuration
+and also allows running doxygen again with the same settings at a later point in time.
-Since some configuration options may use relative paths, the next step is
-to select a directory from which to run doxygen. This is typically the root
-of the source tree and will most of the time already be filled in correctly.
+Since some configuration options may use relative paths, be sure to
+select a working directory that is root of those paths.
+This is often the root of the source tree and will typically be correctly filled in
+if the configuration file is stored at this location as well.
Once the configuration file is saved and the working directory is set, you
-can run doxygen based on the selected settings. Do this by pressing the
-"Start" button. Once doxygen runs you can cancel it by clicking the same
-button again. The output produced by doxygen is captured and shown in a log
-window. Once doxygen finishes, the log can be saved as a text file.
+can run doxygen based on the selected settings. Do this by switching to the
+\ref dw_run "Run" tab, and click the "Run doxygen" button.
+
+Once doxygen runs you can cancel it by clicking the same
+button again. The output produced by doxygen is captured and shown in the "Output produced by doxygen"
+pane. Once doxygen finishes, the log can be saved as a text file.
-<h3>The Wizard Dialog</h3>
+\section dw_wizard Wizard tab
+
+The Wizard tab is divided into two panes
+<dl>
+<dt>Left pane<dd>The main topics for easy setting up doxygen.
+By clicking on a topic the corresponding settings will appear in the Right
+pane.
+<dt>Right pane<dd>The wizard's settings pane, in this pane you will find the
+settings that are available for the selected topic.
+</dl>
-If you select the Wizard button in step 1, then a dialog with
-a number of tabs will appear.
+The wizard only gives the possibility to quickly setup doxygen, for full control
+one should use the \ref dw_expert.
-\image html doxywizard_page1.png "Wizard dialog: Project settings"
-\image latex doxywizard_page1.png "Wizard dialog: Project settings" width=13cm
+\forceNewPage
+\subsection dw_wizard_project Project settings
-The fields in the project tab speak for themselves. Once doxygen has finished
+The fields in the Project pane speak for themselves. Once doxygen has finished
the Destination directory is where to look for the results. Doxygen will
-put each output format in a separate sub-directory.
+put each output format in a separate sub-directory by default.
+
+\image html doxywizard_page1.png "Wizard tab: Project settings"
+\image latex doxywizard_page1.png "Wizard tab: Project settings" width=15cm
+
+\forceNewPage
+\subsection dw_wizard_mode Mode of operating
+
+The Mode pane allows you to select how doxygen will look at your sources.
+The default is to only look for things that have been documented. Furthermore, the
+terminology used in the output can be changed to better match the main programming language used
+(this doesn't affect the way doxygen parses your source code).
-\image html doxywizard_page2.png "Wizard dialog: Mode of operating"
-\image latex doxywizard_page2.png "Wizard dialog: Mode of operating" width=13cm
+\image html doxywizard_page2.png "Wizard tab: Mode of operating"
+\image latex doxywizard_page2.png "Wizard tab: Mode of operating" width=15cm
-The mode tab allows you to select how doxygen will look at your sources.
-The default is to only look for things that have been documented.
+\forceNewPage
+\subsection dw_wizard_output Output to produce
-You can also select how doxygen should present the results.
-The latter does not affect the way doxygen parses your source code.
+The Output pane allows you to select what kinds of output doxygen will produce.
+For HTML and \LaTeX there are additional options available.
-\image html doxywizard_page3.png "Wizard dialog: Output to produce"
-\image latex doxywizard_page3.png "Wizard dialog: Output to produce" width=13cm
+\image html doxywizard_page3.png "Wizard tab: Output to produce"
+\image latex doxywizard_page3.png "Wizard tab: Output to produce" width=15cm
-You can select one or more of the output formats that doxygen should
-produce. For HTML and \LaTeX there are additional options.
+\forceNewPage
+\subsection dw_wizard_diagrams Diagrams to generate
-\image html doxywizard_page4.png "Wizard dialog: Diagrams to generate"
-\image latex doxywizard_page4.png "Wizard dialog: Diagrams to generate" width=13cm
+Doxygen can produce a number of diagrams. Using the Diagrams pane you
+can select which ones to generate. For most diagrams the
+`dot` tool of the <a href="http://www.graphviz.org">GraphViz</a> package
+is needed. This needs to be installed separately.
-Doxygen can produce a number of diagrams. Using the diagrams tab you
-can select which ones to generate. For most diagrams the
-dot tool of the <a href="http://www.graphviz.org">GraphViz</a> package
-is needed (if you use the binary packages for MacOSX this
-tool is already included).
+\image html doxywizard_page4.png "Wizard tab: Diagrams to generate"
+\image latex doxywizard_page4.png "Wizard tab: Diagrams to generate" width=15cm
-<h3>Expert dialog</h3>
+\section dw_expert Expert tab
-The Expert dialog has a number of tab fields, one
-for each section in the configuration file. Each tab-field
-contains a number of lines, one for each configuration option in
-that section.
+The Expert tab is divided into a number of panes:
+<dl>
+<dt>Top left pane<dd>The Topics pane (i.e. sections in the
+configuration file) that are available. By clicking on a topic the
+corresponding settings will appear in the Right pane.
+<dt>Bottom left pane<dd>The help pane, this will be updated when one
+hovers over the name of a setting in the Right pane.
+<dt>Right pane<dd>The Settings pane, in this pane you will find the
+settings that are available for the selected topic. In case the name for a setting is colored
+red, the setting has a non-default value.
+In case a setting is grayed out, the setting is depending on another setting that is disabled.
+Which setting it depends on is indicated in the help pane on the bottom left.
+</dl>
-The kind of input widget depends on the type of the configuration option.
+\image html doxywizard_expert.png "Some options from the Expert tab"
+\image latex doxywizard_expert.png "Some options from the Expert tab" width=15cm
+
+The representation of the input field depends on the type of the configuration option.
<ul>
-<li>For each boolean option (those options that are answered with YES or
- NO in the configuration file) there is a check-box.
-<li>For items taking one of a fixed set of values (like
+<li>For each boolean option (those options that are answered with `YES` or
+ `NO` in the configuration file) there is a check-box. A typical field
+ looks like:<br>
+ \image{inline} html expert_bool.png
+ \image{inline} latex expert_bool.png width=4.6cm
+<li>For items taking one of a fixed set of values (like
\ref cfg_output_language "OUTPUT_LANGUAGE") a combo box is used.
+ A typical field looks like:<br>
+ \image{inline} html expert_enum.png
+ \image{inline} latex expert_enum.png width=7.3cm
<li>For items taking an integer value from a range, a spinbox is used.
-<li>For free form string-type options there is a one line edit field
-<li>For options taking a lists of strings, a one line edit field is
- available, with a `+' button to add this string to the list and
- a `-' button to remove the selected string from the list. There
- is also a `*' button that, when pressed,
- replaces the selected item in the list with the string entered in the
- edit field.
-<li>For file and folder entries, there are special buttons
- that start a file selection dialog.
+ A typical field looks like:<br>
+ \image{inline} html expert_int.png
+ \image{inline} latex expert_int.png width=10.1cm
+<li>For free form string-type options there is a one line edit field.
+ A typical field looks like:<br>
+ \image{inline} html expert_string_string.png
+ \image{inline} latex expert_string_string.png width=12.3cm
+ <br>Additionally, when the string field should contain a file or a folder name, there are the special buttons
+ \image{inline} html images/file.png height=14px \ilinebr \image{inline} latex images/file.png height=\DoxyInlineHeightChar
+ and
+ \image{inline} html images/folder.png height=14px \ilinebr \image{inline} latex images/folder.png height=\DoxyInlineHeightChar
+ that start a file / folder selection dialog.
+ A typical field for a file looks like:<br>
+ \image{inline} html expert_string_file.png
+ \image{inline} latex expert_string_file.png width=11.0cm
+ <br>and a folder looks like:<br>
+ \image{inline} html expert_string_dir.png
+ \image{inline} latex expert_string_dir.png width=11.0cm
+ <br>In case a file represents an image, doxygen also tries to display the selected image.
+ Then a typical field looks like:<br>
+ \image{inline} html expert_string_image.png
+ \image{inline} latex expert_string_image.png width=11.8cm
+<li>For options taking a list of strings, an editor field is
+ shown with a non-editable list below it. The
+ \image{inline} html images/add.png height=14px \ilinebr \image{inline} latex images/add.png height=\DoxyInlineHeightChar
+ button adds the string in the editor field to the list and a the
+ \image{inline} html images/del.png height=14px \ilinebr \image{inline} latex images/del.png height=\DoxyInlineHeightChar
+ button removes the selected string from the list. The
+ \image{inline} html images/refresh.png height=14px \ilinebr \image{inline} latex images/refresh.png height=\DoxyInlineHeightChar
+ button can be clicked to replace the selected item in the list with the string entered in the editor field.
+ A typical field looks like:<br>
+ \image{inline} html expert_list_string.png
+ \image{inline} latex expert_list_string.png width=11.2cm
+ <br>additionally when the list contains file and / or folder names, there are special buttons
+ \image{inline} html images/file.png height=14px \ilinebr \image{inline} latex images/file.png height=\DoxyInlineHeightChar
+ and
+ \image{inline} html images/folder.png height=14px \ilinebr \image{inline} latex images/folder.png height=\DoxyInlineHeightChar
+ that start a file / folder selection dialog.
+ A typical field would for a file looks like:<br>
+ \image{inline} html expert_list_file.png
+ \image{inline} latex expert_list_file.png width=11.2cm
+ <br>and for a folder it looks like<br>
+ \image{inline} html expert_list_dir.png
+ \image{inline} latex expert_list_dir.png width=11.2cm
+ <br>and in case both files and folders are allowed, the look is:<br>
+ \image{inline} html expert_list_filedir.png
+ \image{inline} latex expert_list_filedir.png width=11.9cm
</ul>
-\image html doxywizard_expert.png "Some options from the Expert dialog"
-\image latex doxywizard_expert.png "Some options from the Expert dialog" width=15cm
+\section dw_run Run tab
-The get additional information about the meaning of an option, click
-on the "Help" button at the bottom right of the dialog and then on the
-item. A tooltip with additional information will appear.
+The run tab gives the possibility to run doxygen with the given settings, see the HTML results,
+see the settings used and save the output as displayed in the output pane.
-<h3>Menu options</h3>
+\image html doxywizard_run.png "Run tab"
+\image latex doxywizard_run.png "Run tab" width=15cm
-The GUI front-end has a menu with a couple of useful items
+<dl>
+<dt>Specify additional command line options for running doxygen<dd>Field to
+specify extra options used when running doxygen, e.g. for debugging purposes.
+<dt>Run doxygen<dd>When clicked will start running doxygen.
+The "Output produced by doxygen" pane shows the messages produced by doxygen while it is running.
+Before being able to run doxygen the settings have to be saved.
+<dt>Show HTML output<dd>Clicking this button will open the main HTML output page in the default browser.
+The button will be enabled after doxygen has finished.
+<dt>Show configuration<dd>Clicking this button shows the configuration settings that are used when running
+doxygen. The results will be shown in the "Output produced by doxygen" pane in compact textual form.
+<dt>Condensed<dd>When checked the "Show configuration" button will only list the configuration
+settings that differ from the default settings (analogous to `doxygen -x`).
+<dt>Save Log ...<dd>Will save the information from the "Output produced by doxygen"
+pane in a file as specified by the user.
+</dl>
+
+\section dw_menu Menu options
+
+\subsection dw_menu_file File menu
+
+The file menu with a couple of useful items for loading and saving settings.
-\image html doxywizard_menu.png "File menu"
-\image latex doxywizard_menu.png "File menu" width=15cm
+\image html doxywizard_menu_file.png "File menu"
+\image latex doxywizard_menu_file.png "File menu" width=12.0cm
<dl>
-<dt>Open...<dd>This is the same as the "Load" button in the main window
- and allows to open a configuration file from disk.
-<dt>Save as..<dd>This is the same as the "Save" button in the main window
- and can be used to save the current configuration settings to disk.
-<dt>Recent configurations<dd>Allow to quickly load a recently saved
- configuration.
-<dt>Set as default...<dd>Stores the current configuration settings as the
+<dt>Open...<dd>Load a configuration file from disk, based on a file
+ selection dialog. In case unsaved settings exist you will be asked to
+ confirm the action.
+<dt>Open recent<dd>Quickly load a recently saved configuration file.
+ In case unsaved settings exist you will be asked to confirm the action.
+ This menu item is only accessible when there are recent files in the list.
+<dt>Save<dd>Saves a configuration file to disk. In case the configuration
+ file has already been set this file name is used otherwise a selection dialog
+ will appear. In case the file already exists a confirmation is required.
+<dt>Save as..<dd>Saves the current configuration settings to disk with
+ a specific name. This file name will become the currently set file name.
+<dt>Quit<dd>Leave doxywizard, in case unsaved settings exist you will be asked to
+ confirm the action.
+</dl>
+
+\subsection dw_menu_settings Settings menu
+
+\image html doxywizard_menu_settings.png "Settings menu"
+\image latex doxywizard_menu_settings.png "Settings menu" width=6.7cm
+
+<dl>
+<dt>Reset to factory defaults<dd>Restores the factory defaults as the default settings to use.
+ You will be asked to confirm the action. This menu item is only accessible when the current
+ settings differ from the default settings.
+<dt>Use current settings at startup<dd>Stores the current configuration settings as the
default to use next time the GUI is started. You will be asked to
confirm the action.
-<dt>Reset...<dd>Restores the factory defaults as the default settings to use.
- You will be asked to confirm the action.
+<dt>Clear recent list<dd>Clears the "Open recent" list in the \ref dw_menu_file. This menu
+ item is only accessible when there are recent files in the "Open recent" list.
</dl>
+\subsection dw_menu_help Help menu
+
+\image html doxywizard_menu_help.png "Help menu"
+\image latex doxywizard_menu_help.png "Help menu" width=7.0cm
+
+<dl>
+<dt>Online Manual<dd>Opens the doxygen manual from the doxygen home page in the system defined default HTML browser.
+<dt>About<dd>Shows an About dialog with version information.
+</dl>
\htmlonly
Go to the <a href="config.html">next</a> section or return to the
diff --git a/doc/expert_bool.png b/doc/expert_bool.png
new file mode 100644
index 0000000..c2081e0
--- /dev/null
+++ b/doc/expert_bool.png
Binary files differ
diff --git a/doc/expert_enum.png b/doc/expert_enum.png
new file mode 100644
index 0000000..4672080
--- /dev/null
+++ b/doc/expert_enum.png
Binary files differ
diff --git a/doc/expert_int.png b/doc/expert_int.png
new file mode 100644
index 0000000..e5048f8
--- /dev/null
+++ b/doc/expert_int.png
Binary files differ
diff --git a/doc/expert_list_dir.png b/doc/expert_list_dir.png
new file mode 100644
index 0000000..6089dd1
--- /dev/null
+++ b/doc/expert_list_dir.png
Binary files differ
diff --git a/doc/expert_list_file.png b/doc/expert_list_file.png
new file mode 100644
index 0000000..2d5a99b
--- /dev/null
+++ b/doc/expert_list_file.png
Binary files differ
diff --git a/doc/expert_list_filedir.png b/doc/expert_list_filedir.png
new file mode 100644
index 0000000..08681ec
--- /dev/null
+++ b/doc/expert_list_filedir.png
Binary files differ
diff --git a/doc/expert_list_string.png b/doc/expert_list_string.png
new file mode 100644
index 0000000..9e5d96e
--- /dev/null
+++ b/doc/expert_list_string.png
Binary files differ
diff --git a/doc/expert_string_dir.png b/doc/expert_string_dir.png
new file mode 100644
index 0000000..61479ca
--- /dev/null
+++ b/doc/expert_string_dir.png
Binary files differ
diff --git a/doc/expert_string_file.png b/doc/expert_string_file.png
new file mode 100644
index 0000000..a4a61ae
--- /dev/null
+++ b/doc/expert_string_file.png
Binary files differ
diff --git a/doc/expert_string_image.png b/doc/expert_string_image.png
new file mode 100644
index 0000000..c5cc9a0
--- /dev/null
+++ b/doc/expert_string_image.png
Binary files differ
diff --git a/doc/expert_string_string.png b/doc/expert_string_string.png
new file mode 100644
index 0000000..5d680ae
--- /dev/null
+++ b/doc/expert_string_string.png
Binary files differ
diff --git a/doc/manual.sty b/doc/manual.sty
index 2e85012..fdbc982 100644
--- a/doc/manual.sty
+++ b/doc/manual.sty
@@ -17,6 +17,14 @@
\renewcommand{\sectionmark}[1]{%
\markright{\thesection\ #1}%
}
+% Used by @image
+% (only if inline is specified)
+\newlength{\DoxyInlineHeightChar}
+\settoheight{\DoxyInlineHeightChar}{H}
+\renewenvironment{DoxyInlineImage}{%
+\settoheight{\DoxyInlineHeightChar}{H}
+}{%
+}
% Headers & footers
\pagestyle{fancyplain}