Skip to content

Commit

Permalink
clarify what the last comments in man refer to
Browse files Browse the repository at this point in the history
  • Loading branch information
ferdymercury committed Apr 25, 2022
1 parent 8493321 commit 77a76e5
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions doc/doxygen.1
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
.PP
You can use doxygen in a number of ways:
.TP
1) Use doxygen to generate a template configuration file:
1) Use doxygen to generate a template configuration file*:
.IP
doxygen [-s] \fB\-g\fR [configName]
.TP
2) Use doxygen to update an old configuration file:
2) Use doxygen to update an old configuration file*:
.IP
doxygen [-s] \fB\-u\fR [configName]
.TP
3) Use doxygen to generate documentation using an existing configuration file:
3) Use doxygen to generate documentation using an existing configuration file*:
.IP
doxygen [configName]
.TP
Expand Down Expand Up @@ -66,9 +66,11 @@ doxygen \fB\-f\fR emoji outputFileName
If - is used for outputFileName doxygen will write to standard output.
.RE
.PP
If \fB\-s\fR is specified the comments in the config file will be omitted.
If configName is omitted `Doxyfile' will be used as a default.
If - is used for configFile doxygen will write / read the configuration to /from standard output / input.
.RS 0
*) If \fB\-s\fR is specified the comments in the config file will be omitted.
If configName is omitted `Doxyfile' will be used as a default.
If - is used for configFile doxygen will write / read the configuration to /from standard output / input.
.RE
.SH AUTHOR
Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-@YEAR@
.SH SEE ALSO
Expand Down

0 comments on commit 77a76e5

Please sign in to comment.