Doxygen touch-ups

include/croutine.h

@@ -60,12 +60,13 @@ typedef struct corCoRoutineControlBlock
 
 /**
  * croutine. h
- *<pre>
+ * <pre>
  * BaseType_t xCoRoutineCreate(
  *                               crCOROUTINE_CODE pxCoRoutineCode,
  *                               UBaseType_t uxPriority,
  *                               UBaseType_t uxIndex
- *                             );</pre>
+ *                             ); 
+ * </pre>
  *
  * Create a new co-routine and add it to the list of co-routines that are
  * ready to run.
@@ -137,8 +138,9 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
 
 /**
  * croutine. h
- *<pre>
- * void vCoRoutineSchedule( void );</pre>
+ * <pre>
+ * void vCoRoutineSchedule( void );
+ * </pre>
  *
  * Run a co-routine.
  *
@@ -179,7 +181,8 @@ void vCoRoutineSchedule( void );
 /**
  * croutine. h
  * <pre>
- * crSTART( CoRoutineHandle_t xHandle );</pre>
+ * crSTART( CoRoutineHandle_t xHandle );
+ * </pre>
  *
  * This macro MUST always be called at the start of a co-routine function.
  *
@@ -201,7 +204,8 @@ void vCoRoutineSchedule( void );
  *
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crSTART crSTART
  * \ingroup Tasks
  */
@@ -212,7 +216,8 @@ void vCoRoutineSchedule( void );
 /**
  * croutine. h
  * <pre>
- * crEND();</pre>
+ * crEND();
+ * </pre>
  *
  * This macro MUST always be called at the end of a co-routine function.
  *
@@ -234,7 +239,8 @@ void vCoRoutineSchedule( void );
  *
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crSTART crSTART
  * \ingroup Tasks
  */
@@ -253,8 +259,9 @@ void vCoRoutineSchedule( void );
 
 /**
  * croutine. h
- *<pre>
- * crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );</pre>
+ * <pre>
+ * crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );
+ * </pre>
  *
  * Delay a co-routine for a fixed period of time.
  *
@@ -293,7 +300,8 @@ void vCoRoutineSchedule( void );
  *
  *   // Must end every co-routine with a call to crEND();
  *   crEND();
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crDELAY crDELAY
  * \ingroup Tasks
  */
@@ -312,7 +320,8 @@ void vCoRoutineSchedule( void );
  *                void *pvItemToQueue,
  *                TickType_t xTicksToWait,
  *                BaseType_t *pxResult
- *           )</pre>
+ *           )
+ * </pre>
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
  * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@@ -383,7 +392,8 @@ void vCoRoutineSchedule( void );
  *
  *  // Co-routines must end with a call to crEND().
  *  crEND();
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crQUEUE_SEND crQUEUE_SEND
  * \ingroup Tasks
  */
@@ -411,7 +421,8 @@ void vCoRoutineSchedule( void );
  *                   void *pvBuffer,
  *                   TickType_t xTicksToWait,
  *                   BaseType_t *pxResult
- *               )</pre>
+ *               )
+ * </pre>
  *
  * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
  * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@@ -475,7 +486,8 @@ void vCoRoutineSchedule( void );
  *  }
  *
  *  crEND();
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE
  * \ingroup Tasks
  */
@@ -501,7 +513,8 @@ void vCoRoutineSchedule( void );
  *                          QueueHandle_t pxQueue,
  *                          void *pvItemToQueue,
  *                          BaseType_t xCoRoutinePreviouslyWoken
- *                     )</pre>
+ *                     )
+ * </pre>
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
  * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@@ -584,7 +597,8 @@ void vCoRoutineSchedule( void );
  *       // many characters are posted to the queue.
  *       xCRWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsRxQueue, &cRxedChar, xCRWokenByPost );
  *   }
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crQUEUE_SEND_FROM_ISR crQUEUE_SEND_FROM_ISR
  * \ingroup Tasks
  */
@@ -599,7 +613,8 @@ void vCoRoutineSchedule( void );
  *                          QueueHandle_t pxQueue,
  *                          void *pvBuffer,
  *                          BaseType_t * pxCoRoutineWoken
- *                     )</pre>
+ *                     )
+ * </pre>
  *
  * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
  * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@@ -698,7 +713,8 @@ void vCoRoutineSchedule( void );
  *           SEND_CHARACTER( cCharToTx );
  *       }
  *   }
- * }</pre>
+ * }
+ * </pre>
  * \defgroup crQUEUE_RECEIVE_FROM_ISR crQUEUE_RECEIVE_FROM_ISR
  * \ingroup Tasks
  */

include/event_groups.h

@@ -94,7 +94,7 @@ typedef TickType_t               EventBits_t;
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  * EventGroupHandle_t xEventGroupCreate( void );
  * </pre>
  *
@@ -150,7 +150,7 @@ typedef TickType_t               EventBits_t;
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  * EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );
  * </pre>
  *
@@ -203,7 +203,7 @@ typedef TickType_t               EventBits_t;
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupWaitBits(    EventGroupHandle_t xEventGroup,
  *                                      const EventBits_t uxBitsToWaitFor,
  *                                      const BaseType_t xClearOnExit,
@@ -301,7 +301,7 @@ EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );
  * </pre>
  *
@@ -359,7 +359,7 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
  * </pre>
  *
@@ -420,7 +420,7 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );
  * </pre>
  *
@@ -495,7 +495,7 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );
  * </pre>
  *
@@ -576,7 +576,7 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupSync(    EventGroupHandle_t xEventGroup,
  *                                  const EventBits_t uxBitsToSet,
  *                                  const EventBits_t uxBitsToWaitFor,
@@ -706,7 +706,7 @@ EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );
  * </pre>
  *
@@ -724,7 +724,7 @@ EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup );
  * </pre>
  *
@@ -741,7 +741,7 @@ EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEG
 
 /**
  * event_groups.h
- *<pre>
+ * <pre>
  *  void xEventGroupDelete( EventGroupHandle_t xEventGroup );
  * </pre>
  *

include/message_buffer.h

@@ -218,7 +218,7 @@ typedef void * MessageBufferHandle_t;
  *                         const void *pvTxData,
  *                         size_t xDataLengthBytes,
  *                         TickType_t xTicksToWait );
- * <pre>
+ * </pre>
  *
  * Sends a discrete message to the message buffer.  The message can be any
  * length that fits within the buffer's free space, and is copied into the
@@ -318,7 +318,7 @@ typedef void * MessageBufferHandle_t;
  *                                const void *pvTxData,
  *                                size_t xDataLengthBytes,
  *                                BaseType_t *pxHigherPriorityTaskWoken );
- * <pre>
+ * </pre>
  *
  * Interrupt safe version of the API function that sends a discrete message to
  * the message buffer.  The message can be any length that fits within the

include/queue.h

@@ -664,7 +664,8 @@ BaseType_t xQueueGenericSend( QueueHandle_t xQueue,
  *                           QueueHandle_t xQueue,
  *                           void * const pvBuffer,
  *                           TickType_t xTicksToWait
- *                       );</pre>
+ *                       );
+ * </pre>
  *
  * Receive an item from a queue without removing the item from the queue.
  * The item is received by copy so a buffer of adequate size must be
@@ -759,7 +760,8 @@ BaseType_t xQueuePeek( QueueHandle_t xQueue,
  * BaseType_t xQueuePeekFromISR(
  *                                  QueueHandle_t xQueue,
  *                                  void *pvBuffer,
- *                              );</pre>
+ *                              );
+ * </pre>
  *
  * A version of xQueuePeek() that can be called from an interrupt service
  * routine (ISR).
@@ -794,7 +796,8 @@ BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue,
  *                               QueueHandle_t xQueue,
  *                               void *pvBuffer,
  *                               TickType_t xTicksToWait
- *                          );</pre>
+ *                          );
+ * </pre>
  *
  * Receive an item from a queue.  The item is received by copy so a buffer of
  * adequate size must be provided.  The number of bytes copied into the buffer
@@ -882,7 +885,9 @@ BaseType_t xQueueReceive( QueueHandle_t xQueue,
 
 /**
  * queue. h
- * <pre>UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );</pre>
+ * <pre>
+ * UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );
+ * </pre>
  *
  * Return the number of messages stored in a queue.
  *
@@ -897,7 +902,9 @@ UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNC
 
 /**
  * queue. h
- * <pre>UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );</pre>
+ * <pre>
+ * UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );
+ * </pre>
  *
  * Return the number of free spaces available in a queue.  This is equal to the
  * number of items that can be sent to the queue before the queue becomes full
@@ -914,7 +921,9 @@ UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNC
 
 /**
  * queue. h
- * <pre>void vQueueDelete( QueueHandle_t xQueue );</pre>
+ * <pre>
+ * void vQueueDelete( QueueHandle_t xQueue );
+ * </pre>
  *
  * Delete a queue - freeing all the memory allocated for storing of items
  * placed on the queue.