[Spice-commits] 9 commits - doc/reference src/channel-display.c src/channel-inputs.c src/channel-inputs.h src/channel-main.c src/channel-playback.c src/channel-port.c src/channel-record.c src/smartcard-manager.c src/smartcard-manager.h src/spice-channel.c src/spice-channel.h src/spice-client.c src/spice-client.h src/spice-grabsequence.c src/spice-grabsequence.h src/spice-gtk-session.c src/spice-gtk-session.h src/spice-option.c src/spice-session.c src/spice-session.h src/spice-uri.h src/spice-util.c src/spice-version.h.in src/spice-widget.c src/spice-widget.h src/usb-device-manager.c src/usb-device-manager.h src/usb-device-widget.c src/usb-device-widget.h
Pavel Grunt
pgrunt at kemper.freedesktop.org
Fri Sep 25 05:04:21 PDT 2015
doc/reference/spice-gtk-docs.xml | 1
doc/reference/spice-gtk-sections.txt | 24 ++++++++++++---
src/channel-display.c | 6 +--
src/channel-inputs.c | 20 ++++++-------
src/channel-inputs.h | 8 +++++
src/channel-main.c | 36 +++++++++++++----------
src/channel-playback.c | 7 ++++
src/channel-port.c | 4 +-
src/channel-record.c | 6 +--
src/smartcard-manager.c | 3 -
src/smartcard-manager.h | 21 +++++++++++++
src/spice-channel.c | 28 +++++++++---------
src/spice-channel.h | 14 +++++++++
src/spice-client.c | 7 ++++
src/spice-client.h | 5 +++
src/spice-grabsequence.c | 12 +++++--
src/spice-grabsequence.h | 5 +++
src/spice-gtk-session.c | 4 +-
src/spice-gtk-session.h | 11 +++++++
src/spice-option.c | 2 +
src/spice-session.c | 16 +++++++---
src/spice-session.h | 13 ++++++++
src/spice-uri.h | 12 +++++++
src/spice-util.c | 2 +
src/spice-version.h.in | 2 +
src/spice-widget.c | 18 +++++++----
src/spice-widget.h | 21 +++++++++++++
src/usb-device-manager.c | 53 ++++++++++++++++++++++++++++-------
src/usb-device-manager.h | 8 ++++-
src/usb-device-widget.c | 2 +
src/usb-device-widget.h | 1
31 files changed, 290 insertions(+), 82 deletions(-)
New commits:
commit 33fdcb7ea805943523771b54810de1eb8fc69be7
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Tue Sep 22 14:21:52 2015 +0200
docs: Fix typos
diff --git a/src/channel-inputs.c b/src/channel-inputs.c
index 1a6457d..93cfd2e 100644
--- a/src/channel-inputs.c
+++ b/src/channel-inputs.c
@@ -125,10 +125,10 @@ static void spice_inputs_channel_class_init(SpiceInputsChannelClass *klass)
G_PARAM_STATIC_BLURB));
/**
- * SpiceInputsChannel::inputs-modifier:
+ * SpiceInputsChannel::inputs-modifiers:
* @display: the #SpiceInputsChannel that emitted the signal
*
- * The #SpiceInputsChannel::inputs-modifier signal is emitted when
+ * The #SpiceInputsChannel::inputs-modifiers signal is emitted when
* the guest keyboard locks are changed. You can read the current
* state from #SpiceInputsChannel:key-modifiers property.
**/
diff --git a/src/channel-main.c b/src/channel-main.c
index ca7d575..6e66401 100644
--- a/src/channel-main.c
+++ b/src/channel-main.c
@@ -726,7 +726,7 @@ static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
* @main: the #SpiceMainChannel that emitted the signal
* @types: the VD_AGENT_CLIPBOARD request type
*
- * Request clipbard data from the client.
+ * Request clipboard data from the client.
*
* Return value: %TRUE if the request is successful
*
@@ -749,7 +749,7 @@ static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
* @types: the VD_AGENT_CLIPBOARD request type
*
- * Request clipbard data from the client.
+ * Request clipboard data from the client.
*
* Return value: %TRUE if the request is successful
*
diff --git a/src/channel-port.c b/src/channel-port.c
index f0b6d1e..222074c 100644
--- a/src/channel-port.c
+++ b/src/channel-port.c
@@ -151,7 +151,7 @@ static void spice_port_channel_class_init(SpicePortChannelClass *klass)
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
- * SpicePort::port-data:
+ * SpicePortChannel::port-data:
* @channel: the channel that emitted the signal
* @data: the data received
* @size: number of bytes read
@@ -173,7 +173,7 @@ static void spice_port_channel_class_init(SpicePortChannelClass *klass)
/**
- * SpicePort::port-event:
+ * SpicePortChannel::port-event:
* @channel: the channel that emitted the signal
* @event: the event received
* @size: number of bytes read
diff --git a/src/spice-grabsequence.c b/src/spice-grabsequence.c
index 96d936a..26bf96f 100644
--- a/src/spice-grabsequence.c
+++ b/src/spice-grabsequence.c
@@ -67,7 +67,7 @@ SpiceGrabSequence *spice_grab_sequence_new(guint nkeysyms, guint *keysyms)
/**
* spice_grab_sequence_new_from_string:
- * @str: a string of '+' seperated key names (ex: "Control_L+Alt_L")
+ * @str: a string of '+' separated key names (ex: "Control_L+Alt_L")
*
* Creates a new #SpiceGrabSequence from the string representation.
*
diff --git a/src/spice-session.c b/src/spice-session.c
index 680b2e4..e1d9997 100644
--- a/src/spice-session.c
+++ b/src/spice-session.c
@@ -1901,7 +1901,7 @@ void spice_session_migrate_end(SpiceSession *self)
*
* Checks whether the @session is read-only.
*
- * Returns: wether the @session is in read-only mode.
+ * Returns: whether the @session is in read-only mode.
**/
gboolean spice_session_get_read_only(SpiceSession *self)
{
diff --git a/src/usb-device-manager.c b/src/usb-device-manager.c
index 80463c6..777fdf0 100644
--- a/src/usb-device-manager.c
+++ b/src/usb-device-manager.c
@@ -1305,7 +1305,7 @@ static SpiceUsbredirChannel *spice_usb_device_manager_get_channel_for_dev(
* spice_usb_device_manager_get_devices_with_filter:
* @manager: the #SpiceUsbDeviceManager manager
* @filter: (allow-none): filter string for selecting which devices to return,
- * see #SpiceUsbDeviceManager:auto-connect-filter for the f ilter
+ * see #SpiceUsbDeviceManager:auto-connect-filter for the filter
* string format
*
* Finds devices associated with the @manager complying with the @filter
commit a2f6ac46b3bb43dddfa6e6999c508bcfc9514338
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Tue Sep 22 16:13:25 2015 +0200
docs: Add missing symbol description strings
diff --git a/src/channel-inputs.h b/src/channel-inputs.h
index 3179a76..8933116 100644
--- a/src/channel-inputs.h
+++ b/src/channel-inputs.h
@@ -33,6 +33,14 @@ typedef struct _SpiceInputsChannel SpiceInputsChannel;
typedef struct _SpiceInputsChannelClass SpiceInputsChannelClass;
typedef struct _SpiceInputsChannelPrivate SpiceInputsChannelPrivate;
+/**
+ * SpiceInputsLock:
+ * @SPICE_INPUTS_SCROLL_LOCK: Scroll Lock
+ * @SPICE_INPUTS_NUM_LOCK: Num Lock
+ * @SPICE_INPUTS_CAPS_LOCK: Caps Lock
+ *
+ * Constants used to synchronize modifiers between a client and a guest.
+ **/
typedef enum {
SPICE_INPUTS_SCROLL_LOCK = (1 << 0),
SPICE_INPUTS_NUM_LOCK = (1 << 1),
diff --git a/src/channel-main.c b/src/channel-main.c
index 85e01e4..ca7d575 100644
--- a/src/channel-main.c
+++ b/src/channel-main.c
@@ -661,6 +661,8 @@ static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
* @data: clipboard data
* @size: size of @data in bytes
*
+ * Informs that clipboard selection data are available.
+ *
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION] =
diff --git a/src/channel-playback.c b/src/channel-playback.c
index ddcb757..020f809 100644
--- a/src/channel-playback.c
+++ b/src/channel-playback.c
@@ -453,6 +453,8 @@ static void channel_set_handlers(SpiceChannelClass *klass)
* spice_playback_channel_set_delay:
* @channel: a #SpicePlaybackChannel
* @delay_ms: the delay in ms
+ *
+ * Adjust the multimedia time according to the delay.
**/
void spice_playback_channel_set_delay(SpicePlaybackChannel *channel, guint32 delay_ms)
{
diff --git a/src/smartcard-manager.h b/src/smartcard-manager.h
index 4811083..2a7fd48 100644
--- a/src/smartcard-manager.h
+++ b/src/smartcard-manager.h
@@ -35,8 +35,19 @@ G_BEGIN_DECLS
typedef struct _SpiceSmartcardManager SpiceSmartcardManager;
typedef struct _SpiceSmartcardManagerClass SpiceSmartcardManagerClass;
typedef struct _SpiceSmartcardManagerPrivate SpiceSmartcardManagerPrivate;
+
+/**
+ * SpiceSmartcardReader:
+ *
+ * The #SpiceSmartcardReader struct is opaque and cannot be accessed directly.
+ */
typedef struct _SpiceSmartcardReader SpiceSmartcardReader;
+/**
+ * SpiceSmartcardManager:
+ *
+ * The #SpiceSmartcardManager struct is opaque and should not be accessed directly.
+ */
struct _SpiceSmartcardManager
{
GObject parent;
@@ -46,6 +57,16 @@ struct _SpiceSmartcardManager
/* Do not add fields to this struct */
};
+/**
+ * SpiceSmartcardManagerClass:
+ * @parent_class: Parent class.
+ * @reader_added: Signal class handler for the #SpiceSmartcardManager::reader_added signal.
+ * @reader_removed: Signal class handler for the #SpiceSmartcardManager::reader_removed signal.
+ * @card_inserted: Signal class handler for the #SpiceSmartcardManager::card_inserted signal.
+ * @card_removed: Signal class handler for the #SpiceSmartcardManager::card_removed signal.
+ *
+ * Class structure for #SpiceSmartcardManager.
+ */
struct _SpiceSmartcardManagerClass
{
GObjectClass parent_class;
diff --git a/src/spice-channel.c b/src/spice-channel.c
index ce0923f..2ce52c7 100644
--- a/src/spice-channel.c
+++ b/src/spice-channel.c
@@ -283,7 +283,7 @@ static void spice_channel_class_init(SpiceChannelClass *klass)
(gobject_class, PROP_SESSION,
g_param_spec_object("spice-session",
"Spice session",
- "",
+ "Spice session",
SPICE_TYPE_SESSION,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
@@ -293,7 +293,7 @@ static void spice_channel_class_init(SpiceChannelClass *klass)
(gobject_class, PROP_CHANNEL_TYPE,
g_param_spec_int("channel-type",
"Channel type",
- "",
+ "Channel type",
-1, INT_MAX, -1,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
@@ -303,7 +303,7 @@ static void spice_channel_class_init(SpiceChannelClass *klass)
(gobject_class, PROP_CHANNEL_ID,
g_param_spec_int("channel-id",
"Channel ID",
- "",
+ "Channel ID",
-1, INT_MAX, -1,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
@@ -313,7 +313,7 @@ static void spice_channel_class_init(SpiceChannelClass *klass)
(gobject_class, PROP_TOTAL_READ_BYTES,
g_param_spec_ulong("total-read-bytes",
"Total read bytes",
- "",
+ "Total read bytes",
0, G_MAXULONG, 0,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
diff --git a/src/spice-channel.h b/src/spice-channel.h
index 6f8682e..f465572 100644
--- a/src/spice-channel.h
+++ b/src/spice-channel.h
@@ -62,6 +62,11 @@ typedef enum
SPICE_CHANNEL_ERROR_IO,
} SpiceChannelEvent;
+/**
+ * SpiceChannel:
+ *
+ * The #SpiceChannel struct is opaque and should not be accessed directly.
+ */
struct _SpiceChannel
{
GObject parent;
@@ -71,6 +76,14 @@ struct _SpiceChannel
typedef struct _SpiceChannelClassPrivate SpiceChannelClassPrivate;
+/**
+ * SpiceChannelClass:
+ * @parent_class: Parent class.
+ * @channel_event: Signal class handler for the #SpiceChannel::channel_event signal.
+ * @open_fd: Signal class handler for the #SpiceChannel::open_fd signal.
+ *
+ * Class structure for #SpiceChannel.
+ */
struct _SpiceChannelClass
{
GObjectClass parent_class;
diff --git a/src/spice-client.c b/src/spice-client.c
index 5fd511f..9f6412c 100644
--- a/src/spice-client.c
+++ b/src/spice-client.c
@@ -21,6 +21,13 @@
#include "spice-client.h"
+/**
+ * spice_client_error_quark:
+ *
+ * Gets a #GQuark representing the string "spice-client-error-quark"
+ *
+ * Returns: the #GQuark representing the string.
+ **/
GQuark spice_client_error_quark(void)
{
return g_quark_from_static_string("spice-client-error-quark");
diff --git a/src/spice-client.h b/src/spice-client.h
index e4e1763..5a4d838 100644
--- a/src/spice-client.h
+++ b/src/spice-client.h
@@ -51,6 +51,11 @@
G_BEGIN_DECLS
+/**
+ * SPICE_CLIENT_ERROR:
+ *
+ * Error domain for spice client errors.
+ */
#define SPICE_CLIENT_ERROR spice_client_error_quark()
/**
diff --git a/src/spice-grabsequence.c b/src/spice-grabsequence.c
index ac97e88..96d936a 100644
--- a/src/spice-grabsequence.c
+++ b/src/spice-grabsequence.c
@@ -69,6 +69,8 @@ SpiceGrabSequence *spice_grab_sequence_new(guint nkeysyms, guint *keysyms)
* spice_grab_sequence_new_from_string:
* @str: a string of '+' seperated key names (ex: "Control_L+Alt_L")
*
+ * Creates a new #SpiceGrabSequence from the string representation.
+ *
* Returns: a new #SpiceGrabSequence.
**/
SpiceGrabSequence *spice_grab_sequence_new_from_string(const gchar *str)
@@ -104,6 +106,8 @@ SpiceGrabSequence *spice_grab_sequence_new_from_string(const gchar *str)
* spice_grab_sequence_copy:
* @sequence: sequence to copy
*
+ * Creates a copy of the @sequence.
+ *
* Returns: (transfer full): a copy of @sequence
**/
SpiceGrabSequence *spice_grab_sequence_copy(SpiceGrabSequence *srcSequence)
@@ -136,6 +140,8 @@ void spice_grab_sequence_free(SpiceGrabSequence *sequence)
* spice_grab_sequence_as_string:
* @sequence: a #SpiceGrabSequence
*
+ * Creates a string representing the @sequence.
+ *
* Returns: (transfer full): a newly allocated string representing the key sequence
**/
gchar *spice_grab_sequence_as_string(SpiceGrabSequence *sequence)
diff --git a/src/spice-grabsequence.h b/src/spice-grabsequence.h
index fe58fc1..af227b0 100644
--- a/src/spice-grabsequence.h
+++ b/src/spice-grabsequence.h
@@ -31,6 +31,11 @@ G_BEGIN_DECLS
typedef struct _SpiceGrabSequence SpiceGrabSequence;
+/**
+ * SpiceGrabSequence:
+ *
+ * The #SpiceGrabSequence struct is opaque and should not be accessed directly.
+ */
struct _SpiceGrabSequence {
/*< private >*/
guint nkeysyms;
diff --git a/src/spice-gtk-session.h b/src/spice-gtk-session.h
index 3b4eac6..a69c174 100644
--- a/src/spice-gtk-session.h
+++ b/src/spice-gtk-session.h
@@ -33,6 +33,11 @@ typedef struct _SpiceGtkSession SpiceGtkSession;
typedef struct _SpiceGtkSessionClass SpiceGtkSessionClass;
typedef struct _SpiceGtkSessionPrivate SpiceGtkSessionPrivate;
+/**
+ * SpiceGtkSession:
+ *
+ * The #SpiceGtkSession struct is opaque and should not be accessed directly.
+ */
struct _SpiceGtkSession
{
GObject parent;
@@ -40,6 +45,12 @@ struct _SpiceGtkSession
/* Do not add fields to this struct */
};
+/**
+ * SpiceGtkSessionClass:
+ * @parent_class: Parent class.
+ *
+ * Class structure for #SpiceGtkSession.
+ */
struct _SpiceGtkSessionClass
{
GObjectClass parent_class;
diff --git a/src/spice-option.c b/src/spice-option.c
index 71e29a1..06b9b19 100644
--- a/src/spice-option.c
+++ b/src/spice-option.c
@@ -181,6 +181,8 @@ static gboolean parse_preferred_compression(const gchar *option_name, const gcha
/**
* spice_get_option_group: (skip)
*
+ * Gets commandline options.
+ *
* Returns: (transfer full): a #GOptionGroup for the commandline
* arguments specific to Spice. You have to call
* spice_set_session_option() after to set the options on a
diff --git a/src/spice-session.c b/src/spice-session.c
index 1626539..680b2e4 100644
--- a/src/spice-session.c
+++ b/src/spice-session.c
@@ -1899,6 +1899,8 @@ void spice_session_migrate_end(SpiceSession *self)
* spice_session_get_read_only:
* @session: a #SpiceSession
*
+ * Checks whether the @session is read-only.
+ *
* Returns: wether the @session is in read-only mode.
**/
gboolean spice_session_get_read_only(SpiceSession *self)
@@ -2606,6 +2608,8 @@ void spice_session_set_shared_dir(SpiceSession *session, const gchar *dir)
* spice_session_get_proxy_uri:
* @session: a #SpiceSession
*
+ * Gets the @session proxy uri.
+ *
* Returns: (transfer none): the session proxy #SpiceURI or %NULL.
* Since: 0.24
**/
diff --git a/src/spice-session.h b/src/spice-session.h
index 750af29..56f6959 100644
--- a/src/spice-session.h
+++ b/src/spice-session.h
@@ -63,6 +63,11 @@ typedef enum {
SPICE_SESSION_MIGRATION_CONNECTING,
} SpiceSessionMigration;
+/**
+ * SpiceSession:
+ *
+ * The #SpiceSession struct is opaque and should not be accessed directly.
+ */
struct _SpiceSession
{
GObject parent;
@@ -70,6 +75,14 @@ struct _SpiceSession
/* Do not add fields to this struct */
};
+/**
+ * SpiceSessionClass:
+ * @parent_class: Parent class.
+ * @channel_new: Signal class handler for the #SpiceSession::channel_new signal.
+ * @channel_destroy: Signal class handler for the #SpiceSession::channel_destroy signal.
+ *
+ * Class structure for #SpiceSession.
+ */
struct _SpiceSessionClass
{
GObjectClass parent_class;
diff --git a/src/spice-uri.h b/src/spice-uri.h
index 9e8d590..65ffd0a 100644
--- a/src/spice-uri.h
+++ b/src/spice-uri.h
@@ -29,7 +29,19 @@ G_BEGIN_DECLS
#define SPICE_IS_URI_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_URI))
#define SPICE_URI_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_URI, SpiceURIClass))
+/**
+ * SpiceURI:
+ *
+ * The #SpiceURI struct is opaque and cannot be accessed directly.
+ */
typedef struct _SpiceURI SpiceURI;
+
+/**
+ * SpiceURIClass:
+ *
+ * The #SpiceURIClass struct is opaque and cannot be accessed directly.
+ * It is class structure for #SpiceURI.
+ */
typedef struct _SpiceURIClass SpiceURIClass;
typedef struct _SpiceURIPrivate SpiceURIPrivate;
diff --git a/src/spice-util.c b/src/spice-util.c
index bec237b..b4bc085 100644
--- a/src/spice-util.c
+++ b/src/spice-util.c
@@ -99,6 +99,8 @@ gboolean spice_util_get_debug(void)
/**
* spice_util_get_version_string:
*
+ * Gets the version string
+ *
* Returns: Spice-GTK version as a const string.
**/
const gchar *spice_util_get_version_string(void)
diff --git a/src/spice-widget.c b/src/spice-widget.c
index be5a4d4..524263d 100644
--- a/src/spice-widget.c
+++ b/src/spice-widget.c
@@ -704,6 +704,8 @@ static LRESULT CALLBACK keyboard_hook_cb(int code, WPARAM wparam, LPARAM lparam)
* spice_display_get_grab_keys:
* @display: the display widget
*
+ * Finds the current grab key combination for the @display.
+ *
* Returns: (transfer none): the current grab key combination.
**/
SpiceGrabSequence *spice_display_get_grab_keys(SpiceDisplay *display)
@@ -2535,6 +2537,8 @@ static void channel_destroy(SpiceSession *s, SpiceChannel *channel, gpointer dat
* @session: a #SpiceSession
* @channel_id: the display channel ID to associate with #SpiceDisplay
*
+ * Creates a new #SpiceDisplay widget.
+ *
* Returns: a new #SpiceDisplay widget.
**/
SpiceDisplay *spice_display_new(SpiceSession *session, int channel_id)
@@ -2549,6 +2553,8 @@ SpiceDisplay *spice_display_new(SpiceSession *session, int channel_id)
* @channel_id: the display channel ID to associate with #SpiceDisplay
* @monitor_id: the monitor id within the display channel
*
+ * Creates a new #SpiceDisplay widget associated with the monitor id.
+ *
* Since: 0.13
* Returns: a new #SpiceDisplay widget.
**/
diff --git a/src/spice-widget.h b/src/spice-widget.h
index d239ed2..f180a43 100644
--- a/src/spice-widget.h
+++ b/src/spice-widget.h
@@ -40,12 +40,25 @@ typedef struct _SpiceDisplay SpiceDisplay;
typedef struct _SpiceDisplayClass SpiceDisplayClass;
typedef struct _SpiceDisplayPrivate SpiceDisplayPrivate;
+/**
+ * SpiceDisplay:
+ *
+ * The #SpiceDisplay struct is opaque and should not be accessed directly.
+ */
struct _SpiceDisplay {
GtkDrawingArea parent;
SpiceDisplayPrivate *priv;
/* Do not add fields to this struct */
};
+/**
+ * SpiceDisplayClass:
+ * @parent_class: Parent class.
+ * @mouse_grab: Signal class handler for the #SpiceDisplay::mouse_grab signal.
+ * @keyboard_grab: Signal class handler for the #SpiceDisplay::keyboard_grab signal.
+ *
+ * Class structure for #SpiceDisplay.
+ */
struct _SpiceDisplayClass {
GtkDrawingAreaClass parent_class;
@@ -61,6 +74,14 @@ struct _SpiceDisplayClass {
gchar _spice_reserved[SPICE_RESERVED_PADDING];
};
+/**
+ * SpiceDisplayKeyEvent:
+ * @SPICE_DISPLAY_KEY_EVENT_PRESS: key press
+ * @SPICE_DISPLAY_KEY_EVENT_RELEASE: key release
+ * @SPICE_DISPLAY_KEY_EVENT_CLICK: key click (press and release)
+ *
+ * Constants for key events.
+ */
typedef enum
{
SPICE_DISPLAY_KEY_EVENT_PRESS = 1,
diff --git a/src/usb-device-manager.c b/src/usb-device-manager.c
index 9792217..80463c6 100644
--- a/src/usb-device-manager.c
+++ b/src/usb-device-manager.c
@@ -692,6 +692,8 @@ static gboolean spice_usb_device_manager_get_device_descriptor(
* spice_usb_device_get_libusb_device:
* @device: #SpiceUsbDevice to get the descriptor information of
*
+ * Finds the %libusb_device associated with the @device.
+ *
* Returns: (transfer none): the %libusb_device associated to %SpiceUsbDevice.
*
* Since: 0.27
@@ -1306,6 +1308,8 @@ static SpiceUsbredirChannel *spice_usb_device_manager_get_channel_for_dev(
* see #SpiceUsbDeviceManager:auto-connect-filter for the f ilter
* string format
*
+ * Finds devices associated with the @manager complying with the @filter
+ *
* Returns: (element-type SpiceUsbDevice) (transfer full): a
* %GPtrArray array of %SpiceUsbDevice
*
@@ -1363,6 +1367,8 @@ GPtrArray* spice_usb_device_manager_get_devices_with_filter(
* spice_usb_device_manager_get_devices:
* @manager: the #SpiceUsbDeviceManager manager
*
+ * Finds devices associated with the @manager
+ *
* Returns: (element-type SpiceUsbDevice) (transfer full): a %GPtrArray array of %SpiceUsbDevice
*/
GPtrArray* spice_usb_device_manager_get_devices(SpiceUsbDeviceManager *self)
@@ -1375,6 +1381,8 @@ GPtrArray* spice_usb_device_manager_get_devices(SpiceUsbDeviceManager *self)
* @manager: the #SpiceUsbDeviceManager manager
* @device: a #SpiceUsbDevice
*
+ * Finds if the @device is connected.
+ *
* Returns: %TRUE if @device has an associated USB redirection channel
*/
gboolean spice_usb_device_manager_is_device_connected(SpiceUsbDeviceManager *self,
@@ -1386,14 +1394,6 @@ gboolean spice_usb_device_manager_is_device_connected(SpiceUsbDeviceManager *sel
return !!spice_usb_device_manager_get_channel_for_dev(self, device);
}
-/**
- * spice_usb_device_manager_connect_device_async:
- * @manager: the #SpiceUsbDeviceManager manager
- * @device: a #SpiceUsbDevice to redirect
- * @cancellable: a #GCancellable or NULL
- * @callback: a #GAsyncReadyCallback to call when the request is satisfied
- * @user_data: data to pass to callback
- */
static void
_spice_usb_device_manager_connect_device_async(SpiceUsbDeviceManager *self,
SpiceUsbDevice *device,
@@ -1469,7 +1469,18 @@ done:
g_object_unref(result);
}
-
+/**
+ * spice_usb_device_manager_connect_device_async:
+ * @self: a #SpiceUsbDeviceManager.
+ * @device: a #SpiceUsbDevice to redirect
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
+ * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: the data to pass to callback function
+ *
+ * Asynchronously connects the @device. When completed, @callback will be called.
+ * Then it is possible to call spice_usb_device_manager_connect_device_finish()
+ * to get the result of the operation.
+ */
void spice_usb_device_manager_connect_device_async(SpiceUsbDeviceManager *self,
SpiceUsbDevice *device,
GCancellable *cancellable,
@@ -1506,6 +1517,16 @@ void spice_usb_device_manager_connect_device_async(SpiceUsbDeviceManager *self,
#endif
}
+/**
+ * spice_usb_device_manager_connect_device_finish:
+ * @self: a #SpiceUsbDeviceManager.
+ * @res: a #GAsyncResult
+ * @err: (allow-none): a return location for a #GError, or %NULL.
+ *
+ * Finishes an async operation. See spice_usb_device_manager_connect_device_async().
+ *
+ * Returns: %TRUE if connection is successful
+ */
gboolean spice_usb_device_manager_connect_device_finish(
SpiceUsbDeviceManager *self, GAsyncResult *res, GError **err)
{
@@ -1526,6 +1547,8 @@ gboolean spice_usb_device_manager_connect_device_finish(
* @manager: the #SpiceUsbDeviceManager manager
* @device: a #SpiceUsbDevice to disconnect
*
+ * Disconnects the @device.
+ *
* Returns: %TRUE if @device has an associated USB redirection channel
*/
void spice_usb_device_manager_disconnect_device(SpiceUsbDeviceManager *self,
@@ -1573,6 +1596,16 @@ void spice_usb_device_manager_disconnect_device(SpiceUsbDeviceManager *self,
#endif
}
+/**
+ * spice_usb_device_manager_can_redirect_device:
+ * @self: the #SpiceUsbDeviceManager manager
+ * @device: a #SpiceUsbDevice to disconnect
+ * @err: (allow-none): a return location for a #GError, or %NULL.
+ *
+ * Checks whether it is possible to redirect the @device.
+ *
+ * Returns: %TRUE if @device can be redirected
+ */
gboolean
spice_usb_device_manager_can_redirect_device(SpiceUsbDeviceManager *self,
SpiceUsbDevice *device,
diff --git a/src/usb-device-manager.h b/src/usb-device-manager.h
index 8b173bb..c1e3f76 100644
--- a/src/usb-device-manager.h
+++ b/src/usb-device-manager.h
@@ -39,6 +39,11 @@ typedef struct _SpiceUsbDeviceManager SpiceUsbDeviceManager;
typedef struct _SpiceUsbDeviceManagerClass SpiceUsbDeviceManagerClass;
typedef struct _SpiceUsbDeviceManagerPrivate SpiceUsbDeviceManagerPrivate;
+/**
+ * SpiceUsbDevice:
+ *
+ * The #SpiceUsbDevice struct is opaque and cannot be accessed directly.
+ */
typedef struct _SpiceUsbDevice SpiceUsbDevice;
/**
@@ -102,7 +107,7 @@ GPtrArray* spice_usb_device_manager_get_devices_with_filter(
gboolean spice_usb_device_manager_is_device_connected(SpiceUsbDeviceManager *manager,
SpiceUsbDevice *device);
void spice_usb_device_manager_connect_device_async(
- SpiceUsbDeviceManager *manager,
+ SpiceUsbDeviceManager *self,
SpiceUsbDevice *device,
GCancellable *cancellable,
GAsyncReadyCallback callback,
diff --git a/src/usb-device-widget.c b/src/usb-device-widget.c
index 1ec30e3..84435b2 100644
--- a/src/usb-device-widget.c
+++ b/src/usb-device-widget.c
@@ -334,6 +334,8 @@ static void spice_usb_device_widget_init(SpiceUsbDeviceWidget *self)
* @device_format_string: (allow-none): String passed to
* spice_usb_device_get_description()
*
+ * Creates a new widget to control USB redirection.
+ *
* Returns: a new #SpiceUsbDeviceWidget instance
*/
GtkWidget *spice_usb_device_widget_new(SpiceSession *session,
commit ece91c49ab3050f63882d2b4c876709bb6825a4b
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Tue Sep 22 18:35:41 2015 +0200
docs: Description should be above 'Return'
diff --git a/src/channel-main.c b/src/channel-main.c
index b1c19c0..85e01e4 100644
--- a/src/channel-main.c
+++ b/src/channel-main.c
@@ -724,10 +724,10 @@ static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
* @main: the #SpiceMainChannel that emitted the signal
* @types: the VD_AGENT_CLIPBOARD request type
*
- * Return value: %TRUE if the request is successful
- *
* Request clipbard data from the client.
*
+ * Return value: %TRUE if the request is successful
+ *
* Deprecated: 0.6: use SpiceMainChannel::main-clipboard-selection-request instead.
**/
signals[SPICE_MAIN_CLIPBOARD_REQUEST] =
@@ -747,10 +747,10 @@ static void spice_main_channel_class_init(SpiceMainChannelClass *klass)
* @selection: a VD_AGENT_CLIPBOARD_SELECTION clipboard
* @types: the VD_AGENT_CLIPBOARD request type
*
- * Return value: %TRUE if the request is successful
- *
* Request clipbard data from the client.
*
+ * Return value: %TRUE if the request is successful
+ *
* Since: 0.6
**/
signals[SPICE_MAIN_CLIPBOARD_SELECTION_REQUEST] =
commit a9cd796fefce80febcce52ab6ce544174912c4ec
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Thu Sep 17 14:58:46 2015 +0200
docs: Add missing parameter/field descriptions
diff --git a/src/channel-display.c b/src/channel-display.c
index a65f926..c3a504f 100644
--- a/src/channel-display.c
+++ b/src/channel-display.c
@@ -392,9 +392,9 @@ static void spice_display_channel_class_init(SpiceDisplayChannelClass *klass)
/**
* spice_display_get_primary:
- * @channel:
- * @surface_id:
- * @primary:
+ * @channel: a #SpiceDisplayChannel
+ * @surface_id: a surface id
+ * @primary: a #SpiceDisplayPrimary
*
* Retrieve primary display surface @surface_id.
*
diff --git a/src/channel-inputs.c b/src/channel-inputs.c
index df1ffe1..1a6457d 100644
--- a/src/channel-inputs.c
+++ b/src/channel-inputs.c
@@ -278,7 +278,7 @@ static void channel_set_handlers(SpiceChannelClass *klass)
/**
* spice_inputs_motion:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @dx: delta X mouse coordinates
* @dy: delta Y mouse coordinates
* @button_state: SPICE_MOUSE_BUTTON_MASK flags
@@ -310,7 +310,7 @@ void spice_inputs_motion(SpiceInputsChannel *channel, gint dx, gint dy,
/**
* spice_inputs_position:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @x: X mouse coordinates
* @y: Y mouse coordinates
* @display: display channel id
@@ -343,7 +343,7 @@ void spice_inputs_position(SpiceInputsChannel *channel, gint x, gint y,
/**
* spice_inputs_button_press:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @button: a SPICE_MOUSE_BUTTON
* @button_state: SPICE_MOUSE_BUTTON_MASK flags
*
@@ -390,7 +390,7 @@ void spice_inputs_button_press(SpiceInputsChannel *channel, gint button,
/**
* spice_inputs_button_release:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @button: a SPICE_MOUSE_BUTTON
* @button_state: SPICE_MOUSE_BUTTON_MASK flags
*
@@ -437,7 +437,7 @@ void spice_inputs_button_release(SpiceInputsChannel *channel, gint button,
/**
* spice_inputs_key_press:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @scancode: a PC XT (set 1) key scancode. For scancodes with an %0xe0
* prefix, drop the prefix and OR the scancode with %0x100.
*
@@ -463,7 +463,7 @@ void spice_inputs_key_press(SpiceInputsChannel *channel, guint scancode)
/**
* spice_inputs_key_release:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @scancode: a PC XT (set 1) key scancode. For scancodes with an %0xe0
* prefix, drop the prefix and OR the scancode with %0x100.
*
@@ -489,7 +489,7 @@ void spice_inputs_key_release(SpiceInputsChannel *channel, guint scancode)
/**
* spice_inputs_key_press_and_release:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @scancode: a PC XT (set 1) key scancode. For scancodes with an %0xe0
* prefix, drop the prefix and OR the scancode with %0x100.
*
@@ -562,7 +562,7 @@ static SpiceMsgOut* set_key_locks(SpiceInputsChannel *channel, guint locks)
/**
* spice_inputs_set_key_locks:
- * @channel:
+ * @channel: a #SpiceInputsChannel
* @locks: #SpiceInputsLock modifiers flags
*
* Set the keyboard locks on the guest (Caps, Num, Scroll..)
diff --git a/src/channel-main.c b/src/channel-main.c
index 2ec6457..b1c19c0 100644
--- a/src/channel-main.c
+++ b/src/channel-main.c
@@ -1042,7 +1042,7 @@ static void monitors_align(VDAgentMonConfig *monitors, int nmonitors)
/**
* spice_main_send_monitor_config:
- * @channel:
+ * @channel: a #SpiceMainChannel
*
* Send monitors configuration previously set with
* spice_main_set_display() and spice_main_set_display_enabled()
@@ -2565,7 +2565,7 @@ static void spice_main_handle_msg(SpiceChannel *channel, SpiceMsgIn *msg)
/**
* spice_main_agent_test_capability:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @cap: an agent capability identifier
*
* Test capability of a remote agent.
@@ -2581,7 +2581,7 @@ gboolean spice_main_agent_test_capability(SpiceMainChannel *channel, guint32 cap
/**
* spice_main_update_display:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @id: display ID
* @x: x position
* @y: y position
@@ -2624,7 +2624,7 @@ void spice_main_update_display(SpiceMainChannel *channel, int id,
/**
* spice_main_set_display:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @id: display ID
* @x: x position
* @y: y position
@@ -2642,7 +2642,7 @@ void spice_main_set_display(SpiceMainChannel *channel, int id,
/**
* spice_main_clipboard_grab:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @types: an array of #VD_AGENT_CLIPBOARD types available in the clipboard
* @ntypes: the number of @types
*
@@ -2657,7 +2657,7 @@ void spice_main_clipboard_grab(SpiceMainChannel *channel, guint32 *types, int nt
/**
* spice_main_clipboard_selection_grab:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @types: an array of #VD_AGENT_CLIPBOARD types available in the clipboard
* @ntypes: the number of @types
@@ -2678,7 +2678,7 @@ void spice_main_clipboard_selection_grab(SpiceMainChannel *channel, guint select
/**
* spice_main_clipboard_release:
- * @channel:
+ * @channel: a #SpiceMainChannel
*
* Release the clipboard (for example, when the client loses the
* clipboard grab): Inform the guest no clipboard data is available.
@@ -2692,7 +2692,7 @@ void spice_main_clipboard_release(SpiceMainChannel *channel)
/**
* spice_main_clipboard_selection_release:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
*
* Release the clipboard (for example, when the client loses the
@@ -2716,7 +2716,7 @@ void spice_main_clipboard_selection_release(SpiceMainChannel *channel, guint sel
/**
* spice_main_clipboard_notify:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @type: a #VD_AGENT_CLIPBOARD type
* @data: clipboard data
* @size: data length in bytes
@@ -2734,7 +2734,7 @@ void spice_main_clipboard_notify(SpiceMainChannel *channel,
/**
* spice_main_clipboard_selection_notify:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @type: a #VD_AGENT_CLIPBOARD type
* @data: clipboard data
@@ -2756,7 +2756,7 @@ void spice_main_clipboard_selection_notify(SpiceMainChannel *channel, guint sele
/**
* spice_main_clipboard_request:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @type: a #VD_AGENT_CLIPBOARD type
*
* Request clipboard data of @type from the guest. The reply is sent
@@ -2771,7 +2771,7 @@ void spice_main_clipboard_request(SpiceMainChannel *channel, guint32 type)
/**
* spice_main_clipboard_selection_request:
- * @channel:
+ * @channel: a #SpiceMainChannel
* @selection: one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_*
* @type: a #VD_AGENT_CLIPBOARD type
*
@@ -2996,6 +2996,7 @@ static void file_xfer_send_start_msg_async(SpiceMainChannel *channel,
/**
* spice_main_file_copy_async:
+ * @channel: a #SpiceMainChannel
* @sources: #GFile to be transfer
* @flags: set of #GFileCopyFlags
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
@@ -3058,6 +3059,7 @@ void spice_main_file_copy_async(SpiceMainChannel *channel,
/**
* spice_main_file_copy_finish:
+ * @channel: a #SpiceMainChannel
* @result: a #GAsyncResult.
* @error: a #GError, or %NULL
*
diff --git a/src/channel-playback.c b/src/channel-playback.c
index d8a181e..ddcb757 100644
--- a/src/channel-playback.c
+++ b/src/channel-playback.c
@@ -449,6 +449,11 @@ static void channel_set_handlers(SpiceChannelClass *klass)
spice_channel_set_handlers(klass, handlers, G_N_ELEMENTS(handlers));
}
+/**
+ * spice_playback_channel_set_delay:
+ * @channel: a #SpicePlaybackChannel
+ * @delay_ms: the delay in ms
+ **/
void spice_playback_channel_set_delay(SpicePlaybackChannel *channel, guint32 delay_ms)
{
SpicePlaybackChannelPrivate *c;
diff --git a/src/channel-record.c b/src/channel-record.c
index e581aed..a44c860 100644
--- a/src/channel-record.c
+++ b/src/channel-record.c
@@ -309,7 +309,7 @@ static void spice_record_start_mark(SpiceRecordChannel *channel, uint32_t time)
/**
* spice_record_send_data:
- * @channel:
+ * @channel: a #SpiceRecordChannel
* @data: PCM data
* @bytes: size of @data
* @time: stream timestamp
diff --git a/src/smartcard-manager.c b/src/smartcard-manager.c
index 9e228e9..0cce42b 100644
--- a/src/smartcard-manager.c
+++ b/src/smartcard-manager.c
@@ -596,8 +596,7 @@ gboolean spice_smartcard_reader_remove_card(SpiceSmartcardReader *reader)
/**
* spice_smartcard_manager_get_readers:
- *
- * manager: a #SpiceSmartcardManager
+ * @manager: a #SpiceSmartcardManager
*
* Gets the list of smartcard readers that are currently available, they
* can be either software (emulated) readers, or hardware ones.
diff --git a/src/spice-channel.c b/src/spice-channel.c
index e254b41..ce0923f 100644
--- a/src/spice-channel.c
+++ b/src/spice-channel.c
@@ -2060,7 +2060,7 @@ SpiceChannel *spice_channel_new(SpiceSession *s, int type, int id)
/**
* spice_channel_destroy:
- * @channel:
+ * @channel: a #SpiceChannel
*
* Disconnect and unref the @channel.
*
@@ -2284,7 +2284,7 @@ static int spice_channel_load_ca(SpiceChannel *channel)
/**
* spice_channel_get_error:
- * @channel:
+ * @channel: a #SpiceChannel
*
* Retrieves the #GError currently set on channel, if the #SpiceChannel
* is in error state and can provide additional error details.
@@ -2527,7 +2527,7 @@ static gboolean channel_connect(SpiceChannel *channel, gboolean tls)
/**
* spice_channel_connect:
- * @channel:
+ * @channel: a #SpiceChannel
*
* Connect the channel, using #SpiceSession connection informations
*
@@ -2548,7 +2548,7 @@ gboolean spice_channel_connect(SpiceChannel *channel)
/**
* spice_channel_open_fd:
- * @channel:
+ * @channel: a #SpiceChannel
* @fd: a file descriptor (socket) or -1.
* request mechanism
*
@@ -2661,7 +2661,7 @@ void spice_channel_reset(SpiceChannel *channel, gboolean migrating)
/**
* spice_channel_disconnect:
- * @channel:
+ * @channel: a #SpiceChannel
* @reason: a channel event emitted on main context (or #SPICE_CHANNEL_NONE)
*
* Close the socket and reset connection specific data. Finally, emit
@@ -2716,8 +2716,8 @@ static gboolean test_capability(GArray *caps, guint32 cap)
/**
* spice_channel_test_capability:
- * @channel:
- * @cap:
+ * @channel: a #SpiceChannel
+ * @cap: a capability
*
* Test availability of remote "channel kind capability".
*
@@ -2735,8 +2735,8 @@ gboolean spice_channel_test_capability(SpiceChannel *self, guint32 cap)
/**
* spice_channel_test_common_capability:
- * @channel:
- * @cap:
+ * @channel: a #SpiceChannel
+ * @cap: a capability
*
* Test availability of remote "common channel capability".
*
@@ -2767,7 +2767,7 @@ static void set_capability(GArray *caps, guint32 cap)
/**
* spice_channel_set_capability:
- * @channel:
+ * @channel: a #SpiceChannel
* @cap: a capability
*
* Enable specific channel-kind capability.
diff --git a/src/spice-channel.h b/src/spice-channel.h
index e0ce443..6f8682e 100644
--- a/src/spice-channel.h
+++ b/src/spice-channel.h
@@ -39,6 +39,7 @@ typedef struct _SpiceMsgOut SpiceMsgOut;
* SpiceChannelEvent:
* @SPICE_CHANNEL_NONE: no event, or ignored event
* @SPICE_CHANNEL_OPENED: connection is authentified and ready
+ * @SPICE_CHANNEL_SWITCHING: disconnecting from the current host and connecting to the target host.
* @SPICE_CHANNEL_CLOSED: connection is closed normally (sent if channel was ready)
* @SPICE_CHANNEL_ERROR_CONNECT: connection error
* @SPICE_CHANNEL_ERROR_TLS: SSL error
diff --git a/src/spice-grabsequence.c b/src/spice-grabsequence.c
index 39adfb0..ac97e88 100644
--- a/src/spice-grabsequence.c
+++ b/src/spice-grabsequence.c
@@ -121,7 +121,7 @@ SpiceGrabSequence *spice_grab_sequence_copy(SpiceGrabSequence *srcSequence)
/**
* spice_grab_sequence_free:
- * @sequence:
+ * @sequence: a #SpiceGrabSequence
*
* Free @sequence.
**/
@@ -134,7 +134,7 @@ void spice_grab_sequence_free(SpiceGrabSequence *sequence)
/**
* spice_grab_sequence_as_string:
- * @sequence:
+ * @sequence: a #SpiceGrabSequence
*
* Returns: (transfer full): a newly allocated string representing the key sequence
**/
diff --git a/src/spice-gtk-session.c b/src/spice-gtk-session.c
index 0937434..90f5116 100644
--- a/src/spice-gtk-session.c
+++ b/src/spice-gtk-session.c
@@ -1147,7 +1147,7 @@ SpiceGtkSession *spice_gtk_session_get(SpiceSession *session)
/**
* spice_gtk_session_copy_to_guest:
- * @self:
+ * @self: #SpiceGtkSession
*
* Copy client-side clipboard to guest clipboard.
*
@@ -1169,7 +1169,7 @@ void spice_gtk_session_copy_to_guest(SpiceGtkSession *self)
/**
* spice_gtk_session_paste_from_guest:
- * @self:
+ * @self: #SpiceGtkSession
*
* Copy guest clipboard to client-side clipboard.
*
diff --git a/src/spice-session.c b/src/spice-session.c
index 887b066..1626539 100644
--- a/src/spice-session.c
+++ b/src/spice-session.c
@@ -1542,7 +1542,7 @@ SpiceSession *spice_session_new_from_session(SpiceSession *session)
/**
* spice_session_connect:
- * @session:
+ * @session: a #SpiceSession
*
* Open the session using the #SpiceSession:host and
* #SpiceSession:port.
@@ -1575,7 +1575,7 @@ gboolean spice_session_connect(SpiceSession *session)
/**
* spice_session_open_fd:
- * @session:
+ * @session: a #SpiceSession
* @fd: a file descriptor (socket) or -1
*
* Open the session using the provided @fd socket file
@@ -1593,7 +1593,7 @@ gboolean spice_session_connect(SpiceSession *session)
* @fd this call since you will have to hook to SpiceChannel::open-fd signal
* anyway.
*
- * Returns:
+ * Returns: %TRUE on success.
**/
gboolean spice_session_open_fd(SpiceSession *session, int fd)
{
@@ -1922,7 +1922,7 @@ static gboolean session_disconnect_idle(SpiceSession *self)
/**
* spice_session_disconnect:
- * @session:
+ * @session: a #SpiceSession
*
* Disconnect the @session, and destroy all channels.
**/
@@ -1975,6 +1975,7 @@ GList *spice_session_get_channels(SpiceSession *session)
/**
* spice_session_has_channel_type:
* @session: a #SpiceSession
+ * @type: a #SpiceChannel:channel-type
*
* See if there is a @type channel in the channels associated with this
* @session.
@@ -2656,6 +2657,7 @@ SpiceAudio *spice_audio_get(SpiceSession *session, GMainContext *context)
/**
* spice_usb_device_manager_get:
* @session: #SpiceSession for which to get the #SpiceUsbDeviceManager
+ * @err: (allow-none): a return location for #GError, or %NULL.
*
* Gets the #SpiceUsbDeviceManager associated with the passed in #SpiceSession.
* A new #SpiceUsbDeviceManager instance will be created the first time this
diff --git a/src/spice-widget.c b/src/spice-widget.c
index fdaf6d6..be5a4d4 100644
--- a/src/spice-widget.c
+++ b/src/spice-widget.c
@@ -2563,7 +2563,7 @@ SpiceDisplay* spice_display_new_with_monitor(SpiceSession *session, gint channel
/**
* spice_display_mouse_ungrab:
- * @display:
+ * @display: a #SpiceDisplay
*
* Ungrab the mouse.
**/
@@ -2576,7 +2576,7 @@ void spice_display_mouse_ungrab(SpiceDisplay *display)
/**
* spice_display_copy_to_guest:
- * @display:
+ * @display: a #SpiceDisplay
*
* Copy client-side clipboard to guest clipboard.
*
@@ -2597,7 +2597,7 @@ void spice_display_copy_to_guest(SpiceDisplay *display)
/**
* spice_display_paste_from_guest:
- * @display:
+ * @display: a #SpiceDisplay
*
* Copy guest clipboard to client-side clipboard.
*
@@ -2618,7 +2618,7 @@ void spice_display_paste_from_guest(SpiceDisplay *display)
/**
* spice_display_get_pixbuf:
- * @display:
+ * @display: a #SpiceDisplay
*
* Take a screenshot of the display.
*
diff --git a/src/usb-device-manager.h b/src/usb-device-manager.h
index 5b4cfbe..8b173bb 100644
--- a/src/usb-device-manager.h
+++ b/src/usb-device-manager.h
@@ -61,6 +61,7 @@ struct _SpiceUsbDeviceManager
* @device_added: Signal class handler for the #SpiceUsbDeviceManager::device-added signal.
* @device_removed: Signal class handler for the #SpiceUsbDeviceManager::device-removed signal.
* @auto_connect_failed: Signal class handler for the #SpiceUsbDeviceManager::auto-connect-failed signal.
+ * @device_error: Signal class handler for the #SpiceUsbDeviceManager::device_error signal.
*
* Class structure for #SpiceUsbDeviceManager.
*/
diff --git a/src/usb-device-widget.h b/src/usb-device-widget.h
index b68cc6b..9143d5c 100644
--- a/src/usb-device-widget.h
+++ b/src/usb-device-widget.h
@@ -53,6 +53,7 @@ struct _SpiceUsbDeviceWidget
/**
* SpiceUsbDeviceWidgetClass:
+ * @parent_class: Parent class.
* @connect_failed: Signal class handler for the #SpiceUsbDeviceWidget::connect-failed signal.
*
* Class structure for #SpiceUsbDeviceWidget.
commit 4c1c868b738185619c09c3f557b94d917df40150
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Thu Sep 24 11:51:03 2015 +0200
docs: Move SPICE_TYPE_USB_DEVICE to standard subsection
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index d8b835e..fe24f9f 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -302,7 +302,6 @@ SpiceUsbredirChannelPrivate
<SECTION>
<FILE>usb-device-manager</FILE>
<TITLE>SpiceUsbDeviceManager</TITLE>
-SPICE_TYPE_USB_DEVICE
SpiceUsbDeviceManager
SpiceUsbDeviceManagerClass
<SUBSECTION>
@@ -321,6 +320,7 @@ spice_usb_device_get_libusb_device
<SUBSECTION Standard>
SPICE_USB_DEVICE_MANAGER
SPICE_IS_USB_DEVICE_MANAGER
+SPICE_TYPE_USB_DEVICE
SPICE_TYPE_USB_DEVICE_MANAGER
spice_usb_device_manager_get_type
spice_usb_device_get_type
commit 0795754fdce6e3ecd48fb34443218e52ee982043
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Tue Sep 22 11:27:25 2015 +0200
docs: Add Version Information section
diff --git a/doc/reference/spice-gtk-docs.xml b/doc/reference/spice-gtk-docs.xml
index 5faea74..de68004 100644
--- a/doc/reference/spice-gtk-docs.xml
+++ b/doc/reference/spice-gtk-docs.xml
@@ -53,6 +53,7 @@
<xi:include href="xml/smartcard-manager.xml"/>
<xi:include href="xml/usb-device-manager.xml"/>
<xi:include href="xml/spice-util.xml"/>
+ <xi:include href="xml/spice-version.xml"/>
<xi:include href="xml/spice-uri.xml"/>
</chapter>
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index a12183a..d8b835e 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -415,10 +415,6 @@ SpiceGtkBoxClass
spice_util_set_debug
spice_util_get_version_string
spice_uuid_to_string
-SPICE_GTK_CHECK_VERSION
-SPICE_GTK_MAJOR_VERSION
-SPICE_GTK_MICRO_VERSION
-SPICE_GTK_MINOR_VERSION
<SUBSECTION Private>
SPICE_DEBUG
spice_util_get_debug
@@ -428,6 +424,14 @@ spice_g_signal_connect_object
</SECTION>
<SECTION>
+<FILE>spice-version</FILE>
+SPICE_GTK_CHECK_VERSION
+SPICE_GTK_MAJOR_VERSION
+SPICE_GTK_MICRO_VERSION
+SPICE_GTK_MINOR_VERSION
+</SECTION>
+
+<SECTION>
<FILE>channel-port</FILE>
<TITLE>SpicePortChannel</TITLE>
SpicePortChannel
diff --git a/src/spice-version.h.in b/src/spice-version.h.in
index 4276a23..49164f8 100644
--- a/src/spice-version.h.in
+++ b/src/spice-version.h.in
@@ -21,6 +21,8 @@
/**
* SECTION:spice-version
* @short_description: Spice-Gtk version checking
+ * @title: Version Information
+ * @include: spice-version.h
*
* Spice-Gtk provides macros to check the version of the library
* at compile-time
commit d732f13ae6cdbbee42181596d9e1ba8d47f65fb3
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Wed Sep 16 16:17:31 2015 +0200
docs: Update for missing symbols
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 2f3e09e..a12183a 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -14,6 +14,9 @@ SPICE_IS_PLAYBACK_CHANNEL_CLASS
SPICE_PLAYBACK_CHANNEL_GET_CLASS
<SUBSECTION Private>
SpicePlaybackChannelPrivate
+spice_playback_channel_get_latency
+spice_playback_channel_is_active
+spice_playback_channel_sync_latency
</SECTION>
<SECTION>
@@ -63,6 +66,7 @@ SpiceMainChannelClass
<SUBSECTION>
spice_main_set_display
spice_main_set_display_enabled
+spice_main_update_display
spice_main_update_display_enabled
spice_main_send_monitor_config
spice_main_agent_test_capability
@@ -74,6 +78,8 @@ spice_main_clipboard_grab
spice_main_clipboard_release
spice_main_clipboard_notify
spice_main_clipboard_request
+spice_main_file_copy_async
+spice_main_file_copy_finish
<SUBSECTION Standard>
SPICE_MAIN_CHANNEL
SPICE_IS_MAIN_CHANNEL
@@ -119,6 +125,7 @@ SPICE_CHANNEL_GET_CLASS
<SUBSECTION Private>
SpiceMsgIn
SpiceMsgOut
+SpiceChannelClassPrivate
SpiceChannelPrivate
spice_msg_handler
spice_msg_in
@@ -150,6 +157,8 @@ SpiceAudioPrivate
<TITLE>SpiceDisplayChannel</TITLE>
SpiceDisplayChannel
SpiceDisplayChannelClass
+<SUBSECTION>
+spice_display_get_primary
<SUBSECTION Standard>
SPICE_DISPLAY_CHANNEL
SPICE_IS_DISPLAY_CHANNEL
@@ -405,6 +414,7 @@ SpiceGtkBoxClass
<FILE>spice-util</FILE>
spice_util_set_debug
spice_util_get_version_string
+spice_uuid_to_string
SPICE_GTK_CHECK_VERSION
SPICE_GTK_MAJOR_VERSION
SPICE_GTK_MICRO_VERSION
commit 339322adf4eedfe16c2481cdae724cc28e3facfe
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Thu Sep 24 17:59:42 2015 +0200
channel-main: Rename parameter to match docs
diff --git a/src/spice-widget.c b/src/spice-widget.c
index 34bc128..fdaf6d6 100644
--- a/src/spice-widget.c
+++ b/src/spice-widget.c
@@ -2537,10 +2537,10 @@ static void channel_destroy(SpiceSession *s, SpiceChannel *channel, gpointer dat
*
* Returns: a new #SpiceDisplay widget.
**/
-SpiceDisplay *spice_display_new(SpiceSession *session, int id)
+SpiceDisplay *spice_display_new(SpiceSession *session, int channel_id)
{
return g_object_new(SPICE_TYPE_DISPLAY, "session", session,
- "channel-id", id, NULL);
+ "channel-id", channel_id, NULL);
}
/**
commit 82e06cea4819b3774088659aa8d272d1e77f7018
Author: Pavel Grunt <pgrunt at redhat.com>
Date: Tue Sep 22 18:43:52 2015 +0200
channel-record: Use correct nick name for property
diff --git a/src/channel-record.c b/src/channel-record.c
index d07d84e..e581aed 100644
--- a/src/channel-record.c
+++ b/src/channel-record.c
@@ -200,8 +200,8 @@ static void spice_record_channel_class_init(SpiceRecordChannelClass *klass)
g_object_class_install_property
(gobject_class, PROP_VOLUME,
g_param_spec_pointer("volume",
- "Playback volume",
- "",
+ "Record volume",
+ "Record volume",
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
More information about the Spice-commits
mailing list