External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-03 19:45:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: abort when missing return or argument documentation

Browse Source 
When a function has no associated information to one of its
arguments or its return type we report it and stop with an error.
This commit is contained in:
Claudio Bley 2013-01-29 15:35:28 +01:00
parent d706bdf918
commit 7d3cef8a5c
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/apibuild.py
View File

@ -1962,12 +1962,17 @@ class docBuilder:
self.xref = {} self.xref = {}
self.index = {} self.index = {}
self.basename = name self.basename = name
self.errors = 0
def warning(self, msg): def warning(self, msg):
global warnings global warnings
warnings = warnings + 1 warnings = warnings + 1
print msg print msg
def error(self, msg):
self.errors += 1
print >>sys.stderr, "Error:", msg
def indexString(self, id, str): def indexString(self, id, str):
if str == None: if str == None:
return return
@ -2185,6 +2190,8 @@ class docBuilder:
if ret[0] != None: if ret[0] != None:
if ret[0] == "void": if ret[0] == "void":
output.write(" <return type='void'/>\n") output.write(" <return type='void'/>\n")
elif (ret[1] == None or ret[1] == '') and not ignored_functions.has_key(name):
self.error("Missing documentation for return of function `%s'" % name)
else: else:
output.write(" <return type='%s' info='%s'/>\n" % ( output.write(" <return type='%s' info='%s'/>\n" % (
ret[0], escape(ret[1]))) ret[0], escape(ret[1])))
@ -2192,8 +2199,11 @@ class docBuilder:
for param in params: for param in params:
if param[0] == 'void': if param[0] == 'void':
continue continue
if param[2] == None: if (param[2] == None or param[2] == ''):
output.write(" <arg name='%s' type='%s' info=''/>\n" % (param[1], param[0])) if ignored_functions.has_key(name):
output.write(" <arg name='%s' type='%s' info=''/>\n" % (param[1], param[0]))
else:
self.error("Missing documentation for arg `%s' of function `%s'" % (param[1], name))
else: else:
output.write(" <arg name='%s' type='%s' info='%s'/>\n" % (param[1], param[0], escape(param[2]))) output.write(" <arg name='%s' type='%s' info='%s'/>\n" % (param[1], param[0], escape(param[2])))
self.indexString(name, param[2]) self.indexString(name, param[2])
@ -2463,6 +2473,10 @@ class docBuilder:
output.write("</api>\n") output.write("</api>\n")
output.close() output.close()
if self.errors > 0:
print >>sys.stderr, "apibuild.py: %d error(s) encountered during generation" % self.errors
sys.exit(3)
filename = "%s/%s-refs.xml" % (self.path, self.name) filename = "%s/%s-refs.xml" % (self.path, self.name)
if not quiet: if not quiet:
print "Saving XML Cross References %s" % (filename) print "Saving XML Cross References %s" % (filename)