From 0000628dae381c5ac156186baf3c2c07eda222e2 Mon Sep 17 00:00:00 2001 From: albert-github Date: Tue, 8 Jun 2021 15:20:07 +0200 Subject: issue #8591 Doxygen comment suggestion in help collides with clang-format Added a general warning about the `/****//**` type of comment --- doc/docblocks.doc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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 -- cgit v0.12 From 384cea317256d4555de23db3e4db19e35d4d4191 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 13 Jun 2021 10:29:25 +0200 Subject: Some rewording --- doc/docblocks.doc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 8ccb08c..01fd4bd 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -115,8 +115,8 @@ documentation. For this purpose you can use the following: \endverbatim 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. +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 -- cgit v0.12