doc/manual/style: Fix comments
authorMarc Schink <dev@zapb.de>
Mon, 5 Apr 2021 13:40:35 +0000 (15:40 +0200)
committerAntonio Borneo <borneo.antonio@gmail.com>
Sun, 11 Apr 2021 20:27:40 +0000 (21:27 +0100)
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>
doc/manual/style.txt

index c3fcfd782d8dfd3246eefd4a66839d66a91dd66d..755709fb0891d6a7b601b7227473805bb53beb66 100644 (file)
@@ -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