From 7464e40a4ba3470c12001069bbe5f31db209dc4d Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sat, 4 May 2013 20:54:32 +0000 Subject: Minor documentation improvements. --- LUFA/DoxygenPages/Donating.txt | 2 +- LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h | 12 ++++++------ LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 9 ++++----- LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h | 8 ++++---- LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h | 5 ++--- .../StudioIntegration/HV1/lufa_docbook_transform.xslt | 19 ++++++++++--------- 6 files changed, 27 insertions(+), 28 deletions(-) diff --git a/LUFA/DoxygenPages/Donating.txt b/LUFA/DoxygenPages/Donating.txt index 1436dae42..cb2e0eaf9 100644 --- a/LUFA/DoxygenPages/Donating.txt +++ b/LUFA/DoxygenPages/Donating.txt @@ -19,6 +19,6 @@ * contact author for payment details.). * * \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome" - * Donate to this project via PayPal - Thanks in Advance! + * Donate to this project via PayPal - Thanks in Advance! */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h index c434cf893..5f2e46ddb 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h @@ -196,7 +196,7 @@ { return (UPCFG0X & (1 << EPDIR)) ? PIPE_DIR_IN : PIPE_DIR_OUT; } - + /** Returns the pipe address of the currently selected pipe. This is typically used to save the * currently selected pipe address so that it can be restored after another pipe has been manipulated. * @@ -321,7 +321,7 @@ static inline uint8_t Pipe_GetBoundEndpointAddress(void) { uint8_t UPCFG0X_Temp = UPCFG0X; - + return (((UPCFG0X_Temp >> PEPNUM0) & PIPE_EPNUM_MASK) | ((UPCFG0X_Temp & PEPNUM1) ? ENDPOINT_DIR_OUT : ENDPOINT_DIR_IN)); } @@ -815,12 +815,12 @@ * \param[in] Entries Number of entries in the pipe table to configure. * * \return Boolean \c true if all pipes configured successfully, \c false otherwise. - */ + */ bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table, const uint8_t Entries); - - /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size - * and number of hardware banks. + + /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, + * bank size and number of hardware banks. * * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or diff --git a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h index bcf6b64a5..7e582adef 100644 --- a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h @@ -167,9 +167,8 @@ }; /* Inline Functions: */ - /** Configures the specified endpoint address with the given endpoint type, direction, bank size - * and banking mode. Once configured, the endpoint may be read from or written to, depending - * on its direction. + /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware + * banks. Once configured, the endpoint may be read from or written to, depending on its direction. * * \param[in] Address Endpoint address to configure. * @@ -209,7 +208,7 @@ const uint8_t Banks) { uint8_t Number = (Address & ENDPOINT_EPNUM_MASK); - + if (Number >= ENDPOINT_TOTAL_ENDPOINTS) return false; @@ -277,7 +276,7 @@ static inline void Endpoint_ResetEndpoint(const uint8_t Address) { uint32_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK); - + AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber); AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber); USB_Endpoint_FIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE]; diff --git a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h index f09d56096..a8cb29ebf 100644 --- a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h @@ -206,7 +206,7 @@ { return (((&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken == PIPE_TOKEN_OUT) ? PIPE_DIR_OUT : PIPE_DIR_IN); } - + /** Returns the pipe address of the currently selected pipe. This is typically used to save the * currently selected pipe number so that it can be restored after another pipe has been manipulated. * @@ -817,12 +817,12 @@ * \param[in] Entries Number of entries in the pipe table to configure. * * \return Boolean \c true if all pipes configured successfully, \c false otherwise. - */ + */ bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table, const uint8_t Entries); - /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size - * and number of hardware banks. + /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, + * bank size and number of hardware banks. * * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or diff --git a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h index 9d6a628d5..4ebe0ce53 100644 --- a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h +++ b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h @@ -194,9 +194,8 @@ */ void Endpoint_SelectEndpoint(const uint8_t Address); - /** Configures the specified endpoint address with the given endpoint type, direction, bank size - * and banking mode. Once configured, the endpoint may be read from or written to, depending - * on its direction. + /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware + * banks. Once configured, the endpoint may be read from or written to, depending on its direction. * * \param[in] Address Endpoint address to configure. * diff --git a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt index 18c3ea65f..680cea5e2 100644 --- a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt +++ b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt @@ -74,7 +74,7 @@ - + Modules @@ -226,7 +226,7 @@ - + @@ -435,7 +435,7 @@ - + @@ -467,42 +467,42 @@ <xsl:value-of select="title"/> - + Returns - + Warning - + Precondition - + See also - + Note - + @@ -680,6 +680,7 @@ <xsl:value-of select="caption"/> + -- cgit v1.2.3