aboutsummaryrefslogtreecommitdiff
path: root/include/trace.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/trace.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value. find . -name '*.c' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'include/trace.h')
-rw-r--r--include/trace.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/trace.h b/include/trace.h
index 606dba97689..e7aee024f03 100644
--- a/include/trace.h
+++ b/include/trace.h
@@ -55,7 +55,7 @@ void trace_print_stats(void);
* @param buff Buffer in which to place data, or NULL to count size
* @param buff_size Size of buffer
* @param needed Returns number of bytes used / needed
- * @return 0 if ok, -1 on error (buffer exhausted)
+ * Return: 0 if ok, -1 on error (buffer exhausted)
*/
int trace_list_functions(void *buff, size_t buff_size, size_t *needed);