aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorMarc Schink <dev@zapb.de>2021-04-05 15:40:35 +0200
committerAntonio Borneo <borneo.antonio@gmail.com>2021-04-11 21:27:40 +0100
commit0ec9018040c2fd77807d80225b34e2fc7fb23e82 (patch)
tree888c6127a57d73d782e344326f4ace94688d2b20 /doc/manual
parent134d7d5a5876a53a10ecb2eeac8d193bdddcea81 (diff)
downloadriscv-openocd-0ec9018040c2fd77807d80225b34e2fc7fb23e82.zip
riscv-openocd-0ec9018040c2fd77807d80225b34e2fc7fb23e82.tar.gz
riscv-openocd-0ec9018040c2fd77807d80225b34e2fc7fb23e82.tar.bz2
doc/manual/style: Fix comments
The comments currently used are not rendered. Change-Id: I3fcfb6aee4dea9c4f9186a7aec70d382a1abd634 Signed-off-by: Marc Schink <dev@zapb.de> Reviewed-on: http://openocd.zylin.com/6133 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/style.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/manual/style.txt b/doc/manual/style.txt
index c3fcfd7..755709f 100644
--- a/doc/manual/style.txt
+++ b/doc/manual/style.txt
@@ -114,9 +114,9 @@ pthreads require modest and predictable stack usage.
- static inline functions should be preferred over macros:
@code
-/** do NOT define macro-like functions like this... */
+/* do NOT define macro-like functions like this... */
#define CUBE(x) ((x) * (x) * (x))
-/** instead, define the same expression using a C99 inline function */
+/* instead, define the same expression using a C99 inline function */
static inline int cube(int x) { return x * x * x; }
@endcode
- Functions should be declared static unless required by other modules