diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2013-05-04 20:54:32 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2013-05-04 20:54:32 +0000 |
commit | 7464e40a4ba3470c12001069bbe5f31db209dc4d (patch) | |
tree | 875b1e85378cdd4013e6e48c48148123380b4765 /LUFA | |
parent | fd5e98d380820c01e1f4346cf7f11e573e1c5c75 (diff) | |
download | lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.tar.gz lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.tar.bz2 lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.zip |
Minor documentation improvements.
Diffstat (limited to 'LUFA')
-rw-r--r-- | LUFA/DoxygenPages/Donating.txt | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h | 12 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 9 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h | 8 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h | 5 | ||||
-rw-r--r-- | LUFA/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.</b>). * * \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome" - * <a href='http://www.lufa-lib.org/donate'>Donate to this project via PayPal</a> - Thanks in Advance! + * <a href="http://www.lufa-lib.org/donate">Donate to this project via PayPal</a> - 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 @@ </xsl:if> </xsl:for-each> - <!-- Add Module chapter --> + <!-- Add Modules chapter --> <chapter> <title>Modules</title> <xsl:for-each select="compounddef[@kind = 'group']"> @@ -226,7 +226,7 @@ <xsl:for-each select="memberdef"> <row id="{@id}" xreflabel="{name}"> <entry> - <xsl:apply-templates select="type"/> + <xsl:value-of select="type"/> </entry> <entry> <xsl:value-of select="name"/> @@ -435,7 +435,7 @@ </section> </xsl:template> - <xsl:template match="linebreak"> + <xsl:template match="linebreak | simplesectsep"> <literallayout> </literallayout> </xsl:template> @@ -467,42 +467,42 @@ <title> <xsl:value-of select="title"/> </title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </note> </xsl:when> <xsl:when test="@kind = 'return'"> <note> <title>Returns</title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </note> </xsl:when> <xsl:when test="@kind = 'warning'"> <warning> <title>Warning</title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </warning> </xsl:when> <xsl:when test="@kind = 'pre'"> <note> <title>Precondition</title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </note> </xsl:when> <xsl:when test="@kind = 'see'"> <note> <title>See also</title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </note> </xsl:when> <xsl:when test="@kind = 'note'"> <note> <title>Note</title> - <xsl:apply-templates select="para"/> + <xsl:apply-templates/> </note> </xsl:when> @@ -680,6 +680,7 @@ <title> <xsl:value-of select="caption"/> </title> + <xsl:call-template name="write.table.content"/> </table> </xsl:when> |