Permalink
Browse files

Documentation corrections

Corrected some spelling errors and added / correceted some references
  • Loading branch information...
albert-github committed Jan 12, 2014
1 parent a642629 commit 4b51e6113f1e9e20a5700840d83f1c3928d84825
Showing with 36 additions and 34 deletions.
  1. +16 −14 doc/commands.doc
  2. +1 −1 doc/customize.doc
  3. +3 −3 doc/docblocks.doc
  4. +2 −2 doc/htmlcmds.doc
  5. +6 −6 doc/markdown.doc
  6. +1 −1 doc/searching.doc
  7. +1 −1 examples/include.cpp
  8. +1 −1 examples/mux.vhdl
  9. +5 −5 src/config.xml
@@ -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 \<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
<hr>
\section cmdrelated \\related <name>
\addindex related
\addindex \\related
Equivalent to \ref cmdrelates "\\relates"
<hr>
@@ -946,7 +946,7 @@ Structural indicators
<hr>
\section cmdrelatedalso \\relatedalso <name>
\addindex relatedalso
\addindex \\relatedalso
Equivalent to \ref cmdrelatesalso "\\relatesalso"
<hr>
@@ -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.
<hr>
\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".
<hr>
\section cmdtparam \\tparam <template-parameter-name> { 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
<hr>
\section cmdcopybrief \\copybrief <link-object>
\addindex \\copybrief
Works in a similar way as \ref cmdcopydoc "\\copydoc" but will
only copy the brief description, not the detailed documentation.
<hr>
\section cmdcopydetails \\copydetails <link-object>
\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.
<hr>
@@ -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 <a href="https://github.com/michaeljones/breathe">the Breathe project</a> 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
<a href="http://sphinx.pocoo.org/">Sphinx</a> document generator.
@@ -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
@@ -25,7 +25,7 @@ of a HTML tag are passed on to the HTML output only
<ul>
<li><tt>\<A HREF="..."\></tt> Starts a hyperlink
(if supported by the output format).
<li><tt>\<A NAME="..."\></tt> Starts an named anchor
<li><tt>\<A NAME="..."\></tt> Starts a named anchor
(if supported by the output format).
<li><tt>\</A\></tt> Ends a link or anchor
<li><tt>\<B\></tt> Starts a piece of text displayed in a bold font.
@@ -129,7 +129,7 @@ The special HTML character entities that are recognized by Doxygen:
<li><tt>\&?uml;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y},
writes a character with a diaeresis accent (like &auml;).
<li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y},
writes a character with a acute accent (like &aacute;).
writes a character with an acute accent (like &aacute;).
<li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
writes a character with a grave accent (like &agrave;).
<li><tt>\&?circ;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
@@ -65,11 +65,11 @@ Just like Markdown, doxygen supports two types of headers
Level 1 or 2 headers can be made as the follows
This is an level 1 header
=========================
This is a level 1 header
========================
This is an level 2 header
-------------------------
This is a level 2 header
------------------------
A header is followed by a line containing only ='s or -'s.
Note that the exact amount of ='s or -'s is not important as long as
@@ -530,7 +530,7 @@ stars, so the following will appear as-is:
a_nice_identifier
Furthermore, a `*` or `_` only starts an emphasis if
- it is followed by an alphanumberical character, and
- it is followed by an alphanumerical character, and
- it is preceded by a space, newline, or one the following characters `<{([,:;`
An emphasis ends if
@@ -574,7 +574,7 @@ following as one list with 3 numbered items:
Doxygen however requires that the numbers used as marks are in
strictly ascending order, so the above example would produce 3 lists
with one item. An item with a equal or lower number than
with one item. An item with an equal or lower number than
the preceding item, will start a new list. For example:
1. Item1 of list 1
@@ -164,7 +164,7 @@ has its own advantages and disadvantages:
doxygen as a help plugin. It will then appear as a topic in the help
browser that can be started from "Help contents" in the Help menu.
Eclipse will generate a search index for the documentation when you
first search for an keyword.
first search for a keyword.
To enable the help plugin set
\ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" to \c YES,
@@ -13,7 +13,7 @@ class Test
* Our main function starts like this:
* \skip main
* \until {
* First we create a object \c t of the Test class.
* First we create an object \c t of the Test class.
* \skipline Test
* Then we call the example member function
* \line example
@@ -21,7 +21,7 @@ entity mux_using_with is
);
end entity;
--! @brief Architure definition of the MUX
--! @brief Architecture definition of the MUX
--! @details More details about this mux element.
architecture behavior of mux_using_with is
begin
@@ -283,7 +283,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c ALLOW_UNICODE_NAMES tag is set to \c YES,
doxygen will allow non-ascii characters to appear in the names of generated files.
doxygen will allow non-ASCII characters to appear in the names of generated files.
If set to \c NO, non-ASCII characters will be escaped, for example _xE3_x81_x84
will be used for Unicode U+3044.
]]>
@@ -1563,7 +1563,7 @@ to disable this feature.
<docs>
<![CDATA[
If the \c CLANG_ASSISTED_PARSING tag is set to \c YES, then doxygen will use the
<a href="http://clang.llvm.org/">clang parser</a> for more acurate parsing
<a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing
at the cost of reduced performance. This can be particularly helpful with
template rich C++ code for which doxygen's built-in parser lacks the
necessary type information.
@@ -2338,7 +2338,7 @@ MATHJAX_CODEFILE = disableRenderer.js
When the \c SERVER_BASED_SEARCH tag is enabled the search engine will be
implemented using a web server instead of a web client using Javascript.
There are two flavours of web server based searching depending on the
There are two flavors of web server based searching depending on the
\ref cfg_external_search "EXTERNAL_SEARCH" setting. When disabled,
doxygen will generate a PHP script for searching and an index file used
by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is
@@ -2931,7 +2931,7 @@ put in front of it.
<docs>
<![CDATA[
If the \c SKIP_FUNCTION_MACROS tag is set to \c YES then
doxygen's preprocessor will remove all refrences to function-like macros that are alone
doxygen's preprocessor will remove all references to function-like macros that are alone
on a line, have an all uppercase name, and do not end with a semicolon.
Such function macros are typically
used for boiler-plate code, and will confuse the parser if not removed.
@@ -2959,7 +2959,7 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
See the section \ref external for more information about the use of tag files.
\note
Each tag file must have an unique name
Each tag file must have a unique name
(where the name does \e NOT include the path).
If a tag file is not located in the directory in which doxygen
is run, you must also specify the path to the tagfile here.

0 comments on commit 4b51e61

Please sign in to comment.