interesting
/
riscv-openocd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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 <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5996
Tested-by: jenkins
This commit is contained in:
Antonio Borneo 2021-01-02 16:49:11 +01:00
parent 3fbcb26f98
commit f83c2b0c7c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manual/style.txt
View File

@ -186,9 +186,9 @@ comments.
"empty" lines should be removed from the block. "empty" lines should be removed from the block.
-# Only single spaces should be used; do @b not add mid-line indentation. -# 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 -# 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: - 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 @section styledoxyall Doxygen Style Guide