Commit 38d7cdf8 authored by Dean Camera's avatar Dean Camera

Minor Doxygen documentation improvements.

Add missing ATTR_NON_NULL_PTR_ARG and const decorations.
parent 3b99abb5
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
*/ */
/** \ingroup Group_Buttons /** \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. * \brief Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained.
* *
* Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained. * Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained.
......
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
*/ */
/** \ingroup Group_Dataflash /** \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. * \brief Board specific Dataflash driver header for the Atmel XMEGA A3BU Xplained.
* *
* Board specific Dataflash driver header for the Atmel XMEGA A3BU Xplained board. * Board specific Dataflash driver header for the Atmel XMEGA A3BU Xplained board.
......
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
*/ */
/** \ingroup Group_LEDs /** \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. * \brief Board specific LED driver header for the Atmel XMEGA A3BU Xplained.
* *
* Board specific LED driver header for the Atmel XMEGA A3BU Xplained. * Board specific LED driver header for the Atmel XMEGA A3BU Xplained.
......
...@@ -79,7 +79,7 @@ ...@@ -79,7 +79,7 @@
#define ANSI_ESCAPE_SEQUENCE(EscapeSeq) #define ANSI_ESCAPE_SEQUENCE(EscapeSeq)
#endif #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. */ /** Turns on bold so that any following text is printed to the terminal in bold. */
#define ESC_BOLD_ON ANSI_ESCAPE_SEQUENCE("1m") #define ESC_BOLD_ON ANSI_ESCAPE_SEQUENCE("1m")
......
...@@ -177,7 +177,7 @@ ...@@ -177,7 +177,7 @@
/** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */ /** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
#define ADC_CHANNEL1 (0x01 << MUX0) #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(). /** 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. * \note Not available on all AVR models.
...@@ -203,9 +203,6 @@ ...@@ -203,9 +203,6 @@
/** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */ /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
#define ADC_CHANNEL7 (0x07 << MUX0) #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__)) #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(). /** MUX mask define for the ADC8 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading().
* *
...@@ -251,6 +248,9 @@ ...@@ -251,6 +248,9 @@
#define ADC_INT_TEMP_SENS ((1 << 8) | (0x07 << MUX0)) #define ADC_INT_TEMP_SENS ((1 << 8) | (0x07 << MUX0))
#endif #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. /** 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 * \note This macro will only work correctly on channel numbers that are compile-time
...@@ -422,8 +422,8 @@ ...@@ -422,8 +422,8 @@
* *
* \param[in] Mode Mask of ADC prescale and mode settings. * \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(const uint8_t Mode) ATTR_ALWAYS_INLINE;
static inline void ADC_Init(uint8_t Mode) static inline void ADC_Init(const uint8_t Mode)
{ {
ADCSRA = ((1 << ADEN) | Mode); ADCSRA = ((1 << ADEN) | Mode);
} }
......
...@@ -234,6 +234,7 @@ ...@@ -234,6 +234,7 @@
* *
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. * \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) 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)); return USB_Host_GetDescriptor(DTYPE_Device, 0, DeviceDescriptorPtr, sizeof(USB_Descriptor_Device_t));
...@@ -255,6 +256,9 @@ ...@@ -255,6 +256,9 @@
* *
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
*/ */
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, static inline uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
void* const Buffer, void* const Buffer,
const uint8_t BufferLength) const uint8_t BufferLength)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment