Merge branch 'zim-pre-to-endcode-remaining' into 'master'

freertos:remaining <pre> to @code changes

See merge request espressif/esp-idf!14997

components/freertos/include/freertos/croutine.h

@@ -61,13 +61,13 @@ typedef struct corCoRoutineControlBlock
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * BaseType_t xCoRoutineCreate(
  *                               crCOROUTINE_CODE pxCoRoutineCode,
  *                               UBaseType_t uxPriority,
  *                               UBaseType_t uxIndex
  *                             );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Create a new co-routine and add it to the list of co-routines that are
@@ -143,9 +143,9 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * void vCoRoutineSchedule( void );
- * </pre>
+ * @endcode
  * @endcond
  * Run a co-routine.
  *
@@ -177,7 +177,7 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
  *      vCoRoutineSchedule();
  *  }
  * }
- * </pre>
+ * @endcode
  * @endcode
  * @cond
  * \defgroup vCoRoutineSchedule vCoRoutineSchedule
@@ -189,9 +189,9 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crSTART( CoRoutineHandle_t xHandle );
- * </pre>
+ * @endcode
  * @endcond
  *
  * This macro MUST always be called at the start of a co-routine function.
@@ -228,9 +228,9 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crEND();
- * </pre>
+ * @endcode
  * @endcond
  *
  * This macro MUST always be called at the end of a co-routine function.
@@ -276,9 +276,9 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Delay a co-routine for a fixed period of time.
@@ -334,7 +334,7 @@ void vCoRoutineSchedule( void );
 
 /**
  * @cond
- * <pre>
+ * @code{c}
  * crQUEUE_SEND(
  *                CoRoutineHandle_t xHandle,
  *                QueueHandle_t pxQueue,
@@ -342,7 +342,7 @@ void vCoRoutineSchedule( void );
  *                TickType_t xTicksToWait,
  *                BaseType_t *pxResult
  *           )
- * </pre>
+ * @endcode
  * @endcond
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
@@ -439,7 +439,7 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_RECEIVE(
  *                   CoRoutineHandle_t xHandle,
  *                   QueueHandle_t pxQueue,
@@ -447,7 +447,7 @@ void vCoRoutineSchedule( void );
  *                   TickType_t xTicksToWait,
  *                   BaseType_t *pxResult
  *               )
- * </pre>
+ * @endcode
  * @endcond
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
@@ -513,7 +513,6 @@ void vCoRoutineSchedule( void );
  *
  *  crEND();
  * }
- * </pre>
  * @endcode
  * @cond
  * \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE
@@ -538,13 +537,13 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_SEND_FROM_ISR(
  *                          QueueHandle_t pxQueue,
  *                          void *pvItemToQueue,
  *                          BaseType_t xCoRoutinePreviouslyWoken
  *                     )
- * </pre>
+ * @endcode
  * @endcond
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
@@ -642,13 +641,13 @@ void vCoRoutineSchedule( void );
 /**
  * @cond
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_SEND_FROM_ISR(
  *                          QueueHandle_t pxQueue,
  *                          void *pvBuffer,
  *                          BaseType_t * pxCoRoutineWoken
  *                     )
- * </pre>
+ * @endcode
  * @endcond
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the

components/freertos/include/freertos/event_groups.h

@@ -101,9 +101,9 @@ typedef TickType_t               EventBits_t;
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  * EventGroupHandle_t xEventGroupCreate( void );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Create a new event group.
@@ -161,9 +161,9 @@ typedef TickType_t               EventBits_t;
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  * EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Create a new event group.
@@ -216,13 +216,13 @@ typedef TickType_t               EventBits_t;
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupWaitBits(    EventGroupHandle_t xEventGroup,
  *                                      const EventBits_t uxBitsToWaitFor,
  *                                      const BaseType_t xClearOnExit,
  *                                      const BaseType_t xWaitForAllBits,
  *                                      const TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * [Potentially] block to wait for one or more bits to be set within a
@@ -318,9 +318,9 @@ EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Clear bits within an event group.  This function cannot be called from an
@@ -380,9 +380,9 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
- * </pre>
+ * @endcode
  * @endcond
  *
  * A version of xEventGroupClearBits() that can be called from an interrupt.
@@ -445,9 +445,9 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Set bits within an event group.
@@ -524,9 +524,9 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * A version of xEventGroupSetBits() that can be called from an interrupt.
@@ -609,12 +609,12 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupSync(    EventGroupHandle_t xEventGroup,
  *                                  const EventBits_t uxBitsToSet,
  *                                  const EventBits_t uxBitsToWaitFor,
  *                                  TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Atomically set bits within an event group, then wait for a combination of
@@ -743,9 +743,9 @@ EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Returns the current value of the bits in an event group.  This function
@@ -765,9 +765,9 @@ EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup );
- * </pre>
+ * @endcode
  * @endcond
  *
  * A version of xEventGroupGetBits() that can be called from an ISR.
@@ -786,9 +786,9 @@ EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEG
 /**
  * @cond
  * event_groups.h
- * <pre>
+ * @code{c}
  *  void xEventGroupDelete( EventGroupHandle_t xEventGroup );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Delete an event group that was previously created by a call to

components/freertos/include/freertos/message_buffer.h

@@ -88,9 +88,9 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * MessageBufferHandle_t xMessageBufferCreate( size_t xBufferSizeBytes );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new message buffer using dynamically allocated memory.  See
@@ -151,11 +151,11 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * MessageBufferHandle_t xMessageBufferCreateStatic( size_t xBufferSizeBytes,
  *                                                uint8_t *pucMessageBufferStorageArea,
  *                                                StaticMessageBuffer_t *pxStaticMessageBuffer );
- * </pre>
+ * @endcode
  * @endcond
  * Creates a new message buffer using statically allocated memory.  See
  * xMessageBufferCreate() for a version that uses dynamically allocated memory.
@@ -222,12 +222,12 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSend( MessageBufferHandle_t xMessageBuffer,
  *                         const void *pvTxData,
  *                         size_t xDataLengthBytes,
  *                         TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Sends a discrete message to the message buffer.  The message can be any
@@ -326,12 +326,12 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSendFromISR( MessageBufferHandle_t xMessageBuffer,
  *                                const void *pvTxData,
  *                                size_t xDataLengthBytes,
  *                                BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Interrupt safe version of the API function that sends a discrete message to
@@ -435,12 +435,12 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferReceive( MessageBufferHandle_t xMessageBuffer,
  *                            void *pvRxData,
  *                            size_t xBufferLengthBytes,
  *                            TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Receives a discrete message from a message buffer.  Messages can be of
@@ -529,12 +529,12 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferReceiveFromISR( MessageBufferHandle_t xMessageBuffer,
  *                                   void *pvRxData,
  *                                   size_t xBufferLengthBytes,
  *                                   BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * An interrupt safe version of the API function that receives a discrete
@@ -634,9 +634,9 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Deletes a message buffer that was previously created using a call to
@@ -656,9 +656,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * @cond
  * message_buffer.h
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ) );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Tests to see if a message buffer is full.  A message buffer is full if it
@@ -676,9 +676,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * @cond
  * message_buffer.h
- * <pre>
+ * @code{c}{c}
  * BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ) );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Tests to see if a message buffer is empty (does not contain any messages).
@@ -695,9 +695,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * @cond
  * message_buffer.h
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Resets a message buffer to its initial empty state, discarding any message it
@@ -724,9 +724,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * @cond
  * message_buffer.h
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer ) );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Returns the number of bytes of free space in the message buffer.
@@ -753,9 +753,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * @cond
  * message_buffer.h
- * <pre>
+ * @code{c}
  * size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer ) );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Returns the length (in bytes) of the next message in a message buffer.
@@ -779,9 +779,9 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferSendCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * For advanced users only.
@@ -823,9 +823,9 @@ typedef void * MessageBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferReceiveCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * For advanced users only.

components/freertos/include/freertos/queue.h

@@ -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

components/freertos/include/freertos/semphr.h

@@ -42,9 +42,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /** @cond */
 /**
  * semphr. h
- * <pre>
+ * @code{c}
  * vSemaphoreCreateBinary( SemaphoreHandle_t xSemaphore );
- * </pre>
+ * @endcode
  *
  * In many usage scenarios it is faster and more memory efficient to use a
  * direct to task notification in place of a binary semaphore!
@@ -72,7 +72,7 @@ typedef QueueHandle_t SemaphoreHandle_t;
  * @param xSemaphore Handle to the created semaphore.  Should be of type SemaphoreHandle_t.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphore = NULL;
  *
  * void vATask( void * pvParameters )
@@ -87,7 +87,7 @@ typedef QueueHandle_t SemaphoreHandle_t;
  *      // The semaphore can now be used.
  *  }
  * }
- * </pre>
+ * @endcode
  * @cond
  * \defgroup vSemaphoreCreateBinary vSemaphoreCreateBinary
  * @endcond
@@ -108,9 +108,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateBinary( void );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new binary semaphore instance, and returns a handle by which the
@@ -175,9 +175,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateBinaryStatic( StaticSemaphore_t *pxSemaphoreBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new binary semaphore instance, and returns a handle by which the
@@ -241,12 +241,12 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * xSemaphoreTake(
  *                   SemaphoreHandle_t xSemaphore,
  *                   TickType_t xBlockTime
  *               );
- * </pre>
+ * @endcode
  * @endcond
  *
  * <i>Macro</i> to obtain a semaphore.  The semaphore must have previously been
@@ -481,9 +481,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * xSemaphoreGiveRecursive( SemaphoreHandle_t xMutex );
- * </pre>
+ * @endcode
  * @endcond
  *
  * <i>Macro</i> to recursively release, or 'give', a mutex type semaphore.
@@ -674,12 +674,12 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * xSemaphoreTakeFromISR(
  *                        SemaphoreHandle_t xSemaphore,
  *                        BaseType_t *pxHigherPriorityTaskWoken
  *                    );
- * </pre>
+ * @endcode
  * @endcond
  *
  * <i>Macro</i> to  take a semaphore from an ISR.  The semaphore must have
@@ -711,9 +711,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateMutex( void );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new mutex type semaphore instance, and returns a handle by which
@@ -776,9 +776,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateMutexStatic( StaticSemaphore_t *pxMutexBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new mutex type semaphore instance, and returns a handle by which
@@ -976,9 +976,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateCounting( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new counting semaphore instance, and returns a handle by which the
@@ -1062,9 +1062,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * SemaphoreHandle_t xSemaphoreCreateCountingStatic( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount, StaticSemaphore_t *pxSemaphoreBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new counting semaphore instance, and returns a handle by which the
@@ -1153,9 +1153,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr. h
- * <pre>
+ * @code{c}
  * void vSemaphoreDelete( SemaphoreHandle_t xSemaphore );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Delete a semaphore.  This function must be used with care.  For example,
@@ -1173,9 +1173,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr.h
- * <pre>
+ * @code{c}
  * TaskHandle_t xSemaphoreGetMutexHolder( SemaphoreHandle_t xMutex );
- * </pre>
+ * @endcode
  * @endcond
  *
  * If xMutex is indeed a mutex type semaphore, return the current mutex holder.
@@ -1192,9 +1192,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr.h
- * <pre>
+ * @code{c}
  * TaskHandle_t xSemaphoreGetMutexHolderFromISR( SemaphoreHandle_t xMutex );
- * </pre>
+ * @endcode
  * @endcond
  *
  * If xMutex is indeed a mutex type semaphore, return the current mutex holder.
@@ -1207,9 +1207,9 @@ typedef QueueHandle_t SemaphoreHandle_t;
 /**
  * @cond
  * semphr.h
- * <pre>
+ * @code{c}
  * UBaseType_t uxSemaphoreGetCount( SemaphoreHandle_t xSemaphore );
- * </pre>
+ * @endcode
  * @endcond
  *
  * If the semaphore is a counting semaphore then uxSemaphoreGetCount() returns

components/freertos/include/freertos/stream_buffer.h

@@ -74,9 +74,9 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
  * @cond
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * StreamBufferHandle_t xStreamBufferCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new stream buffer using dynamically allocated memory.  See
@@ -145,12 +145,12 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * StreamBufferHandle_t xStreamBufferCreateStatic( size_t xBufferSizeBytes,
  *                                              size_t xTriggerLevelBytes,
  *                                              uint8_t *pucStreamBufferStorageArea,
  *                                              StaticStreamBuffer_t *pxStaticStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Creates a new stream buffer using statically allocated memory.  See
@@ -232,12 +232,12 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
  *                        const void *pvTxData,
  *                        size_t xDataLengthBytes,
  *                        TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Sends bytes to a stream buffer.  The bytes are copied into the stream buffer.
@@ -333,12 +333,12 @@ size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
  *                               const void *pvTxData,
  *                               size_t xDataLengthBytes,
  *                               BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Interrupt safe version of the API function that sends a stream of bytes to
@@ -438,12 +438,12 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
  *                           void *pvRxData,
  *                           size_t xBufferLengthBytes,
  *                           TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Receives bytes from a stream buffer.
@@ -531,12 +531,12 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,
  *                                  void *pvRxData,
  *                                  size_t xBufferLengthBytes,
  *                                  BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * An interrupt safe version of the API function that receives bytes from a
@@ -621,9 +621,9 @@ size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Deletes a stream buffer that was previously created using a call to
@@ -647,9 +647,9 @@ void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTI
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Queries a stream buffer to see if it is full.  A stream buffer is full if it
@@ -671,9 +671,9 @@ BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Queries a stream buffer to see if it is empty.  A stream buffer is empty if
@@ -695,9 +695,9 @@ BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Resets a stream buffer to its initial, empty, state.  Any data that was in
@@ -722,9 +722,9 @@ BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_F
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Queries a stream buffer to see how much free space it contains, which is
@@ -747,9 +747,9 @@ size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVIL
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Queries a stream buffer to see how much data it contains, which is equal to
@@ -772,9 +772,9 @@ size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILE
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );
- * </pre>
+ * @endcode
  * @endcond
  *
  * A stream buffer's trigger level is the number of bytes that must be in the
@@ -814,9 +814,9 @@ BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer,
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * For advanced users only.
@@ -858,9 +858,9 @@ BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer
  * @cond
  * stream_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  * @endcond
  *
  * For advanced users only.

components/freertos/include/freertos/task.h

@@ -763,9 +763,9 @@ typedef enum
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * void vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Memory regions are assigned to a restricted task when the task is created by
@@ -975,9 +975,9 @@ void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime,
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * BaseType_t xTaskAbortDelay( TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * INCLUDE_xTaskAbortDelay must be defined as 1 in FreeRTOSConfig.h for this
@@ -1011,9 +1011,9 @@ BaseType_t xTaskAbortDelay( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * INCLUDE_uxTaskPriorityGet must be defined as 1 for this function to be available.
@@ -1064,9 +1064,9 @@ UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * A version of uxTaskPriorityGet() that can be used from an ISR.
@@ -1076,9 +1076,9 @@ UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask ) PRIVILEGED_FUNC
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * eTaskState eTaskGetState( TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * INCLUDE_eTaskGetState must be defined as 1 for this function to be available.
@@ -1098,9 +1098,9 @@ eTaskState eTaskGetState( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );
- * </pre>
+ * @endcode
  * @endcond
  *
  * configUSE_TRACE_FACILITY must be defined as 1 for this function to be
@@ -1163,9 +1163,9 @@ void vTaskGetInfo( TaskHandle_t xTask,
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority );
- * </pre>
+ * @endcode
  * @endcond
  *
  * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.
@@ -1264,9 +1264,9 @@ void vTaskSuspend( TaskHandle_t xTaskToSuspend ) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * void vTaskResume( TaskHandle_t xTaskToResume );
- * </pre>
+ * @endcode
  * @endcond
  *
  * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.
@@ -1361,7 +1361,7 @@ BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;
  * tasks and starting the kernel.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * void vAFunction( void )
  * {
  *   // Create at least one task before starting the kernel.
@@ -1372,7 +1372,7 @@ BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;
  *
  *   // Will not get here unless a task calls vTaskEndScheduler ()
  * }
- * </pre>
+ * @endcode
  *
  * @cond
  * \defgroup vTaskStartScheduler vTaskStartScheduler
@@ -1404,7 +1404,7 @@ void vTaskStartScheduler( void ) PRIVILEGED_FUNCTION;
  * tasks.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * void vTaskCode( void * pvParameters )
  * {
  *   for( ;; )
@@ -1429,7 +1429,7 @@ void vTaskStartScheduler( void ) PRIVILEGED_FUNCTION;
  *   // vTaskEndScheduler ().  When we get here we are back to single task
  *   // execution.
  * }
- * </pre>
+ * @endcode
  *
  * @cond
  * \defgroup vTaskEndScheduler vTaskEndScheduler
@@ -1494,9 +1494,9 @@ void vTaskSuspendAll( void ) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task. h
- * <pre>
+ * @code{c}
  * BaseType_t xTaskResumeAll( void );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Resumes scheduler activity after it was suspended by a call to
@@ -1706,9 +1706,9 @@ uint8_t* pxTaskGetStackStart( TaskHandle_t xTask) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task.h
- * <pre>
+ * @code{c}
  * void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Sets pxHookFunction to be the task hook function used by the task xTask.
@@ -1723,9 +1723,9 @@ uint8_t* pxTaskGetStackStart( TaskHandle_t xTask) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task.h
- * <pre>
+ * @code{c}
  * void xTaskGetApplicationTaskTag( TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Returns the pxHookFunction value assigned to the task xTask.  Do not
@@ -1737,9 +1737,9 @@ uint8_t* pxTaskGetStackStart( TaskHandle_t xTask) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task.h
- * <pre>
+ * @code{c}
  * void xTaskGetApplicationTaskTagFromISR( TaskHandle_t xTask );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Returns the pxHookFunction value assigned to the task xTask.  Can
@@ -1820,9 +1820,9 @@ uint8_t* pxTaskGetStackStart( TaskHandle_t xTask) PRIVILEGED_FUNCTION;
 /**
  * @cond
  * task.h
- * <pre>
+ * @code{c}
  * BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );
- * </pre>
+ * @endcode
  * @endcond
  *
  * Calls the hook function associated with xTask.  Passing xTask as NULL has
@@ -2052,7 +2052,7 @@ void vTaskGetRunTimeStats( char * pcWriteBuffer ) PRIVILEGED_FUNCTION;     /*lin
 /**
  * @cond
  * task. h
- * <pre>uint32_t ulTaskGetIdleRunTimeCounter( void );</pre>
+ * @code{c}uint32_t ulTaskGetIdleRunTimeCounter( void );@endcode
  * @endcond
  *
  * configGENERATE_RUN_TIME_STATS and configUSE_STATS_FORMATTING_FUNCTIONS

components/freertos/include/freertos/timers.h

@@ -1338,7 +1338,9 @@ BaseType_t xTimerGenericCommand( TimerHandle_t xTimer,
     /**
      * @cond
      * task.h
-     * <pre>void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, StackType_t ** ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize ) </pre>
+     * @code{c}
+     * void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, StackType_t ** ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )
+     * @endcode
      * @endcond
      *
      * This function is used to provide a statically allocated block of memory to FreeRTOS to hold the Timer Task TCB.  This function is required when