Use sane ANSI terminal escape codes for the Host mode demos, so that they do not...

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

diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
index 66cdaf5..6048d86 100644 (file)
--- a/LUFA/Drivers/Peripheral/SPI.h
+++ b/LUFA/Drivers/Peripheral/SPI.h
@@ -41,7 +41,8 @@
  *    - None\r
  *\r
  *  \section Module Description\r
  *    - None\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the setup of a the SPI port.\r
+ *  Driver for the hardware SPI port avaliable on most AVR models. This module provides\r
+ *  an easy to use driver for the setup of and transfer of data over the AVR's SPI port.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -90,8 +91,8 @@
                        /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other\r
                         *  SPI routines.\r
                         *\r
                        /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other\r
                         *  SPI routines.\r
                         *\r

-                        *  \param PrescalerMask  Prescaler mask to set the SPI clock speed\r
-                        *  \param Master         If true, sets the SPI system to use master mode, slave if false\r
+                        *  \param[in] PrescalerMask  Prescaler mask to set the SPI clock speed\r
+                        *  \param[in] Master         If true, sets the SPI system to use master mode, slave if false\r

                         */\r
                        static inline void SPI_Init(const uint8_t PrescalerMask, const bool Master)\r
                        {\r
                         */\r
                        static inline void SPI_Init(const uint8_t PrescalerMask, const bool Master)\r
                        {\r


@@ -109,7 +110,7 @@
                        \r
                        /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
                         *\r
                        \r
                        /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
                         *\r

-                        *  \param Byte  Byte to send through the SPI interface\r
+                        *  \param[in] Byte  Byte to send through the SPI interface\r

                         *\r
                         *  \return Response byte from the attached SPI device\r
                         */\r
                         *\r
                         *  \return Response byte from the attached SPI device\r
                         */\r


@@ -124,7 +125,7 @@
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response\r
                         *  byte sent to from the attached SPI device is ignored.\r
                         *\r
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response\r
                         *  byte sent to from the attached SPI device is ignored.\r
                         *\r

-                        *  \param Byte Byte to send through the SPI interface\r
+                        *  \param[in] Byte Byte to send through the SPI interface\r

                         */\r
                        static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
                        static inline void SPI_SendByte(const uint8_t Byte)\r
                         */\r
                        static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
                        static inline void SPI_SendByte(const uint8_t Byte)\r