mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-12-22 17:34:18 +03:00
docs: Format @variable properly
When documenting our public API in some places we use '@' to refer to the variable. For instance: * This API tries to set guest time to the given value. The time * to set (@seconds and @nseconds) should be in seconds relative * to the Epoch of 1970-01-01 00:00:00 in UTC. However, when generating HTML documentation these tokens are copied verbatim. What we can do is drop the '@' character and wrap the variable in <code/> so that it is formatted properly. Due to the way we 'parse' docs a token might actually be slightly more than just '@variable'. For instance in the example above we will have the following tokens: '(@seconds' and '@nseconds)'. Thus we need to handle possible substring before and after variable. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
parent
0cb4550305
commit
bdd3dfba15
@ -139,6 +139,12 @@
|
||||
</a>
|
||||
<xsl:value-of select="substring-after($token, '>')"/>
|
||||
</xsl:when>
|
||||
<xsl:when test="contains($token, '@')">
|
||||
<xsl:variable name="prologue" select="substring-before($token, '@')"/>
|
||||
<xsl:value-of select="$prologue"/>
|
||||
<code><xsl:value-of select="$stem"/></code>
|
||||
<xsl:value-of select="substring($token, string-length($prologue) + string-length($stem) + 2)"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:value-of select="$token"/>
|
||||
</xsl:otherwise>
|
||||
|
Loading…
Reference in New Issue
Block a user