From: Marc Schink Date: Mon, 5 Apr 2021 13:40:35 +0000 (+0200) Subject: doc/manual/style: Fix comments X-Git-Url: https://git.gag.com/?a=commitdiff_plain;h=0ec9018040c2fd77807d80225b34e2fc7fb23e82;p=fw%2Fopenocd doc/manual/style: Fix comments The comments currently used are not rendered. Change-Id: I3fcfb6aee4dea9c4f9186a7aec70d382a1abd634 Signed-off-by: Marc Schink Reviewed-on: http://openocd.zylin.com/6133 Tested-by: jenkins Reviewed-by: Antonio Borneo --- diff --git a/doc/manual/style.txt b/doc/manual/style.txt index c3fcfd782..755709fb0 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