diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2019-09-04 22:22:34 +1000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2019-09-04 22:22:34 +1000 |
| commit | 1695f8cc631d0fedd81b3ae6a8c1f02680154454 (patch) | |
| tree | 5063dbca7921d43f21430a2058ea0f2ec6dbdac0 | |
| parent | 03f72c5fb0bb9b9997b0433d472752c3afe2468c (diff) | |
| download | lufa-1695f8cc631d0fedd81b3ae6a8c1f02680154454.tar.gz lufa-1695f8cc631d0fedd81b3ae6a8c1f02680154454.tar.bz2 lufa-1695f8cc631d0fedd81b3ae6a8c1f02680154454.zip | |
Documentation: Fix Doxygen grouping.
36 files changed, 184 insertions, 187 deletions
diff --git a/Bootloaders/MassStorage/Lib/VirtualFAT.h b/Bootloaders/MassStorage/Lib/VirtualFAT.h index 07abb9eb2..2ecad9b88 100644 --- a/Bootloaders/MassStorage/Lib/VirtualFAT.h +++ b/Bootloaders/MassStorage/Lib/VirtualFAT.h @@ -126,7 +126,7 @@ (uint8_t)(ROT8(ROT8(ROT8(ROT8(ROT8(ROT8(ROT8(ROT8(ROT8(ROT8(n0)+n1)+n2)+n3)+n4)+n5)+n6)+n7)+e0)+e1)+e2) /** \name FAT Filesystem Flags */ - //@{ + /**@{*/ /** FAT attribute flag to indicate a read-only file. */ #define FAT_FLAG_READONLY (1 << 0) @@ -150,7 +150,7 @@ /** Ordinal flag marker for FAT Long File Name entries to mark the last entry. */ #define FAT_ORDINAL_LAST_ENTRY (1 << 6) - //@} + /**@}*/ /* Enums: */ /** Enum for the Root FAT file entry indexes on the disk. This can be used diff --git a/LUFA/CodeTemplates/DriverStubs/Board.h b/LUFA/CodeTemplates/DriverStubs/Board.h index 9e5f04b6a..7b33cafb1 100644 --- a/LUFA/CodeTemplates/DriverStubs/Board.h +++ b/LUFA/CodeTemplates/DriverStubs/Board.h @@ -77,6 +77,3 @@ #endif #endif - -/** @} */ - diff --git a/LUFA/Common/Endianness.h b/LUFA/Common/Endianness.h index 32ef463a0..cdc90e5b8 100644 --- a/LUFA/Common/Endianness.h +++ b/LUFA/Common/Endianness.h @@ -122,7 +122,7 @@ #define CPU_TO_BE32(x) (x) #elif !defined(le16_to_cpu) /** \name Run-time endianness conversion */ - //@{ + /**@{*/ /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the * Endianness of the currently selected CPU architecture. @@ -252,10 +252,10 @@ */ #define cpu_to_be32(x) SwapEndian_32(x) - //@} + /**@}*/ /** \name Compile-time endianness conversion */ - //@{ + /**@{*/ /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the * Endianness of the currently selected CPU architecture. @@ -385,7 +385,7 @@ */ #define CPU_TO_BE32(x) SWAPENDIAN_32(x) - //! @} + /**@}*/ #endif /* Inline Functions: */ diff --git a/LUFA/Drivers/Misc/AT45DB321C.h b/LUFA/Drivers/Misc/AT45DB321C.h index d6b20a82a..be16bc3ff 100644 --- a/LUFA/Drivers/Misc/AT45DB321C.h +++ b/LUFA/Drivers/Misc/AT45DB321C.h @@ -48,14 +48,14 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name Dataflash Status Values */ - //@{ + /**@{*/ #define DF_STATUS_READY (1 << 7) #define DF_STATUS_COMPMISMATCH (1 << 6) #define DF_STATUS_SECTORPROTECTION_ON (1 << 1) - //@} + /**@}*/ /** \name Dataflash Commands */ - //@{ + /**@{*/ #define DF_CMD_GETSTATUS 0xD7 #define DF_CMD_MAINMEMTOBUFF1 0x53 @@ -89,7 +89,7 @@ #define DF_CMD_SECTORPROTECTIONOFF_BYTE4 0xCF #define DF_CMD_READMANUFACTURERDEVICEINFO 0x9F - //@} + /**@}*/ /** Manufacturer code for Atmel Corporation, returned by Atmel Dataflash ICs in response to the \c DF_CMD_READMANUFACTURERDEVICEINFO command. */ #define DF_MANUFACTURER_ATMEL 0x1F diff --git a/LUFA/Drivers/Misc/AT45DB642D.h b/LUFA/Drivers/Misc/AT45DB642D.h index 95b1c75c9..c332bd6a7 100644 --- a/LUFA/Drivers/Misc/AT45DB642D.h +++ b/LUFA/Drivers/Misc/AT45DB642D.h @@ -48,15 +48,15 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name Dataflash Status Values */ - //@{ + /**@{*/ #define DF_STATUS_READY (1 << 7) #define DF_STATUS_COMPMISMATCH (1 << 6) #define DF_STATUS_SECTORPROTECTION_ON (1 << 1) #define DF_STATUS_BINARYPAGESIZE_ON (1 << 0) - //@} + /**@}*/ /** \name Dataflash Commands */ - //@{ + /**@{*/ #define DF_CMD_GETSTATUS 0xD7 #define DF_CMD_POWERDOWN 0xB9 #define DF_CMD_WAKEUP 0xAB @@ -105,7 +105,7 @@ #define DF_CMD_BINARYPAGESIZEMODEON_BYTE4 0xA6 #define DF_CMD_READMANUFACTURERDEVICEINFO 0x9F - //@} + /**@}*/ /** Manufacturer code for Atmel Corporation, returned by Atmel Dataflash ICs in response to the \c DF_CMD_READMANUFACTURERDEVICEINFO command. */ #define DF_MANUFACTURER_ATMEL 0x1F diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index e4bde4143..62fc246cd 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -80,7 +80,7 @@ #endif /** \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") @@ -114,10 +114,10 @@ * the center. */ #define ESC_STRIKETHROUGH_OFF ANSI_ESCAPE_SEQUENCE("29m") - //@} + /**@}*/ /** \name Text Colour Control Sequences */ - //@{ + /**@{*/ /** Sets the foreground (text) colour to black. */ #define ESC_FG_BLACK ANSI_ESCAPE_SEQUENCE("30m") @@ -171,10 +171,10 @@ /** Sets the text background colour to the terminal's default. */ #define ESC_BG_DEFAULT ANSI_ESCAPE_SEQUENCE("49m") - //@} + /**@}*/ /** \name Cursor Positioning Control Sequences */ - //@{ + /**@{*/ /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */ #define ESC_CURSOR_POS_SAVE ANSI_ESCAPE_SEQUENCE("s") @@ -211,10 +211,10 @@ * \param[in] Columns Number of columns to move the cursor position */ #define ESC_CURSOR_BACKWARD(Columns) ANSI_ESCAPE_SEQUENCE(#Columns "D") - //@} + /**@}*/ /** \name Miscellaneous Control Sequences */ - //@{ + /**@{*/ /** Resets any escape sequence modifiers back to their defaults. */ #define ESC_RESET ANSI_ESCAPE_SEQUENCE("0m") @@ -223,7 +223,7 @@ /** Erases the current line, returning the cursor to the far left. */ #define ESC_ERASE_LINE ANSI_ESCAPE_SEQUENCE("K") - //@} + /**@}*/ #endif diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h index f464eefc4..7e5f2f176 100644 --- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h @@ -100,7 +100,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name ADC Reference Configuration Masks */ - //@{ + /**@{*/ /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */ #define ADC_REFERENCE_AREF 0 @@ -109,10 +109,10 @@ /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */ #define ADC_REFERENCE_INT2560MV ((1 << REFS1) | (1 << REFS0)) - //@} + /**@}*/ /** \name ADC Result Adjustment Configuration Masks */ - //@{ + /**@{*/ /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the * \ref ADC_GetResult() macro contain the 8 most significant bits of the result. */ @@ -122,10 +122,10 @@ * \ref ADC_GetResult() macro contain the 8 least significant bits of the result. */ #define ADC_RIGHT_ADJUSTED (0 << ADLAR) - //@} + /**@}*/ /** \name ADC Mode Configuration Masks */ - //@{ + /**@{*/ /** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC * is capable of at the given input clock speed. */ @@ -135,10 +135,10 @@ * the ADC returns to idle. */ #define ADC_SINGLE_CONVERSION (0 << ADATE) - //@} + /**@}*/ /** \name ADC Prescaler Configuration Masks */ - //@{ + /**@{*/ /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */ #define ADC_PRESCALE_2 (1 << ADPS0) @@ -159,10 +159,10 @@ /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */ #define ADC_PRESCALE_128 ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0)) - //@} + /**@}*/ /** \name ADC MUX Masks */ - //@{ + /**@{*/ /** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */ #define ADC_CHANNEL0 (0x00 << MUX0) @@ -251,7 +251,7 @@ * \param[in] Channel Index of the ADC channel whose MUX mask is to be retrieved. */ #define ADC_GET_CHANNEL_MASK(Channel) CONCAT_EXPANDED(ADC_CHANNEL, Channel) - //@} + /**@}*/ /* Inline Functions: */ /** Configures the given ADC channel, ready for ADC conversions. This function sets the diff --git a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h index 005b26688..750db0dc4 100644 --- a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h @@ -99,7 +99,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name SPI Prescaler Configuration Masks */ - //@{ + /**@{*/ /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 2. */ #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED @@ -120,43 +120,43 @@ /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 128. */ #define SPI_SPEED_FCPU_DIV_128 ((1 << SPR1) | (1 << SPR0)) - //@} + /**@}*/ /** \name SPI SCK Polarity Configuration Masks */ - //@{ + /**@{*/ /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the rising edge. */ #define SPI_SCK_LEAD_RISING (0 << CPOL) /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the falling edge. */ #define SPI_SCK_LEAD_FALLING (1 << CPOL) - //@} + /**@}*/ /** \name SPI Sample Edge Configuration Masks */ - //@{ + /**@{*/ /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should sampled on the leading edge. */ #define SPI_SAMPLE_LEADING (0 << CPHA) /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should be sampled on the trailing edge. */ #define SPI_SAMPLE_TRAILING (1 << CPHA) - //@} + /**@}*/ /** \name SPI Data Ordering Configuration Masks */ - //@{ + /**@{*/ /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out MSB first. */ #define SPI_ORDER_MSB_FIRST (0 << DORD) /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out LSB first. */ #define SPI_ORDER_LSB_FIRST (1 << DORD) - //@} + /**@}*/ /** \name SPI Mode Configuration Masks */ - //@{ + /**@{*/ /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */ #define SPI_MODE_SLAVE (0 << MSTR) /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */ #define SPI_MODE_MASTER (1 << MSTR) - //@} + /**@}*/ /* Inline Functions: */ /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other diff --git a/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h index d5b4b189e..a6754a27a 100644 --- a/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h @@ -105,31 +105,31 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name SPI SCK Polarity Configuration Masks */ - //@{ + /**@{*/ /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the rising edge. */ #define USART_SPI_SCK_LEAD_RISING (0 << UCPOL1) /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the falling edge. */ #define USART_SPI_SCK_LEAD_FALLING (1 << UCPOL1) - //@} + /**@}*/ /** \name SPI Sample Edge Configuration Masks */ - //@{ + /**@{*/ /** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should sampled on the leading edge. */ #define USART_SPI_SAMPLE_LEADING (0 << UCPHA1) /** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should be sampled on the trailing edge. */ #define USART_SPI_SAMPLE_TRAILING (1 << UCPHA1) - //@} + /**@}*/ /** \name SPI Data Ordering Configuration Masks */ - //@{ + /**@{*/ /** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out MSB first. */ #define USART_SPI_ORDER_MSB_FIRST (0 << UDORD1) /** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out LSB first. */ #define USART_SPI_ORDER_LSB_FIRST (1 << UDORD1) - //@} + /**@}*/ /* Inline Functions: */ /** Initialize the USART module in Master SPI mode. diff --git a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h index fffc0d162..96e5f76ad 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h @@ -96,7 +96,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name SPI Prescaler Configuration Masks */ - //@{ + /**@{*/ /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 2. */ #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED @@ -117,43 +117,43 @@ /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 128. */ #define SPI_SPEED_FCPU_DIV_128 (3 << SPI_PRESCALER_gp) - //@} + /**@}*/ /** \name SPI SCK Polarity Configuration Masks */ - //@{ + /**@{*/ /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the rising edge. */ #define SPI_SCK_LEAD_RISING 0 /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the falling edge. */ #define SPI_SCK_LEAD_FALLING SPI_MODE1_bm - //@} + /**@}*/ /** \name SPI Sample Edge Configuration Masks */ - //@{ + /**@{*/ /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should sampled on the leading edge. */ #define SPI_SAMPLE_LEADING 0 /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should be sampled on the trailing edge. */ #define SPI_SAMPLE_TRAILING SPI_MODE0_bm - //@} + /**@}*/ /** \name SPI Data Ordering Configuration Masks */ - //@{ + /**@{*/ /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out MSB first. */ #define SPI_ORDER_MSB_FIRST 0 /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out LSB first. */ #define SPI_ORDER_LSB_FIRST SPI_DORD_bm - //@} + /**@}*/ /** \name SPI Mode Configuration Masks */ - //@{ + /**@{*/ /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */ #define SPI_MODE_SLAVE 0 /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */ #define SPI_MODE_MASTER SPI_MASTER_bm - //@} + /**@}*/ /* Inline Functions: */ /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other diff --git a/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h index 8d91baa20..dff500ec1 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h @@ -97,28 +97,28 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name SPI SCK Polarity Configuration Masks */ - //@{ + /**@{*/ /** SPI clock polarity mask for \ref SerialSPI_Init(). Indicates that the SCK should lead on the rising edge. */ #define USART_SPI_SCK_LEAD_RISING 0 - //@} + /**@}*/ /** \name SPI Sample Edge Configuration Masks */ - //@{ + /**@{*/ /** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should sampled on the leading edge. */ #define USART_SPI_SAMPLE_LEADING 0 /** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should be sampled on the trailing edge. */ #define USART_SPI_SAMPLE_TRAILING (1 << 1) - //@} + /**@}*/ /** \name SPI Data Ordering Configuration Masks */ - //@{ + /**@{*/ /** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out MSB first. */ #define USART_SPI_ORDER_MSB_FIRST 0 /** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out LSB first. */ #define USART_SPI_ORDER_LSB_FIRST (1 << 2) - //@} + /**@}*/ /* Inline Functions: */ /** Initialize the USART module in Master SPI mode. diff --git a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h index 4ab201800..b545dc499 100644 --- a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h @@ -65,7 +65,7 @@ /* Macros: */ /** \name Audio Channel Masks */ - //@{ + /**@{*/ /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */ #define AUDIO_CHANNEL_LEFT_FRONT (1 << 0) @@ -101,10 +101,10 @@ /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */ #define AUDIO_CHANNEL_TOP (1 << 11) - //@} + /**@}*/ /** \name Audio Feature Masks */ - //@{ + /**@{*/ /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */ #define AUDIO_FEATURE_MUTE (1 << 0) @@ -134,10 +134,10 @@ /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */ #define AUDIO_FEATURE_BASS_LOUDNESS (1 << 9) - //@} + /**@}*/ /** \name Audio Terminal Types */ - //@{ + /**@{*/ /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ #define AUDIO_TERMINAL_UNDEFINED 0x0100 @@ -191,7 +191,7 @@ /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */ #define AUDIO_TERMINAL_OUT_LOWFREQ 0x0307 - //@} + /**@}*/ /** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number. * diff --git a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h index c107a36a0..cf3261185 100644 --- a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h @@ -65,7 +65,7 @@ /* Macros: */ /** \name Virtual Control Line Masks */ - //@{ + /**@{*/ /** Mask for the DTR handshake line for use with the \ref CDC_REQ_SetControlLineState class-specific request * from the host, to indicate that the DTR line state should be high. */ @@ -110,7 +110,7 @@ * to indicate that a data overrun error has occurred on the virtual serial port. */ #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6) - //@} + /**@}*/ /* Enums: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the CDC diff --git a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h index c59e769d8..9f50ef156 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h @@ -66,7 +66,7 @@ /* Macros: */ /** \name Keyboard Standard Report Modifier Masks */ - //@{ + /**@{*/ /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */ #define HID_KEYBOARD_MODIFIER_LEFTCTRL (1 << 0) @@ -90,10 +90,10 @@ /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */ #define HID_KEYBOARD_MODIFIER_RIGHTGUI (1 << 7) - //@} + /**@}*/ /** \name Keyboard Standard Report LED Masks */ - //@{ + /**@{*/ /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */ #define HID_KEYBOARD_LED_NUMLOCK (1 << 0) @@ -108,10 +108,10 @@ /** Constant for a keyboard output report LED byte, indicating that the host's KANA mode is currently set. */ #define HID_KEYBOARD_LED_KANA (1 << 4) - //@} + /**@}*/ /** \name Keyboard Standard Report Key Scan-codes */ - //@{ + /**@{*/ #define HID_KEYBOARD_SC_RESERVED 0x00 #define HID_KEYBOARD_SC_ERROR_ROLLOVER 0x01 #define HID_KEYBOARD_SC_POST_FAIL 0x02 @@ -348,10 +348,10 @@ #define HID_KEYBOARD_SC_MEDIA_LOCK 0xF9 #define HID_KEYBOARD_SC_MEDIA_RELOAD 0xFA #define HID_KEYBOARD_SC_MEDIA_CALCULATOR 0xFB - //@} + /**@}*/ /** \name Common HID Device Report Descriptors */ - //@{ + /**@{*/ /** \hideinitializer * A list of HID report item array elements that describe a typical HID USB Joystick. The resulting report * descriptor is structured according to the following layout: @@ -537,7 +537,7 @@ HID_RI_REPORT_COUNT(8, NumBytes), \ HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE), \ HID_RI_END_COLLECTION(0) - //@} + /**@}*/ /* Type Defines: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the HID diff --git a/LUFA/Drivers/USB/Class/Common/HIDReportData.h b/LUFA/Drivers/USB/Class/Common/HIDReportData.h index 979fc46c3..694a6d844 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDReportData.h +++ b/LUFA/Drivers/USB/Class/Common/HIDReportData.h @@ -75,7 +75,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name HID Input, Output and Feature Report Descriptor Item Flags */ - //@{ + /**@{*/ #define HID_IOF_CONSTANT (1 << 0) #define HID_IOF_DATA (0 << 0) #define HID_IOF_VARIABLE (1 << 1) @@ -94,10 +94,10 @@ #define HID_IOF_NON_VOLATILE (0 << 7) #define HID_IOF_BUFFERED_BYTES (1 << 8) #define HID_IOF_BITFIELD (0 << 8) - //@} + /**@}*/ /** \name HID Report Descriptor Item Macros */ - //@{ + /**@{*/ #define HID_RI_INPUT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x80, DataBits, __VA_ARGS__) #define HID_RI_OUTPUT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x90, DataBits, __VA_ARGS__) #define HID_RI_COLLECTION(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xA0, DataBits, __VA_ARGS__) @@ -118,7 +118,7 @@ #define HID_RI_USAGE(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x00, DataBits, __VA_ARGS__) #define HID_RI_USAGE_MINIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x10, DataBits, __VA_ARGS__) #define HID_RI_USAGE_MAXIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x20, DataBits, __VA_ARGS__) - //@} + /**@}*/ /** @} */ diff --git a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h index d4976c796..97687c10b 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h @@ -71,7 +71,7 @@ /** \name MIDI Command Values * See http://www.midi.org/techspecs/midimessages.php for more information. */ - //@{ + /**@{*/ /** MIDI command for System Exclusive (SysEx) single event that has one byte of data total. */ #define MIDI_COMMAND_SYSEX_1BYTE MIDI_COMMAND_SYSEX_END_1BYTE @@ -113,7 +113,7 @@ /** MIDI command for a pitch change event. */ #define MIDI_COMMAND_PITCH_WHEEL_CHANGE 0xE0 - //@} + /**@}*/ /** Standard key press velocity value used for all note events. */ #define MIDI_STANDARD_VELOCITY 64 diff --git a/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h b/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h index ddf2c9f12..36c8ab53f 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h @@ -77,7 +77,7 @@ #define MS_COMMAND_DIR_DATA_IN (1 << 7) /** \name SCSI Commands*/ - //@{ + /**@{*/ /** SCSI Command Code for an INQUIRY command. */ #define SCSI_CMD_INQUIRY 0x12 @@ -119,10 +119,10 @@ /** SCSI Command Code for a MODE SENSE (10) command. */ #define SCSI_CMD_MODE_SENSE_10 0x5A - //@} + /**@}*/ /** \name SCSI Sense Key Values */ - //@{ + /**@{*/ /** SCSI Sense Code to indicate no error has occurred. */ #define SCSI_SENSE_KEY_GOOD 0x00 @@ -166,10 +166,10 @@ /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */ #define SCSI_SENSE_KEY_MISCOMPARE 0x0E - //@} + /**@}*/ /** \name SCSI Additional Sense Codes */ - //@{ + /**@{*/ /** SCSI Additional Sense Code to indicate no additional sense information is available. */ #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION 0x00 @@ -198,10 +198,10 @@ /** SCSI Additional Sense Code to indicate that no removable medium is inserted into the device. */ #define SCSI_ASENSE_MEDIUM_NOT_PRESENT 0x3A - //@} + /**@}*/ /** \name SCSI Additional Sense Key Code Qualifiers */ - //@{ + /**@{*/ /** SCSI Additional Sense Qualifier Code to indicate no additional sense qualifier information is available. */ #define SCSI_ASENSEQ_NO_QUALIFIER 0x00 @@ -215,7 +215,7 @@ /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */ #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS 0x07 - //@} + /**@}*/ /* Enums: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Mass diff --git a/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h b/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h index 64412993d..b0602704b 100644 --- a/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h @@ -65,7 +65,7 @@ /* Macros: */ /** \name Virtual Printer Status Line Masks */ - //@{ + /**@{*/ /** Port status mask for a printer device, indicating that an error has *not* occurred. */ #define PRNT_PORTSTATUS_NOTERROR (1 << 3) @@ -74,7 +74,7 @@ /** Port status mask for a printer device, indicating that the device is currently out of paper. */ #define PRNT_PORTSTATUS_PAPEREMPTY (1 << 5) - //@} + /**@}*/ /* Enums: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Printer diff --git a/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h b/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h index 7bc94b703..035f5dfa8 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h @@ -78,7 +78,7 @@ #define REMOTE_NDIS_VERSION_MINOR 0x00 /** \name RNDIS Message Values */ - //@{ + /**@{*/ #define REMOTE_NDIS_PACKET_MSG 0x00000001UL #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002UL #define REMOTE_NDIS_HALT_MSG 0x00000003UL @@ -87,46 +87,46 @@ #define REMOTE_NDIS_RESET_MSG 0x00000006UL #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007UL #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008UL - //@} + /**@}*/ /** \name RNDIS Response Values */ - //@{ + /**@{*/ #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002UL #define REMOTE_NDIS_QUERY_CMPLT 0x80000004UL #define REMOTE_NDIS_SET_CMPLT 0x80000005UL #define REMOTE_NDIS_RESET_CMPLT 0x80000006UL #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008UL - //@} + /**@}*/ /** \name RNDIS Status Values */ - //@{ + /**@{*/ #define REMOTE_NDIS_STATUS_SUCCESS 0x00000000UL #define REMOTE_NDIS_STATUS_FAILURE 0xC0000001UL #define REMOTE_NDIS_STATUS_INVALID_DATA 0xC0010015UL #define REMOTE_NDIS_STATUS_NOT_SUPPORTED 0xC00000BBUL #define REMOTE_NDIS_STATUS_MEDIA_CONNECT 0x4001000BUL #define REMOTE_NDIS_STATUS_MEDIA_DISCONNECT 0x4001000CUL - //@} + /**@}*/ /** \name RNDIS Media States */ - //@{ + /**@{*/ #define REMOTE_NDIS_MEDIA_STATE_CONNECTED 0x00000000UL #define REMOTE_NDIS_MEDIA_STATE_DISCONNECTED 0x00000001UL - //@} + /**@}*/ /** \name RNDIS Media Types */ - //@{ + /**@{*/ #define REMOTE_NDIS_MEDIUM_802_3 0x00000000UL - //@} + /**@}*/ /** \name RNDIS Connection Types */ - //@{ + /**@{*/ #define REMOTE_NDIS_DF_CONNECTIONLESS 0x00000001UL #define REMOTE_NDIS_DF_CONNECTION_ORIENTED 0x00000002UL - //@} + /**@}*/ /** \name RNDIS Packet Types */ - //@{ + /**@{*/ #define REMOTE_NDIS_PACKET_DIRECTED 0x00000001UL #define REMOTE_NDIS_PACKET_MULTICAST 0x00000002UL #define REMOTE_NDIS_PACKET_ALL_MULTICAST 0x00000004UL @@ -139,10 +139,10 @@ #define REMOTE_NDIS_PACKET_ALL_FUNCTIONAL 0x00002000UL #define REMOTE_NDIS_PACKET_FUNCTIONAL 0x00004000UL #define REMOTE_NDIS_PACKET_MAC_FRAME 0x00008000UL - //@} + /**@}*/ /** \name RNDIS OID Values */ - //@{ + /**@{*/ #define OID_GEN_SUPPORTED_LIST 0x00010101UL #define OID_GEN_HARDWARE_STATUS 0x00010102UL #define OID_GEN_MEDIA_SUPPORTED 0x00010103UL @@ -170,7 +170,7 @@ #define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101UL #define OID_802_3_XMIT_ONE_COLLISION 0x01020102UL #define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103UL - //@} + /**@}*/ /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */ #define ETHERNET_FRAME_SIZE_MAX 1500 diff --git a/LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h index 16411028f..c1e95b380 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h @@ -80,7 +80,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Device Mode Option Masks */ - //@{ + /**@{*/ #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__) /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the * USB interface should be initialized in low speed (1.5Mb/s) mode. @@ -98,7 +98,7 @@ * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0) - //@} + /**@}*/ #if (!defined(NO_INTERNAL_SERIAL) && \ (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || \ diff --git a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h index 67748ab72..be7e0c76f 100644 --- a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Function Prototypes: */ /** \name Stream functions for null data */ - //@{ + /**@{*/ /** Reads and discards the given number of bytes from the currently selected endpoint's bank, * discarding fully read packets from the host as needed. The last packet is not automatically @@ -175,10 +175,10 @@ uint8_t Endpoint_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); - //@} + /**@}*/ /** \name Stream functions for RAM source/destination data */ - //@{ + /**@{*/ /** Writes the given number of bytes to the endpoint from the given buffer in little endian, * sending full packets to the host as needed. The last packet filled is not automatically sent; @@ -425,10 +425,10 @@ */ uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for EEPROM source/destination data */ - //@{ + /**@{*/ /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE(). * @@ -565,10 +565,10 @@ */ uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for PROGMEM source/destination data */ - //@{ + /**@{*/ /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE(). * @@ -645,7 +645,7 @@ */ uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.h index 472ab780f..6be3abdaf 100644 --- a/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.h @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Function Prototypes: */ /** \name Stream functions for null data */ - //@{ + /**@{*/ /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the @@ -173,10 +173,10 @@ uint8_t Pipe_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); - //@} + /**@}*/ /** \name Stream functions for RAM source/destination data */ - //@{ + /**@{*/ /** Writes the given number of bytes to the pipe from the given buffer in little endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; @@ -339,10 +339,10 @@ uint8_t Pipe_Read_Stream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for EEPROM source/destination data */ - //@{ + /**@{*/ /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE(). * @@ -395,10 +395,10 @@ uint8_t Pipe_Read_EStream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for PROGMEM source/destination data */ - //@{ + /**@{*/ /** FLASH buffer source version of \ref Pipe_Write_Stream_LE(). * @@ -429,7 +429,7 @@ uint8_t Pipe_Write_PStream_BE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h index a59fb9ca3..9178f17ce 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h @@ -99,7 +99,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name Pipe Error Flag Masks */ - //@{ + /**@{*/ /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */ #define PIPE_ERRORFLAG_OVERFLOW (1 << 6) @@ -120,10 +120,10 @@ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */ #define PIPE_ERRORFLAG_DATATGL (1 << 0) - //@} + /**@}*/ /** \name Pipe Token Masks */ - //@{ + /**@{*/ /** Token mask for \ref Pipe_SetPipeToken() and \ref Pipe_GetPipeToken(). This sets the pipe as a SETUP token (for CONTROL type pipes), * which will trigger a control request on the attached device when data is written to the pipe. */ @@ -138,7 +138,7 @@ * indicating that the pipe data will flow from host to device. */ #define PIPE_TOKEN_OUT (2 << PTOKEN0) - //@} + /**@}*/ /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value * in the device descriptor of the attached device. diff --git a/LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h index 807e6b809..0debaa74a 100644 --- a/LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h @@ -117,7 +117,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Controller Option Masks */ - //@{ + /**@{*/ /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad * regulator should be disabled and the AVR's VCC level used for the data pads. * @@ -152,7 +152,7 @@ * that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations. */ #define USB_OPT_AUTO_PLL (0 << 2) - //@} + /**@}*/ #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__) /** Constant for the maximum software timeout period of the USB data stream transfer functions diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h index 70e97940c..6da9cf496 100644 --- a/LUFA/Drivers/USB/Core/StdDescriptors.h +++ b/LUFA/Drivers/USB/Core/StdDescriptors.h @@ -120,7 +120,7 @@ #define LANGUAGE_ID_ENG 0x0409 /** \name USB Configuration Descriptor Attribute Masks */ - //@{ + /**@{*/ /** Mask for the reserved bit in the Configuration Descriptor's \c ConfigAttributes field, which must be always * set on all USB devices for historical purposes. */ @@ -145,10 +145,10 @@ * see \ref USB_Device_RemoteWakeupEnabled(). */ #define USB_CONFIG_ATTR_REMOTEWAKEUP 0x20 - //@} + /**@}*/ /** \name Endpoint Descriptor Attribute Masks */ - //@{ + /**@{*/ /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's * \c Attributes value to indicate that the specified endpoint is not synchronized. * @@ -176,10 +176,10 @@ * \see The USB specification for more details on the possible Endpoint attributes. */ #define ENDPOINT_ATTR_SYNC (3 << 2) - //@} + /**@}*/ /** \name Endpoint Descriptor Usage Masks */ - //@{ + /**@{*/ /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's * \c Attributes value to indicate that the specified endpoint is used for data transfers. * @@ -200,7 +200,7 @@ * \see The USB specification for more details on the possible Endpoint usage attributes. */ #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4) - //@} + /**@}*/ /* Enums: */ /** Enum for the possible standard descriptor types, as given in each descriptor's header. */ diff --git a/LUFA/Drivers/USB/Core/StdRequestType.h b/LUFA/Drivers/USB/Core/StdRequestType.h index ead56f5b6..ce7f84f22 100644 --- a/LUFA/Drivers/USB/Core/StdRequestType.h +++ b/LUFA/Drivers/USB/Core/StdRequestType.h @@ -88,7 +88,7 @@ #define CONTROL_REQTYPE_RECIPIENT 0x1F /** \name Control Request Data Direction Masks */ - //@{ + /**@{*/ /** Request data direction mask, indicating that the request data will flow from host to device. * * \see \ref CONTROL_REQTYPE_DIRECTION macro. @@ -100,10 +100,10 @@ * \see \ref CONTROL_REQTYPE_DIRECTION macro. */ #define REQDIR_DEVICETOHOST (1 << 7) - //@} + /**@}*/ /** \name Control Request Type Masks */ - //@{ + /**@{*/ /** Request type mask, indicating that the request is a standard request. * * \see \ref CONTROL_REQTYPE_TYPE macro. @@ -121,10 +121,10 @@ * \see \ref CONTROL_REQTYPE_TYPE macro. */ #define REQTYPE_VENDOR (2 << 5) - //@} + /**@}*/ /** \name Control Request Recipient Masks */ - //@{ + /**@{*/ /** Request recipient mask, indicating that the request is to be issued to the device as a whole. * * \see \ref CONTROL_REQTYPE_RECIPIENT macro. @@ -151,7 +151,7 @@ * \see \ref CONTROL_REQTYPE_RECIPIENT macro. */ #define REQREC_OTHER (3 << 0) - //@} + /**@}*/ /* Type Defines: */ /** \brief Standard USB Control Request diff --git a/LUFA/Drivers/USB/Core/UC3/Device_UC3.h b/LUFA/Drivers/USB/Core/UC3/Device_UC3.h index 770cf10d8..c8d15b7ca 100644 --- a/LUFA/Drivers/USB/Core/UC3/Device_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Device_UC3.h @@ -68,7 +68,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Device Mode Option Masks */ - //@{ + /**@{*/ /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the * USB interface should be initialized in low speed (1.5Mb/s) mode. * @@ -88,7 +88,7 @@ */ #define USB_DEVICE_OPT_HIGHSPEED (1 << 1) #endif - //@} + /**@}*/ #if (!defined(NO_INTERNAL_SERIAL) && \ (defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32) || \ diff --git a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h index bb8fc2b8c..5d021b7b1 100644 --- a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Function Prototypes: */ /** \name Stream functions for null data */ - //@{ + /**@{*/ /** Reads and discards the given number of bytes from the currently selected endpoint's bank, * discarding fully read packets from the host as needed. The last packet is not automatically @@ -175,10 +175,10 @@ uint8_t Endpoint_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); - //@} + /**@}*/ /** \name Stream functions for RAM source/destination data */ - //@{ + /**@{*/ /** Writes the given number of bytes to the endpoint from the given buffer in little endian, * sending full packets to the host as needed. The last packet filled is not automatically sent; @@ -425,7 +425,7 @@ */ uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.h b/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.h index 8af02e93c..7d842b0b6 100644 --- a/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.h @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Function Prototypes: */ /** \name Stream functions for null data */ - //@{ + /**@{*/ /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the @@ -173,10 +173,10 @@ uint8_t Pipe_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); - //@} + /**@}*/ /** \name Stream functions for RAM source/destination data */ - //@{ + /**@{*/ /** Writes the given number of bytes to the pipe from the given buffer in little endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; @@ -339,7 +339,7 @@ uint8_t Pipe_Read_Stream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h index 67b717d91..699169b03 100644 --- a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h @@ -109,7 +109,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name Pipe Error Flag Masks */ - //@{ + /**@{*/ /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */ #define PIPE_ERRORFLAG_OVERFLOW (AVR32_USBB_UPSTA0_OVERFI_MASK << 8) @@ -127,10 +127,10 @@ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */ #define PIPE_ERRORFLAG_DATATGL AVR32_USBB_UPERR0_DATATGL_MASK - //@} + /**@}*/ /** \name Pipe Token Masks */ - //@{ + /**@{*/ /** Token mask for \ref Pipe_SetPipeToken() and \ref Pipe_GetPipeToken(). This sets the pipe as a SETUP token (for CONTROL type pipes), * which will trigger a control request on the attached device when data is written to the pipe. */ @@ -145,7 +145,7 @@ * indicating that the pipe data will flow from host to device. */ #define PIPE_TOKEN_OUT AVR32_USBB_UPCFG0_PTOKEN_OUT - //@} + /**@}*/ /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value * in the device descriptor of the attached device. diff --git a/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h b/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h index 5b56dbbf6..6b56f6dce 100644 --- a/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h @@ -97,7 +97,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Controller Option Masks */ - //@{ + /**@{*/ /** Selects one of the system's main clock oscillators as the input clock to the USB Generic Clock source * generation module. This indicates that an external oscillator should be used directly instead of an * internal PLL clock source. @@ -115,7 +115,7 @@ /** Selects PLL or External Oscillator 1 as the USB Generic Clock source module input clock. */ #define USB_OPT_GCLK_CHANNEL_1 (0 << 3) - //@} + /**@}*/ #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__) /** Constant for the maximum software timeout period of the USB data stream transfer functions diff --git a/LUFA/Drivers/USB/Core/USBController.h b/LUFA/Drivers/USB/Core/USBController.h index 25fb37dee..d8773a4cb 100644 --- a/LUFA/Drivers/USB/Core/USBController.h +++ b/LUFA/Drivers/USB/Core/USBController.h @@ -64,7 +64,7 @@ /* Defines: */ /** \name Endpoint Direction Masks */ - //@{ + /**@{*/ /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's * direction for comparing with the \c ENDPOINT_DIR_* masks. */ @@ -79,10 +79,10 @@ * the index of the address within a device to obtain the full endpoint address. */ #define ENDPOINT_DIR_IN 0x80 - //@} + /**@}*/ /** \name Pipe Direction Masks */ - //@{ + /**@{*/ /** Pipe direction mask, for masking against pipe addresses to retrieve the pipe's * direction for comparing with the \c PIPE_DIR_* masks. */ @@ -97,10 +97,10 @@ * the index of the address within a device to obtain the full endpoint address. */ #define PIPE_DIR_IN 0x80 - //@} + /**@}*/ /** \name Endpoint/Pipe Type Masks */ - //@{ + /**@{*/ /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared * with the \c EP_TYPE_* masks to determine the exact type of the endpoint. */ @@ -129,7 +129,7 @@ * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions. */ #define EP_TYPE_INTERRUPT 0x03 - //@} + /**@}*/ /* Enums: */ /** Enum for the possible USB controller modes, for initialization via \ref USB_Init() and indication back to the diff --git a/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h index c12c25d42..909d75854 100644 --- a/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h +++ b/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h @@ -80,7 +80,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Device Mode Option Masks */ - //@{ + /**@{*/ /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the * USB interface should be initialized in low speed (1.5Mb/s) mode. * @@ -98,7 +98,7 @@ */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0) #endif - //@} + /**@}*/ #if (!defined(NO_INTERNAL_SERIAL) || defined(__DOXYGEN__)) /** String descriptor index for the device's unique serial number string descriptor within the device. diff --git a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h index cff888d83..a62e1ef3d 100644 --- a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h +++ b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h @@ -67,7 +67,7 @@ /* Public Interface - May be used in end-application: */ /* Function Prototypes: */ /** \name Stream functions for null data */ - //@{ + /**@{*/ /** Reads and discards the given number of bytes from the currently selected endpoint's bank, * discarding fully read packets from the host as needed. The last packet is not automatically @@ -175,10 +175,10 @@ uint8_t Endpoint_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); - //@} + /**@}*/ /** \name Stream functions for RAM source/destination data */ - //@{ + /**@{*/ /** Writes the given number of bytes to the endpoint from the given buffer in little endian, * sending full packets to the host as needed. The last packet filled is not automatically sent; @@ -425,10 +425,10 @@ */ uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for EEPROM source/destination data */ - //@{ + /**@{*/ /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE(). * @@ -565,10 +565,10 @@ */ uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /** \name Stream functions for PROGMEM source/destination data */ - //@{ + /**@{*/ /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE(). * @@ -645,7 +645,7 @@ */ uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); - //@} + /**@}*/ /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) diff --git a/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h index 0915e3f9d..c8bb101a7 100644 --- a/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h +++ b/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h @@ -108,7 +108,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name USB Controller Option Masks */ - //@{ + /**@{*/ /** Sets the USB bus interrupt priority level to be low priority. The USB bus interrupt is used for Start of Frame events, bus suspend * and resume events, bus reset events and other events related to the management of the USB bus. */ @@ -129,7 +129,7 @@ /** Sets the USB controller to source its clock from the internal PLL. */ #define USB_OPT_PLLCLKSRC (1 << 3) - //@} + /**@}*/ #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__) /** Constant for the maximum software timeout period of the USB data stream transfer functions diff --git a/LUFA/Version.h b/LUFA/Version.h index 30b40cf76..401886104 100644 --- a/LUFA/Version.h +++ b/LUFA/Version.h @@ -43,7 +43,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** \name LUFA Release Type Constants */ - //@{ + /**@{*/ /** Constant for \ref LUFA_VERSION_RELEASE_TYPE indicating a development release. */ #define LUFA_VERSION_RELEASE_TYPE_DEVELOPMENT 0 @@ -52,7 +52,7 @@ /** Constant for \ref LUFA_VERSION_RELEASE_TYPE indicating a full official release. */ #define LUFA_VERSION_RELEASE_TYPE_FULL 2 - //@} + /**@}*/ /** Indicates the version number of the library, as an integer. \note This value is only updates in non-development releases. */ #define LUFA_VERSION_INTEGER 0x170418 |