pxcloud/spice-gtk
5
0
Fork 0
mirror of https://gitlab.uni-freiburg.de/opensourcevdi/spice-gtk synced 2026-01-07 20:30:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

gtk/doc: improve the generated gtk-doc a bit

Browse Source
This commit is contained in:
Marc-André Lureau 2011-07-13 19:00:29 +02:00 committed by Marc-André Lureau
parent 2f7b91ae99
commit fd0c76a889
7 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/reference/spice-gtk-docs.xml
View File

@ -35,7 +35,6 @@
<xi:include href="xml/channel-playback.xml"/>
<xi:include href="xml/channel-record.xml"/>
<xi:include href="xml/channel-smartcard.xml"/>
<xi:include href="xml/smartcard-manager.xml"/>
</chapter>
<chapter>
@ -46,6 +45,7 @@
<chapter id="application-support">
<title>Application Support, from spice-client-glib</title>
<xi:include href="xml/spice-audio.xml"/>
<xi:include href="xml/smartcard-manager.xml"/>
<xi:include href="xml/spice-util.xml"/>
</chapter>

19
doc/reference/spice-gtk-sections.txt
View File

@ -45,6 +45,7 @@ spice_session_verify_get_type
<TITLE>SpiceMainChannel</TITLE>
SpiceMainChannel
SpiceMainChannelClass
<SUBSECTION>
spice_main_channel
spice_main_set_display
spice_main_clipboard_grab
@ -68,6 +69,7 @@ SpiceChannelEvent
SpiceChannelVerify
SpiceChannel
SpiceChannelClass
<SUBSECTION>
spice_channel_new
spice_channel_destroy
spice_channel_connect
@ -96,6 +98,7 @@ spice_msg_out
<TITLE>SpiceAudio</TITLE>
SpiceAudio
SpiceAudioClass
<SUBSECTION>
spice_audio_new
<SUBSECTION Standard>
SPICE_AUDIO
@ -146,6 +149,7 @@ spice_cursor_channel
<TITLE>SpiceRecordChannel</TITLE>
SpiceRecordChannel
SpiceRecordChannelClass
<SUBSECTION>
spice_record_send_data
<SUBSECTION Standard>
SPICE_RECORD_CHANNEL
@ -165,6 +169,7 @@ spice_record_channel
SpiceInputsChannel
SpiceInputsChannelClass
SpiceInputsLock
<SUBSECTION>
spice_inputs_motion
spice_inputs_position
spice_inputs_button_press
@ -189,7 +194,6 @@ spice_inputs_channel
<SECTION>
<FILE>channel-smartcard</FILE>
<TITLE>SpiceSmartcardChannel</TITLE>
spice_smartcard_channel
SpiceSmartcardChannel
SpiceSmartcardChannelClass
<SUBSECTION Standard>
@ -200,21 +204,22 @@ spice_smartcard_channel_get_type
SPICE_SMARTCARD_CHANNEL_CLASS
SPICE_IS_SMARTCARD_CHANNEL_CLASS
SPICE_SMARTCARD_CHANNEL_GET_CLASS
<SUBSECTION Private>
spice_smartcard_channel
</SECTION>
<SECTION>
<FILE>smartcard-manager</FILE>
<TITLE>SpiceSmartcardManager</TITLE>
SPICE_TYPE_SMARTCARD_READER
spice_smartcard_manager
SpiceSmartcardManager
SpiceSmartcardManagerClass
spice_smartcard_reader_get_type
SpiceSmartcardReader
<SUBSECTION>
spice_smartcard_manager_get
spice_smartcard_manager_insert_card
spice_smartcard_manager_remove_card
<SUBSECTION>
spice_smartcard_reader_is_software
SpiceSmartcardReader
<SUBSECTION Standard>
SPICE_SMARTCARD_MANAGER
SPICE_IS_SMARTCARD_MANAGER
@ -223,6 +228,10 @@ spice_smartcard_manager_get_type
SPICE_SMARTCARD_MANAGER_CLASS
SPICE_IS_SMARTCARD_MANAGER_CLASS
SPICE_SMARTCARD_MANAGER_GET_CLASS
SPICE_TYPE_SMARTCARD_READER
spice_smartcard_reader_get_type
<SUBSECTION Private>
spice_smartcard_manager
</SECTION>
<SECTION>

5
doc/reference/spice-gtk.types
View File

@ -11,8 +11,10 @@
#include "channel-inputs.h"
#include "channel-playback.h"
#include "channel-record.h"
#include "channel-smartcard.h"
#include "spice-widget.h"
#include "spice-grabsequence.h"
#include "smartcard-manager.h"
spice_audio_get_type
spice_channel_event_get_type
@ -28,3 +30,6 @@ spice_playback_channel_get_type
spice_record_channel_get_type
spice_session_get_type
spice_session_verify_get_type
spice_smartcard_channel_get_type
spice_smartcard_manager_get_type
spice_session_verify_get_type

2
gtk/channel-smartcard.c
View File

@ -34,7 +34,7 @@
* @title: Smartcard Channel
* @section_id:
* @see_also: #SpiceSmartcardManager, #SpiceSession
* @stability: In Development
* @stability: API Stable (channel in development)
* @include: channel-smartcard.h
*
* The Spice protocol defines a set of messages to forward smartcard

2
gtk/channel-smartcard.h
View File

@ -35,6 +35,8 @@ typedef struct spice_smartcard_channel spice_smartcard_channel;
struct _SpiceSmartcardChannel {
SpiceChannel parent;
/*< private >*/
spice_smartcard_channel *priv;
/* Do not add fields to this struct */
};

2
gtk/smartcard-manager.c
View File

@ -34,7 +34,7 @@
/**
* SECTION:smartcard-manager
* @short_description: smartcard management
* @title: Spice SmartcardManager
* @title: Spice Smartcard Manager
* @section_id:
* @see_also:
* @stability: Stable

4
gtk/smartcard-manager.h
View File

@ -41,6 +41,8 @@ typedef struct _SpiceSmartcardReader SpiceSmartcardReader;
struct _SpiceSmartcardManager
{
GObject parent;
/*< private >*/
spice_smartcard_manager *priv;
/* Do not add fields to this struct */
};
@ -54,6 +56,8 @@ struct _SpiceSmartcardManagerClass
void (*reader_removed)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader);
void (*card_inserted)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader);
void (*card_removed)(SpiceSmartcardManager *manager, SpiceSmartcardReader *reader );
/*< private >*/
/*
* If adding fields to this struct, remove corresponding
* amount of padding to avoid changing overall struct size