summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-06-13 08:26:43 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2021-06-13 08:26:43 (GMT)
commitf555ca5f7e3086066da17289e5945ed0c4bb78a8 (patch)
tree13837585d633f4905ed46c77690059ac34ef9507
parentc9c102a9df33d10e653ee94d6a2579773ef759ad (diff)
parent0000628dae381c5ac156186baf3c2c07eda222e2 (diff)
downloadDoxygen-f555ca5f7e3086066da17289e5945ed0c4bb78a8.zip
Doxygen-f555ca5f7e3086066da17289e5945ed0c4bb78a8.tar.gz
Doxygen-f555ca5f7e3086066da17289e5945ed0c4bb78a8.tar.bz2
Merge branch 'feature/issue_8591' of https://github.com/albert-github/doxygen into albert-github-feature/issue_8591
-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