openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

apibuild: Disallow 'returns' return description 

Our documentation generator is a bit messy, to say the least. For
instance, the description to return values of a function is
searched within C comment. Currently, all lines that start with
'returns' or 'Returns' are viewed as return value description.
However, there are some valid uses where the 'returns' word is in
the middle of a sentence describing function behavior not the
return value. And there are no places where 'returns' is used to
describe return values.  For instance:
virDomainDetachDeviceFlags, virConnectNetworkEventRegisterAny and
virDomainGetDiskErrors. This leads to HTML documemtation being
generated incorrectly.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Michal Privoznik 2014-05-12 14:23:18 +02:00
parent 2bb520c802
commit 0f1a0fff0e
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/apibuild.py
View File

@ -926,7 +926,7 @@ class CParser:
if i < len(l) and l[i] == ' ': if i < len(l) and l[i] == ' ':
i = i + 1 i = i + 1
l = l[i:] l = l[i:]
if len(l) >= 6 and l[0:7] == "returns" or l[0:7] == "Returns": if len(l) >= 6 and l[0:7] == "Returns":
try: try:
l = string.split(l, ' ', 1)[1] l = string.split(l, ' ', 1)[1]
except: except: