summaryrefslogtreecommitdiffstats
path: root/doc/reference
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2012-03-20 01:13:40 +0100
committerMarc-André Lureau <marcandre.lureau@redhat.com>2012-03-20 02:15:21 +0100
commitb9b658f6ea41a2473853149b41fef2cb808ec4f2 (patch)
treed40d90de91e9266ab78416588bf0916789b5b375 /doc/reference
parent126794d3014df5b0759b02b679e0ca86ba8fc9bc (diff)
downloadspice-gtk-b9b658f6ea41a2473853149b41fef2cb808ec4f2.tar.gz
spice-gtk-b9b658f6ea41a2473853149b41fef2cb808ec4f2.tar.xz
spice-gtk-b9b658f6ea41a2473853149b41fef2cb808ec4f2.zip
doc: gtk-doc cleanup
Fix all the unused symbols and a few warnings (a lot left)
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/Makefile.am114
-rw-r--r--doc/reference/spice-gtk-sections.txt39
2 files changed, 66 insertions, 87 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 2549119..372850a 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,113 +1,63 @@
-## Process this file with automake to produce Makefile.in
+NULL =
-# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.6
+DOC_MODULE = spice-gtk
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
+# The top-level SGML file
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=spice-gtk
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=2
-
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# Directories containing the source code, relative to $(srcdir).
-# gtk-doc will search all .c and .h files beneath these paths
-# for inline comments documenting functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
-DOC_SOURCE_DIR=../../gtk
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
+# Source code location
+DOC_SOURCE_DIR = $(top_srcdir)/gtk
# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS= \
+SCAN_OPTIONS = \
--deprecated-guards="SPICE_DISABLE_DEPRECATED" \
--ignore-decorators="G_GNUC_INTERNAL"
# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--xml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+MKDB_OPTIONS = --xml-mode --output-format=xml
# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/gtk/*.h
-CFILE_GLOB=$(top_srcdir)/gtk/*.c
-
-# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
-# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
-EXTRA_HFILES=
+HFILE_GLOB = $(top_srcdir)/gtk/*.h
+CFILE_GLOB = $(top_srcdir)/gtk/*.c
# Header files to ignore when scanning. Use base file name, no paths
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= \
- spice-display-mjpeg.h \
+IGNORE_HFILES= \
+ bio-gsocket.h \
channel-display-priv.h \
- spice-channel-priv.h \
+ channel-usbredir-priv.h \
continuation.h \
+ controller \
coroutine.h \
decode.h \
+ display \
gio-coroutine.h \
+ glib-compat.h \
+ smartcard-manager-priv.h \
+ spice-audio-priv.h \
spice-channel-cache.h \
+ spice-channel-priv.h \
+ spice-cmdline.h \
+ spice-common.h \
+ spice-gstaudio.h \
+ spice-gtk-session-priv.h \
spice-marshal.h \
spice-pulse.h \
spice-session-priv.h \
- spice-types.h \
- spice-cmdline.h \
- tcp.h \
- vncdisplaykeymap.h
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=
+ spice-util-priv.h \
+ spice-widget-priv.h \
+ usb-acl-helper.h \
+ usb-device-manager-priv.h \
+ usbutil.h \
+ vncdisplaykeymap.h \
+ $(NULL)
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) -I$(top_srcdir)/gtk -I$(top_builddir)/gtk $(SPICE_GLIB_CFLAGS) $(SPICE_GTK_CFLAGS)
-GTKDOC_LIBS=$(top_builddir)/gtk/libspice-client-glib-2.0.la $(top_builddir)/gtk/libspice-client-gtk-$(SPICE_GTK_API_VERSION).la
+GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir) -I$(top_srcdir)/gtk -I$(top_builddir)/gtk $(SPICE_GLIB_CFLAGS) $(SPICE_GTK_CFLAGS)
+GTKDOC_LIBS = $(top_builddir)/gtk/libspice-client-glib-2.0.la $(top_builddir)/gtk/libspice-client-gtk-$(SPICE_GTK_API_VERSION).la
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
# Comment this out if you want 'make check' to test you doc status
# and run some sanity checks
if ENABLE_GTK_DOC
diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 3e5ce0b..a339d32 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -3,6 +3,7 @@
<TITLE>SpicePlaybackChannel</TITLE>
SpicePlaybackChannel
SpicePlaybackChannelClass
+spice_playback_channel_set_delay
<SUBSECTION Standard>
SPICE_PLAYBACK_CHANNEL
SPICE_IS_PLAYBACK_CHANNEL
@@ -25,11 +26,17 @@ spice_session_connect
spice_session_open_fd
spice_session_disconnect
spice_session_get_channels
+spice_session_get_read_only
+spice_session_has_channel_type
<SUBSECTION>
SpiceSessionMigration
SpiceSessionVerify
spice_get_option_group
spice_set_session_option
+<SUBSECTION>
+SpiceClientError
+SPICE_CLIENT_ERROR
+spice_client_error_quark
<SUBSECTION Standard>
SPICE_SESSION
SPICE_IS_SESSION
@@ -40,6 +47,10 @@ SPICE_IS_SESSION_CLASS
SPICE_SESSION_GET_CLASS
SPICE_TYPE_SESSION_VERIFY
spice_session_verify_get_type
+SPICE_TYPE_SESSION_MIGRATION
+spice_session_migration_get_type
+<SUBSECTION Private>
+SpiceSessionPrivate
</SECTION>
<SECTION>
@@ -48,8 +59,9 @@ spice_session_verify_get_type
SpiceMainChannel
SpiceMainChannelClass
<SUBSECTION>
-spice_main_channel
spice_main_set_display
+spice_main_set_display_enabled
+spice_main_send_monitor_config
spice_main_agent_test_capability
spice_main_clipboard_selection_grab
spice_main_clipboard_selection_notify
@@ -67,13 +79,14 @@ spice_main_channel_get_type
SPICE_MAIN_CHANNEL_CLASS
SPICE_IS_MAIN_CHANNEL_CLASS
SPICE_MAIN_CHANNEL_GET_CLASS
+<SUBSECTION Private>
+SpiceMainChannelPrivate
</SECTION>
<SECTION>
<FILE>spice-channel</FILE>
<TITLE>SpiceChannel</TITLE>
SpiceChannelEvent
-SpiceChannelVerify
SpiceChannel
SpiceChannelClass
<SUBSECTION>
@@ -83,6 +96,8 @@ spice_channel_connect
spice_channel_open_fd
spice_channel_disconnect
spice_channel_test_capability
+spice_channel_test_common_capability
+spice_channel_type_to_string
spice_channel_set_capability
<SUBSECTION Standard>
SPICE_TYPE_CHANNEL_EVENT
@@ -95,6 +110,9 @@ SPICE_CHANNEL_CLASS
SPICE_IS_CHANNEL_CLASS
SPICE_CHANNEL_GET_CLASS
<SUBSECTION Private>
+SpiceMsgIn
+SpiceMsgOut
+SpiceChannelPrivate
spice_msg_handler
spice_msg_in
spice_msg_out
@@ -106,6 +124,7 @@ spice_msg_out
SpiceAudio
SpiceAudioClass
<SUBSECTION>
+spice_audio_get
spice_audio_new
<SUBSECTION Standard>
SPICE_AUDIO
@@ -115,6 +134,8 @@ spice_audio_get_type
SPICE_AUDIO_CLASS
SPICE_IS_AUDIO_CLASS
SPICE_AUDIO_GET_CLASS
+<SUBSECTION Private>
+SpiceAudioPrivate
</SECTION>
<SECTION>
@@ -268,10 +289,13 @@ SpiceUsbDeviceManagerClass
spice_usb_device_manager_get
spice_usb_device_manager_get_devices
spice_usb_device_manager_is_device_connected
-spice_usb_device_manager_connect_device
spice_usb_device_manager_disconnect_device
-spice_usb_device_get_description
+spice_usb_device_manager_can_redirect_device
+spice_usb_device_manager_connect_device_async
+spice_usb_device_manager_connect_device_finish
+<SUBSECTION>
SpiceUsbDevice
+spice_usb_device_get_description
<SUBSECTION Standard>
SPICE_USB_DEVICE_MANAGER
SPICE_IS_USB_DEVICE_MANAGER
@@ -302,7 +326,7 @@ SPICE_GTK_SESSION_CLASS
SPICE_IS_GTK_SESSION_CLASS
SPICE_GTK_SESSION_GET_CLASS
<SUBSECTION Private>
-SpiceGtkSectionPrivate
+SpiceGtkSessionPrivate
</SECTION>
<SECTION>
@@ -356,8 +380,11 @@ spice_usb_device_widget_get_type
SPICE_USB_DEVICE_WIDGET_CLASS
SPICE_IS_USB_DEVICE_WIDGET_CLASS
SPICE_USB_DEVICE_WIDGET_GET_CLASS
+SPICE_TYPE_USB_DEVICE_WIDGET
<SUBSECTION Private>
SpiceUsbDeviceWidgetPrivate
+SpiceGtkBox
+SpiceGtkBoxClass
</SECTION>
<SECTION>
@@ -368,5 +395,7 @@ spice_util_get_version_string
SPICE_DEBUG
spice_util_get_debug
SPICE_RESERVED_PADDING
+SPICE_DEPRECATED_FOR
+spice_g_signal_connect_object
</SECTION>