Skip to content

Commit

Permalink
[doc][doxygen]: Fix doxygen warning in comment
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
supperthomas authored and mysterywolf committed Jun 25, 2024
1 parent 7ae476d commit 038ff8b
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 3 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/**
Expand Down
2 changes: 1 addition & 1 deletion documentation/doxygen/kernel.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 change: 1 addition & 0 deletions src/kservice.c
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 038ff8b

Please sign in to comment.