summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-06-13 08:29:44 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2021-06-13 08:29:44 (GMT)
commitdb2276c89792975c88dceb6b704fc1dae403f28a (patch)
tree5186c3b3dff30daebce633b4bc7aa16c442731b5
parentc9c102a9df33d10e653ee94d6a2579773ef759ad (diff)
parent384cea317256d4555de23db3e4db19e35d4d4191 (diff)
downloadDoxygen-db2276c89792975c88dceb6b704fc1dae403f28a.zip
Doxygen-db2276c89792975c88dceb6b704fc1dae403f28a.tar.gz
Doxygen-db2276c89792975c88dceb6b704fc1dae403f28a.tar.bz2
Merge branch '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..01fd4bd 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 like clang-format as it may see this type of comment
+as 2 separate comments and introduce spacing between them.
or