Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

体验新版 GitCode，发现更多精彩内容 >>

提交 458dd20d 编写于 作者: C Claudio Bley 提交者： Jiri Denemark
浏览文件
操作

docs: Assign classes to documentation elements 

In CSS the following class names are available:

* keyword     (keywords like "typedef", "struct")
* type        (types like "int", "void*")
* comment     (comments after members of enums or structs)
* directive   (preprocessor directives, #define)
* undisclosed (text saying that the API is not public)

Additionally, kill all of the left-over "programlisting" class
assignments. There are no CSS rules for them.
Signed-off-by: NClaudio Bley <cbley@av-test.de>
上级 de78bf60
隐藏空白更改
内联 并排
Showing with 108 addition and 79 deletion
docs/newapi.xsl
浏览文件 @ 458dd20d
...@@ -116,16 +116,18 @@ ...@@ -116,16 +116,18 @@
</xsl:template> </xsl:template>
<xsl:template match="macro" mode="toc"> <xsl:template match="macro" mode="toc">
<xsl:text>#define </xsl:text> <span class="directive">#define</span><xsl:text> </xsl:text>
<a href="#{@name}"><xsl:value-of select="@name"/></a> <a href="#{@name}"><xsl:value-of select="@name"/></a>
<xsl:text> <xsl:text>
</xsl:text> </xsl:text>
</xsl:template> </xsl:template>
<xsl:template match="variable" mode="toc"> <xsl:template match="variable" mode="toc">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="string(@type)"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="string(@type)"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<a name="{@name}"></a> <a name="{@name}"></a>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
...@@ -134,18 +136,21 @@ ...@@ -134,18 +136,21 @@
</xsl:template> </xsl:template>
<xsl:template match="typedef" mode="toc"> <xsl:template match="typedef" mode="toc">
<xsl:text>typedef </xsl:text><xsl:variable name="name" select="string(@name)"/> <span class="keyword">typedef</span>
<xsl:text> </xsl:text><xsl:variable name="name" select="string(@name)"/>
<xsl:choose> <xsl:choose>
<xsl:when test="@type = 'enum'"> <xsl:when test="@type = 'enum'">
<xsl:text>enum </xsl:text> <span class="keyword">enum</span><xsl:text> </xsl:text>
<a href="#{$name}"><xsl:value-of select="$name"/></a> <a href="#{$name}"><xsl:value-of select="$name"/></a>
<xsl:text> <xsl:text>
</xsl:text> </xsl:text>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<a name="{$name}"><xsl:value-of select="$name"/></a> <a name="{$name}"><xsl:value-of select="$name"/></a>
<xsl:text> <xsl:text>
...@@ -159,7 +164,7 @@ ...@@ -159,7 +164,7 @@
<h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3> <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<div class="api"> <div class="api">
<pre> <pre>
<xsl:text>enum </xsl:text> <span class="keyword">enum</span><xsl:text> </xsl:text>
<xsl:value-of select="$name"/> <xsl:value-of select="$name"/>
<xsl:text> { <xsl:text> {
</xsl:text> </xsl:text>
...@@ -173,10 +178,11 @@ ...@@ -173,10 +178,11 @@
<td><xsl:value-of select="@value"/></td> <td><xsl:value-of select="@value"/></td>
<xsl:if test="@info != ''"> <xsl:if test="@info != ''">
<td> <td>
<xsl:text> : </xsl:text> <div class="comment">
<xsl:call-template name="dumptext"> <xsl:call-template name="dumptext">
<xsl:with-param name="text" select="@info"/> <xsl:with-param name="text" select="@info"/>
</xsl:call-template> </xsl:call-template>
</div>
</td> </td>
</xsl:if> </xsl:if>
</tr> </tr>
...@@ -190,8 +196,8 @@ ...@@ -190,8 +196,8 @@
</xsl:template> </xsl:template>
<xsl:template match="struct" mode="toc"> <xsl:template match="struct" mode="toc">
<xsl:text>typedef </xsl:text> <span class="keyword">typedef</span><xsl:text> </xsl:text>
<xsl:value-of select="@type"/> <span class="type"><xsl:value-of select="@type"/></span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<a href="#{@name}"><xsl:value-of select="@name"/></a> <a href="#{@name}"><xsl:value-of select="@name"/></a>
<xsl:text> <xsl:text>
...@@ -202,32 +208,35 @@ ...@@ -202,32 +208,35 @@
<h3><a name="{@name}"><code><xsl:value-of select="@name"/></code></a></h3> <h3><a name="{@name}"><code><xsl:value-of select="@name"/></code></a></h3>
<div class="api"> <div class="api">
<pre> <pre>
<xsl:text>struct </xsl:text> <span class="keyword">struct </span>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:text>{ <xsl:text> {
</xsl:text> </xsl:text>
</pre> </pre>
<table> <table>
<xsl:for-each select="field"> <xsl:for-each select="field">
<xsl:choose> <xsl:choose>
<xsl:when test='@type = "union"'> <xsl:when test='@type = "union"'>
<tr><td>union {</td></tr> <tr><td><span class="keyword">union</span> {</td></tr>
<tr> <tr>
<td><table> <td><table>
<xsl:for-each select="union/field"> <xsl:for-each select="union/field">
<tr> <tr>
<td> <td>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
</td> </td>
<td><xsl:value-of select="@name"/></td> <td><xsl:value-of select="@name"/></td>
<xsl:if test="@info != ''"> <xsl:if test="@info != ''">
<td> <td>
<xsl:text> : </xsl:text> <div class="comment">
<xsl:call-template name="dumptext"> <xsl:call-template name="dumptext">
<xsl:with-param name="text" select="@info"/> <xsl:with-param name="text" select="@info"/>
</xsl:call-template> </xsl:call-template>
</div>
</td> </td>
</xsl:if> </xsl:if>
</tr> </tr>
...@@ -238,10 +247,11 @@ ...@@ -238,10 +247,11 @@
<td><xsl:value-of select="@name"/></td> <td><xsl:value-of select="@name"/></td>
<xsl:if test="@info != ''"> <xsl:if test="@info != ''">
<td> <td>
<xsl:text> : </xsl:text> <div class="comment">
<xsl:call-template name="dumptext"> <xsl:call-template name="dumptext">
<xsl:with-param name="text" select="@info"/> <xsl:with-param name="text" select="@info"/>
</xsl:call-template> </xsl:call-template>
</div>
</td> </td>
</xsl:if> </xsl:if>
<td></td></tr> <td></td></tr>
...@@ -249,17 +259,20 @@ ...@@ -249,17 +259,20 @@
<xsl:otherwise> <xsl:otherwise>
<tr> <tr>
<td> <td>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
</td> </td>
<td><xsl:value-of select="@name"/></td> <td><xsl:value-of select="@name"/></td>
<xsl:if test="@info != ''"> <xsl:if test="@info != ''">
<td> <td>
<xsl:text> : </xsl:text> <div class="comment">
<xsl:call-template name="dumptext"> <xsl:call-template name="dumptext">
<xsl:with-param name="text" select="@info"/> <xsl:with-param name="text" select="@info"/>
</xsl:call-template> </xsl:call-template>
</div>
</td> </td>
</xsl:if> </xsl:if>
</tr> </tr>
...@@ -269,7 +282,7 @@ ...@@ -269,7 +282,7 @@
<xsl:if test="not(field)"> <xsl:if test="not(field)">
<tr> <tr>
<td colspan="3"> <td colspan="3">
<xsl:text>The content of this structure is not made public by the API</xsl:text> <span class="undisclosed">The content of this structure is not made public by the API</span>
</td> </td>
</tr> </tr>
</xsl:if> </xsl:if>
...@@ -285,7 +298,7 @@ ...@@ -285,7 +298,7 @@
<xsl:template match="macro"> <xsl:template match="macro">
<xsl:variable name="name" select="string(@name)"/> <xsl:variable name="name" select="string(@name)"/>
<h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3> <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre><xsl:text>#define </xsl:text><xsl:value-of select="$name"/></pre> <pre class="api"><span class="directive">#define</span><xsl:text> </xsl:text><xsl:value-of select="$name"/></pre>
<div> <div>
<xsl:call-template name="formattext"> <xsl:call-template name="formattext">
<xsl:with-param name="text" select="info"/> <xsl:with-param name="text" select="info"/>
...@@ -299,9 +312,11 @@ ...@@ -299,9 +312,11 @@
<xsl:variable name="nlen" select="string-length($name)"/> <xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/> <xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="return/@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
</span>
<xsl:text>&#9;</xsl:text> <xsl:text>&#9;</xsl:text>
<a href="#{@name}"><xsl:value-of select="@name"/></a> <a href="#{@name}"><xsl:value-of select="@name"/></a>
<xsl:if test="$blen - 40 &lt; -8"> <xsl:if test="$blen - 40 &lt; -8">
...@@ -312,12 +327,14 @@ ...@@ -312,12 +327,14 @@
</xsl:if> </xsl:if>
<xsl:text>&#9;(</xsl:text> <xsl:text>&#9;(</xsl:text>
<xsl:if test="not(arg)"> <xsl:if test="not(arg)">
<xsl:text>void</xsl:text> <span class="type">void</span>
</xsl:if> </xsl:if>
<xsl:for-each select="arg"> <xsl:for-each select="arg">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
...@@ -340,13 +357,15 @@ ...@@ -340,13 +357,15 @@
<xsl:variable name="nlen" select="string-length($name)"/> <xsl:variable name="nlen" select="string-length($name)"/>
<xsl:variable name="tlen" select="string-length(return/@type)"/> <xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
<xsl:text>typedef </xsl:text> <span class="keyword">typedef</span><xsl:text> </xsl:text>
<a href="#{$name}"><xsl:value-of select="$name"/></a> <a href="#{$name}"><xsl:value-of select="$name"/></a>
<xsl:text> <xsl:text>
</xsl:text> </xsl:text>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="return/@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
</span>
<xsl:text>&#9;</xsl:text> <xsl:text>&#9;</xsl:text>
<a href="#{$name}"><xsl:value-of select="$name"/></a> <a href="#{$name}"><xsl:value-of select="$name"/></a>
<xsl:if test="$blen - 40 &lt; -8"> <xsl:if test="$blen - 40 &lt; -8">
...@@ -357,12 +376,14 @@ ...@@ -357,12 +376,14 @@
</xsl:if> </xsl:if>
<xsl:text>&#9;(</xsl:text> <xsl:text>&#9;(</xsl:text>
<xsl:if test="not(arg)"> <xsl:if test="not(arg)">
<xsl:text>void</xsl:text> <span class="type">void</span>
</xsl:if> </xsl:if>
<xsl:for-each select="arg"> <xsl:for-each select="arg">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
...@@ -388,11 +409,13 @@ ...@@ -388,11 +409,13 @@
<xsl:variable name="tlen" select="string-length(return/@type)"/> <xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
<h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3> <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre class="programlisting"> <pre class="api">
<xsl:text>typedef </xsl:text> <span class="keyword">typedef</span><xsl:text> </xsl:text>
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="return/@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
</span>
<xsl:text>&#9;(*</xsl:text> <xsl:text>&#9;(*</xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="$blen - 40 &lt; -8"> <xsl:if test="$blen - 40 &lt; -8">
...@@ -403,16 +426,19 @@ ...@@ -403,16 +426,19 @@
</xsl:if> </xsl:if>
<xsl:text>)&#9;(</xsl:text> <xsl:text>)&#9;(</xsl:text>
<xsl:if test="not(arg)"> <xsl:if test="not(arg)">
<xsl:text>void</xsl:text> <span class="type">void</span>
</xsl:if> </xsl:if>
<xsl:for-each select="arg"> <xsl:for-each select="arg">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
<xsl:text>, </xsl:text><br/> <xsl:text>,
</xsl:text>
<xsl:if test="$blen - 40 &gt; 8"> <xsl:if test="$blen - 40 &gt; 8">
<xsl:text>&#9;</xsl:text> <xsl:text>&#9;</xsl:text>
</xsl:if> </xsl:if>
...@@ -465,10 +491,12 @@ ...@@ -465,10 +491,12 @@
<xsl:variable name="tlen" select="string-length(return/@type)"/> <xsl:variable name="tlen" select="string-length(return/@type)"/>
<xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/>
<h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3> <h3><a name="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
<pre class="programlisting"> <pre class="api">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="return/@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="return/@type"/>
</xsl:call-template>
</span>
<xsl:text>&#9;</xsl:text> <xsl:text>&#9;</xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="$blen - 40 &lt; -8"> <xsl:if test="$blen - 40 &lt; -8">
...@@ -479,16 +507,19 @@ ...@@ -479,16 +507,19 @@
</xsl:if> </xsl:if>
<xsl:text>&#9;(</xsl:text> <xsl:text>&#9;(</xsl:text>
<xsl:if test="not(arg)"> <xsl:if test="not(arg)">
<xsl:text>void</xsl:text> <span class="type">void</span>
</xsl:if> </xsl:if>
<xsl:for-each select="arg"> <xsl:for-each select="arg">
<xsl:call-template name="dumptext"> <span class="type">
<xsl:with-param name="text" select="@type"/> <xsl:call-template name="dumptext">
</xsl:call-template> <xsl:with-param name="text" select="@type"/>
</xsl:call-template>
</span>
<xsl:text> </xsl:text> <xsl:text> </xsl:text>
<xsl:value-of select="@name"/> <xsl:value-of select="@name"/>
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
<xsl:text>, </xsl:text><br/> <xsl:text>,
</xsl:text>
<xsl:if test="$blen - 40 &gt; 8"> <xsl:if test="$blen - 40 &gt; 8">
<xsl:text>&#9;</xsl:text> <xsl:text>&#9;</xsl:text>
</xsl:if> </xsl:if>
...@@ -498,9 +529,7 @@ ...@@ -498,9 +529,7 @@
<xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text> <xsl:text>&#9;&#9;&#9;&#9;&#9; </xsl:text>
</xsl:if> </xsl:if>
</xsl:for-each> </xsl:for-each>
<xsl:text>)</xsl:text><br/> <xsl:text>)</xsl:text>
<xsl:text>
</xsl:text>
</pre> </pre>
<div> <div>
<xsl:call-template name="formattext"> <xsl:call-template name="formattext">
...@@ -579,20 +608,20 @@ ...@@ -579,20 +608,20 @@
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<xsl:if test="count(exports[@type='macro']) > 0"> <xsl:if test="count(exports[@type='macro']) > 0">
<h3><a href="#macros">Macros</a></h3> <h3><a href="#macros">Macros</a></h3>
<pre> <pre class="api">
<xsl:apply-templates select="exports[@type='macro']" mode="toc"> <xsl:apply-templates select="exports[@type='macro']" mode="toc">
<xsl:sort select='@symbol'/> <xsl:sort select='@symbol'/>
</xsl:apply-templates> </xsl:apply-templates>
</pre> </pre>
</xsl:if> </xsl:if>
<h3><a href="#types">Types</a></h3> <h3><a href="#types">Types</a></h3>
<pre> <pre class="api">
<xsl:apply-templates select="exports[@type='typedef']" mode="toc"> <xsl:apply-templates select="exports[@type='typedef']" mode="toc">
<xsl:sort select='@symbol'/> <xsl:sort select='@symbol'/>
</xsl:apply-templates> </xsl:apply-templates>
</pre> </pre>
<h3><a href="#functions">Functions</a></h3> <h3><a href="#functions">Functions</a></h3>
<pre> <pre class="api">
<xsl:apply-templates select="exports[@type='function']" mode="toc"> <xsl:apply-templates select="exports[@type='function']" mode="toc">
<xsl:sort select='@symbol'/> <xsl:sort select='@symbol'/>
</xsl:apply-templates> </xsl:apply-templates>
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或