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

Martin Kletzander mkletzan at redhat.com
Tue May 13 09:53:09 UTC 2014


On Mon, May 12, 2014 at 02:29:44PM +0200, Michal Privoznik wrote:
>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 at redhat.com>
>---
> 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":

You could've just used l.startswith("Returns"), but more of this would
be needed in greater part of the code, right? :)

Martin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20140513/84392584/attachment-0001.sig>


More information about the libvir-list mailing list