diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2018-08-26 11:56:39 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2018-08-26 11:56:39 (GMT) |
commit | 716dfb2404342b9e33110ae2124f65f96199fbc7 (patch) | |
tree | 9023a8d286702a4f13662aea38b3a083e2577fe6 /doc | |
parent | a1b52e405ee8bf74179a22e24c3d6fc6db9fa66b (diff) | |
parent | 94a52469b177703d3e0d94bed6c4a48bddba18cb (diff) | |
download | Doxygen-716dfb2404342b9e33110ae2124f65f96199fbc7.zip Doxygen-716dfb2404342b9e33110ae2124f65f96199fbc7.tar.gz Doxygen-716dfb2404342b9e33110ae2124f65f96199fbc7.tar.bz2 |
Merge branch 'master' of github.com:doxygen/doxygen
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 8 | ||||
-rw-r--r-- | doc/doxygen.1 | 4 | ||||
-rw-r--r-- | doc/doxyindexer.1 | 2 | ||||
-rw-r--r-- | doc/doxysearch.1 | 4 |
4 files changed, 9 insertions, 9 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 2e51d79..a630aac 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2157,7 +2157,7 @@ Commands for displaying examples \ref cmdinclude "\\include". </p><hr> -\section cmdinclude[{lineno|doc}] \\include <file-name> +\section cmdinclude \\include[{lineno|doc}] <file-name> \addindex \\include This command can be used to include a source file as a block of code. @@ -2210,8 +2210,8 @@ Commands for displaying examples \section cmdincludelineno \\includelineno <file-name> \addindex \\includelineno - This command works the same way as \ref cmdinclude "\\include", but will add line - numbers to the included file. + This command is obsolete and is still supported for backward compatibility reasons, + it works the same way as \ref cmdinclude "\\include{lineno}" \sa sections \ref cmdinclude "\\include{lineno}". @@ -2222,7 +2222,7 @@ Commands for displaying examples This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \ref cmdinclude "\\include{doc}" - \sa section \ref cmdinclude "\\include". + \sa section \ref cmdinclude "\\include{doc}". <hr> \section cmdline \\line ( pattern ) diff --git a/doc/doxygen.1 b/doc/doxygen.1 index 1deb7b6..5ac287e 100644 --- a/doc/doxygen.1 +++ b/doc/doxygen.1 @@ -3,7 +3,7 @@ doxygen \- documentation system for various programming languages .SH DESCRIPTION Doxygen is a documentation system for C++, C, Java, Objective-C, IDL -(Corba and Microsoft flavors) and to some extent PHP, C#, and D. +(Corba and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D. .PP You can use doxygen in a number of ways: .TP @@ -25,7 +25,7 @@ If - is used for configName doxygen will read from standard input. .TP 4) Use doxygen to generate a template file controlling the layout of the generated documentation: .IP -doxygen -l layoutFileName.xml +doxygen -l [layoutFileName.xml] .TP 5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. .TP diff --git a/doc/doxyindexer.1 b/doc/doxyindexer.1 index ae4b282..b0d46d0 100644 --- a/doc/doxyindexer.1 +++ b/doc/doxyindexer.1 @@ -3,7 +3,7 @@ doxyindexer \- creates a search index from raw search data .SH SYNOPSIS .B doxyindexer -[\fI-o output_dir\fR] \fIsearchdata.xml \fR[\fIsearchdata2.xml\fR...] ] +[\fI-o output_dir\fR] \fIsearchdata.xml \fR[\fIsearchdata2.xml\fR...] .SH DESCRIPTION Generates a search index called \fBdoxysearch.db\fR from one or more search data files produced by doxygen. Use diff --git a/doc/doxysearch.1 b/doc/doxysearch.1 index a00124f..a26107b 100644 --- a/doc/doxysearch.1 +++ b/doc/doxysearch.1 @@ -2,10 +2,10 @@ .SH NAME doxysearch.cgi \- search engine used for searching in doxygen documentation. .SH SYNOPSIS -.B doxyindexer.cgi +.B doxysearch.cgi .SH DESCRIPTION CGI binary that is used by doxygen generated HTML output to search for words. The tool uses the search index called \fBdoxysearch.db\fR produced by doxyindexer. .SH SEE ALSO -doxygen(1), doxysearch(1), doxywizard(1). +doxygen(1), doxyindexer(1), doxywizard(1). |