[libvirt] [PATCH v3 06/13] docs: only generate function argument info for args with a description

[Eric Blake]

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

Can you point to an example of an argument lacking a description?  This
is another case where I think we're better off fixing things to fail
noisily so that we can fix our docs to be more complete, than we are to
paper over it with this patch.

> 
> Signed-off-by: Claudio Bley <cbley at 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

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 621 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20130131/ca129c17/attachment-0001.sig>