diff options
| -rw-r--r-- | doc/docblocks.doc | 5 |
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 |