From 57de50e8e6277092df53c6eaaa70776b8f4c2c8f Mon Sep 17 00:00:00 2001 From: supperthomas <78900636@qq.com> Date: Tue, 25 Jun 2024 10:20:06 +0800 Subject: [PATCH] [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 <78900636@qq.com> --- .github/workflows/doxygen.yml | 2 -- documentation/doxygen/kernel.h | 2 +- src/kservice.c | 1 + 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 6fecc086ec6..447c66634c8 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 ad6471db365..15f6983e078 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 25d7f2e7e0a..e61bae296ad 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,