diff options
-rw-r--r-- | test/expected/spec.html.canon | 20 | ||||
-rw-r--r-- | tools/doc-generator.xsl | 26 |
2 files changed, 23 insertions, 23 deletions
diff --git a/test/expected/spec.html.canon b/test/expected/spec.html.canon index 50d2bad..e8c4dcf 100644 --- a/test/expected/spec.html.canon +++ b/test/expected/spec.html.canon @@ -120,31 +120,31 @@ Lesser General Public License for more details.</p><h2>Interfaces</h2><ul><li><c ) → a(uv)</h3><div class="docstring"> Does stuff. - </div><div><h4>Parameters</h4><dl><dt><code>badger</code> - - <code>b</code></dt><dd>A badger, which MAY be breezy.</dd><dt><code>mushroom</code> - - <code>a{sv}</code></dt><dd>Use of hallucinogenic mushrooms will lead to undefined behaviour.</dd><dt><code>snake</code> - + </div><div><h4>Parameters</h4><dl><dt><code>badger</code> − + <code>b</code></dt><dd>A badger, which MAY be breezy.</dd><dt><code>mushroom</code> − + <code>a{sv}</code></dt><dd>Use of hallucinogenic mushrooms will lead to undefined behaviour.</dd><dt><code>snake</code> − <code>s</code></dt><dd>A snake, it's a snake.</dd></dl></div><div><h4>Returns</h4><dl><dt><code>a(uv)</code></dt><dd>Array of structs containing whatever seems appropriate.</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.Telepathy.SpecAutoGenTest.MiscError</code></dt><dd> Raised whenever appropriate. <em>(generic description)</em></dd><dt><code>org.freedesktop.Telepathy.SpecAutoGenTest.OtherError</code></dt><dd>Raised if the badger or the snake eats the mushrooms</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a id="org.freedesktop.Telepathy.SpecAutoGenTest.StuffHappened" name="org.freedesktop.Telepathy.SpecAutoGenTest.StuffHappened" shape="rect">StuffHappened</a> ( ay: stoat, s: ferret, b: weasel )</h3><div class="docstring"> Emitted when stuff happened. - </div><div><h4>Parameters</h4><dl><dt><code>stoat</code> - + </div><div><h4>Parameters</h4><dl><dt><code>stoat</code> − <code>ay</code></dt><dd> <em>Mustela erminea</em> - </dd><dt><code>ferret</code> - + </dd><dt><code>ferret</code> − <code>s</code></dt><dd> <em>Mustela putorius furo</em> - </dd><dt><code>weasel</code> - + </dd><dt><code>weasel</code> − <code>b</code></dt><dd> <em>Mustela nivalis</em> (or compatible) </dd></dl></div></div><h2>Telepathy Properties:</h2><p>Accessed using the <a href="#org.freedesktop.Telepathy.Properties" shape="rect">Telepathy - Properties</a> interface.</p><dl><dt><code>wobbly</code> - + Properties</a> interface.</p><dl><dt><code>wobbly</code> − <code>b</code></dt><dd> Whether or not this badger is wobbly. </dd></dl><h2>D-Bus core Properties:</h2><p>Accessed using the - org.freedesktop.DBus.Properties interface.</p><dl><dt><a id="org.freedesktop.Telepathy.SpecAutoGenTest.Introspective" name="org.freedesktop.Telepathy.SpecAutoGenTest.Introspective" shape="rect"><code>Introspective</code></a> - <code>b</code>, read-only</dt><dd> + org.freedesktop.DBus.Properties interface.</p><dl><dt><a id="org.freedesktop.Telepathy.SpecAutoGenTest.Introspective" name="org.freedesktop.Telepathy.SpecAutoGenTest.Introspective" shape="rect"><code>Introspective</code></a> − <code>b</code>, read-only</dt><dd> True if the badger is introspective. <div class="rationale"> @@ -171,5 +171,5 @@ Lesser General Public License for more details.</p><h2>Interfaces</h2><ul><li><c <h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.Telepathy.SpecAutoGenTest" shape="rect">org.freedesktop.Telepathy.SpecAutoGenTest</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-Adjective" shape="rect">Adjective</a></code> - - </li><li><code><a href="#type-Test_Flags" shape="rect">Test_Flags</a></code> - - </li></ul></body></html>
\ No newline at end of file + − </li><li><code><a href="#type-Test_Flags" shape="rect">Test_Flags</a></code> + − </li></ul></body></html>
\ No newline at end of file diff --git a/tools/doc-generator.xsl b/tools/doc-generator.xsl index 11c2077..0137174 100644 --- a/tools/doc-generator.xsl +++ b/tools/doc-generator.xsl @@ -23,7 +23,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" xmlns:html="http://www.w3.org/1999/xhtml" exclude-result-prefixes="tp html"> - <!--Don't move the declaration of the HTML namespace up here - XMLNSs + <!--Don't move the declaration of the HTML namespace up here — XMLNSs don't work ideally in the presence of two things that want to use the absence of a prefix, sadly. --> @@ -333,7 +333,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <a name="{concat(../@name, '.', @name)}"> <code><xsl:value-of select="@name"/></code> </a> - <xsl:text> - </xsl:text> + <xsl:text> − </xsl:text> <code><xsl:value-of select="@type"/></code> <xsl:call-template name="parenthesized-tp-type"/> <xsl:text>, </xsl:text> @@ -364,7 +364,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <xsl:template match="tp:property"> <dt xmlns="http://www.w3.org/1999/xhtml"> <xsl:if test="@name"> - <code><xsl:value-of select="@name"/></code> - + <code><xsl:value-of select="@name"/></code> − </xsl:if> <code><xsl:value-of select="@type"/></code> </dt> @@ -381,7 +381,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <h3> <a name="type-{@name}"> <xsl:value-of select="@name"/> - </a> - a{ + </a> − a{ <xsl:for-each select="tp:member"> <xsl:value-of select="@type"/> <xsl:text>: </xsl:text> @@ -411,7 +411,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <xsl:template match="tp:simple-type | tp:enum | tp:flags | tp:external-type" mode="in-index"> - - <xsl:value-of select="@type"/> + − <xsl:value-of select="@type"/> </xsl:template> <xsl:template match="tp:simple-type"> @@ -419,7 +419,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <h3> <a name="type-{@name}"> <xsl:value-of select="@name"/> - </a> - <xsl:value-of select="@type"/> + </a> − <xsl:value-of select="@type"/> </h3> <div class="docstring"> <xsl:apply-templates select="tp:docstring"/> @@ -435,21 +435,21 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <dt> <a name="type-{@name}"> <xsl:value-of select="@name"/> - </a> - <xsl:value-of select="@type"/> + </a> − <xsl:value-of select="@type"/> </dt> <dd>Defined by: <xsl:value-of select="@from"/></dd> </div> </xsl:template> <xsl:template match="tp:struct" mode="in-index"> - - ( <xsl:for-each select="tp:member"> + − ( <xsl:for-each select="tp:member"> <xsl:value-of select="@type"/> <xsl:if test="position() != last()">, </xsl:if> </xsl:for-each> ) </xsl:template> <xsl:template match="tp:mapping" mode="in-index"> - - a{ <xsl:for-each select="tp:member"> + − a{ <xsl:for-each select="tp:member"> <xsl:value-of select="@type"/> <xsl:if test="position() != last()"> → </xsl:if> </xsl:for-each> } @@ -460,7 +460,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <h3> <a name="type-{@name}"> <xsl:value-of select="@name"/> - </a> - ( + </a> − ( <xsl:for-each select="tp:member"> <xsl:value-of select="@type"/> <xsl:text>: </xsl:text> @@ -600,7 +600,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <xsl:template match="tp:member" mode="members-in-docstring"> <dt xmlns="http://www.w3.org/1999/xhtml"> - <code><xsl:value-of select="@name"/></code> - + <code><xsl:value-of select="@name"/></code> − <code><xsl:value-of select="@type"/></code> <xsl:call-template name="parenthesized-tp-type"/> </dt> @@ -618,7 +618,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <xsl:template match="arg" mode="parameters-in-docstring"> <dt xmlns="http://www.w3.org/1999/xhtml"> - <code><xsl:value-of select="@name"/></code> - + <code><xsl:value-of select="@name"/></code> − <code><xsl:value-of select="@type"/></code> <xsl:call-template name="parenthesized-tp-type"/> </dt> @@ -630,7 +630,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA <xsl:template match="arg" mode="returns-in-docstring"> <dt xmlns="http://www.w3.org/1999/xhtml"> <xsl:if test="@name"> - <code><xsl:value-of select="@name"/></code> - + <code><xsl:value-of select="@name"/></code> − </xsl:if> <code><xsl:value-of select="@type"/></code> <xsl:call-template name="parenthesized-tp-type"/> |