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 struct error. #9103

Merged
merged 1 commit into from
Jun 26, 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
17 changes: 13 additions & 4 deletions 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 @@ -32,10 +32,10 @@
* round-robin scheduling is used for this case.
* - The time of scheduler to choose the next highest ready thread is determinant.
* - There are four status in thread management
* -# Initialization
* -# Running/Ready
* -# Blocked
* -# Closed
* -# Initialization
* -# Running/Ready
* -# Blocked
* -# Closed
* - The number of threads in the system is unlimited, only related with RAM.
*/

Expand All @@ -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,13 +88,22 @@
*
* 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.
* - The send action for communication facilities is also safe for interrupt service routine.
*/

/**
* @defgroup Signal Signal
* @brief signal is used for thread kill etc.
*
* A signal (also known as a soft interrupt signal), from a software perspective,
* is a simulation of interrupt mechanism. When it comes to its principle,
* thread receiving a signal is similar to processor receiving an interrupt request.
*/

/**
* @defgroup MM Memory Management
* @brief memory management for memory pool and heap memory
Expand Down
35 changes: 35 additions & 0 deletions include/rtdef.h
Original file line number Diff line number Diff line change
Expand Up @@ -1024,6 +1024,11 @@ struct rt_ipc_object
rt_list_t suspend_thread; /**< threads pended on this resource */
};

/**
* @addtogroup semaphore
* @{
*/

#ifdef RT_USING_SEMAPHORE
/**
* Semaphore structure
Expand All @@ -1039,6 +1044,13 @@ struct rt_semaphore
typedef struct rt_semaphore *rt_sem_t;
#endif /* RT_USING_SEMAPHORE */

/**@}*/

/**
* @addtogroup mutex
* @{
*/

#ifdef RT_USING_MUTEX
/**
* Mutual exclusion (mutex) structure
Expand All @@ -1059,6 +1071,13 @@ struct rt_mutex
typedef struct rt_mutex *rt_mutex_t;
#endif /* RT_USING_MUTEX */

/**@}*/

/**
* @addtogroup event
* @{
*/

#ifdef RT_USING_EVENT
/**
* flag definitions in event
Expand All @@ -1080,6 +1099,13 @@ struct rt_event
typedef struct rt_event *rt_event_t;
#endif /* RT_USING_EVENT */

/**@}*/

/**
* @addtogroup mailbox
* @{
*/

#ifdef RT_USING_MAILBOX
/**
* mailbox structure
Expand All @@ -1102,6 +1128,13 @@ struct rt_mailbox
typedef struct rt_mailbox *rt_mailbox_t;
#endif /* RT_USING_MAILBOX */

/**@}*/

/**
* @addtogroup messagequeue
* @{
*/

#ifdef RT_USING_MESSAGEQUEUE
/**
* message queue structure
Expand Down Expand Up @@ -1129,6 +1162,8 @@ typedef struct rt_messagequeue *rt_mq_t;

/**@}*/

/**@}*/

/**
* @addtogroup MM
*/
Expand Down
36 changes: 35 additions & 1 deletion include/rtthread.h
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ void rt_scheduler_ipi_handler(int vector, void *param);
/**@}*/

/**
* @addtogroup Signals
* @addtogroup Signal
* @{
*/
#ifdef RT_USING_SIGNALS
Expand Down Expand Up @@ -403,6 +403,11 @@ rt_err_t rt_thread_suspend_to_list(rt_thread_t thread, rt_list_t *susp_list, int
/* only for a suspended thread, and caller must hold the scheduler lock */
rt_err_t rt_susp_list_enqueue(rt_list_t *susp_list, rt_thread_t thread, int ipc_flags);

/**
* @addtogroup semaphore
* @{
*/

#ifdef RT_USING_SEMAPHORE
/*
* semaphore interface
Expand All @@ -425,6 +430,13 @@ rt_err_t rt_sem_release(rt_sem_t sem);
rt_err_t rt_sem_control(rt_sem_t sem, int cmd, void *arg);
#endif /* RT_USING_SEMAPHORE */

/**@}*/

/**
* @addtogroup mutex
* @{
*/

#ifdef RT_USING_MUTEX
/*
* mutex interface
Expand Down Expand Up @@ -457,6 +469,13 @@ rt_inline rt_ubase_t rt_mutex_get_hold(rt_mutex_t mutex)

#endif /* RT_USING_MUTEX */

/**@}*/

/**
* @addtogroup event
* @{
*/

#ifdef RT_USING_EVENT
/*
* event interface
Expand Down Expand Up @@ -487,6 +506,13 @@ rt_err_t rt_event_recv_killable(rt_event_t event,
rt_err_t rt_event_control(rt_event_t event, int cmd, void *arg);
#endif /* RT_USING_EVENT */

/**@}*/

/**
* @addtogroup mailbox
* @{
*/

#ifdef RT_USING_MAILBOX
/*
* mailbox interface
Expand Down Expand Up @@ -521,6 +547,12 @@ rt_err_t rt_mb_recv_killable(rt_mailbox_t mb, rt_ubase_t *value, rt_int32_t time
rt_err_t rt_mb_control(rt_mailbox_t mb, int cmd, void *arg);
#endif /* RT_USING_MAILBOX */

/**@}*/

/**
* @addtogroup messagequeue
* @{
*/
#ifdef RT_USING_MESSAGEQUEUE

struct rt_mq_message
Expand Down Expand Up @@ -599,6 +631,8 @@ rt_ssize_t rt_mq_recv_prio(rt_mq_t mq,
#endif /* RT_USING_MESSAGEQUEUE_PRIORITY */
#endif /* RT_USING_MESSAGEQUEUE */

/**@}*/

/* defunct */
void rt_thread_defunct_enqueue(rt_thread_t thread);
rt_thread_t rt_thread_defunct_dequeue(void);
Expand Down
Loading