blob: ff6f117c2b383edafe32ebc2c9c9d9ada2efba06 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
/******************************************************************************
*
* $Id$
*
* Copyright (C) 1997-1999 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
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* All output generated with Doxygen is not covered by this license.
*
*/
/*! \page doxygen_usage Doxygen usage
Doxygen is a command line based utility. Calling \c doxygen with the
\c -h option at the command line will give you a brief description of the
usage of the program.
All options consist of a leading character <tt>-</tt>,
followed by one character and optionally an argument.
To generate a class browser you typically need to follow these steps:
<ol>
<li> You document your source code with
special documentation blocks.
<li> You generate a configuration file (see section \ref config) by
calling doxygen with the \c -g option:
\verbatim
doxygen -g <config_file>
\endverbatim
<li> You edit the configuration file so it matches your project.
In the configuration file you can specify the input files and
a lot of optional information.
<li> You let doxygen generate the documentation, based on the settings in the
configuration file:
\verbatim
doxygen <config_file>
\endverbatim
</ol>
<b>Note:</b><br>
<ul>
<li> If you do not want the description for each item in the configuration
file then you can use the optional \c -s option.
Try to use this option if you send me a configuration file as part of
a bug report!
<li> To make doxygen read/write to standard input/output instead of from/to
a file, use \c - for the file name.
</ul>
If you also want to use the search engine, you should look
at section \ref doxysearch_usage.
*/
|
