From a4d254f92f7c892a7dc1ce3a83b0894dbe3870f1 Mon Sep 17 00:00:00 2001 From: albert-github Date: Mon, 9 Nov 2020 14:45:36 +0100 Subject: Update of doxywizard documetation Bringing the doxywizard documentation up to date with the current version. --- doc/CMakeLists.txt | 37 ++++- doc/Doxyfile | 3 +- doc/doxywizard.gif | Bin 18928 -> 0 bytes doc/doxywizard_expert.png | Bin 24299 -> 38516 bytes doc/doxywizard_main.png | Bin 39432 -> 24624 bytes doc/doxywizard_menu.png | Bin 46176 -> 0 bytes doc/doxywizard_menu_file.png | Bin 0 -> 5242 bytes doc/doxywizard_menu_help.png | Bin 0 -> 2035 bytes doc/doxywizard_menu_settings.png | Bin 0 -> 2903 bytes doc/doxywizard_page1.png | Bin 29943 -> 23796 bytes doc/doxywizard_page2.png | Bin 29907 -> 26879 bytes doc/doxywizard_page3.png | Bin 38861 -> 25940 bytes doc/doxywizard_page4.png | Bin 33348 -> 24864 bytes doc/doxywizard_run.png | Bin 0 -> 16756 bytes doc/doxywizard_usage.doc | 287 ++++++++++++++++++++++++++++----------- doc/expert_bool.png | Bin 0 -> 753 bytes doc/expert_enum.png | Bin 0 -> 1126 bytes doc/expert_int.png | Bin 0 -> 988 bytes doc/expert_list_dir.png | Bin 0 -> 3674 bytes doc/expert_list_file.png | Bin 0 -> 3956 bytes doc/expert_list_filedir.png | Bin 0 -> 4295 bytes doc/expert_list_string.png | Bin 0 -> 4585 bytes doc/expert_string_dir.png | Bin 0 -> 2196 bytes doc/expert_string_file.png | Bin 0 -> 2167 bytes doc/expert_string_image.png | Bin 0 -> 3193 bytes doc/expert_string_string.png | Bin 0 -> 1458 bytes doc/manual.sty | 8 ++ 27 files changed, 255 insertions(+), 80 deletions(-) delete mode 100644 doc/doxywizard.gif mode change 100644 => 100755 doc/doxywizard_expert.png mode change 100644 => 100755 doc/doxywizard_main.png delete mode 100644 doc/doxywizard_menu.png create mode 100755 doc/doxywizard_menu_file.png create mode 100755 doc/doxywizard_menu_help.png create mode 100755 doc/doxywizard_menu_settings.png mode change 100644 => 100755 doc/doxywizard_page1.png mode change 100644 => 100755 doc/doxywizard_page2.png mode change 100644 => 100755 doc/doxywizard_page3.png mode change 100644 => 100755 doc/doxywizard_page4.png create mode 100755 doc/doxywizard_run.png create mode 100755 doc/expert_bool.png create mode 100755 doc/expert_enum.png create mode 100755 doc/expert_int.png create mode 100755 doc/expert_list_dir.png create mode 100755 doc/expert_list_file.png create mode 100755 doc/expert_list_filedir.png create mode 100755 doc/expert_list_string.png create mode 100755 doc/expert_string_dir.png create mode 100755 doc/expert_string_file.png create mode 100755 doc/expert_string_image.png create mode 100755 doc/expert_string_string.png 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/doxywizard.gif b/doc/doxywizard.gif deleted file mode 100644 index 80bb636..0000000 Binary files a/doc/doxywizard.gif and /dev/null differ diff --git a/doc/doxywizard_expert.png b/doc/doxywizard_expert.png old mode 100644 new mode 100755 index 5eb14d4..d07152f Binary files a/doc/doxywizard_expert.png and b/doc/doxywizard_expert.png differ diff --git a/doc/doxywizard_main.png b/doc/doxywizard_main.png old mode 100644 new mode 100755 index b170e15..1c4ee1b Binary files a/doc/doxywizard_main.png and b/doc/doxywizard_main.png differ diff --git a/doc/doxywizard_menu.png b/doc/doxywizard_menu.png deleted file mode 100644 index 7f37192..0000000 Binary files a/doc/doxywizard_menu.png and /dev/null differ diff --git a/doc/doxywizard_menu_file.png b/doc/doxywizard_menu_file.png new file mode 100755 index 0000000..e3c6092 Binary files /dev/null and b/doc/doxywizard_menu_file.png differ diff --git a/doc/doxywizard_menu_help.png b/doc/doxywizard_menu_help.png new file mode 100755 index 0000000..4d6812b Binary files /dev/null and b/doc/doxywizard_menu_help.png differ diff --git a/doc/doxywizard_menu_settings.png b/doc/doxywizard_menu_settings.png new file mode 100755 index 0000000..c22e361 Binary files /dev/null and b/doc/doxywizard_menu_settings.png differ diff --git a/doc/doxywizard_page1.png b/doc/doxywizard_page1.png old mode 100644 new mode 100755 index 3e008d0..7834573 Binary files a/doc/doxywizard_page1.png and b/doc/doxywizard_page1.png differ diff --git a/doc/doxywizard_page2.png b/doc/doxywizard_page2.png old mode 100644 new mode 100755 index 8343902..ec5ce51 Binary files a/doc/doxywizard_page2.png and b/doc/doxywizard_page2.png differ diff --git a/doc/doxywizard_page3.png b/doc/doxywizard_page3.png old mode 100644 new mode 100755 index 0201981..dff15e7 Binary files a/doc/doxywizard_page3.png and b/doc/doxywizard_page3.png differ diff --git a/doc/doxywizard_page4.png b/doc/doxywizard_page4.png old mode 100644 new mode 100755 index 1068e6c..8378a5c Binary files a/doc/doxywizard_page4.png and b/doc/doxywizard_page4.png differ diff --git a/doc/doxywizard_run.png b/doc/doxywizard_run.png new file mode 100755 index 0000000..156fc9d Binary files /dev/null and b/doc/doxywizard_run.png differ diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc index 310c358..e591052 100644 --- a/doc/doxywizard_usage.doc +++ b/doc/doxywizard_usage.doc @@ -16,134 +16,269 @@ */ /*! \page doxywizard_usage Doxywizard usage -Doxywizard is a GUI front-end for configuring and running doxygen. +The 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. +It is possible to start the doxywizard with as argument the configuration file to be used or +without a configuration file meaning to start with the default settings. -When you start doxywizard it will display the main window +When you start the doxywizard it will display the main window (the actual look depends on the OS 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 Gui consists of the following parts:
-
Wizard
Click this button to quickly configure the most important - settings and leave the rest of the options to their defaults. -
Expert
Click this button to gain access to the - \ref config "full range of configuration options". -
Load
Click this button to load an existing configuration file - from disk. +
Specify the working directory from which doxygen will run
In case the doxywizard is started +with a configuration file or a doxygen configuration file is loaded by means of an open command +(see: \ref dw_menu_file) the directory of this settings file is used as default for this setting. + +
Available dialogs
+Note that you can select multiple tabs in a row, for instance to first +configure doxygen using the \ref dw_wizard and then fine tune the settings via +the \ref dw_expert. +
+
\ref dw_wizard
in this tab it is possible to quickly configure the most + important settings and leave the rest of the options to + their defaults. +
\ref dw_expert
in this tab one gains access to the \ref config + "full range of configuration options". +
\ref dw_run
in this tab it is possible to run doxygen and view the used settings for doxygen. +
+
\ref dw_menu
In the menu bar the following parts are available: +\ref dw_menu_file, \ref dw_menu_settings and \ref dw_menu_help.
-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 +After doxygen is configured you need to save (see: \ref dw_menu_file) the configuration as a file +to disk. This 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. -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 +Since some configuration options may use relative paths, be sure 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. 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. +"Run doxygen" button (in the \ref dw_run tab). 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. -

The Wizard Dialog

+\section dw_wizard Wizard dialog -If you select the Wizard button in step 1, then a dialog with -a number of tabs will appear. +The Wizard dialog has a number of sub-panes: +
+
Left sub-pane
The main topics for easy setting up doxygen. +By clicking on a topic the corresponding settings will appear in the Right +sub-pane. +
Right sub-pane
The wizard settings sub-pane, in this pane you will find the +settings that are available for the selected topic. +
-\image html doxywizard_page1.png "Wizard dialog: Project settings" -\image latex doxywizard_page1.png "Wizard dialog: Project settings" width=13cm +The wizard only gives the possibility to quickly setup doxygen, for full control +one should use the \ref dw_expert. -The fields in the project tab speak for themselves. Once doxygen has finished +\forceNewPage +\subsection dw_wizard_project Project settings + +The fields in the Project sub-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. +\image html doxywizard_page1.png "Wizard dialog: Project settings" +\image latex doxywizard_page1.png "Wizard dialog: Project settings" width=15cm + +\forceNewPage +\subsection dw_wizard_mode Mode of operating + +The Mode sub-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 of the output can be selected by means of the terminology of the +main computer 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 latex doxywizard_page2.png "Wizard dialog: 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 sub-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 latex doxywizard_page3.png "Wizard dialog: Output to produce" width=15cm + +\forceNewPage +\subsection dw_wizard_diagrams Diagrams to generate -You can select one or more of the output formats that doxygen should -produce. For HTML and \LaTeX there are additional options. +Doxygen can produce a number of diagrams. Using the Diagrams sub-pane you +can select which ones to generate. For most diagrams the +`dot` tool of the GraphViz package +is needed. \image html doxywizard_page4.png "Wizard dialog: Diagrams to generate" -\image latex doxywizard_page4.png "Wizard dialog: Diagrams to generate" width=13cm +\image latex doxywizard_page4.png "Wizard dialog: Diagrams to generate" width=15cm -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 GraphViz package -is needed (if you use the binary packages for MacOSX this -tool is already included). +\section dw_expert Expert dialog -

Expert dialog

+The Expert dialog has a number of sub-panes: +
+
Top left sub-pane
The topics sub-pane (i.e. sections in the +configuration file) that are available. By clicking on a topic the +corresponding settings will appear in the Right sub-pane. +
Bottom left sub-pane
The help sub-pane, this will be updated when one +hovers over the name of a setting in the Right sub-pane. +
Right sub-pane
The settings sub-pane, in this pane you will find the +settings that are available for the selected topic. In case a setting appears +with its name in red it means that the setting doesn't contain the default +setting. In case a setting is grayed out it means that the setting is depending +on another setting as indicated in the Bottom left sub-pane. +
-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. +\image html doxywizard_expert.png "Some options from the Expert dialog" +\image latex doxywizard_expert.png "Some options from the Expert dialog" width=15cm -The kind of input widget depends on the type of the configuration option. +The kind of input field depends on the type of the configuration option. -\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 dialog + +The run dialog gives the possibility to run doxygen with the given settings, see the HTML results, see the settings used and save the ouput as displayed in the output pane. + +\image html doxywizard_run.png "Run dialog" +\image latex doxywizard_run.png "Run dialog" width=15cm -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. +
+
Specify additional command line options for running doxygen
Field to +specify extra options to run doxygen with e.g. for debugging purposes. +
Run doxygen
Run doxygen, the results of the run process will become +available in the "Output produced by doxygen" pane. To see the HTML results one +can use the "Show HTML output" button. Before being able to run doxygen the settings +have to be saved. +
Show HTML output
This will start the system defined default HTML browser to show HTML +output. +
Condensed
When set the "Show configuration" will only show the configuration +settings that differ from the default settings (analogous to `doxygen -x`). +
Show configuration
Show the configuration settings as will be used when running +doxygen. The results will be shown in the "Output produced by doxygen" pane. +
Save Log ...
Will save the information from the "Output produced by doxygen" +pane in a file as specified by the user. +
-

Menu options

+\section dw_menu Menu options -The GUI front-end has a menu with a couple of useful items +\subsection dw_menu_file File menu -\image html doxywizard_menu.png "File menu" -\image latex doxywizard_menu.png "File menu" width=15cm +The GUI front-end has a menu with a couple of useful items for loading and saving settings. + +\image html doxywizard_menu_file.png "File menu" +\image latex doxywizard_menu_file.png "File menu" width=12.0cm
-
Open...
This is the same as the "Load" button in the main window - and allows to open a configuration file from disk. -
Save as..
This is the same as the "Save" button in the main window - and can be used to save the current configuration settings to disk. -
Recent configurations
Allow to quickly load a recently saved - configuration. -
Set as default...
Stores the current configuration settings as the +
Open...
This allows to load a configuration file from disk, based on a file + selection window. In case unsaved settings exist you will be asked to + confirm the action. +
Open recent
Allow to quickly load a recently saved configuration. + 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. +
Save
Allow to save a configuration file to disk. In case the configuration + file has already been defined this file name is used otherwise a selection window + will appear. In case the file already exists a confirmation is required. +
Save as..
This allows to save the current configuration settings to disk with + a name different from the defined name. Note: This name will be the new defined name. +
Quit
Leave the doxywizard, in case unsaved settings exist you will be asked to + confirm the action. +
+ +\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 + +
+
Reset to factory defaults
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. +
Use current settings at startup
Stores the current configuration settings as the default to use next time the GUI is started. You will be asked to confirm the action. -
Reset...
Restores the factory defaults as the default settings to use. - You will be asked to confirm the action. +
Clear recent list
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.
+\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 + +
+
Online Manual
Opens the doxygen manual from the doxygen home page in the system defined default HTML browser. +
About
Shows an about box. +
\htmlonly Go to the next section or return to the diff --git a/doc/expert_bool.png b/doc/expert_bool.png new file mode 100755 index 0000000..c2081e0 Binary files /dev/null and b/doc/expert_bool.png differ diff --git a/doc/expert_enum.png b/doc/expert_enum.png new file mode 100755 index 0000000..4672080 Binary files /dev/null and b/doc/expert_enum.png differ diff --git a/doc/expert_int.png b/doc/expert_int.png new file mode 100755 index 0000000..e5048f8 Binary files /dev/null and b/doc/expert_int.png differ diff --git a/doc/expert_list_dir.png b/doc/expert_list_dir.png new file mode 100755 index 0000000..6089dd1 Binary files /dev/null and b/doc/expert_list_dir.png differ diff --git a/doc/expert_list_file.png b/doc/expert_list_file.png new file mode 100755 index 0000000..2d5a99b Binary files /dev/null and b/doc/expert_list_file.png differ diff --git a/doc/expert_list_filedir.png b/doc/expert_list_filedir.png new file mode 100755 index 0000000..08681ec Binary files /dev/null and b/doc/expert_list_filedir.png differ diff --git a/doc/expert_list_string.png b/doc/expert_list_string.png new file mode 100755 index 0000000..9e5d96e Binary files /dev/null and b/doc/expert_list_string.png differ diff --git a/doc/expert_string_dir.png b/doc/expert_string_dir.png new file mode 100755 index 0000000..61479ca Binary files /dev/null and b/doc/expert_string_dir.png differ diff --git a/doc/expert_string_file.png b/doc/expert_string_file.png new file mode 100755 index 0000000..a4a61ae Binary files /dev/null and b/doc/expert_string_file.png differ diff --git a/doc/expert_string_image.png b/doc/expert_string_image.png new file mode 100755 index 0000000..c5cc9a0 Binary files /dev/null and b/doc/expert_string_image.png differ diff --git a/doc/expert_string_string.png b/doc/expert_string_string.png new file mode 100755 index 0000000..5d680ae Binary files /dev/null and b/doc/expert_string_string.png 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} -- cgit v0.12 From 2de24206533adc27a6f0b942decc37e4308f2e14 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sat, 14 Nov 2020 19:12:51 +0100 Subject: Changed some wording. --- doc/doxywizard_usage.doc | 247 ++++++++++++++++++++++++----------------------- 1 file changed, 124 insertions(+), 123 deletions(-) diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc index e591052..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,64 +14,70 @@ */ /*! \page doxywizard_usage Doxywizard usage -The doxywizard is a GUI front-end for configuring and running doxygen. +Doxywizard is a GUI front-end for configuring and running doxygen. -It is possible to start the doxywizard with as argument the configuration file to be used or -without a configuration file meaning to start with the default settings. +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 the 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 Gui consists of the following parts: -
-
Specify the working directory from which doxygen will run
In case the doxywizard is started -with a configuration file or a doxygen configuration file is loaded by means of an open command -(see: \ref dw_menu_file) the directory of this settings file is used as default for this setting. - -
Available dialogs
-Note that you can select multiple tabs in a row, for instance to first -configure doxygen using the \ref dw_wizard and then fine tune the settings via -the \ref dw_expert. +The user interface consists of the following sections:
-
\ref dw_wizard
in this tab it is possible to quickly configure the most +
\ref dw_menu +
In the menu bar the following parts are available: +\ref dw_menu_file, \ref dw_menu_settings and \ref dw_menu_help. + +
Specify the working directory from which doxygen will run +
+Using the Select... 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. + +
Configure doxygen using the Wizard and/or Expert tab... +
+
+
\ref dw_wizard
with this tab it is possible to quickly configure the most important settings and leave the rest of the options to their defaults. -
\ref dw_expert
in this tab one gains access to the \ref config - "full range of configuration options". -
\ref dw_run
in this tab it is possible to run doxygen and view the used settings for doxygen. -
-
\ref dw_menu
In the menu bar the following parts are available: -\ref dw_menu_file, \ref dw_menu_settings and \ref dw_menu_help. +
\ref dw_expert
with this tab one gains access to the \ref config + "full set of configuration options". +
\ref dw_run
with this tab it is possible to run doxygen and view the used settings. +
+ +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. +
After doxygen is configured you need to save (see: \ref dw_menu_file) the configuration as a file -to disk. This 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. +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, be sure 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. +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 -"Run doxygen" button (in the \ref dw_run tab). Once doxygen runs you can cancel it by clicking the same +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. -\section dw_wizard Wizard dialog +\section dw_wizard Wizard tab -The Wizard dialog has a number of sub-panes: +The Wizard tab is divided into two panes
-
Left sub-pane
The main topics for easy setting up doxygen. +
Left pane
The main topics for easy setting up doxygen. By clicking on a topic the corresponding settings will appear in the Right -sub-pane. -
Right sub-pane
The wizard settings sub-pane, in this pane you will find the +pane. +
Right pane
The wizard's settings pane, in this pane you will find the settings that are available for the selected topic.
@@ -83,148 +87,145 @@ one should use the \ref dw_expert. \forceNewPage \subsection dw_wizard_project Project settings -The fields in the Project sub-pane 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 dialog: Project settings" -\image latex doxywizard_page1.png "Wizard dialog: Project settings" width=15cm +\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 sub-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 of the output can be selected by means of the terminology of the -main computer language used (this doesn't affect the way doxygen parses your source code). +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=15cm +\image html doxywizard_page2.png "Wizard tab: Mode of operating" +\image latex doxywizard_page2.png "Wizard tab: Mode of operating" width=15cm \forceNewPage \subsection dw_wizard_output Output to produce -The Output sub-pane allows you to select what kinds of output doxygen will produce. +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=15cm +\image html doxywizard_page3.png "Wizard tab: Output to produce" +\image latex doxywizard_page3.png "Wizard tab: Output to produce" width=15cm \forceNewPage \subsection dw_wizard_diagrams Diagrams to generate -Doxygen can produce a number of diagrams. Using the Diagrams sub-pane you -can select which ones to generate. For most diagrams the +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 GraphViz package -is needed. +is needed. This needs to be installed separately. -\image html doxywizard_page4.png "Wizard dialog: Diagrams to generate" -\image latex doxywizard_page4.png "Wizard dialog: Diagrams to generate" width=15cm +\image html doxywizard_page4.png "Wizard tab: Diagrams to generate" +\image latex doxywizard_page4.png "Wizard tab: Diagrams to generate" width=15cm -\section dw_expert Expert dialog +\section dw_expert Expert tab -The Expert dialog has a number of sub-panes: +The Expert tab is divided into a number of panes:
-
Top left sub-pane
The topics sub-pane (i.e. sections in the +
Top left pane
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 sub-pane. -
Bottom left sub-pane
The help sub-pane, this will be updated when one -hovers over the name of a setting in the Right sub-pane. -
Right sub-pane
The settings sub-pane, in this pane you will find the -settings that are available for the selected topic. In case a setting appears -with its name in red it means that the setting doesn't contain the default -setting. In case a setting is grayed out it means that the setting is depending -on another setting as indicated in the Bottom left sub-pane. +corresponding settings will appear in the Right pane. +
Bottom left pane
The help pane, this will be updated when one +hovers over the name of a setting in the Right pane. +
Right pane
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.
-\image html doxywizard_expert.png "Some options from the Expert dialog" -\image latex doxywizard_expert.png "Some options from the Expert dialog" width=15cm +\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 kind of input field depends on the type of the configuration option. +The representation of the input field depends on the type of the configuration option. -\section dw_run Run dialog +\section dw_run Run tab -The run dialog gives the possibility to run doxygen with the given settings, see the HTML results, see the settings used and save the ouput as displayed in the output pane. +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. -\image html doxywizard_run.png "Run dialog" -\image latex doxywizard_run.png "Run dialog" width=15cm +\image html doxywizard_run.png "Run tab" +\image latex doxywizard_run.png "Run tab" width=15cm
Specify additional command line options for running doxygen
Field to -specify extra options to run doxygen with e.g. for debugging purposes. -
Run doxygen
Run doxygen, the results of the run process will become -available in the "Output produced by doxygen" pane. To see the HTML results one -can use the "Show HTML output" button. Before being able to run doxygen the settings -have to be saved. -
Show HTML output
This will start the system defined default HTML browser to show HTML -output. -
Condensed
When set the "Show configuration" will only show the configuration +specify extra options used when running doxygen, e.g. for debugging purposes. +
Run doxygen
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. +
Show HTML output
Clicking this button will open the main HTML output page in the default browser. +The button will be enabled after doxygen has finished. +
Show configuration
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. +
Condensed
When checked the "Show configuration" button will only list the configuration settings that differ from the default settings (analogous to `doxygen -x`). -
Show configuration
Show the configuration settings as will be used when running -doxygen. The results will be shown in the "Output produced by doxygen" pane.
Save Log ...
Will save the information from the "Output produced by doxygen" pane in a file as specified by the user.
@@ -233,24 +234,24 @@ pane in a file as specified by the user. \subsection dw_menu_file File menu -The GUI front-end has a menu with a couple of useful items for loading and saving settings. +The file menu with a couple of useful items for loading and saving settings. \image html doxywizard_menu_file.png "File menu" \image latex doxywizard_menu_file.png "File menu" width=12.0cm
-
Open...
This allows to load a configuration file from disk, based on a file - selection window. In case unsaved settings exist you will be asked to +
Open...
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. -
Open recent
Allow to quickly load a recently saved configuration. - 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. -
Save
Allow to save a configuration file to disk. In case the configuration - file has already been defined this file name is used otherwise a selection window +
Open recent
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. +
Save
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. -
Save as..
This allows to save the current configuration settings to disk with - a name different from the defined name. Note: This name will be the new defined name. -
Quit
Leave the doxywizard, in case unsaved settings exist you will be asked to +
Save as..
Saves the current configuration settings to disk with + a specific name. This file name will become the currently set file name. +
Quit
Leave doxywizard, in case unsaved settings exist you will be asked to confirm the action.
@@ -277,7 +278,7 @@ The GUI front-end has a menu with a couple of useful items for loading and savin
Online Manual
Opens the doxygen manual from the doxygen home page in the system defined default HTML browser. -
About
Shows an about box. +
About
Shows an About dialog with version information.
\htmlonly -- cgit v0.12