forked from mfulz_github/qmk_firmware
Minor documentation improvements.
This commit is contained in:
Dean Camera
parent
fd5e98d380
commit
7464e40a4b
|
|
@ -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!
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -819,8 +819,8 @@
|
|||
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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -821,8 +821,8 @@
|
|||
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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
Loading…
Reference in New Issue