summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/docblocks.doc5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 92bf3df..8ccb08c 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -113,7 +113,10 @@ documentation. For this purpose you can use the following:
* ... text
***********************************************/
\endverbatim
-(note the 2 slashes to end the normal comment block and start a special comment block).
+Note: the 2 slashes to end the normal comment block and start a special comment block.
+
+Note: be careful when using a reformatter as a reformatter can see this type of comment
+as 2 separate comments resulting in non expected comment formatting.
or