diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2011-08-31 14:27:04 +0200 |
---|---|---|
committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2011-08-31 14:28:12 +0200 |
commit | 097356b437432167cef5ba2da506ee3ad99469f2 (patch) | |
tree | f9fa10d86a09b33de0c948e082a13f445364ef9b | |
parent | 4479fc4eb5c8bf5219f902fafe4740909da0e5a2 (diff) |
doc: various improvements
-rw-r--r-- | doc/reference/spice-gtk-sections.txt | 22 | ||||
-rw-r--r-- | gtk/channel-cursor.h | 18 | ||||
-rw-r--r-- | gtk/channel-display.h | 18 | ||||
-rw-r--r-- | gtk/channel-inputs.h | 15 | ||||
-rw-r--r-- | gtk/channel-main.h | 16 | ||||
-rw-r--r-- | gtk/channel-playback.h | 17 | ||||
-rw-r--r-- | gtk/channel-record.h | 17 | ||||
-rw-r--r-- | gtk/channel-smartcard.h | 12 | ||||
-rw-r--r-- | gtk/channel-usbredir.h | 12 | ||||
-rw-r--r-- | gtk/smartcard-manager.c | 4 | ||||
-rw-r--r-- | gtk/spice-audio.h | 12 | ||||
-rw-r--r-- | gtk/usb-device-manager.h | 18 |
12 files changed, 169 insertions, 12 deletions
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt index b4fd817..4ac8576 100644 --- a/doc/reference/spice-gtk-sections.txt +++ b/doc/reference/spice-gtk-sections.txt @@ -12,7 +12,7 @@ SPICE_PLAYBACK_CHANNEL_CLASS SPICE_IS_PLAYBACK_CHANNEL_CLASS SPICE_PLAYBACK_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_playback_channel +SpicePlaybackChannelPrivate </SECTION> <SECTION> @@ -26,6 +26,8 @@ spice_session_open_fd spice_session_disconnect spice_session_get_channels <SUBSECTION> +SpiceSessionMigration +SpiceSessionVerify spice_get_option_group spice_set_session_option <SUBSECTION Standard> @@ -48,6 +50,10 @@ SpiceMainChannelClass <SUBSECTION> spice_main_channel spice_main_set_display +spice_main_clipboard_selection_grab +spice_main_clipboard_selection_notify +spice_main_clipboard_selection_release +spice_main_clipboard_selection_request spice_main_clipboard_grab spice_main_clipboard_release spice_main_clipboard_notify @@ -124,7 +130,7 @@ SPICE_DISPLAY_CHANNEL_CLASS SPICE_IS_DISPLAY_CHANNEL_CLASS SPICE_DISPLAY_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_display_channel +SpiceDisplayChannelPrivate </SECTION> <SECTION> @@ -141,7 +147,7 @@ SPICE_CURSOR_CHANNEL_CLASS SPICE_IS_CURSOR_CHANNEL_CLASS SPICE_CURSOR_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_cursor_channel +SpiceCursorChannelPrivate </SECTION> <SECTION> @@ -160,7 +166,7 @@ SPICE_RECORD_CHANNEL_CLASS SPICE_IS_RECORD_CHANNEL_CLASS SPICE_RECORD_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_record_channel +SpiceRecordChannelPrivate </SECTION> <SECTION> @@ -188,7 +194,7 @@ SPICE_INPUTS_CHANNEL_CLASS SPICE_IS_INPUTS_CHANNEL_CLASS SPICE_INPUTS_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_inputs_channel +SpiceInputsChannelPrivate </SECTION> <SECTION> @@ -205,7 +211,7 @@ SPICE_SMARTCARD_CHANNEL_CLASS SPICE_IS_SMARTCARD_CHANNEL_CLASS SPICE_SMARTCARD_CHANNEL_GET_CLASS <SUBSECTION Private> -spice_smartcard_channel +SpiceSmartcardChannelPrivate </SECTION> <SECTION> @@ -231,7 +237,7 @@ SPICE_SMARTCARD_MANAGER_GET_CLASS SPICE_TYPE_SMARTCARD_READER spice_smartcard_reader_get_type <SUBSECTION Private> -spice_smartcard_manager +SpiceSmartcardManagerPrivate </SECTION> <SECTION> @@ -313,7 +319,7 @@ spice_grab_sequence_get_type SPICE_TYPE_DISPLAY_KEY_EVENT spice_display_key_event_get_type <SUBSECTION Private> -spice_display +SpiceDisplayPrivate </SECTION> <SECTION> diff --git a/gtk/channel-cursor.h b/gtk/channel-cursor.h index 4f44d16..6c9e72d 100644 --- a/gtk/channel-cursor.h +++ b/gtk/channel-cursor.h @@ -33,12 +33,30 @@ typedef struct _SpiceCursorChannel SpiceCursorChannel; typedef struct _SpiceCursorChannelClass SpiceCursorChannelClass; typedef struct _SpiceCursorChannelPrivate SpiceCursorChannelPrivate; +/** + * SpiceCursorChannel: + * @parent: Parent instance. + * + * The #SpiceCursorChannel struct is opaque and should not be accessed directly. + */ struct _SpiceCursorChannel { SpiceChannel parent; + + /*< private >*/ SpiceCursorChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpiceCursorChannelClass: + * @parent_class: Parent class. + * @cursor_set: Signal class handler for the #SpiceCursorChannel::cursor-set signal. + * @cursor_move: Signal class handler for the #SpiceCursorChannel::cursor-move signal. + * @cursor_hide: Signal class handler for the #SpiceCursorChannel::cursor-hide signal. + * @cursor_reset: Signal class handler for the #SpiceCursorChannel::cursor-reset signal. + * + * Class structure for #SpiceCursorChannel. + */ struct _SpiceCursorChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-display.h b/gtk/channel-display.h index bccf78c..db72fc9 100644 --- a/gtk/channel-display.h +++ b/gtk/channel-display.h @@ -33,12 +33,30 @@ typedef struct _SpiceDisplayChannel SpiceDisplayChannel; typedef struct _SpiceDisplayChannelClass SpiceDisplayChannelClass; typedef struct _SpiceDisplayChannelPrivate SpiceDisplayChannelPrivate; +/** + * SpiceDisplayChannel: + * @parent: Parent instance. + * + * The #SpiceDisplayChannel struct is opaque and should not be accessed directly. + */ struct _SpiceDisplayChannel { SpiceChannel parent; + + /*< private >*/ SpiceDisplayChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpiceDisplayChannelClass: + * @parent_class: Parent class. + * @display_primary_create: Signal class handler for the #SpiceDisplayChannel::display-primary-create signal. + * @display_primary_destroy: Signal class handler for the #SpiceDisplayChannel::display-primary-destroy signal. + * @display_invalidate: Signal class handler for the #SpiceDisplayChannel::display-invalidate signal. + * @display_mark: Signal class handler for the #SpiceDisplayChannel::display-mark signal. + * + * Class structure for #SpiceDisplayChannel. + */ struct _SpiceDisplayChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-inputs.h b/gtk/channel-inputs.h index bd3923b..64f3e5b 100644 --- a/gtk/channel-inputs.h +++ b/gtk/channel-inputs.h @@ -39,12 +39,27 @@ typedef enum { SPICE_INPUTS_CAPS_LOCK = (1 << 2) } SpiceInputsLock; +/** + * SpiceInputsChannel: + * @parent: Parent instance. + * + * The #SpiceInputsChannel struct is opaque and should not be accessed directly. + */ struct _SpiceInputsChannel { SpiceChannel parent; + + /*< private >*/ SpiceInputsChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpiceInputsChannelClass: + * @parent_class: Parent class. + * @inputs_modifiers: Signal class handler for the #SpiceInputsChannel::inputs-modifiers signal. + * + * Class structure for #SpiceInputsChannel. + */ struct _SpiceInputsChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-main.h b/gtk/channel-main.h index d34993b..f1ab6ae 100644 --- a/gtk/channel-main.h +++ b/gtk/channel-main.h @@ -33,12 +33,28 @@ typedef struct _SpiceMainChannel SpiceMainChannel; typedef struct _SpiceMainChannelClass SpiceMainChannelClass; typedef struct _SpiceMainChannelPrivate SpiceMainChannelPrivate; +/** + * SpiceMainChannel: + * @parent: Parent instance. + * + * The #SpiceMainChannel struct is opaque and should not be accessed directly. + */ struct _SpiceMainChannel { SpiceChannel parent; + + /*< private >*/ SpiceMainChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpiceMainChannelClass: + * @parent_class: Parent class. + * @mouse_update: Signal class handler for the #SpiceMainChannel::mouse-update signal. + * @agent_update: Signal class handler for the #SpiceMainChannel::agent-update signal. + * + * Class structure for #SpiceMainChannel. + */ struct _SpiceMainChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-playback.h b/gtk/channel-playback.h index 5e63c21..a1f0529 100644 --- a/gtk/channel-playback.h +++ b/gtk/channel-playback.h @@ -33,12 +33,29 @@ typedef struct _SpicePlaybackChannel SpicePlaybackChannel; typedef struct _SpicePlaybackChannelClass SpicePlaybackChannelClass; typedef struct _SpicePlaybackChannelPrivate SpicePlaybackChannelPrivate; +/** + * SpicePlaybackChannel: + * @parent: Parent instance. + * + * The #SpicePlaybackChannel struct is opaque and should not be accessed directly. + */ struct _SpicePlaybackChannel { SpiceChannel parent; + + /*< private >*/ SpicePlaybackChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpicePlaybackChannelClass: + * @parent_class: Parent class. + * @playback_start: Signal class handler for the #SpicePlaybackChannel::playback-start signal. + * @playback_data: Signal class handler for the #SpicePlaybackChannel::playback-data signal. + * @playback_stop: Signal class handler for the #SpicePlaybackChannel::playback-stop signal. + * + * Class structure for #SpicePlaybackChannel. + */ struct _SpicePlaybackChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-record.h b/gtk/channel-record.h index 0a6a7a7..26511cb 100644 --- a/gtk/channel-record.h +++ b/gtk/channel-record.h @@ -33,12 +33,29 @@ typedef struct _SpiceRecordChannel SpiceRecordChannel; typedef struct _SpiceRecordChannelClass SpiceRecordChannelClass; typedef struct _SpiceRecordChannelPrivate SpiceRecordChannelPrivate; +/** + * SpiceRecordChannel: + * @parent: Parent instance. + * + * The #SpiceRecordChannel struct is opaque and should not be accessed directly. + */ struct _SpiceRecordChannel { SpiceChannel parent; + + /*< private >*/ SpiceRecordChannelPrivate *priv; /* Do not add fields to this struct */ }; +/** + * SpiceRecordChannelClass: + * @parent_class: Parent class. + * @record_start: Signal class handler for the #SpiceRecordChannel::record-start signal. + * @record_stop: Signal class handler for the #SpiceRecordChannel::record-stop signal. + * @record_data: Unused (deprecated). + * + * Class structure for #SpiceRecordChannel. + */ struct _SpiceRecordChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-smartcard.h b/gtk/channel-smartcard.h index 146fef5..ec1ed2e 100644 --- a/gtk/channel-smartcard.h +++ b/gtk/channel-smartcard.h @@ -33,6 +33,12 @@ typedef struct _SpiceSmartcardChannel SpiceSmartcardChannel; typedef struct _SpiceSmartcardChannelClass SpiceSmartcardChannelClass; typedef struct _SpiceSmartcardChannelPrivate SpiceSmartcardChannelPrivate; +/** + * SpiceSmartcardChannel: + * @parent: Parent instance. + * + * The #SpiceSmartcardChannel struct is opaque and should not be accessed directly. + */ struct _SpiceSmartcardChannel { SpiceChannel parent; @@ -41,6 +47,12 @@ struct _SpiceSmartcardChannel { /* Do not add fields to this struct */ }; +/** + * SpiceSmartcardChannelClass: + * @parent_class: Parent class. + * + * Class structure for #SpiceSmartcardChannel. + */ struct _SpiceSmartcardChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/channel-usbredir.h b/gtk/channel-usbredir.h index ca0b535..c7263b9 100644 --- a/gtk/channel-usbredir.h +++ b/gtk/channel-usbredir.h @@ -36,6 +36,12 @@ typedef struct _SpiceUsbredirChannel SpiceUsbredirChannel; typedef struct _SpiceUsbredirChannelClass SpiceUsbredirChannelClass; typedef struct _SpiceUsbredirChannelPrivate SpiceUsbredirChannelPrivate; +/** + * SpiceUsbredirChannel: + * @parent: Parent instance. + * + * The #SpiceUsbredirChannel struct is opaque and should not be accessed directly. + */ struct _SpiceUsbredirChannel { SpiceChannel parent; @@ -44,6 +50,12 @@ struct _SpiceUsbredirChannel { /* Do not add fields to this struct */ }; +/** + * SpiceUsbredirChannelClass: + * @parent_class: Parent class. + * + * Class structure for #SpiceUsbredirChannel. + */ struct _SpiceUsbredirChannelClass { SpiceChannelClass parent_class; diff --git a/gtk/smartcard-manager.c b/gtk/smartcard-manager.c index a192bd6..067e14e 100644 --- a/gtk/smartcard-manager.c +++ b/gtk/smartcard-manager.c @@ -38,7 +38,7 @@ * @section_id: * @see_also: * @stability: Stable - * @include: spice-smartcard-manager.h + * @include: smartcard-manager.h * * #SpiceSmartcardManager monitors smartcard reader plugging/unplugging, * and smartcard insertions/removals. It also provides methods to handle @@ -531,7 +531,7 @@ gboolean spice_smartcard_manager_init_finish(SpiceSession *session, * @manager: a #SpiceSmartcardManager * * Simulates the insertion of a smartcard in the guest. Valid certificates - * must have been set in #SpiceSession::smartcard-certificates for software + * must have been set in #SpiceSession:smartcard-certificates for software * smartcard support to work. At the moment, only one software smartcard * reader is supported, that's why there is no parameter to indicate which * reader to insert the card in. diff --git a/gtk/spice-audio.h b/gtk/spice-audio.h index 272bb81..b881698 100644 --- a/gtk/spice-audio.h +++ b/gtk/spice-audio.h @@ -44,10 +44,22 @@ G_BEGIN_DECLS typedef struct _SpiceAudio SpiceAudio; typedef struct _SpiceAudioClass SpiceAudioClass; +/** + * SpiceAudio: + * @parent: Parent instance. + * + * The #SpiceAudio struct is opaque and should not be accessed directly. + */ struct _SpiceAudio { GObject parent; }; +/** + * SpiceAudioClass: + * @parent_class: Parent class. + * + * Class structure for #SpiceAudio. + */ struct _SpiceAudioClass { GObjectClass parent_class; diff --git a/gtk/usb-device-manager.h b/gtk/usb-device-manager.h index 855accb..03048f4 100644 --- a/gtk/usb-device-manager.h +++ b/gtk/usb-device-manager.h @@ -40,6 +40,12 @@ typedef struct _SpiceUsbDeviceManagerPrivate SpiceUsbDeviceManagerPrivate; typedef struct _SpiceUsbDevice SpiceUsbDevice; +/** + * SpiceUsbDeviceManager: + * @parent: Parent instance. + * + * The #SpiceUsbDeviceManager struct is opaque and should not be accessed directly. + */ struct _SpiceUsbDeviceManager { GObject parent; @@ -49,16 +55,24 @@ struct _SpiceUsbDeviceManager /* Do not add fields to this struct */ }; +/** + * SpiceUsbDeviceManagerClass: + * @parent_class: Parent class. + * @device_added: Signal class handler for the #SpiceUsbDeviceManager::device-added signal. + * @device_removed: Signal class handler for the #SpiceUsbDeviceManager::device-removed signal. + * + * Class structure for #SpiceUsbDeviceManager. + */ struct _SpiceUsbDeviceManagerClass { GObjectClass parent_class; - /*< public >*/ - /*< private >*/ + /* signals */ void (*device_added) (SpiceUsbDeviceManager *manager, SpiceUsbDevice *device); void (*device_removed) (SpiceUsbDeviceManager *manager, SpiceUsbDevice *device); + /*< private >*/ /* * If adding fields to this struct, remove corresponding * amount of padding to avoid changing overall struct size |