[libvirt] [PATCH] docs: remove "returns" word from beginning of lines

Move "returns" keyword from beginning of API doc lines when it does not describe return values. Maybe the API doc extractor could be changed to look for "returns: " to avoid such confusion. --- src/libvirt.c | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/libvirt.c b/src/libvirt.c index 85dfc58..344e921 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -10097,8 +10097,8 @@ error: * * The virDomainPtr object handle passed into the callback upon delivery * of an event is only valid for the duration of execution of the callback. - * If the callback wishes to keep the domain object after the callback - * returns, it shall take a reference to it, by calling virDomainRef. + * If the callback wishes to keep the domain object after the callback returns, + * it shall take a reference to it, by calling virDomainRef. * The reference can be released once the object is no longer required * by calling virDomainFree. * @@ -12727,8 +12727,8 @@ error: * * The virDomainPtr object handle passed into the callback upon delivery * of an event is only valid for the duration of execution of the callback. - * If the callback wishes to keep the domain object after the callback - * returns, it shall take a reference to it, by calling virDomainRef. + * If the callback wishes to keep the domain object after the callback returns, + * it shall take a reference to it, by calling virDomainRef. * The reference can be released once the object is no longer required * by calling virDomainFree. * -- 1.7.0.4

On 04/07/2011 02:47 AM, Jean-Baptiste Rouault wrote:
Move "returns" keyword from beginning of API doc lines when it does not describe return values.
ACK, and pushed.
Maybe the API doc extractor could be changed to look for "returns: " to avoid such confusion.
Probably, but I'm no python wizard, so I'm not writing that patch. Anyone else want to help?
- * If the callback wishes to keep the domain object after the callback - * returns, it shall take a reference to it, by calling virDomainRef. + * If the callback wishes to keep the domain object after the callback returns, + * it shall take a reference to it, by calling virDomainRef.
-- Eric Blake eblake@redhat.com +1-801-349-2682 Libvirt virtualization library http://libvirt.org

On Fri, Apr 08, 2011 at 04:31:38PM -0600, Eric Blake wrote:
On 04/07/2011 02:47 AM, Jean-Baptiste Rouault wrote:
Move "returns" keyword from beginning of API doc lines when it does not describe return values.
ACK, and pushed.
Maybe the API doc extractor could be changed to look for "returns: " to avoid such confusion.
Probably, but I'm no python wizard, so I'm not writing that patch. Anyone else want to help?
I looked at it upon receiving the patch, it's trivial from a python puoint of view, the problem is that we then need to change all function descriptions to use "Returns:" instead of "Returns" and I'm not sure it's really teh right thing to do, Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
participants (3)
-
Daniel Veillard
-
Eric Blake
-
Jean-Baptiste Rouault