summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2010-09-20 18:19:55 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2010-09-20 18:19:55 (GMT)
commita80f9320bf9fdd879869cee2cea1ec3f9af822f8 (patch)
treec3964e8a42bc4dfecf5a99d6de94650878e67a0f /doc/docblocks.doc
parentce8facca2c23f4656747ad3a5b4a8db475855e27 (diff)
downloadDoxygen-a80f9320bf9fdd879869cee2cea1ec3f9af822f8.zip
Doxygen-a80f9320bf9fdd879869cee2cea1ec3f9af822f8.tar.gz
Doxygen-a80f9320bf9fdd879869cee2cea1ec3f9af822f8.tar.bz2
Release-1.7.1-20100920
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index aa9e873..41f5d99 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -155,7 +155,7 @@ The option has the same effect for multi-line special C++ comments:
or
\verbatim
-//! Brief descripion.
+//! Brief description.
//! Detailed description
//! starts here.
@@ -205,7 +205,7 @@ for the Qt style.
By default a JavaDoc style documentation block behaves the same way as a
Qt style documentation block. This is not according the JavaDoc specification
however, where the first sentence of the documentation block is automatically
-treated as a brief description. To enable this behaviour you should set
+treated as a brief description. To enable this behavior you should set
\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to YES in the configuration
file. If you enable this option and want to put a dot in the middle of a
sentence without ending it, you should put a backslash and a space after it.
@@ -426,7 +426,7 @@ Go to the <a href="lists.html">next</a> section or return to the
For VHDL a comment normally start with "--". Doxygen will extract comments
starting with "--!". There are only two types of comment blocks in VHDL;
-a one line --! comment representing a brief description, and a multiline
+a one line --! comment representing a brief description, and a multi-line
--! comment (where the --! prefix is repeated for each line) representing
a detailed description.
@@ -453,7 +453,7 @@ settings where overruled.
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
+For Fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to
continuate a one line comment into a multi-line comment.
Here is an example of a documented Fortran subroutine: