[libvirt] [PATCH 2/2] docs: Span cells if there's not doc text for enum val

Michal Privoznik mprivozn at redhat.com
Sat Jul 22 09:04:34 UTC 2017


When generating HTML documentation we put enum values into a
table so that we can display the value's name, numerical value
and description (if it has one). Now the last part is problem. If
the value doesn't have description the table row has just two
cells and if it has one the row counts three cells. This makes
HTML engines render the description into very little space - for
instance see:

  html/libvirt-libvirt-domain.html#virDomainMemoryStatTags

We can avoid this problem if we let the cell that corresponds to
numerical value span over two cells if there's no description.

Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
---
 docs/newapi.xsl | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/docs/newapi.xsl b/docs/newapi.xsl
index 815c1b9d7..9dd961507 100644
--- a/docs/newapi.xsl
+++ b/docs/newapi.xsl
@@ -307,16 +307,21 @@
           <tr>
             <td><a name="{@name}"><xsl:value-of select="@name"/></a></td>
             <td><xsl:text> = </xsl:text></td>
-            <td><xsl:value-of select="@value"/></td>
-            <xsl:if test="@info != ''">
-              <td>
-                <div class="comment">
-                  <xsl:call-template name="dumptext">
-                    <xsl:with-param name="text" select="@info"/>
-                  </xsl:call-template>
-                </div>
-              </td>
-            </xsl:if>
+            <xsl:choose>
+              <xsl:when test="@info != ''">
+                <td><xsl:value-of select="@value"/></td>
+                <td>
+                  <div class="comment">
+                    <xsl:call-template name="dumptext">
+                      <xsl:with-param name="text" select="@info"/>
+                    </xsl:call-template>
+                  </div>
+                </td>
+              </xsl:when>
+              <xsl:otherwise>
+                <td colspan="2"><xsl:value-of select="@value"/></td>
+              </xsl:otherwise>
+            </xsl:choose>
           </tr>
         </xsl:for-each>
       </table>
-- 
2.13.0




More information about the libvir-list mailing list