[libvirt] [PATCH 1/7] docs: don't write out empty info attributes for function arguments

[Claudio Bley]

At Mon, 28 Jan 2013 17:36:08 -0700,
Eric Blake wrote:
> 
> [1  <text/plain; UTF-8 (quoted-printable)>]
> On 01/22/2013 07:31 AM, Claudio Bley wrote:
> > 
> > Signed-off-by: Claudio Bley <cbley at av-test.de>
> > ---
> >  docs/apibuild.py |    8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/docs/apibuild.py b/docs/apibuild.py
> > index 9a29c42..f9500b1 100755
> > --- a/docs/apibuild.py
> > +++ b/docs/apibuild.py
> > @@ -2183,8 +2183,8 @@ class docBuilder:
> >              output.write("      <info><![CDATA[%s]]></info>\n" % (desc))
> >              self.indexString(name, desc)
> >              if ret[0] != None:
> > -                if ret[0] == "void":
> > -                    output.write("      <return type='void'/>\n")
> > +                if ret[0] == "void" or ret[1] == None or ret[1] == '':
> > +                    output.write("      <return type='%s'/>\n" % ret[0])
> 
> Can we instead make it a fatal error if ret[1] == None or ret[1] == '',
> to force 'make' to fail and point out the missing documentation?

Sounds good to me. Follow-up patch is coming.

Claudio
-- 
AV-Test GmbH, Henricistraße 20, 04155 Leipzig, Germany
Phone: +49 341 265 310 19
Web:<http://www.av-test.org>

Eingetragen am / Registered at: Amtsgericht Stendal (HRB 114076)
Geschaeftsfuehrer (CEO): Andreas Marx, Guido Habicht, Maik Morgenstern