diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2003-08-24 20:42:56 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2003-08-24 20:42:56 (GMT) |
| commit | 5b0de0b4249965d3ae2ca3e67f40ef810e0a9598 (patch) | |
| tree | bfd280ef12015bf793b71236c30364c6618cbaf8 /doc/starting.doc | |
| parent | 8626ab32d671ffcdc75dffce04dd05a671cfb42c (diff) | |
| download | Doxygen-5b0de0b4249965d3ae2ca3e67f40ef810e0a9598.zip Doxygen-5b0de0b4249965d3ae2ca3e67f40ef810e0a9598.tar.gz Doxygen-5b0de0b4249965d3ae2ca3e67f40ef810e0a9598.tar.bz2 | |
Release-1.3.3-20030824
Diffstat (limited to 'doc/starting.doc')
| -rw-r--r-- | doc/starting.doc | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/doc/starting.doc b/doc/starting.doc index e2335e3..534d339 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -22,15 +22,12 @@ detailed usage information. The executable \c doxytag is only needed if you want to generate references to external documentation (i.e. documentation that was generated by doxygen) -for which you do not have the sources or to create a search index for -the search engine. See section \ref doxytag_usage for more detailed usage -information. +for which you do not have the sources. See section \ref doxytag_usage +for more detailed usage information. -The executable \c doxysearch is only needed if you want to use the search -engine. See section \ref doxysearch_usage for more detailed usage information. - -Optionally, the executable \c doxywizard is a graphical front-end for editing -the configuration files that are used by doxygen. +Optionally, the executable \c doxywizard can be used, which is a +graphical front-end for editing the configuration file that is used by +doxygen. The following figure shows the relation between the tools and the flow of information between them: @@ -46,8 +43,8 @@ of a single source file, but can also be an entire source tree that is recursively scanned. To simplify the creation of a configuration file, doxygen can create a -template configuration file for you. To do this call \c doxygen with the \c -g -option: +template configuration file for you. To do this call \c doxygen +from the command line with the \c -g option: \verbatim doxygen -g <config-file> \endverbatim @@ -70,7 +67,7 @@ You can probably leave the values of most tags in a generated template configuration file to their default value. See section \ref config for more details about the configuration file. -If you do not like to edit the config file with a text editor, you should +If you do not wish to edit the config file with a text editor, you should have a look at \ref doxywizard_usage "doxywizard", which is a GUI front-end that can create, read and write doxygen configuration files, and allows setting configuration options by entering them via dialogs. |