Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc][doxygen]: Fix doxygen warning in comment #9096

Merged
merged 1 commit into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
@@ -1,5 +1,5 @@
/*
* This file is only used for doxygen document generation.

Check failure on line 2 in documentation/doxygen/kernel.h

View workflow job for this annotation

GitHub Actions / Check Spelling

`doxygen` is not a recognized word. (unrecognized-spelling)
*/

/**
Expand Down Expand Up @@ -58,11 +58,11 @@
* Kernel objects include most of the facilities in the kernel:
* - thread
* - semaphore and mutex
* - event/fast event, mailbox, messagequeue

Check failure on line 61 in documentation/doxygen/kernel.h

View workflow job for this annotation

GitHub Actions / Check Spelling

`messagequeue` is not a recognized word. (unrecognized-spelling)
* - memory pool
* - timer
* @image html Kernel_Object.png "Figure 2: Kernel Object"
* @image rtf Kernel_Object.png "Figure 2: Kernel Object"

Check failure on line 65 in documentation/doxygen/kernel.h

View workflow job for this annotation

GitHub Actions / Check Spelling

`rtf` is not a recognized word. (unrecognized-spelling)
*
* Kernel objects can be static objects, whose memory is allocated in compiling.
* It can be dynamic objects as well, whose memory is allocated from system heaps
Expand All @@ -88,7 +88,7 @@
*
* RT-Thread operating systems supports event/fast event, mail box and message queue.
* - The event mechanism is used to awake a thread by setting one or more corresponding
* bit of a binary number when an event ocurs.

Check failure on line 91 in documentation/doxygen/kernel.h

View workflow job for this annotation

GitHub Actions / Check Spelling

`ocurs` is not a recognized word. (unrecognized-spelling)
* - The fast event supports event thread queue. Once a one bit event occurs, the corresponding
* blocked thread can be found out timing accurately, then will be waked up.
* - In mailbox, the mail length is fixed to 4 byte, which is more effective than message queue.
Expand Down 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
Loading