Endpoint configuration is now refined to give better output when all configurations...

[pub/USBasp.git] / LUFA / Drivers / Peripheral / Serial.h

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index d83761f..a50456b 100644 (file)
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -33,9 +33,14 @@
  *  Driver for the USART subsystem on supported USB AVRs.\r
  */\r
  \r
-/** \ingroup Group_SubsystemDrivers\r
+/** \ingroup Group_PeripheralDrivers\r
  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h\r
  *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/Peripheral/Serial.c\r
+ *\r
+ *  \section Module Description\r
  *  Functions, macros, variables, enums and types related to the setup of the USART for serial communications.\r
  *\r
  *  @{\r
@@ -59,11 +64,6 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */   \r
-                       /** Indicates whether a character has been received through the USART - boolean false if no character\r
-                        *  has been received, or non-zero if a character is waiting to be read from the reception buffer.\r
-                        */\r
-                       #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
-\r
                        /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
                         *  not set.\r
                         */\r
@@ -74,6 +74,17 @@
                         */\r
                        #define SERIAL_2X_UBBRVAL(baud) (((F_CPU / 8) / baud) - 1)\r
 \r
+               /* Pseudo-Function Macros: */\r
+                       #if defined(__DOXYGEN__)\r
+                               /** Indicates whether a character has been received through the USART.\r
+                                *\r
+                                *  \return Boolean true if a character has been received, false otherwise\r
+                                */\r
+                               static inline bool Serial_IsCharReceived(void);\r
+                       #else\r
+                               #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
+                       #endif\r
+\r
                /* Function Prototypes: */\r
                        /** Initializes the USART, ready for serial data transmission and reception.\r
                         *\r