From f83c2b0c7c53770df9771d46a32c045175d02284 Mon Sep 17 00:00:00 2001 From: Antonio Borneo Date: Sat, 2 Jan 2021 16:49:11 +0100 Subject: [PATCH] doc/style: fix doxygen error Doxygen complains about non-closed nested comments: doc/manual/style.txt:423: warning: Reached end of file while still inside a (nested) comment. Nesting level 1 (probable line reference: 149) This is caused by the string '/**' that is interpreted as the beginning of a comment. Escape the string to not let doxygen consider it as a comment While there, replace @code/@endcode with @verbatim/@endverbatim to properly render the line. Change-Id: If2a27c4cf659326e317cc4ac8c0b313e97e40432 Signed-off-by: Antonio Borneo Reviewed-on: http://openocd.zylin.com/5996 Tested-by: jenkins --- doc/manual/style.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 7191a4b0e6..dad3bb440c 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -186,9 +186,9 @@ comments. "empty" lines should be removed from the block. -# Only single spaces should be used; do @b not add mid-line indentation. -# If the total line length will be less than 72-80 columns, then - - The @c /**< form can be used on the same line. + - The @c /\**< form can be used on the same line. - This style should be used sparingly; the best use is for fields: - @code int field; /**< field description */ @endcode + @verbatim int field; /**< field description */ @endverbatim @section styledoxyall Doxygen Style Guide -- 2.30.2