]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: remove "returns" word from beginning of lines
authorJean-Baptiste Rouault <jean-baptiste.rouault@diateam.net>
Thu, 7 Apr 2011 08:47:44 +0000 (10:47 +0200)
committerEric Blake <eblake@redhat.com>
Fri, 8 Apr 2011 22:27:06 +0000 (16:27 -0600)
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

index dde4bd443d0bcb8f61c9b7836ba87cea0193cf04..abde7db80bdbca66a349582ce18c02d562b4241f 100644 (file)
@@ -10101,8 +10101,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.
  *
@@ -12731,8 +12731,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.
  *