diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-08-23 13:36:25 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-08-23 13:36:25 +0000 |
| commit | 718dc5084f7719f91eaacfc99e8c7de654eb2ad8 (patch) | |
| tree | 14b0f47f04f720f251828ed87fbf008b0331e91a /os/hal/include/uart.h | |
| parent | c9be79def630f153b0b2d28e905939c15743f989 (diff) | |
| download | ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.gz ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.tar.bz2 ChibiOS-718dc5084f7719f91eaacfc99e8c7de654eb2ad8.zip | |
HAL documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3252 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/uart.h')
| -rw-r--r-- | os/hal/include/uart.h | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/os/hal/include/uart.h b/os/hal/include/uart.h index 148aa6877..6d3d12d5f 100644 --- a/os/hal/include/uart.h +++ b/os/hal/include/uart.h @@ -35,18 +35,17 @@ /* Driver constants. */
/*===========================================================================*/
-/** @brief No pending conditions.*/
-#define UART_NO_ERROR 0
-/** @brief Parity error happened.*/
-#define UART_PARITY_ERROR 4
-/** @brief Framing error happened.*/
-#define UART_FRAMING_ERROR 8
-/** @brief Overflow happened.*/
-#define UART_OVERRUN_ERROR 16
-/** @brief Noise on the line.*/
-#define UART_NOISE_ERROR 32
-/** @brief Break detected.*/
-#define UART_BREAK_DETECTED 64
+/**
+ * @name UART status flags
+ * @{
+ */
+#define UART_NO_ERROR 0 /**< @brief No pending conditions. */
+#define UART_PARITY_ERROR 4 /**< @brief Parity error happened. */
+#define UART_FRAMING_ERROR 8 /**< @brief Framing error happened. */
+#define UART_OVERRUN_ERROR 16 /**< @brief Overflow happened. */
+#define UART_NOISE_ERROR 32 /**< @brief Noise on the line. */
+#define UART_BREAK_DETECTED 64 /**< @brief Break detected. */
+/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
|