Merge branch 'main' into feature/mchp-updates

Author: aggarg

include/croutine.h

@@ -62,13 +62,13 @@ typedef struct corCoRoutineControlBlock
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * BaseType_t xCoRoutineCreate(
  *                               crCOROUTINE_CODE pxCoRoutineCode,
  *                               UBaseType_t uxPriority,
  *                               UBaseType_t uxIndex
  *                             );
- * </pre>
+ * @endcode
  *
  * Create a new co-routine and add it to the list of co-routines that are
  * ready to run.
@@ -88,7 +88,7 @@ typedef struct corCoRoutineControlBlock
  * list, otherwise an error code defined with ProjDefs.h.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // Co-routine to be created.
  * void vFlashCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
  * {
@@ -129,7 +129,7 @@ typedef struct corCoRoutineControlBlock
  *       xCoRoutineCreate( vFlashCoRoutine, 0, uxIndex );
  *   }
  * }
- * </pre>
+ * @endcode
  * \defgroup xCoRoutineCreate xCoRoutineCreate
  * \ingroup Tasks
  */
@@ -140,9 +140,9 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * void vCoRoutineSchedule( void );
- * </pre>
+ * @endcode
  *
  * Run a co-routine.
  *
@@ -156,7 +156,7 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
  * hook).
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // This idle task hook will schedule a co-routine each time it is called.
  * // The rest of the idle task will execute between co-routine calls.
  * void vApplicationIdleHook( void )
@@ -174,22 +174,22 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
  *      vCoRoutineSchedule();
  *  }
  * }
- * </pre>
+ * @endcode
  * \defgroup vCoRoutineSchedule vCoRoutineSchedule
  * \ingroup Tasks
  */
 void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crSTART( CoRoutineHandle_t xHandle );
- * </pre>
+ * @endcode
  *
  * This macro MUST always be called at the start of a co-routine function.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // Co-routine to be created.
  * void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
  * {
@@ -207,7 +207,7 @@ void vCoRoutineSchedule( void );
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
  * }
- * </pre>
+ * @endcode
  * \defgroup crSTART crSTART
  * \ingroup Tasks
  */
@@ -217,14 +217,14 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crEND();
- * </pre>
+ * @endcode
  *
  * This macro MUST always be called at the end of a co-routine function.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // Co-routine to be created.
  * void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
  * {
@@ -242,7 +242,7 @@ void vCoRoutineSchedule( void );
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
  * }
- * </pre>
+ * @endcode
  * \defgroup crSTART crSTART
  * \ingroup Tasks
  */
@@ -261,9 +261,9 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );
- * </pre>
+ * @endcode
  *
  * Delay a co-routine for a fixed period of time.
  *
@@ -280,7 +280,7 @@ void vCoRoutineSchedule( void );
  * can be used to convert ticks to milliseconds.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // Co-routine to be created.
  * void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
  * {
@@ -303,7 +303,7 @@ void vCoRoutineSchedule( void );
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
  * }
- * </pre>
+ * @endcode
  * \defgroup crDELAY crDELAY
  * \ingroup Tasks
  */
@@ -315,15 +315,15 @@ void vCoRoutineSchedule( void );
     crSET_STATE0( ( xHandle ) );
 
 /**
- * <pre>
+ * @code{c}
  * crQUEUE_SEND(
  *                CoRoutineHandle_t xHandle,
  *                QueueHandle_t pxQueue,
  *                void *pvItemToQueue,
  *                TickType_t xTicksToWait,
  *                BaseType_t *pxResult
  *           )
- * </pre>
+ * @endcode
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
  * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@@ -363,7 +363,7 @@ void vCoRoutineSchedule( void );
  * error defined within ProjDefs.h.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // Co-routine function that blocks for a fixed period then posts a number onto
  * // a queue.
  * static void prvCoRoutineFlashTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@@ -395,7 +395,7 @@ void vCoRoutineSchedule( void );
  *  // Co-routines must end with a call to crEND().
  *  crEND();
  * }
- * </pre>
+ * @endcode
  * \defgroup crQUEUE_SEND crQUEUE_SEND
  * \ingroup Tasks
  */
@@ -416,15 +416,15 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_RECEIVE(
  *                   CoRoutineHandle_t xHandle,
  *                   QueueHandle_t pxQueue,
  *                   void *pvBuffer,
  *                   TickType_t xTicksToWait,
  *                   BaseType_t *pxResult
  *               )
- * </pre>
+ * @endcode
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
  * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@@ -463,7 +463,7 @@ void vCoRoutineSchedule( void );
  * an error code as defined within ProjDefs.h.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // A co-routine receives the number of an LED to flash from a queue.  It
  * // blocks on the queue until the number is received.
  * static void prvCoRoutineFlashWorkTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@@ -489,7 +489,7 @@ void vCoRoutineSchedule( void );
  *
  *  crEND();
  * }
- * </pre>
+ * @endcode
  * \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE
  * \ingroup Tasks
  */
@@ -510,13 +510,13 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_SEND_FROM_ISR(
  *                          QueueHandle_t pxQueue,
  *                          void *pvItemToQueue,
  *                          BaseType_t xCoRoutinePreviouslyWoken
  *                     )
- * </pre>
+ * @endcode
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
  * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@@ -551,7 +551,7 @@ void vCoRoutineSchedule( void );
  * the ISR.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // A co-routine that blocks on a queue waiting for characters to be received.
  * static void vReceivingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
  * {
@@ -600,7 +600,7 @@ void vCoRoutineSchedule( void );
  *       xCRWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsRxQueue, &cRxedChar, xCRWokenByPost );
  *   }
  * }
- * </pre>
+ * @endcode
  * \defgroup crQUEUE_SEND_FROM_ISR crQUEUE_SEND_FROM_ISR
  * \ingroup Tasks
  */
@@ -610,13 +610,13 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- * <pre>
+ * @code{c}
  * crQUEUE_SEND_FROM_ISR(
  *                          QueueHandle_t pxQueue,
  *                          void *pvBuffer,
  *                          BaseType_t * pxCoRoutineWoken
  *                     )
- * </pre>
+ * @endcode
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
  * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@@ -651,7 +651,7 @@ void vCoRoutineSchedule( void );
  * pdFALSE.
  *
  * Example usage:
- * <pre>
+ * @code{c}
  * // A co-routine that posts a character to a queue then blocks for a fixed
  * // period.  The character is incremented each time.
  * static void vSendingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@@ -716,7 +716,7 @@ void vCoRoutineSchedule( void );
  *       }
  *   }
  * }
- * </pre>
+ * @endcode
  * \defgroup crQUEUE_RECEIVE_FROM_ISR crQUEUE_RECEIVE_FROM_ISR
  * \ingroup Tasks
  */