Commit 9257f4ab authored by Dean Camera's avatar Dean Camera
Browse files

Add briefs for the library core structures.

parent 05576760
...@@ -74,7 +74,7 @@ void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo) ...@@ -74,7 +74,7 @@ void TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo)
} }
/* Get pointer to the output frame info struct for convenience */ /* Get pointer to the output frame info struct for convenience */
Ethernet_Frame_Info_t* FrameOUT = (Ethernet_Frame_Info_t*)&RNDISInterfaceInfo->State.FrameOUT; Ethernet_Frame_Info_t* FrameOUT = &RNDISInterfaceInfo->State.FrameOUT;
/* Bail out early if there is already a frame waiting to be sent in the Ethernet OUT buffer */ /* Bail out early if there is already a frame waiting to be sent in the Ethernet OUT buffer */
if (FrameOUT->FrameInBuffer) if (FrameOUT->FrameInBuffer)
......
This diff is collapsed.
...@@ -74,7 +74,7 @@ BRIEF_MEMBER_DESC = YES ...@@ -74,7 +74,7 @@ BRIEF_MEMBER_DESC = YES
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed. # brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES REPEAT_BRIEF = NO
# This tag implements a quasi-intelligent brief description abbreviator # This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string # that is used to form the text in various listings. Each string
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Buttons driver header for the ATAVRUSBRF01. * \brief Board specific Buttons driver header for the ATAVRUSBRF01.
* *
* Board specific Buttons driver header for the ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver * \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h. * dispatch header located in LUFA/Drivers/Board/Buttons.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific LED driver header for the ATAVRUSBRF01. * \brief Board specific LED driver header for the ATAVRUSBRF01.
* *
* Board specific LED driver header for the ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver * \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h. * dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Buttons driver header for the BUMBLEB. * \brief Board specific Buttons driver header for the BUMBLEB.
* *
* Board specific Buttons driver header for the BUMBLEB.
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick. * external peripheral layout for buttons, LEDs and a Joystick.
* *
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific joystick driver header for the BUMLEB. * \brief Board specific joystick driver header for the BUMLEB.
* *
* Board specific joystick driver header for the BUMLEB.
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick. * external peripheral layout for buttons, LEDs and a Joystick.
* *
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific LED driver header for the BUMBLEB. * \brief Board specific LED driver header for the BUMBLEB.
* *
* Board specific LED driver header for the BUMBLEB.
*
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended * The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick. * external peripheral layout for buttons, LEDs and a Joystick.
* *
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527. * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
* *
* Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver * \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. * dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Buttons driver header for the EVK527. * \brief Board specific Buttons driver header for the EVK527.
* *
* Board specific Buttons driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver * \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h. * dispatch header located in LUFA/Drivers/Board/Buttons.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Dataflash driver header for the EVK527. * \brief Board specific Dataflash driver header for the EVK527.
* *
* Board specific Dataflash driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver * \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. * dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific joystick driver header for the EVK527. * \brief Board specific joystick driver header for the EVK527.
* *
* Board specific joystick driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver * \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h. * dispatch header located in LUFA/Drivers/Board/Joystick.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific LED driver header for the EVK527. * \brief Board specific LED driver header for the EVK527.
* *
* Board specific LED driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver * \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h. * dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific LED driver header for the RZUSBSTICK. * \brief Board specific LED driver header for the RZUSBSTICK.
* *
* Board specific LED driver header for the RZUSBSTICK.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver * \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h. * dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525. * \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
* *
* Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver * \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. * dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Buttons driver header for the STK525. * \brief Board specific Buttons driver header for the STK525.
* *
* Board specific Buttons driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver * \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h. * dispatch header located in LUFA/Drivers/Board/Buttons.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Dataflash driver header for the STK525. * \brief Board specific Dataflash driver header for the STK525.
* *
* Board specific Dataflash driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver * \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. * dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific joystick driver header for the STK525. * \brief Board specific joystick driver header for the STK525.
* *
* Board specific joystick driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver * \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h. * dispatch header located in LUFA/Drivers/Board/Joystick.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific LED driver header for the STK525. * \brief Board specific LED driver header for the STK525.
* *
* Board specific LED driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver * \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h. * dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/ */
......
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
/** \file /** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526. * \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
* *
* Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver * \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h. * dispatch header located in LUFA/Drivers/Board/Dataflash.h.
*/ */
......
Supports Markdown
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