[libvirt] [PATCH libvirt-glib 1/3] Add some missing docs

--- libvirt-gobject/libvirt-gobject-connection.c | 15 ++++++++++++++- libvirt-gobject/libvirt-gobject-domain.c | 2 +- libvirt-gobject/libvirt-gobject-stream.c | 10 ++++++++++ 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/libvirt-gobject/libvirt-gobject-connection.c b/libvirt-gobject/libvirt-gobject-connection.c index 3f17265..47a3f0c 100644 --- a/libvirt-gobject/libvirt-gobject-connection.c +++ b/libvirt-gobject/libvirt-gobject-connection.c @@ -487,6 +487,10 @@ static gboolean _gvir_connection_open(GVirConnection *conn, * gvir_connection_open: * @conn: a #GVirConnection * @cancellable: (allow-none)(transfer none): cancellation object + * + * Open a connection + * + * Returns: TRUE on success, FALSE on error */ gboolean gvir_connection_open(GVirConnection *conn, GCancellable *cancellable, @@ -495,6 +499,15 @@ gboolean gvir_connection_open(GVirConnection *conn, return _gvir_connection_open(conn, FALSE, cancellable, err); } +/** + * gvir_connection_open_read_only: + * @conn: a #GVirConnection + * @cancellable: (allow-none)(transfer none): cancellation object + * + * Open a connection read only + * + * Returns: TRUE on success, FALSE on error + */ gboolean gvir_connection_open_read_only(GVirConnection *conn, GCancellable *cancellable, GError **err) @@ -1340,7 +1353,7 @@ G_DEFINE_BOXED_TYPE(GVirConnectionHandle, gvir_connection_handle, * @conn: a #GVirConnection * @flags: flags to use for the stream * - * Return value: (transfer full): a #GVirStream stream, or NULL.The returned + * Return value: (transfer full): a #GVirStream stream, or NULL. The returned * object should be unreffed with g_object_unref() when no longer needed. */ GVirStream *gvir_connection_get_stream(GVirConnection *self, diff --git a/libvirt-gobject/libvirt-gobject-domain.c b/libvirt-gobject/libvirt-gobject-domain.c index 7be936d..3bfc65f 100644 --- a/libvirt-gobject/libvirt-gobject-domain.c +++ b/libvirt-gobject/libvirt-gobject-domain.c @@ -1088,8 +1088,8 @@ end: /** * gvir_domain_open_console: * @dom: (transfer none): the domain - * @devname: (transfer none)(allow-none): the device name * @stream: (transfer none): stream to use as output + * @devname: (transfer none)(allow-none): the device name * @flags: extra flags, currently unused * * Open a text console for the domain @dom, connecting it to the diff --git a/libvirt-gobject/libvirt-gobject-stream.c b/libvirt-gobject/libvirt-gobject-stream.c index a518a19..b6bf774 100644 --- a/libvirt-gobject/libvirt-gobject-stream.c +++ b/libvirt-gobject/libvirt-gobject-stream.c @@ -67,6 +67,16 @@ enum { }; +/** + * SECTION:gvir-stream + * @short_description: Streaming operations for domain input and output + * + * #GVirStream implements #GInputStream and #GOutputStream for reading from and + * writing to a domain e.g. via a text based console on a emulated serial port. + * + * It is usually created via #gvir_connection_get_stream. + */ + #define GVIR_STREAM_ERROR gvir_stream_error_quark() static void gvir_stream_update_events(GVirStream *stream); -- 2.14.1