summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 8ac55bb..ebbe879 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -70,7 +70,7 @@ In both cases the intermediate *'s are optional, so
is also valid.
-<li> A third alternative is to use a block of at least two C++ comment
+<li> A third alternative is to use a block of <i>at least two</i> C++ comment
lines, where each line starts with an additional slash or an
exclamation mark. Here are examples of the two cases:
@@ -88,6 +88,8 @@ or
//!
\endverbatim
+Note that a blank line ends a documentation block in this case.
+
<li>
Some people like to make their comment blocks more visible in the