/* uart_defs.h */
/*
- This file is part of the AVR-uart_ni.
- Copyright (C) 2009 Daniel Otte (daniel.otte@rub.de)
+ This file is part of the AVR-uart_i.
+ Copyright (C) 2006-2015 Daniel Otte (bg@nerilex.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/**
+ * \file uart_defs.h
+ * \email bg@nerilex.org
+ * \author Daniel Otte
+ * \date 2009-07-24
+ * \license GPLv3 or later
+ * \addtogroup uart_config
+ * \brief definitions for uart configuration
+ * \details
+ * This file declares some macros for use in uart configuration
+ */
+/*@{*/
#ifndef UART_DEFS_H_
#define UART_DEFS_H_
-#define UART_PARATY_NONE 0 /** \def UART_PARATY_NONE define no paraty */
-#define UART_PARATY_EVEN 2 /** \def UART_PARATY_EVEN define even paraty */
-#define UART_PARATY_ODD 3 /** \def UART_PARATY_ODD define odd paraty */
-#define UART_STOPBITS_1 0 /** \def UART_STOPBITS_1 define 1 stop bit */
-#define UART_STOPBITS_2 1 /** \def UART_STOPBITS_2 define 2 stop bits */
-#define UART_DATABITS_5 0 /** \def UART_DATABITS_5 define 5 data bits */
-#define UART_DATABITS_6 1 /** \def UART_DATABITS_6 define 6 data bits */
-#define UART_DATABITS_7 2 /** \def UART_DATABITS_7 define 7 data bits */
-#define UART_DATABITS_8 3 /** \def UART_DATABITS_8 define 8 data bits */
-#define UART_DATABITS_9 7 /** \def UART_DATABITS_9 define 9 data bits */
-
+#define UART_PARATY_NONE 0 /**< define no paraty */
+#define UART_PARATY_EVEN 2 /**< define even paraty */
+#define UART_PARATY_ODD 3 /**< define odd paraty */
+#define UART_STOPBITS_1 0 /**< define 1 stop bit */
+#define UART_STOPBITS_2 1 /**< define 2 stop bits */
+#define UART_DATABITS_5 0 /**< define 5 data bits */
+#define UART_DATABITS_6 1 /**< define 6 data bits */
+#define UART_DATABITS_7 2 /**< define 7 data bits */
+#define UART_DATABITS_8 3 /**< define 8 data bits */
+#define UART_DATABITS_9 7 /**< define 9 data bits */
+/*@}*/
#endif /* UART_DEFS_H_ */