Skip to content

Commit 038ff8b

Browse files
supperthomasmysterywolf
authored andcommitted
[doc][doxygen]: Fix doxygen warning in comment
kservice.c:474: warning: The following parameter of rt_backtrace_to_buffer(rt_thread_t thread, struct rt_hw_backtrace_frame *frame, long skip, rt_ubase_t *buffer, long buflen) is not documented: parameter 'thread' kernel.h:157: warning: unable to resolve reference to '_rt_errno' for \ref command Signed-off-by: supperthomas <[email protected]>
1 parent 7ae476d commit 038ff8b

File tree

3 files changed

+2
-3
lines changed

3 files changed

+2
-3
lines changed

.github/workflows/doxygen.yml

-2
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@ on:
77
branches:
88
- master
99
paths-ignore:
10-
- documentation/**
1110
- '**/README.md'
1211
- '**/README_zh.md'
1312
pull_request:
1413
branches:
1514
- master
1615
paths-ignore:
17-
- documentation/**
1816
- bsp/**
1917
- examples/**
2018
- .github/**

documentation/doxygen/kernel.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@
154154
* @brief error code
155155
*
156156
* The error code is defined to identify which kind of error occurs. When some
157-
* bad things happen, the current thread's errno will be set. see @ref _rt_errno
157+
* bad things happen, the current thread's errno will be set.
158158
*/
159159

160160
/**@}*/

src/kservice.c

+1
Original file line numberDiff line numberDiff line change
@@ -461,6 +461,7 @@ rt_weak rt_err_t rt_backtrace_formatted_print(rt_ubase_t *buffer, long buflen)
461461
/**
462462
* @brief Print backtrace from frame to the given buffer
463463
*
464+
* @param thread the thread which frame belongs to
464465
* @param frame where backtrace starts from. NULL if it's the current one
465466
* @param skip the number of frames to discarded counted from calling function.
466467
* Noted that the inner most frame is always discarded and not counted,

0 commit comments

Comments
 (0)