aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/style.txt
diff options
context:
space:
mode:
authorPaul Fertser <fercerpav@gmail.com>2018-01-16 15:08:34 +0300
committerPaul Fertser <fercerpav@gmail.com>2018-01-30 07:35:50 +0000
commitab597027ea98d4fa39980f9674dced42b5193b79 (patch)
tree4b27ce6ee34a69c0688954df180a9d593b72411b /doc/manual/style.txt
parentfa86553e76ebf6285d5b580a08bfbecdd9ec38c1 (diff)
downloadriscv-openocd-ab597027ea98d4fa39980f9674dced42b5193b79.zip
riscv-openocd-ab597027ea98d4fa39980f9674dced42b5193b79.tar.gz
riscv-openocd-ab597027ea98d4fa39980f9674dced42b5193b79.tar.bz2
doxygen: fix issues with recent Doxygen versions
This fixes parsing of several documentation files which do not have dot in the filename. style.txt change fixes doxygen warnings and ensures proper display of comment begin/end instructions in HTML. Tested with Doxygen 1.8.13. Change-Id: I9fd9ac3b51b47076b8fdbd3e93b90c3eba9b9631 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/4342 Tested-by: jenkins
Diffstat (limited to 'doc/manual/style.txt')
-rw-r--r--doc/manual/style.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index 2ff2a29..0bfae35 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 *&zwj;/, 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