Replace <pre> with @code - remaining files (#388)

Co-authored-by: Paul Bartell <pbartell@amazon.com>
Co-authored-by: Ming Yue <mingyue86010@gmail.com>

include/message_buffer.h

@@ -89,9 +89,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * MessageBufferHandle_t xMessageBufferCreate( size_t xBufferSizeBytes );
- * </pre>
+ * @endcode
  *
  * Creates a new message buffer using dynamically allocated memory.  See
  * xMessageBufferCreateStatic() for a version that uses statically allocated
@@ -115,7 +115,7 @@ typedef void * MessageBufferHandle_t;
  * buffer.
  *
  * Example use:
- * <pre>
+ * @code{c}
  *
  * void vAFunction( void )
  * {
@@ -138,7 +138,7 @@ typedef void * MessageBufferHandle_t;
  *      // The message buffer was created successfully and can now be used.
  *  }
  *
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferCreate xMessageBufferCreate
  * \ingroup MessageBufferManagement
  */
@@ -148,11 +148,11 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * MessageBufferHandle_t xMessageBufferCreateStatic( size_t xBufferSizeBytes,
  *                                                uint8_t *pucMessageBufferStorageArea,
  *                                                StaticMessageBuffer_t *pxStaticMessageBuffer );
- * </pre>
+ * @endcode
  * Creates a new message buffer using statically allocated memory.  See
  * xMessageBufferCreate() for a version that uses dynamically allocated memory.
  *
@@ -177,7 +177,7 @@ typedef void * MessageBufferHandle_t;
  * pxStaticmessageBuffer are NULL then NULL is returned.
  *
  * Example use:
- * <pre>
+ * @code{c}
  *
  * // Used to dimension the array used to hold the messages.  The available space
  * // will actually be one less than this, so 999.
@@ -205,7 +205,7 @@ typedef void * MessageBufferHandle_t;
  *  // Other code that uses the message buffer can go here.
  * }
  *
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferCreateStatic xMessageBufferCreateStatic
  * \ingroup MessageBufferManagement
  */
@@ -215,12 +215,12 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSend( MessageBufferHandle_t xMessageBuffer,
  *                         const void *pvTxData,
  *                         size_t xDataLengthBytes,
  *                         TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  *
  * 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
@@ -277,7 +277,7 @@ typedef void * MessageBufferHandle_t;
  * time out then xDataLengthBytes is returned.
  *
  * Example use:
- * <pre>
+ * @code{c}
  * void vAFunction( MessageBufferHandle_t xMessageBuffer )
  * {
  * size_t xBytesSent;
@@ -305,7 +305,7 @@ typedef void * MessageBufferHandle_t;
  *      // not enough free space in the buffer.
  *  }
  * }
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferSend xMessageBufferSend
  * \ingroup MessageBufferManagement
  */
@@ -315,12 +315,12 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSendFromISR( MessageBufferHandle_t xMessageBuffer,
  *                                const void *pvTxData,
  *                                size_t xDataLengthBytes,
  *                                BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  *
  * 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
@@ -378,7 +378,7 @@ typedef void * MessageBufferHandle_t;
  * then 0 is returned, otherwise xDataLengthBytes is returned.
  *
  * Example use:
- * <pre>
+ * @code{c}
  * // A message buffer that has already been created.
  * MessageBufferHandle_t xMessageBuffer;
  *
@@ -410,7 +410,7 @@ typedef void * MessageBufferHandle_t;
  *  // documentation for the port in use for port specific instructions.
  *  portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
  * }
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferSendFromISR xMessageBufferSendFromISR
  * \ingroup MessageBufferManagement
  */
@@ -420,12 +420,12 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferReceive( MessageBufferHandle_t xMessageBuffer,
  *                            void *pvRxData,
  *                            size_t xBufferLengthBytes,
  *                            TickType_t xTicksToWait );
- * </pre>
+ * @endcode
  *
  * Receives a discrete message from a message buffer.  Messages can be of
  * variable length and are copied out of the buffer.
@@ -478,7 +478,7 @@ typedef void * MessageBufferHandle_t;
  * zero is returned.
  *
  * Example use:
- * <pre>
+ * @code{c}
  * void vAFunction( MessageBuffer_t xMessageBuffer )
  * {
  * uint8_t ucRxData[ 20 ];
@@ -499,7 +499,7 @@ typedef void * MessageBufferHandle_t;
  *      // the message here....
  *  }
  * }
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferReceive xMessageBufferReceive
  * \ingroup MessageBufferManagement
  */
@@ -510,12 +510,12 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * size_t xMessageBufferReceiveFromISR( MessageBufferHandle_t xMessageBuffer,
  *                                   void *pvRxData,
  *                                   size_t xBufferLengthBytes,
  *                                   BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  *
  * An interrupt safe version of the API function that receives a discrete
  * message from a message buffer.  Messages can be of variable length and are
@@ -569,7 +569,7 @@ typedef void * MessageBufferHandle_t;
  * any.
  *
  * Example use:
- * <pre>
+ * @code{c}
  * // A message buffer that has already been created.
  * MessageBuffer_t xMessageBuffer;
  *
@@ -601,7 +601,7 @@ typedef void * MessageBufferHandle_t;
  *  // documentation for the port in use for port specific instructions.
  *  portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
  * }
- * </pre>
+ * @endcode
  * \defgroup xMessageBufferReceiveFromISR xMessageBufferReceiveFromISR
  * \ingroup MessageBufferManagement
  */
@@ -611,9 +611,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  *
  * Deletes a message buffer that was previously created using a call to
  * xMessageBufferCreate() or xMessageBufferCreateStatic().  If the message
@@ -631,9 +631,9 @@ typedef void * MessageBufferHandle_t;
 
 /**
  * message_buffer.h
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  *
  * Tests to see if a message buffer is full.  A message buffer is full if it
  * cannot accept any more messages, of any size, until space is made available
@@ -649,9 +649,9 @@ typedef void * MessageBufferHandle_t;
 
 /**
  * message_buffer.h
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  *
  * Tests to see if a message buffer is empty (does not contain any messages).
  *
@@ -666,9 +666,9 @@ typedef void * MessageBufferHandle_t;
 
 /**
  * message_buffer.h
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  *
  * Resets a message buffer to its initial empty state, discarding any message it
  * contained.
@@ -691,9 +691,9 @@ typedef void * MessageBufferHandle_t;
 
 /**
  * message_buffer.h
- * <pre>
+ * @code{c}
  * size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  * Returns the number of bytes of free space in the message buffer.
  *
  * @param xMessageBuffer The handle of the message buffer being queried.
@@ -715,9 +715,9 @@ typedef void * MessageBufferHandle_t;
 
 /**
  * message_buffer.h
- * <pre>
+ * @code{c}
  * size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer );
- * </pre>
+ * @endcode
  * Returns the length (in bytes) of the next message in a message buffer.
  * Useful if xMessageBufferReceive() returned 0 because the size of the buffer
  * passed into xMessageBufferReceive() was too small to hold the next message.
@@ -736,9 +736,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferSendCompletedFromISR( MessageBufferHandle_t xMessageBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  *
  * For advanced users only.
  *
@@ -776,9 +776,9 @@ typedef void * MessageBufferHandle_t;
 /**
  * message_buffer.h
  *
- * <pre>
+ * @code{c}
  * BaseType_t xMessageBufferReceiveCompletedFromISR( MessageBufferHandle_t xMessageBuffer, BaseType_t *pxHigherPriorityTaskWoken );
- * </pre>
+ * @endcode
  *
  * For advanced users only.
  *