Update all demos, projects and bootloaders to indent all function parameters, one...

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

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index 5abc6e0..83bdbbf 100644 (file)
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -39,7 +39,7 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
- *    - LUFA/Drivers/Peripheral/Serial.c
+ *    - LUFA/Drivers/Peripheral/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
  *
  *  \section Module Description
  *  Hardware serial USART driver. This module provides an easy to use driver for
@@ -80,7 +80,7 @@
                        #if defined(__DOXYGEN__)
                                /** Indicates whether a character has been received through the USART.
                                 *
-                                *  \return Boolean true if a character has been received, false otherwise
+                                *  \return Boolean true if a character has been received, false otherwise.
                                 */
                                static inline bool Serial_IsCharReceived(void);
                        #else
@@ -90,24 +90,25 @@
                /* Function Prototypes: */
                        /** Transmits a given string located in program space (FLASH) through the USART.
                         *
-                        *  \param[in] FlashStringPtr  Pointer to a string located in program space
+                        *  \param[in] FlashStringPtr  Pointer to a string located in program space.
                         */
-                       void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
+                       void Serial_TxString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Transmits a given string located in SRAM memory through the USART.
                         *
-                        *  \param[in] StringPtr  Pointer to a string located in SRAM space
+                        *  \param[in] StringPtr  Pointer to a string located in SRAM space.
                         */
-                       void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);
+                       void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
 
                /* Inline Functions: */
                        /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to
                         *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
                         *
-                        *  \param[in] BaudRate     Serial baud rate, in bits per second
-                        *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate
+                        *  \param[in] BaudRate     Serial baud rate, in bits per second.
+                        *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
                         */
-                       static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)
+                       static inline void Serial_Init(const uint32_t BaudRate,
+                                                      const bool DoubleSpeed)
                        {
                                UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);
                                UCSR1B = ((1 << TXEN1)  | (1 << RXEN1));
@@ -134,7 +135,7 @@
                        
                        /** Transmits a given byte through the USART.
                         *
-                        *  \param[in] DataByte  Byte to transmit through the USART
+                        *  \param[in] DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_TxByte(const char DataByte)
                        {
@@ -144,7 +145,7 @@
 
                        /** Receives a byte from the USART.
                         *
-                        *  \return Byte received from the USART
+                        *  \return Byte received from the USART.
                         */
                        static inline char Serial_RxByte(void)
                        {