[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH 2/7] docs: only generate function argument info for args with a description



On 01/22/2013 07:31 AM, Claudio Bley wrote:
> When function arguments or return values lack a description there's no
> use in generating a meaningless "ARG1: " stanza.

Again, can we instead tweak this to cause 'make' to fail if there is
missing documentation?

> 
> Signed-off-by: Claudio Bley <cbley av-test de>
> ---
>  docs/newapi.xsl |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/newapi.xsl b/docs/newapi.xsl
> index 0d32e55..fb95c44 100644
> --- a/docs/newapi.xsl
> +++ b/docs/newapi.xsl
> @@ -533,9 +533,9 @@
>      </xsl:call-template>
>      </div><xsl:text>
>  </xsl:text>
> -    <xsl:if test="arg | return/@info">
> +    <xsl:if test="arg[ info] | return/@info">
>        <dl class="variablelist">
> -        <xsl:for-each select="arg">
> +        <xsl:for-each select="arg[ info]">
>            <dt><xsl:value-of select="@name"/></dt>
>            <dd>
>              <xsl:call-template name="dumptext">
> 

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]