Minor Doxygen documentation improvements.

Add missing ATTR_NON_NULL_PTR_ARG and const decorations.

diff --git a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Buttons.h b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Buttons.h
index 74233d4..9da328d 100644 (file)
--- a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Buttons.h
+++ b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Buttons.h
@@ -37,7 +37,7 @@
  */
 
 /** \ingroup Group_Buttons
- *  \defgroup Group_Buttons_A3BU_XPLAINED XMEGA A3BU Xplained.
+ *  \defgroup Group_Buttons_A3BU_XPLAINED A3BU_XPLAINED
  *  \brief Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained.
  *
  *  Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained.

diff --git a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Dataflash.h b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Dataflash.h
index 18c6607..7f65746 100644 (file)
--- a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Dataflash.h
+++ b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Dataflash.h
@@ -37,7 +37,7 @@
  */
 
 /** \ingroup Group_Dataflash
- *  \defgroup Group_Dataflash_A3BU_XPLAINED XMEGA A3BU Xplained.
+ *  \defgroup Group_Dataflash_A3BU_XPLAINED A3BU_XPLAINED
  *  \brief Board specific Dataflash driver header for the Atmel XMEGA A3BU Xplained.
  *
  *  Board specific Dataflash driver header for the Atmel XMEGA A3BU Xplained board.

diff --git a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/LEDs.h b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/LEDs.h
index eb37ae4..c49ad03 100644 (file)
--- a/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/LEDs.h
+++ b/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/LEDs.h
@@ -37,7 +37,7 @@
  */
 
 /** \ingroup Group_LEDs
- *  \defgroup Group_LEDs_A3BU_XPLAINED XMEGA A3BU Xplained
+ *  \defgroup Group_LEDs_A3BU_XPLAINED A3BU_XPLAINED
  *  \brief Board specific LED driver header for the Atmel XMEGA A3BU Xplained.
  *
  *  Board specific LED driver header for the Atmel XMEGA A3BU Xplained.

diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index a2ef3fa..f8c51bc 100644 (file)
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -79,7 +79,7 @@
                                #define ANSI_ESCAPE_SEQUENCE(EscapeSeq)
                        #endif
 
-                       /** \name Text Display Modifier Escape Sequences */
+                       /** \name Text Display Modifier Control Sequences */
                        //@{
                        /** Turns on bold so that any following text is printed to the terminal in bold. */
                        #define ESC_BOLD_ON                     ANSI_ESCAPE_SEQUENCE("1m")

diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
index 5ba789e..a0e9a87 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
@@ -177,7 +177,7 @@
                        /** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
                        #define ADC_CHANNEL1                    (0x01 << MUX0)
 
-                       #if !(defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
+                       #if (!(defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) || defined(__DOXYGEN__))
                                /** MUX mask define for the ADC2 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading().
                                 *
                                 *  \note Not available on all AVR models.
@@ -203,9 +203,6 @@
                        /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_CHANNEL7                    (0x07 << MUX0)
 
-                       /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
-                       #define ADC_1100MV_BANDGAP              (0x1E << MUX0)
-
                        #if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
                                /** MUX mask define for the ADC8 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading().
                                 *
@@ -251,6 +248,9 @@
                                #define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
                        #endif
 
+                       /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
+                       #define ADC_1100MV_BANDGAP              (0x1E << MUX0)
+
                        /** Retrieves the ADC MUX mask for the given ADC channel number.
                         *
                         *  \note This macro will only work correctly on channel numbers that are compile-time
@@ -422,8 +422,8 @@
                         *
                         *  \param[in] Mode  Mask of ADC prescale and mode settings.
                         */
-                       static inline void ADC_Init(uint8_t Mode) ATTR_ALWAYS_INLINE;
-                       static inline void ADC_Init(uint8_t Mode)
+                       static inline void ADC_Init(const uint8_t Mode) ATTR_ALWAYS_INLINE;
+                       static inline void ADC_Init(const uint8_t Mode)
                        {
                                ADCSRA = ((1 << ADEN) | Mode);
                        }

diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index 92b37f8..7b456c7 100644 (file)
--- a/LUFA/Drivers/USB/Core/HostStandardReq.h
+++ b/LUFA/Drivers/USB/Core/HostStandardReq.h
@@ -234,6 +234,7 @@
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
+                       static inline uint8_t USB_Host_GetDeviceDescriptor(USB_Descriptor_Device_t* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(1);
                        static inline uint8_t USB_Host_GetDeviceDescriptor(USB_Descriptor_Device_t* const DeviceDescriptorPtr)
                        {
                                return USB_Host_GetDescriptor(DTYPE_Device, 0, DeviceDescriptorPtr, sizeof(USB_Descriptor_Device_t));
@@ -257,6 +258,9 @@
                         */
                        static inline uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
                                                                                 void* const Buffer,
+                                                                                const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(2);
+                       static inline uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
+                                                                                void* const Buffer,
                                                                                 const uint8_t BufferLength)
                        {
                                return USB_Host_GetDescriptor(DTYPE_String, Index,  Buffer, BufferLength);