From 4b51e6113f1e9e20a5700840d83f1c3928d84825 Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 12 Jan 2014 13:41:04 +0100 Subject: [PATCH] Documentation corrections Corrected some spelling errors and added / correceted some references --- doc/commands.doc | 30 ++++++++++++++++-------------- doc/customize.doc | 2 +- doc/docblocks.doc | 6 +++--- doc/htmlcmds.doc | 4 ++-- doc/markdown.doc | 12 ++++++------ doc/searching.doc | 2 +- examples/include.cpp | 2 +- examples/mux.vhdl | 2 +- src/config.xml | 10 +++++----- 9 files changed, 36 insertions(+), 34 deletions(-) diff --git a/doc/commands.doc b/doc/commands.doc index 7b598f6e45b..ab7c56972a4 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -290,7 +290,7 @@ Structural indicators \addindex \\category For Objective-C only: Indicates that a comment block contains documentation for a class category with name \. The arguments are - equal to the \\class command. + equal to the \ref cmdclass "\\class" command. \sa section \ref cmdclass "\\class". @@ -929,7 +929,7 @@ Structural indicators
\section cmdrelated \\related - \addindex related + \addindex \\related Equivalent to \ref cmdrelates "\\relates"
@@ -946,7 +946,7 @@ Structural indicators
\section cmdrelatedalso \\relatedalso - \addindex relatedalso + \addindex \\relatedalso Equivalent to \ref cmdrelatesalso "\\relatesalso"
@@ -1496,13 +1496,13 @@ void setPosition(double x,double y,double z,double t) * Rest of the comment block continues. */ \endverbatim - Note that the \\parblock command may also appear directly after - \\param's first argument. + Note that the \c \\parblock command may also appear directly after + \ref cmdparam "\\param"'s first argument.
\section cmdendparblock \\endparblock \addindex \\endparblock - This ends a block of paragraphs started with \\ref cmdparblock "\\parblock". + This ends a block of paragraphs started with \ref cmdparblock "\\parblock".
\section cmdtparam \\tparam { description } @@ -1612,7 +1612,7 @@ void setPosition(double x,double y,double z,double t) may be selected by including a parenthesized list of argument types after the method name. - Synonymous to \\see. + Synonymous to \ref cmdsee "\\see". \sa section \ref autolink "autolink" for information on how to create links to objects. @@ -1633,7 +1633,7 @@ void setPosition(double x,double y,double z,double t) \section cmdsince \\since { text } \addindex \\since - This tag can be used to specify since when (version or time) an + This command can be used to specify since when (version or time) an entity is available. The paragraph that follows \c \\since does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The \c \\since description ends when a blank @@ -1656,7 +1656,7 @@ void setPosition(double x,double y,double z,double t) Synonymous \ref cmdexception "\\exception". \par Note: - the tag \c \\throws is a synonym for this tag. + the command \ref cmdthrows "\\throws" is a synonym for this command. \sa section \ref cmdexception "\\exception" @@ -2060,7 +2060,7 @@ Commands for displaying examples \ref cmddontinclude "\\dontinclude" command in combination with the \ref cmdline "\\line", \ref cmdskip "\\skip", \ref cmdskipline "\\skipline", - and \\until commands. + and \ref cmduntil "\\until" commands. Alternatively, the \ref cmdsnippet "\\snippet" command can be used to include only a fragment of a source file. For this to work the @@ -2392,12 +2392,14 @@ Commands for visual enhancements
\section cmdcopybrief \\copybrief + \addindex \\copybrief Works in a similar way as \ref cmdcopydoc "\\copydoc" but will only copy the brief description, not the detailed documentation.
\section cmdcopydetails \\copydetails + \addindex \\copydetails Works in a similar way as \ref cmdcopydoc "\\copydoc" but will only copy the detailed documentation, not the brief description. @@ -2424,7 +2426,7 @@ only copy the detailed documentation, not the brief description. Doxygen will pass the text on to dot and include the resulting image (and image map) into the output. The nodes of a graph can be made clickable by using the URL attribute. - By using the command \\ref inside the URL value you can conveniently + By using the command \ref cmdref "\\ref" inside the URL value you can conveniently link to an item inside doxygen. Here is an example: \code /*! class B */ @@ -2475,12 +2477,12 @@ Here is an example of the use of the \c \\msc command. class Sender { public: - /** Acknowledgement from server */ + /** Acknowledgment from server */ void Ack(bool ok); }; /** Receiver class. Can be used to receive and execute commands. - * After execution of a command, the receiver will send an acknowledgement + * After execution of a command, the receiver will send an acknowledgment * \msc * Receiver,Sender; * Receiver<-Sender [label="Command()", URL="\ref Command()"]; @@ -2977,7 +2979,7 @@ class Receiver \section cmdamp \\\& \addindex \\\& - This command writes the \c \& character to output. + This command writes the \c \& character to the output. This character has to be escaped because it has a special meaning in HTML.
diff --git a/doc/customize.doc b/doc/customize.doc index 6e321bd8b0b..b1ef58d493e 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -389,7 +389,7 @@ result this works even for very large projects where reading all XML files as one big DOM tree would not fit into memory. See the Breathe project for -a example that uses doxygen XML output from Python to bridge it with the +an example that uses doxygen XML output from Python to bridge it with the Sphinx document generator. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 1b9636108bf..b86ed892366 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -461,7 +461,7 @@ When using doxygen for Fortran code you should set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES. For Fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to -continuate a one line comment into a multi-line comment. +continue an one line comment into a multi-line comment. Here is an example of a documented Fortran subroutine: \verbatim @@ -476,7 +476,7 @@ Here is an example of a documented Fortran subroutine: Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix \endverbatim -As a alternative you can also use comments in fixed format code: +As an alternative you can also use comments in fixed format code: \verbatim C> Function comment @@ -541,7 +541,7 @@ commands without the leading namespace use p.e.: \verbatim TCL_SUBST = class itcl:class body itcl:body \endverbatim --> -Following is a example using doxygen style comments: +Following is an example using doxygen style comments: \include tclexample.tcl \htmlonly diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 2afb2138b92..7038e99e32d 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -25,7 +25,7 @@ of a HTML tag are passed on to the HTML output only