RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doxygen: Rework some Doxygen comments

Browse Source 
They are intended as examples in the RTEMS Software Engineering manual.

Update #3704.
This commit is contained in:
Sebastian Huber
2019-04-03 12:44:42 +02:00
parent a2aec0b72d
commit fbe8a7ab90
3 changed files with 46 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
cpukit/include/rtems/rtems/message.h
View File

@@ -104,19 +104,27 @@ rtems_status_code rtems_message_queue_delete(
); );
/** /**
* @brief rtems_message_queue_send * @brief Sends a message to the message queue.
* *
* Message Queue Manager - rtems_message_queue_send * This directive sends the message buffer to the message queue indicated by
* ID. If one or more tasks is blocked waiting to receive a message from this
* message queue, then one will receive the message. The task selected to
* receive the message is based on the task queue discipline algorithm in use
* by this particular message queue. If no tasks are waiting, then the message
* buffer will be placed at the rear of the chain of pending messages for this
* message queue.
* *
* This routine implements the rtems_message_queue_send directive. * @param id The message queue ID.
* This directive sends the message buffer to the message queue * @param buffer The message content buffer.
* indicated by ID. If one or more tasks is blocked waiting * @param size The size of the message.
* to receive a message from this message queue, then one will *
* receive the message. The task selected to receive the * @retval RTEMS_SUCCESSFUL Successful operation.
* message is based on the task queue discipline algorithm in * @retval RTEMS_INVALID_ID Invalid message queue ID.
* use by this particular message queue. If no tasks are waiting, * @retval RTEMS_INVALID_ADDRESS The message buffer pointer is @c NULL.
* then the message buffer will be placed at the REAR of the * @retval RTEMS_INVALID_SIZE The message size is larger than the maximum
* chain of pending messages for this message queue. * message size of the message queue.
* @retval RTEMS_TOO_MANY The new message would exceed the message queue limit
* for pending messages.
*/ */
rtems_status_code rtems_message_queue_send( rtems_status_code rtems_message_queue_send(
rtems_id id, rtems_id id,
@@ -169,25 +177,27 @@ rtems_status_code rtems_message_queue_broadcast(
); );
/** /**
* @brief RTEMS Message Queue Receive * @brief Receives a message from the message queue
* *
* This routine implements the rtems_message_queue_receive directive. * This directive is invoked when the calling task wishes to receive a message
* This directive is invoked when the calling task wishes to receive * from the message queue indicated by ID. The received message is to be placed
* a message from the message queue indicated by ID. The received * in the buffer. If no messages are outstanding and the option set indicates
* message is to be placed in buffer. If no messages are outstanding * that the task is willing to block, then the task will be blocked until a
* and the option_set indicates that the task is willing to block, * message arrives or until, optionally, timeout clock ticks have passed.
* then the task will be blocked until a message arrives or until,
* optionally, timeout clock ticks have passed.
* *
* @param[in] id is the queue id * @param id The message queue ID.
* @param[in] buffer is the pointer to message buffer * @param[out] buffer The buffer for the message content. The buffer must be
* @param[in] size is the size of message receive * large enough to store maximum size messages of this message queue.
* @param[in] option_set is the options on receive * @param[out] size The size of the message.
* @param[in] timeout is the number of ticks to wait * @param option_set The option set, e.g. RTEMS_NO_WAIT or RTEMS_WAIT.
* @param timeout The number of ticks to wait if the RTEMS_WAIT is set. Use
* RTEMS_NO_TIMEOUT to wait indefinitely.
* *
* @retval This method returns RTEMS_SUCCESSFUL if there was not an * @retval RTEMS_SUCCESSFUL Successful operation.
* error. Otherwise, a status code is returned indicating the * @retval RTEMS_INVALID_ID Invalid message queue ID.
* source of the error. * @retval RTEMS_INVALID_ADDRESS The message buffer pointer or the message size
* pointer is @c NULL.
* @retval RTEMS_TIMEOUT A timeout occurred and no message was received.
*/ */
rtems_status_code rtems_message_queue_receive( rtems_status_code rtems_message_queue_receive(
rtems_id id, rtems_id id,

4
cpukit/include/rtems/score/rbtree.h
View File

@@ -106,8 +106,8 @@ RTEMS_INLINE_ROUTINE bool _RBTree_Is_node_off_tree(
/** /**
* @brief Rebalances the red-black tree after insertion of the node. * @brief Rebalances the red-black tree after insertion of the node.
* *
* @param[in] the_rbtree The red-black tree control. * @param[in, out] the_rbtree The red-black tree control.
* @param[in] the_node The most recently inserted node. * @param[in, out] the_node The most recently inserted node.
*/ */
void _RBTree_Insert_color( void _RBTree_Insert_color(
RBTree_Control *the_rbtree, RBTree_Control *the_rbtree,

17
cpukit/include/rtems/score/wkspace.h
View File

@@ -57,19 +57,16 @@ void _Workspace_Handler_initialization(
); );
/** /**
* @brief Allocate memory from workspace. * @brief Allocates a memory block of the specified size from the workspace.
* *
* This routine returns the address of a block of memory of size * @param size The size of the memory block.
* bytes. If a block of the appropriate size cannot be allocated
* from the workspace, then NULL is returned.
* *
* @param size is the requested size * @retval pointer The pointer to the memory block. The pointer is at least
* * aligned by CPU_HEAP_ALIGNMENT.
* @retval a pointer to the requested memory or NULL. * @retval NULL No memory block with the requested size is available in the
* workspace.
*/ */
void *_Workspace_Allocate( void *_Workspace_Allocate( size_t size );
size_t size
);
/** /**
* @brief Allocate aligned memory from workspace. * @brief Allocate aligned memory from workspace.