interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Marc Schink 2021-04-05 15:40:35 +02:00 committed by Antonio Borneo
parent 134d7d5a58
commit 0ec9018040
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manual/style.txt
View File

@ -114,9 +114,9 @@ pthreads require modest and predictable stack usage.
- static inline functions should be preferred over macros: - static inline functions should be preferred over macros:
@code @code
/** do NOT define macro-like functions like this... */ /* do NOT define macro-like functions like this... */
#define CUBE(x) ((x) * (x) * (x)) #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; } static inline int cube(int x) { return x * x * x; }
@endcode @endcode
- Functions should be declared static unless required by other modules - Functions should be declared static unless required by other modules