[Spice-commits] 5 commits - doc/reference src/channel-display.c src/spice-gtk-session.h src/spice-widget.h src/usb-device-manager.c src/usb-device-widget.h

Pavel Grunt pgrunt at kemper.freedesktop.org
Mon May 15 13:04:50 UTC 2017


 doc/reference/spice-gtk-sections.txt |    6 ++++++
 src/channel-display.c                |   11 +++++++++--
 src/spice-gtk-session.h              |   11 +++++++++++
 src/spice-widget.h                   |   11 +++++++++++
 src/usb-device-manager.c             |   14 ++++++++++++++
 src/usb-device-widget.h              |   10 ++++++++++
 6 files changed, 61 insertions(+), 2 deletions(-)

New commits:
commit f6bf9d352441ff2203afb1885ac8d5815d6b45bb
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Wed May 10 11:33:09 2017 +0200

    doc: Display properties of spice-gtk classes
    
    It is done by putting their symbols in appropriate sections

diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 6f49df3..99baddf 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -350,6 +350,8 @@ SpiceUsbDeviceManagerPrivate
 <SECTION>
 <FILE>spice-gtk-session</FILE>
 <TITLE>SpiceGtkSession</TITLE>
+SpiceGtkSession
+SpiceGtkSessionClass
 spice_gtk_session_get
 spice_gtk_session_copy_to_guest
 spice_gtk_session_paste_from_guest
@@ -368,6 +370,8 @@ SpiceGtkSessionPrivate
 <SECTION>
 <FILE>spice-widget</FILE>
 <TITLE>SpiceDisplay</TITLE>
+SpiceDisplay
+SpiceDisplayClass
 SpiceDisplayKeyEvent
 spice_display_new
 spice_display_new_with_monitor
@@ -402,6 +406,8 @@ SpiceDisplayPrivate
 <SECTION>
 <FILE>usb-device-widget</FILE>
 <TITLE>SpiceUsbDeviceWidget</TITLE>
+SpiceUsbDeviceWidget
+SpiceUsbDeviceWidgetClass
 <SUBSECTION>
 spice_usb_device_widget_new
 <SUBSECTION Standard>
diff --git a/src/spice-gtk-session.h b/src/spice-gtk-session.h
index b04f4fc..28b45f6 100644
--- a/src/spice-gtk-session.h
+++ b/src/spice-gtk-session.h
@@ -33,7 +33,18 @@ G_BEGIN_DECLS
 #define SPICE_IS_GTK_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_GTK_SESSION))
 #define SPICE_GTK_SESSION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_GTK_SESSION, SpiceGtkSessionClass))
 
+/**
+ * SpiceGtkSession:
+ *
+ * The #SpiceGtkSession struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceGtkSession SpiceGtkSession;
+
+/**
+ * SpiceGtkSessionClass:
+ *
+ * Class structure for #SpiceGtkSession. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceGtkSessionClass SpiceGtkSessionClass;
 
 GType spice_gtk_session_get_type(void);
diff --git a/src/spice-widget.h b/src/spice-widget.h
index a8adf9c..d93737e 100644
--- a/src/spice-widget.h
+++ b/src/spice-widget.h
@@ -40,7 +40,18 @@ G_BEGIN_DECLS
 #define SPICE_DISPLAY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), SPICE_TYPE_DISPLAY, SpiceDisplayClass))
 
 
+/**
+ * SpiceDisplay:
+ *
+ * The #SpiceDisplay struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceDisplay SpiceDisplay;
+
+/**
+ * SpiceDisplayClass:
+ *
+ * Class structure for #SpiceDisplay. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceDisplayClass SpiceDisplayClass;
 
 /**
diff --git a/src/usb-device-widget.h b/src/usb-device-widget.h
index a4ba638..f566283 100644
--- a/src/usb-device-widget.h
+++ b/src/usb-device-widget.h
@@ -37,7 +37,17 @@ G_BEGIN_DECLS
 #define SPICE_IS_USB_DEVICE_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_USB_DEVICE_WIDGET))
 #define SPICE_USB_DEVICE_WIDGET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_USB_DEVICE_WIDGET, SpiceUsbDeviceWidgetClass))
 
+/**
+ * SpiceUsbDeviceWidget:
+ *
+ * The #SpiceUsbDeviceWidget struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceUsbDeviceWidget SpiceUsbDeviceWidget;
+/**
+ * SpiceUsbDeviceWidgetClass:
+ *
+ * Class structure for #SpiceUsbDeviceWidget. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceUsbDeviceWidgetClass SpiceUsbDeviceWidgetClass;
 typedef struct _SpiceUsbDeviceWidgetPrivate SpiceUsbDeviceWidgetPrivate;
 
commit f076dd11ce4c83b09350e372307c23c486905d34
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Wed May 10 12:49:09 2017 +0200

    doc: Describe spice_usb_device_manager_disconnect_device_async

diff --git a/src/usb-device-manager.c b/src/usb-device-manager.c
index 66f0eb5..bbe2391 100644
--- a/src/usb-device-manager.c
+++ b/src/usb-device-manager.c
@@ -1609,6 +1609,20 @@ void _disconnect_device_async_cb(GObject *gobject,
 }
 #endif
 
+/**
+ * spice_usb_device_manager_disconnect_device_async:
+ * @self: the #SpiceUsbDeviceManager manager.
+ * @device: a connected #SpiceUsbDevice to disconnect.
+ * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
+ * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied.
+ * @user_data: (closure): the data to pass to @callback.
+ *
+ * Asynchronously disconnects the @device. When completed, @callback will be called.
+ * Then it is possible to call spice_usb_device_manager_disconnect_device_finish()
+ * to get the result of the operation.
+ *
+ * Since: 0.32
+ */
 void spice_usb_device_manager_disconnect_device_async(SpiceUsbDeviceManager *self,
                                                       SpiceUsbDevice *device,
                                                       GCancellable *cancellable,
commit c7cc23c6c3a9ca5e4b5430804ed618d02a32c88b
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Wed May 10 11:33:07 2017 +0200

    doc: Describe spice_gl_scanout_free

diff --git a/src/channel-display.c b/src/channel-display.c
index 0595579..06c503c 100644
--- a/src/channel-display.c
+++ b/src/channel-display.c
@@ -130,6 +130,14 @@ spice_gl_scanout_copy(const SpiceGlScanout *scanout)
     return so;
 }
 
+/**
+ * spice_gl_scanout_free:
+ * @scanout: a #SpiceGlScanout
+ *
+ * Frees the @scanout.
+ *
+ * Since: 0.31
+ */
 void
 spice_gl_scanout_free(SpiceGlScanout *scanout)
 {
commit d956a40d382668ed68edf2d100f86ae6a97ec6e0
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Wed May 10 11:33:06 2017 +0200

    doc: Remove invalid parameter of property
    
    Probably copy'n'pasted from the signal description

diff --git a/src/channel-display.c b/src/channel-display.c
index 659054e..0595579 100644
--- a/src/channel-display.c
+++ b/src/channel-display.c
@@ -319,7 +319,6 @@ static void spice_display_channel_class_init(SpiceDisplayChannelClass *klass)
 
     /**
      * SpiceDisplayChannel:gl-scanout:
-     * @display: the #SpiceDisplayChannel that emitted the signal
      *
      * The last #SpiceGlScanout received.
      *
commit b49247008ce89c1a4127a85fe0470a80cc354bc3
Author: Pavel Grunt <pgrunt at redhat.com>
Date:   Wed May 10 11:33:05 2017 +0200

    doc: Set correct label
    
    Otherwise it does not appear in the generated documentation

diff --git a/src/channel-display.c b/src/channel-display.c
index ccaa747..659054e 100644
--- a/src/channel-display.c
+++ b/src/channel-display.c
@@ -545,7 +545,7 @@ static void spice_display_send_client_preferred_video_codecs(SpiceChannel *chann
 }
 
 /**
- * spice_display_change_preferred_video_codec:
+ * spice_display_change_preferred_video_codec_type:
  * @channel: a #SpiceDisplayChannel
  * @codec_type: a #SpiceVideoCodecType
  *


More information about the Spice-commits mailing list