]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: newapi.xsl: Generate overall docs for enums too
authorMichal Privoznik <mprivozn@redhat.com>
Tue, 23 May 2023 16:46:58 +0000 (18:46 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Thu, 25 May 2023 12:22:34 +0000 (14:22 +0200)
There are/can be overall docs for enums (e.g.
virDomainModificationImpact) not just individual values. But
these never make it into the generated HTML which is a bit
unfortunate as they can contain valuable information for users.

Generate a block with overall enum documentation, just like we do
for functions.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
docs/newapi.xsl

index 9e35fe3a60b626cfae0903a777c8fe2cce97bd60..cafe49f61f3ee4ead74fc8f185eba6dfbf6012e2 100644 (file)
   <xsl:template match="typedef[@type = 'enum']">
     <xsl:variable name="name" select="string(@name)"/>
     <h3><a id="{$name}"><code><xsl:value-of select="$name"/></code></a></h3>
+    <div class="description">
+    <xsl:call-template name="formattext">
+      <xsl:with-param name="text" select="info"/>
+    </xsl:call-template>
+    </div>
     <div class="api">
       <pre>
         <span class="keyword">enum</span><xsl:text> </xsl:text>