Skip to content

Commit 81416b7

Browse files
committed
synchronize man and help messages
1 parent 648e62c commit 81416b7

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

doc/doxygen.1

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ doxygen [configName]
2121
.TP
2222
4) Use doxygen to generate a template file controlling the layout of the generated documentation:
2323
.IP
24-
doxygen -l [layoutFileName]
24+
doxygen \fB\-l\fR [layoutFileName]
2525
.IP
2626
.RS 0
2727
In case layoutFileName is omitted DoxygenLayout.xml will be used as filename.
@@ -67,10 +67,15 @@ doxygen \fB\-f\fR emoji outputFileName
6767
.RE
6868
.PP
6969
.RS 0
70-
*) If \fB\-s\fR is specified the comments in the config file will be omitted.
71-
If configName is omitted `Doxyfile' will be used as a default.
70+
*) If \fB\-s\fR is specified the comments of the configuration items in the config file will be omitted.
71+
If configName is omitted 'Doxyfile' will be used as a default.
7272
If - is used for configFile doxygen will write / read the configuration to /from standard output / input.
7373
.RE
74+
.PP
75+
If \fB\-q\fR is used for a doxygen documentation run, doxygen will see this as if QUIET=YES has been set.
76+
.PP
77+
\fB\-v\fR print version string, \fB\-V\fR print extended version information
78+
.PP
7479
.SH AUTHOR
7580
Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-@YEAR@
7681
.SH SEE ALSO

src/doxygen.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10723,12 +10723,12 @@ static void usage(const QCString &name,const QCString &versionString)
1072310723
{
1072410724
msg("Doxygen version %s\nCopyright Dimitri van Heesch 1997-2021\n\n",qPrint(versionString));
1072510725
msg("You can use doxygen in a number of ways:\n\n");
10726-
msg("1) Use doxygen to generate a template configuration file:\n");
10726+
msg("1) Use doxygen to generate a template configuration file*:\n");
1072710727
msg(" %s [-s] -g [configName]\n\n",qPrint(name));
10728-
msg("2) Use doxygen to update an old configuration file:\n");
10728+
msg("2) Use doxygen to update an old configuration file*:\n");
1072910729
msg(" %s [-s] -u [configName]\n\n",qPrint(name));
1073010730
msg("3) Use doxygen to generate documentation using an existing ");
10731-
msg("configuration file:\n");
10731+
msg("configuration file*:\n");
1073210732
msg(" %s [configName]\n\n",qPrint(name));
1073310733
msg("4) Use doxygen to generate a template file controlling the layout of the\n");
1073410734
msg(" generated documentation:\n");
@@ -10750,9 +10750,9 @@ static void usage(const QCString &name,const QCString &versionString)
1075010750
msg("8) Use doxygen to show a list of built-in emojis.\n");
1075110751
msg(" %s -f emoji outputFileName\n\n",qPrint(name));
1075210752
msg(" If - is used for outputFileName doxygen will write to standard output.\n\n");
10753-
msg("If -s is specified the comments of the configuration items in the config file will be omitted.\n");
10754-
msg("If configName is omitted 'Doxyfile' will be used as a default.\n");
10755-
msg("If - is used for configFile doxygen will write / read the configuration to /from standard output / input.\n\n");
10753+
msg("*) If -s is specified the comments of the configuration items in the config file will be omitted.\n");
10754+
msg(" If configName is omitted 'Doxyfile' will be used as a default.\n");
10755+
msg(" If - is used for configFile doxygen will write / read the configuration to /from standard output / input.\n\n");
1075610756
msg("If -q is used for a doxygen documentation run, doxygen will see this as if QUIET=YES has been set.\n\n");
1075710757
msg("-v print version string, -V print extended version information\n");
1075810758
}

0 commit comments

Comments
 (0)