diff options
| author | supperthomas <[email protected]> | 2024-06-25 10:20:06 +0800 |
|---|---|---|
| committer | Meco Man <[email protected]> | 2024-06-26 01:21:57 +0800 |
| commit | 038ff8b2e502133e931c70e93e751f13637932ac (patch) | |
| tree | 095337dce681c6c98efb137dea61402b616cc94c | |
| parent | 7ae476dcf2ac0e2f5c37311fb7f5fa872fd5f49f (diff) | |
[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]>
| -rw-r--r-- | .github/workflows/doxygen.yml | 2 | ||||
| -rw-r--r-- | documentation/doxygen/kernel.h | 2 | ||||
| -rw-r--r-- | src/kservice.c | 1 |
3 files changed, 2 insertions, 3 deletions
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 6fecc086ec..447c66634c 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -7,14 +7,12 @@ on: branches: - master paths-ignore: - - documentation/** - '**/README.md' - '**/README_zh.md' pull_request: branches: - master paths-ignore: - - documentation/** - bsp/** - examples/** - .github/** diff --git a/documentation/doxygen/kernel.h b/documentation/doxygen/kernel.h index ad6471db36..15f6983e07 100644 --- a/documentation/doxygen/kernel.h +++ b/documentation/doxygen/kernel.h @@ -154,7 +154,7 @@ * @brief error code * * The error code is defined to identify which kind of error occurs. When some - * bad things happen, the current thread's errno will be set. see @ref _rt_errno + * bad things happen, the current thread's errno will be set. */ /**@}*/ diff --git a/src/kservice.c b/src/kservice.c index 25d7f2e7e0..e61bae296a 100644 --- a/src/kservice.c +++ b/src/kservice.c @@ -461,6 +461,7 @@ rt_weak rt_err_t rt_backtrace_formatted_print(rt_ubase_t *buffer, long buflen) /** * @brief Print backtrace from frame to the given buffer * + * @param thread the thread which frame belongs to * @param frame where backtrace starts from. NULL if it's the current one * @param skip the number of frames to discarded counted from calling function. * Noted that the inner most frame is always discarded and not counted, |