forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor documentation improvements.

Browse Source
pull/1469/head
Dean Camera 12 years ago
parent fd5e98d380
commit 7464e40a4b
6 changed files with 27 additions and 28 deletions
Show Stats Download Patch File Download Diff File

2
LUFA/DoxygenPages/Donating.txt
Unescape View File

@ -19,6 +19,6 @@
* contact author for payment details.</b>). * contact author for payment details.</b>).
* *
* \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome" * \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!
*/ */

12
LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h
Unescape View File

@ -196,7 +196,7 @@
{ {
return (UPCFG0X & (1 << EPDIR)) ? PIPE_DIR_IN : PIPE_DIR_OUT; 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 /** 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. * 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) static inline uint8_t Pipe_GetBoundEndpointAddress(void)
{ {
uint8_t UPCFG0X_Temp = UPCFG0X; uint8_t UPCFG0X_Temp = UPCFG0X;
return (((UPCFG0X_Temp >> PEPNUM0) & PIPE_EPNUM_MASK) | ((UPCFG0X_Temp & PEPNUM1) ? ENDPOINT_DIR_OUT : ENDPOINT_DIR_IN)); 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. * \param[in] Entries Number of entries in the pipe table to configure.
* *
* \return Boolean \c true if all pipes configured successfully, \c false otherwise. * \return Boolean \c true if all pipes configured successfully, \c false otherwise.
*/ */
bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table, bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table,
const uint8_t Entries); const uint8_t Entries);
/** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device,
* and number of hardware banks. * 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() * 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 * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or

9
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
Unescape View File

@ -167,9 +167,8 @@
}; };
/* Inline Functions: */ /* Inline Functions: */
/** Configures the specified endpoint address with the given endpoint type, direction, bank size /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware
* and banking mode. Once configured, the endpoint may be read from or written to, depending * banks. Once configured, the endpoint may be read from or written to, depending on its direction.
* on its direction.
* *
* \param[in] Address Endpoint address to configure. * \param[in] Address Endpoint address to configure.
* *
@ -209,7 +208,7 @@
const uint8_t Banks) const uint8_t Banks)
{ {
uint8_t Number = (Address & ENDPOINT_EPNUM_MASK); uint8_t Number = (Address & ENDPOINT_EPNUM_MASK);
if (Number >= ENDPOINT_TOTAL_ENDPOINTS) if (Number >= ENDPOINT_TOTAL_ENDPOINTS)
return false; return false;
@ -277,7 +276,7 @@
static inline void Endpoint_ResetEndpoint(const uint8_t Address) static inline void Endpoint_ResetEndpoint(const uint8_t Address)
{ {
uint32_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK); uint32_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK);
AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber); AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber);
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]; USB_Endpoint_FIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];

8
LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h
Unescape View File

@ -206,7 +206,7 @@
{ {
return (((&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken == PIPE_TOKEN_OUT) ? PIPE_DIR_OUT : PIPE_DIR_IN); 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 /** 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. * 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. * \param[in] Entries Number of entries in the pipe table to configure.
* *
* \return Boolean \c true if all pipes configured successfully, \c false otherwise. * \return Boolean \c true if all pipes configured successfully, \c false otherwise.
*/ */
bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table, bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table,
const uint8_t Entries); const uint8_t Entries);
/** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device,
* and number of hardware banks. * 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() * 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 * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or

5
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
Unescape View File

@ -194,9 +194,8 @@
*/ */
void Endpoint_SelectEndpoint(const uint8_t Address); void Endpoint_SelectEndpoint(const uint8_t Address);
/** Configures the specified endpoint address with the given endpoint type, direction, bank size /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware
* and banking mode. Once configured, the endpoint may be read from or written to, depending * banks. Once configured, the endpoint may be read from or written to, depending on its direction.
* on its direction.
* *
* \param[in] Address Endpoint address to configure. * \param[in] Address Endpoint address to configure.
* *

19
LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
Unescape View File

@ -74,7 +74,7 @@
</xsl:if> </xsl:if>
</xsl:for-each> </xsl:for-each>
<!-- Add Module chapter --> <!-- Add Modules chapter -->
<chapter> <chapter>
<title>Modules</title> <title>Modules</title>
<xsl:for-each select="compounddef[@kind = 'group']"> <xsl:for-each select="compounddef[@kind = 'group']">
@ -226,7 +226,7 @@
<xsl:for-each select="memberdef"> <xsl:for-each select="memberdef">
<row id="{@id}" xreflabel="{name}"> <row id="{@id}" xreflabel="{name}">
<entry> <entry>
<xsl:apply-templates select="type"/> <xsl:value-of select="type"/>
</entry> </entry>
<entry> <entry>
<xsl:value-of select="name"/> <xsl:value-of select="name"/>
@ -435,7 +435,7 @@
</section> </section>
</xsl:template> </xsl:template>
<xsl:template match="linebreak"> <xsl:template match="linebreak | simplesectsep">
<literallayout> <literallayout>
</literallayout> </literallayout>
</xsl:template> </xsl:template>
@ -467,42 +467,42 @@
<title> <title>
<xsl:value-of select="title"/> <xsl:value-of select="title"/>
</title> </title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</note> </note>
</xsl:when> </xsl:when>
<xsl:when test="@kind = 'return'"> <xsl:when test="@kind = 'return'">
<note> <note>
<title>Returns</title> <title>Returns</title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</note> </note>
</xsl:when> </xsl:when>
<xsl:when test="@kind = 'warning'"> <xsl:when test="@kind = 'warning'">
<warning> <warning>
<title>Warning</title> <title>Warning</title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</warning> </warning>
</xsl:when> </xsl:when>
<xsl:when test="@kind = 'pre'"> <xsl:when test="@kind = 'pre'">
<note> <note>
<title>Precondition</title> <title>Precondition</title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</note> </note>
</xsl:when> </xsl:when>
<xsl:when test="@kind = 'see'"> <xsl:when test="@kind = 'see'">
<note> <note>
<title>See also</title> <title>See also</title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</note> </note>
</xsl:when> </xsl:when>
<xsl:when test="@kind = 'note'"> <xsl:when test="@kind = 'note'">
<note> <note>
<title>Note</title> <title>Note</title>
<xsl:apply-templates select="para"/> <xsl:apply-templates/>
</note> </note>
</xsl:when> </xsl:when>
@ -680,6 +680,7 @@
<title> <title>
<xsl:value-of select="caption"/> <xsl:value-of select="caption"/>
</title> </title>
<xsl:call-template name="write.table.content"/> <xsl:call-template name="write.table.content"/>
</table> </table>
</xsl:when> </xsl:when>

Write Preview
Loading…
Cancel
Save