Re: [libvirt] [PATCH] apibuild: Disallow 'returns' return decription

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 nor the return value. For instance: virDomainDetachDeviceFlags, virConnectNetworkEventRegisterAny and virDomainGetDiskErrors. This leads to HTML documentation to be not correctly generated. Signed-off-by: Michal Privoznik <mprivozn(a)redhat.com&gt; --- docs/apibuild.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/apibuild.py b/docs/apibuild.py index 71494d5..5250c5a 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -926,7 +926,7 @@ class CParser: if i < len(l) and l[i] == ' ': i = i + 1 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":