[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [libvirt-glib 1/9] doc: add some missing return value documentation



From: Marc-André Lureau <marcandre lureau gmail com>

---
 libvirt-gobject/libvirt-gobject-stream.c |    1 +
 libvirt-gobject/libvirt-gobject-stream.h |    2 ++
 2 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/libvirt-gobject/libvirt-gobject-stream.c b/libvirt-gobject/libvirt-gobject-stream.c
index 255ad73..519d733 100644
--- a/libvirt-gobject/libvirt-gobject-stream.c
+++ b/libvirt-gobject/libvirt-gobject-stream.c
@@ -191,6 +191,7 @@ stream_sink(virStreamPtr st G_GNUC_UNUSED,
  * @stream: the stream
  * @func: (scope notified): the callback for writing data to application
  * @user_data: (closure): data to be passed to @callback
+ * Returns: the number of bytes consumed or -1 upon error
  *
  * Receive the entire data stream, sending the data to the
  * requested data sink. This is simply a convenient alternative
diff --git a/libvirt-gobject/libvirt-gobject-stream.h b/libvirt-gobject/libvirt-gobject-stream.h
index 27fa8b7..fd9c9bb 100644
--- a/libvirt-gobject/libvirt-gobject-stream.h
+++ b/libvirt-gobject/libvirt-gobject-stream.h
@@ -65,6 +65,8 @@ struct _GVirStreamClass
  * @buf: data pointer
  * @nbytes: data size
  * @user_data: user data passed to the function
+ * Returns: the number of bytes filled, 0 upon end
+ * of file, or -1 upon error
  */
 typedef gint (* GVirStreamSinkFunc) (GVirStream *stream,
                                      const gchar *buf,
-- 
1.7.6.2


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]