X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fmanual%2Fstyle.txt;h=0bfae35f70fe33085aa3d5430d853a9d530e3e70;hp=2ff2a29eed4a29fad8883a8057d9b79f5a7f1edb;hb=ab597027ea98d4fa39980f9674dced42b5193b79;hpb=fa86553e76ebf6285d5b580a08bfbecdd9ec38c1 diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 2ff2a29eed..0bfae35f70 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -176,10 +176,10 @@ comments. * @returns The value(s) returned, or possible error conditions. */ @endverbatim - -# The block should start on the line following the opening @c /**. - -# The end of the block, \f$*/\f$, should also be on its own line. + -# The block should start on the line following the opening @c /\**. + -# The end of the block, @c *‍/, should also be on its own line. -# Every line in the block should have a @c '*' in-line with its start: - - A leading space is required to align the @c '*' with the @c /** line. + - A leading space is required to align the @c '*' with the @c /\** line. - A single "empty" line should separate the function documentation from the block of parameter and return value descriptions. - Except to separate paragraphs of documentation, other extra