|
Packit |
1c1d7e |
/******************************************************************************
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Permission to use, copy, modify, and distribute this software and its
|
|
Packit |
1c1d7e |
* documentation under the terms of the GNU General Public License is hereby
|
|
Packit |
1c1d7e |
* granted. No representations are made about the suitability of this software
|
|
Packit |
1c1d7e |
* for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit |
1c1d7e |
* See the GNU General Public License for more details.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Documents produced by Doxygen are derivative works derived from the
|
|
Packit |
1c1d7e |
* input used in their production; they are not affected by this license.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
/*! \page doxywizard_usage Doxywizard usage
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Doxywizard is a GUI front-end for configuring and running doxygen.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Note it is possible to start the doxywizard with as argument the configuration file to be used.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
When you start doxywizard it will display the main window
|
|
Packit |
1c1d7e |
(the actual look depends on the OS used).
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_main.png "Main window"
|
|
Packit |
1c1d7e |
\image latex doxywizard_main.png "Main window" width=15cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The windows shows the steps to take to configure and run doxygen.
|
|
Packit |
1c1d7e |
The first step is to choose one of the ways to configure doxygen.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
WizardClick this button to quickly configure the most important
|
|
Packit |
1c1d7e |
settings and leave the rest of the options to their defaults.
|
|
Packit |
1c1d7e |
ExpertClick this button to gain access to the
|
|
Packit |
1c1d7e |
\ref config "full range of configuration options".
|
|
Packit |
1c1d7e |
LoadClick this button to load an existing configuration file
|
|
Packit |
1c1d7e |
from disk.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Note that you can select multiple buttons in a row, for instance to first
|
|
Packit |
1c1d7e |
configure doxygen using the Wizard and then fine tune the settings via
|
|
Packit |
1c1d7e |
the Expert.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
After doxygen is configured you need to save the configuration as a file
|
|
Packit |
1c1d7e |
to disk. This second step allows doxygen to use the configuration
|
|
Packit |
1c1d7e |
and has the additional advantage that the configuration can be reused
|
|
Packit |
1c1d7e |
to run doxygen with the same settings at a later point in time.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Since some configuration options may use relative paths, the next step is
|
|
Packit |
1c1d7e |
to select a directory from which to run doxygen. This is typically the root
|
|
Packit |
1c1d7e |
of the source tree and will most of the time already be filled in correctly.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Once the configuration file is saved and the working directory is set, you
|
|
Packit |
1c1d7e |
can run doxygen based on the selected settings. Do this by pressing the
|
|
Packit |
1c1d7e |
"Start" button. Once doxygen runs you can cancel it by clicking the same
|
|
Packit |
1c1d7e |
button again. The output produced by doxygen is captured and shown in a log
|
|
Packit |
1c1d7e |
window. Once doxygen finishes, the log can be saved as a text file.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The Wizard Dialog
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
If you select the Wizard button in step 1, then a dialog with
|
|
Packit |
1c1d7e |
a number of tabs will appear.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_page1.png "Wizard dialog: Project settings"
|
|
Packit |
1c1d7e |
\image latex doxywizard_page1.png "Wizard dialog: Project settings" width=13cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The fields in the project tab speak for themselves. Once doxygen has finished
|
|
Packit |
1c1d7e |
the Destination directory is where to look for the results. Doxygen will
|
|
Packit |
1c1d7e |
put each output format in a separate sub-directory.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_page2.png "Wizard dialog: Mode of operating"
|
|
Packit |
1c1d7e |
\image latex doxywizard_page2.png "Wizard dialog: Mode of operating" width=13cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The mode tab allows you to select how doxygen will look at your sources.
|
|
Packit |
1c1d7e |
The default is to only look for things that have been documented.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
You can also select how doxygen should present the results.
|
|
Packit |
1c1d7e |
The latter does not affect the way doxygen parses your source code.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_page3.png "Wizard dialog: Output to produce"
|
|
Packit |
1c1d7e |
\image latex doxywizard_page3.png "Wizard dialog: Output to produce" width=13cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
You can select one or more of the output formats that doxygen should
|
|
Packit |
1c1d7e |
produce. For HTML and \LaTeX there are additional options.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_page4.png "Wizard dialog: Diagrams to generate"
|
|
Packit |
1c1d7e |
\image latex doxywizard_page4.png "Wizard dialog: Diagrams to generate" width=13cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Doxygen can produce a number of diagrams. Using the diagrams tab you
|
|
Packit |
1c1d7e |
can select which ones to generate. For most diagrams the
|
|
Packit |
1c1d7e |
dot tool of the GraphViz package
|
|
Packit |
1c1d7e |
is needed (if you use the binary packages for MacOSX this
|
|
Packit |
1c1d7e |
tool is already included).
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Expert dialog
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The Expert dialog has a number of tab fields, one
|
|
Packit |
1c1d7e |
for each section in the configuration file. Each tab-field
|
|
Packit |
1c1d7e |
contains a number of lines, one for each configuration option in
|
|
Packit |
1c1d7e |
that section.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The kind of input widget depends on the type of the configuration option.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
For each boolean option (those options that are answered with YES or
|
|
Packit |
1c1d7e |
NO in the configuration file) there is a check-box.
|
|
Packit |
1c1d7e |
For items taking one of a fixed set of values (like
|
|
Packit |
1c1d7e |
\ref cfg_output_language "OUTPUT_LANGUAGE") a combo box is used.
|
|
Packit |
1c1d7e |
For items taking an integer value from a range, a spinbox is used.
|
|
Packit |
1c1d7e |
For free form string-type options there is a one line edit field
|
|
Packit |
1c1d7e |
For options taking a lists of strings, a one line edit field is
|
|
Packit |
1c1d7e |
available, with a `+' button to add this string to the list and
|
|
Packit |
1c1d7e |
a `-' button to remove the selected string from the list. There
|
|
Packit |
1c1d7e |
is also a `*' button that, when pressed,
|
|
Packit |
1c1d7e |
replaces the selected item in the list with the string entered in the
|
|
Packit |
1c1d7e |
edit field.
|
|
Packit |
1c1d7e |
For file and folder entries, there are special buttons
|
|
Packit |
1c1d7e |
that start a file selection dialog.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_expert.png "Some options from the Expert dialog"
|
|
Packit |
1c1d7e |
\image latex doxywizard_expert.png "Some options from the Expert dialog" width=15cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The get additional information about the meaning of an option, click
|
|
Packit |
1c1d7e |
on the "Help" button at the bottom right of the dialog and then on the
|
|
Packit |
1c1d7e |
item. A tooltip with additional information will appear.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Menu options
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
The GUI front-end has a menu with a couple of useful items
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\image html doxywizard_menu.png "File menu"
|
|
Packit |
1c1d7e |
\image latex doxywizard_menu.png "File menu" width=15cm
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Open...This is the same as the "Load" button in the main window
|
|
Packit |
1c1d7e |
and allows to open a configuration file from disk.
|
|
Packit |
1c1d7e |
Save as..This is the same as the "Save" button in the main window
|
|
Packit |
1c1d7e |
and can be used to save the current configuration settings to disk.
|
|
Packit |
1c1d7e |
Recent configurationsAllow to quickly load a recently saved
|
|
Packit |
1c1d7e |
configuration.
|
|
Packit |
1c1d7e |
Set as default...Stores the current configuration settings as the
|
|
Packit |
1c1d7e |
default to use next time the GUI is started. You will be asked to
|
|
Packit |
1c1d7e |
confirm the action.
|
|
Packit |
1c1d7e |
Reset...Restores the factory defaults as the default settings to use.
|
|
Packit |
1c1d7e |
You will be asked to confirm the action.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\htmlonly
|
|
Packit |
1c1d7e |
Go to the next section or return to the
|
|
Packit |
1c1d7e |
index.
|
|
Packit |
1c1d7e |
\endhtmlonly
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
*/
|