boost_mirror/boostbook
1
0
Fork 0
mirror of https://github.com/boostorg/boostbook.git synced 2025-05-09 02:43:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundant spaces from return types and default values/types.

Browse Source 
Doxygen generates extra spaces in some function return types (e.g. involving
a const reference) and template parameter defaults (in partucular, when
the default is formatted across multiple lines in the C++ source).
Normalize spaces in those cases.
This commit is contained in:
Andrey Semashev 2024-07-06 19:18:27 +03:00
parent 73c527537e
commit 4e5a5ab0d3
1 changed files with 36 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
xsl/doxygen/doxygen2boostbook.xsl
View File

@ -653,6 +653,31 @@
</xsl:apply-templates>
</xsl:template>
<!-- Normalizes spaces in text, but preserves one leading and trailing spaces
to keep the text distinct from the surrounding content. -->
<xsl:template name="normalize-text">
<xsl:param name="text"/>
<xsl:if test="starts-with(string($text), ' ')">
<xsl:text> </xsl:text>
</xsl:if>
<xsl:value-of select="normalize-space($text)"/>
<xsl:if test="substring(string($text), string-length(string($text))) = ' '">
<xsl:text> </xsl:text>
</xsl:if>
</xsl:template>
<xsl:template match="text()" mode="default-value">
<!-- Doxygen generates extra spaces in default values for template parameters -->
<xsl:call-template name="normalize-text">
<xsl:with-param name="text" select="."/>
</xsl:call-template>
</xsl:template>
<xsl:template match="*" mode="default-value">
<xsl:apply-templates mode="passthrough"/>
</xsl:template>
<!-- Classes -->
<xsl:template match="templateparamlist" mode="template">
<template>
@ -675,8 +700,7 @@
<emphasis>unspecified</emphasis>
</xsl:when>
<xsl:otherwise>
<xsl:apply-templates select="defval/*|defval/text()"
mode="passthrough"/>
<xsl:apply-templates select="defval/*|defval/text()" mode="default-value"/>
</xsl:otherwise>
</xsl:choose>
</default>
@ -708,8 +732,7 @@
<emphasis>unspecified</emphasis>
</xsl:when>
<xsl:otherwise>
<xsl:apply-templates select="defval/*|defval/text()"
mode="passthrough"/>
<xsl:apply-templates select="defval/*|defval/text()" mode="default-value"/>
</xsl:otherwise>
</xsl:choose>
</default>
@ -741,8 +764,7 @@
<emphasis>unspecified</emphasis>
</xsl:when>
<xsl:otherwise>
<xsl:apply-templates select="defval/*|defval/text()"
mode="passthrough"/>
<xsl:apply-templates select="defval/*|defval/text()" mode="default-value"/>
</xsl:otherwise>
</xsl:choose>
</default>
@ -1160,8 +1182,7 @@
<emphasis>unspecified</emphasis>
</xsl:when>
<xsl:otherwise>
<xsl:apply-templates select="defval/*|defval/text()"
mode="passthrough"/>
<xsl:apply-templates select="defval/*|defval/text()" mode="default-value"/>
</xsl:otherwise>
</xsl:choose>
</default>
@ -1854,6 +1875,13 @@
</xsl:choose>
</xsl:template>
<xsl:template match="text()" mode="type">
<!-- Doxygen sometimes puts redundant spaces in complex type descriptions -->
<xsl:call-template name="normalize-text">
<xsl:with-param name="text" select="string(.)"/>
</xsl:call-template>
</xsl:template>
<xsl:template match="*" mode="type">
<xsl:value-of select="."/>
</xsl:template>