Browse Source

[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>
supperthomas 1 year ago
parent
commit
038ff8b2e5
3 changed files with 2 additions and 3 deletions
  1. 0 2
      .github/workflows/doxygen.yml
  2. 1 1
      documentation/doxygen/kernel.h
  3. 1 0
      src/kservice.c

+ 0 - 2
.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/**

+ 1 - 1
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.
  */
 
 /**@}*/

+ 1 - 0
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,