alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-03 03:58:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

remaining <pre> to @code changes

Browse Source
This commit is contained in:
Zim Kalinowski
2021-08-30 15:13:27 +08:00
parent 32f4138c6b
commit 29ae014fd6
8 changed files with 198 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
components/freertos/include/freertos/queue.h
View File

@@ -136,14 +136,14 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* QueueHandle_t xQueueCreateStatic(
* UBaseType_t uxQueueLength,
* UBaseType_t uxItemSize,
* uint8_t *pucQueueStorageBuffer,
* StaticQueue_t *pxQueueBuffer
* );
* </pre>
* @endcode
* @endcond
* Creates a new queue instance, and returns a handle by which the new queue
* can be referenced.
@@ -225,13 +225,13 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSendToToFront(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* TickType_t xTicksToWait
* );
* </pre>
* @endcode
* @endcond
*
* Post an item to the front of a queue. The item is queued by copy, not by
@@ -310,13 +310,13 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSendToBack(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* TickType_t xTicksToWait
* );
* </pre>
* @endcode
* @endcond
*
* This is a macro that calls xQueueGenericSend().
@@ -397,13 +397,13 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSend(
* QueueHandle_t xQueue,
* const void * pvItemToQueue,
* TickType_t xTicksToWait
* );
* </pre>
* @endcode
* @endcond
*
* This is a macro that calls xQueueGenericSend(). It is included for
@@ -486,12 +486,12 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueOverwrite(
* QueueHandle_t xQueue,
* const void * pvItemToQueue
* );
* </pre>
* @endcode
* @endcond
*
* Only for use with queues that have a length of one - so the queue is either
@@ -575,14 +575,14 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueGenericSend(
* QueueHandle_t xQueue,
* const void * pvItemToQueue,
* TickType_t xTicksToWait
* BaseType_t xCopyPosition
* );
* </pre>
* @endcode
* @endcond
*
* It is preferred that the macros xQueueSend(), xQueueSendToFront() and
@@ -669,13 +669,13 @@ BaseType_t xQueueGenericSend( QueueHandle_t xQueue,
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueuePeek(
* QueueHandle_t xQueue,
* void * const pvBuffer,
* TickType_t xTicksToWait
* );
* </pre>
* @endcode
* @endcond
*
* Receive an item from a queue without removing the item from the queue.
@@ -770,12 +770,12 @@ BaseType_t xQueuePeek( QueueHandle_t xQueue,
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueuePeekFromISR(
* QueueHandle_t xQueue,
* void *pvBuffer,
* );
* </pre>
* @endcode
* @endcond
*
* A version of xQueuePeek() that can be called from an interrupt service
@@ -809,7 +809,7 @@ BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue,
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueReceive(
* QueueHandle_t xQueue,
* void *pvBuffer,
@@ -907,9 +907,9 @@ BaseType_t xQueueReceive( QueueHandle_t xQueue,
/**
* @cond
* queue. h
* <pre>
* @code{c}
* UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );
* </pre>
* @endcode
* @endcond
*
* Return the number of messages stored in a queue.
@@ -928,9 +928,9 @@ UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNC
/**
* @cond
* queue. h
* <pre>
* @code{c}
* UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );
* </pre>
* @endcode
* @endcond
*
* Return the number of free spaces available in a queue. This is equal to the
@@ -951,9 +951,9 @@ UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNC
/**
* @cond
* queue. h
* <pre>
* @code{c}
* void vQueueDelete( QueueHandle_t xQueue );
* </pre>
* @endcode
* @endcond
*
* Delete a queue - freeing all the memory allocated for storing of items
@@ -971,13 +971,13 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSendToFrontFromISR(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* BaseType_t *pxHigherPriorityTaskWoken
* );
* </pre>
* @endcode
* @endcond
*
* This is a macro that calls xQueueGenericSendFromISR().
@@ -1047,13 +1047,13 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSendToBackFromISR(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* BaseType_t *pxHigherPriorityTaskWoken
* );
* </pre>
* @endcode
* @endcond
*
* This is a macro that calls xQueueGenericSendFromISR().
@@ -1122,13 +1122,13 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueOverwriteFromISR(
* QueueHandle_t xQueue,
* const void * pvItemToQueue,
* BaseType_t *pxHigherPriorityTaskWoken
* );
* </pre>
* @endcode
* @endcond
*
* A version of xQueueOverwrite() that can be used in an interrupt service
@@ -1214,13 +1214,13 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueSendFromISR(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* BaseType_t *pxHigherPriorityTaskWoken
* );
* </pre>
* @endcode
* @endcond
*
* This is a macro that calls xQueueGenericSendFromISR(). It is included
@@ -1295,14 +1295,14 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueGenericSendFromISR(
* QueueHandle_t xQueue,
* const void *pvItemToQueue,
* BaseType_t *pxHigherPriorityTaskWoken,
* BaseType_t xCopyPosition
* );
* </pre>
* @endcode
* @endcond
*
* It is preferred that the macros xQueueSendFromISR(),
@@ -1382,13 +1382,13 @@ BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue,
/**
* @cond
* queue. h
* <pre>
* @code{c}
* BaseType_t xQueueReceiveFromISR(
* QueueHandle_t xQueue,
* void *pvBuffer,
* BaseType_t *pxTaskWoken
* );
* </pre>
* @endcode
* @endcond
*
* Receive an item from a queue. It is safe to use this function from within an