[Spice-commits] 3 commits - doc/reference src/channel-display.h src/spice-grabsequence.h src/spice-grabsequence-priv.h src/vmcstream.c src/win-usb-driver-install.c

Marc-André Lureau elmarco at kemper.freedesktop.org
Tue May 31 11:36:03 UTC 2016


 doc/reference/Makefile.am            |   12 +++++++++++-
 doc/reference/spice-gtk-sections.txt |   16 +++++++++++++++-
 src/channel-display.h                |   35 +++++++++++++++++++++++++++++++++++
 src/spice-grabsequence-priv.h        |    1 +
 src/spice-grabsequence.h             |    5 +++++
 src/vmcstream.c                      |    2 +-
 src/win-usb-driver-install.c         |    2 +-
 7 files changed, 69 insertions(+), 4 deletions(-)

New commits:
commit 320a58d8fcf85e9bf41bb7948d29ec348780f52d
Author: Marc-André Lureau <marcandre.lureau at gmail.com>
Date:   Tue May 31 13:01:34 2016 +0200

    doc: fix unused declarations
    
    Fix all the gtk-doc: "unused declarations. They should be added to
    spice-gtk-sections.txt in the appropriate place."
    
    Signed-off-by: Marc-André Lureau <marcandre.lureau at gmail.com>

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 5aa8557..29f31fc 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -23,21 +23,25 @@ CFILE_GLOB = $(top_srcdir)/src/*.c
 
 # Header files to ignore when scanning. Use base file name, no paths
 IGNORE_HFILES=					\
-	bio-gsocket.h				\
+	bio-gio.h				\
 	channel-display-priv.h			\
 	channel-usbredir-priv.h			\
+	client_sw_canvas.h			\
 	continuation.h				\
 	controller				\
 	coroutine.h				\
 	decode.h				\
+	desktop-integration.h			\
 	display					\
 	gio-coroutine.h				\
+	giopipe.h				\
 	smartcard-manager-priv.h		\
 	spice-audio-priv.h			\
 	spice-channel-cache.h			\
 	spice-channel-priv.h			\
 	spice-cmdline.h				\
 	spice-common.h				\
+	spice-grab-sequence-prive.h		\
 	spice-gstaudio.h			\
 	spice-gtk-session-priv.h		\
 	spice-marshal.h				\
@@ -49,8 +53,14 @@ IGNORE_HFILES=					\
 	spicy-connect.h				\
 	usb-acl-helper.h			\
 	usb-device-manager-priv.h		\
+	usbdk_api.h				\
 	usbutil.h				\
+	vmcstream.h				\
 	vncdisplaykeymap.h			\
+	win-usb-clerk.h				\
+	win-usb-dev.h				\
+	win-usb-driver-install.h		\
+	wocky-http-proxy.h			\
 	$(NULL)
 
 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 9a86553..df58297 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -56,6 +56,8 @@ SPICE_TYPE_SESSION_MIGRATION
 spice_session_migration_get_type
 <SUBSECTION Private>
 SpiceSessionPrivate
+SPICE_CLIENT_USB_DEVICE_LOST
+SPICE_CLIENT_USB_DEVICE_REJECTED
 </SECTION>
 
 <SECTION>
@@ -158,10 +160,15 @@ SpiceAudioPrivate
 <TITLE>SpiceDisplayChannel</TITLE>
 SpiceDisplayChannel
 SpiceDisplayChannelClass
+SpiceDisplayMonitorConfig
+SpiceDisplayPrimary
+SpiceGlScanout
 <SUBSECTION>
 spice_display_get_gl_scanout
+spice_display_gl_draw_done
 spice_display_get_primary
 spice_display_change_preferred_compression
+spice_gl_scanout_free
 <SUBSECTION Standard>
 SPICE_DISPLAY_CHANNEL
 SPICE_IS_DISPLAY_CHANNEL
@@ -170,6 +177,8 @@ spice_display_channel_get_type
 SPICE_DISPLAY_CHANNEL_CLASS
 SPICE_IS_DISPLAY_CHANNEL_CLASS
 SPICE_DISPLAY_CHANNEL_GET_CLASS
+SPICE_TYPE_GL_SCANOUT
+spice_gl_scanout_get_type
 <SUBSECTION Private>
 SpiceDisplayChannelPrivate
 </SECTION>
@@ -313,10 +322,12 @@ spice_usb_device_manager_get_devices
 spice_usb_device_manager_get_devices_with_filter
 spice_usb_device_manager_is_device_connected
 spice_usb_device_manager_is_redirecting
-spice_usb_device_manager_disconnect_device
 spice_usb_device_manager_can_redirect_device
 spice_usb_device_manager_connect_device_async
 spice_usb_device_manager_connect_device_finish
+spice_usb_device_manager_disconnect_device
+spice_usb_device_manager_disconnect_device_async
+spice_usb_device_manager_disconnect_device_finish
 <SUBSECTION>
 SpiceUsbDevice
 spice_usb_device_get_description
@@ -365,6 +376,7 @@ spice_display_get_grab_keys
 spice_display_send_keys
 spice_display_get_pixbuf
 <SUBSECTION>
+SpiceGrabSequence
 spice_grab_sequence_new
 spice_grab_sequence_new_from_string
 spice_grab_sequence_copy
@@ -416,6 +428,8 @@ spice_util_get_debug
 SPICE_RESERVED_PADDING
 SPICE_DEPRECATED_FOR
 spice_g_signal_connect_object
+SPICE_DEPRECATED
+SPICE_GNUC_DEPRECATED_FOR
 </SECTION>
 
 <SECTION>
commit 48ca4df9da28f26e537ed8caeab14a7803faac5e
Author: Marc-André Lureau <marcandre.lureau at gmail.com>
Date:   Tue May 31 13:02:20 2016 +0200

    doc: add some missing block comments
    
    Signed-off-by: Marc-André Lureau <marcandre.lureau at gmail.com>

diff --git a/src/channel-display.h b/src/channel-display.h
index bd4bc87..ad82a16 100644
--- a/src/channel-display.h
+++ b/src/channel-display.h
@@ -39,6 +39,17 @@ typedef struct _SpiceDisplayChannelPrivate SpiceDisplayChannelPrivate;
 
 #define SPICE_TYPE_GL_SCANOUT (spice_gl_scanout_get_type ())
 
+/**
+ * SpiceGlScanout:
+ * @fd: a drm DMABUF file that can be imported with eglCreateImageKHR
+ * @width: width of the scanout
+ * @height: height of the scanout
+ * @stride: stride of the scanout
+ * @format: the drm fourcc format
+ * @y0top: orientation of the scanout
+ *
+ * Holds the information necessary for using the GL display scanout.
+ **/
 typedef struct _SpiceGlScanout SpiceGlScanout;
 struct _SpiceGlScanout {
     gint fd;
@@ -49,6 +60,17 @@ struct _SpiceGlScanout {
     gboolean y0top;
 };
 
+/**
+ * SpiceDisplayMonitorConfig:
+ * @id: monitor id
+ * @surface_id: monitor surface id
+ * @x: x position of the monitor
+ * @y: y position of the monitor
+ * @width: width of the monitor
+ * @height: height of the monitor
+ *
+ * Holds a monitor configuration.
+ **/
 typedef struct _SpiceDisplayMonitorConfig SpiceDisplayMonitorConfig;
 struct _SpiceDisplayMonitorConfig {
     guint id;
@@ -59,6 +81,19 @@ struct _SpiceDisplayMonitorConfig {
     guint height;
 };
 
+/**
+ * SpiceDisplayPrimary:
+ * @format: primary buffer format
+ * @width: width of the primary
+ * @height: height of the primary
+ * @stride: stride of the primary
+ * @shmid: identifier of the shared memory segment associated with
+ * the @data, or -1 if not shm
+ * @data: pointer to primary buffer
+ * @marked: whether the display is marked ready
+ *
+ * Holds the information necessary to use the primary surface.
+ **/
 typedef struct _SpiceDisplayPrimary SpiceDisplayPrimary;
 struct _SpiceDisplayPrimary {
     enum SpiceSurfaceFmt format;
diff --git a/src/spice-grabsequence-priv.h b/src/spice-grabsequence-priv.h
index 5475730..97f05b2 100644
--- a/src/spice-grabsequence-priv.h
+++ b/src/spice-grabsequence-priv.h
@@ -21,6 +21,7 @@
 #include <glib.h>
 
 struct _SpiceGrabSequence {
+    /*< private >*/
     guint nkeysyms;
     guint *keysyms;
 };
diff --git a/src/spice-grabsequence.h b/src/spice-grabsequence.h
index 6e68e29..7f61ba1 100644
--- a/src/spice-grabsequence.h
+++ b/src/spice-grabsequence.h
@@ -33,6 +33,11 @@ G_BEGIN_DECLS
 
 #define SPICE_TYPE_GRAB_SEQUENCE            (spice_grab_sequence_get_type ())
 
+/**
+ * SpiceGrabSequence:
+ *
+ * An opaque type that represents a grab sequence.
+ **/
 typedef struct _SpiceGrabSequence SpiceGrabSequence;
 
 GType spice_grab_sequence_get_type(void);
commit 52db98dbcb4b426fc6e9a4a667bae7825c4210fd
Author: Marc-André Lureau <marcandre.lureau at gmail.com>
Date:   Tue May 31 12:10:44 2016 +0200

    Fix non gtk-doc comments
    
    Fixes the following warning:
    ../../src/vmcstream.c:124: warning: Symbol name not found at the start of the comment block.
    ../../src/win-usb-driver-install.c:347: warning: Symbol name not found at the start of the comment block.
    
    Signed-off-by: Marc-André Lureau <marcandre.lureau at gmail.com>

diff --git a/src/vmcstream.c b/src/vmcstream.c
index 4963de4..c536f71 100644
--- a/src/vmcstream.c
+++ b/src/vmcstream.c
@@ -116,7 +116,7 @@ complete_in_idle_cb(gpointer user_data)
 }
 
 /* coroutine */
-/**
+/*
  * Feed a SpiceVmc stream with new data from a coroutine
  *
  * The other end will be waiting on read_async() until data is fed
diff --git a/src/win-usb-driver-install.c b/src/win-usb-driver-install.c
index 0d4627a..99660ce 100644
--- a/src/win-usb-driver-install.c
+++ b/src/win-usb-driver-install.c
@@ -341,7 +341,7 @@ void spice_win_usb_driver_op(SpiceWinUsbDriver *self,
     g_clear_object(&task);
 }
 
-/**
+/*
  * Returns: currently returns 0 (failure) and 1 (success)
  * possibly later we'll add error-codes
  */


More information about the Spice-commits mailing list