[telepathy-glib/master] document tube new API

Guillaume Desmottes guillaume.desmottes at collabora.co.uk
Wed May 27 05:46:20 PDT 2009 

---
 docs/reference/telepathy-glib-docs.sgml    |    2 +
 docs/reference/telepathy-glib-sections.txt |   87 ++++++++++++++++++++++++++++
 telepathy-glib/extra-gtkdoc.h              |   23 +++++++
 3 files changed, 112 insertions(+), 0 deletions(-)

diff --git a/docs/reference/telepathy-glib-docs.sgml b/docs/reference/telepathy-glib-docs.sgml
index 7987ad9..1ddb54b 100644
--- a/docs/reference/telepathy-glib-docs.sgml
+++ b/docs/reference/telepathy-glib-docs.sgml
@@ -43,6 +43,7 @@
     <xi:include href="xml/channel-media.xml"/>
     <xi:include href="xml/channel-file-transfer.xml"/>
     <xi:include href="xml/channel-tubes.xml"/>
+    <xi:include href="xml/channel-tube.xml"/>
     <xi:include href="xml/channel-roomlist.xml"/>
     <xi:include href="xml/media-interfaces.xml"/>
   </chapter>
@@ -58,6 +59,7 @@
     <xi:include href="xml/svc-channel-media.xml"/>
     <xi:include href="xml/svc-channel-file-transfer.xml"/>
     <xi:include href="xml/svc-channel-tubes.xml"/>
+    <xi:include href="xml/svc-channel-tube.xml"/>
     <xi:include href="xml/svc-channel-roomlist.xml"/>
     <xi:include href="xml/svc-connection.xml"/>
     <xi:include href="xml/svc-media-interfaces.xml"/>
diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
index fd2eaf3..d7eb70d 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib-sections.txt
@@ -484,6 +484,51 @@ TP_TYPE_SVC_CHANNEL_TYPE_TUBES
 </SECTION>
 
 <SECTION>
+<INCLUDE>telepathy-glib/svc-channel.h</INCLUDE>
+<TITLE>svc-channel-tube</TITLE>
+<FILE>svc-channel-tube</FILE>
+TpSvcChannelInterfaceTube
+TpSvcChannelInterfaceTubeClass
+tp_svc_channel_interface_tube_emit_tube_channel_state_changed
+TpSvcChannelTypeStreamTube
+TpSvcChannelTypeStreamTubeClass
+tp_svc_channel_type_stream_tube_offer_impl
+tp_svc_channel_type_stream_tube_implement_offer
+tp_svc_channel_type_stream_tube_return_from_offer
+tp_svc_channel_type_stream_tube_accept_impl
+tp_svc_channel_type_stream_tube_implement_accept
+tp_svc_channel_type_stream_tube_return_from_accept
+tp_svc_channel_type_stream_tube_emit_new_remote_connection
+tp_svc_channel_type_stream_tube_emit_new_local_connection
+tp_svc_channel_type_stream_tube_emit_connection_closed
+TpSvcChannelTypeDBusTube
+TpSvcChannelTypeDBusTubeClass
+tp_svc_channel_type_dbus_tube_offer_impl
+tp_svc_channel_type_dbus_tube_implement_offer
+tp_svc_channel_type_dbus_tube_return_from_offer
+tp_svc_channel_type_dbus_tube_accept_impl
+tp_svc_channel_type_dbus_tube_implement_accept
+tp_svc_channel_type_dbus_tube_return_from_accept
+tp_svc_channel_type_dbus_tube_emit_dbus_names_changed
+<SUBSECTION Standard>
+TP_TYPE_SVC_CHANNEL_INTERFACE_TUBE
+TP_SVC_CHANNEL_INTERFACE_TUBE
+TP_IS_SVC_CHANNEL_INTERFACE_TUBE
+tp_svc_channel_interface_tube_get_type
+TP_SVC_CHANNEL_INTERFACE_TUBE_GET_CLASS
+TP_SVC_CHANNEL_TYPE_STREAM_TUBE
+TP_IS_SVC_CHANNEL_TYPE_STREAM_TUBE
+TP_TYPE_SVC_CHANNEL_TYPE_STREAM_TUBE
+tp_svc_channel_type_stream_tube_get_type
+TP_SVC_CHANNEL_TYPE_STREAM_TUBE_GET_CLASS
+TP_SVC_CHANNEL_TYPE_DBUS_TUBE
+TP_IS_SVC_CHANNEL_TYPE_DBUS_TUBE
+TP_TYPE_SVC_CHANNEL_TYPE_DBUS_TUBE
+tp_svc_channel_type_dbus_tube_get_type
+TP_SVC_CHANNEL_TYPE_DBUS_TUBE_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>svc-channel-roomlist</FILE>
 <TITLE>svc-channel-roomlist</TITLE>
 <INCLUDE>telepathy-glib/svc-channel.h</INCLUDE>
@@ -1088,6 +1133,9 @@ TP_ARRAY_TYPE_TUBE_INFO_LIST
 TP_STRUCT_TYPE_DBUS_TUBE_MEMBER
 TP_ARRAY_TYPE_DBUS_TUBE_MEMBER_LIST
 <SUBSECTION>
+# Channel - DBusTube
+TP_HASH_TYPE_DBUS_TUBE_PARTICIPANTS
+<SUBSECTION>
 # Properties
 TP_STRUCT_TYPE_PROPERTY_SPEC
 TP_ARRAY_TYPE_PROPERTY_SPEC_LIST
@@ -1797,6 +1845,8 @@ TpFileTransferState
 NUM_TP_FILE_TRANSFER_STATES
 TpFileTransferStateChangeReason
 NUM_TP_FILE_TRANSFER_STATE_CHANGE_REASONS
+TpTubeChannelState
+NUM_TP_TUBE_CHANNEL_STATES
 </SECTION>
 
 <SECTION>
@@ -1843,6 +1893,12 @@ TP_IFACE_CHANNEL_TYPE_TEXT
 TP_IFACE_QUARK_CHANNEL_TYPE_TEXT
 TP_IFACE_CHANNEL_TYPE_TUBES
 TP_IFACE_QUARK_CHANNEL_TYPE_TUBES
+TP_IFACE_CHANNEL_INTERFACE_TUBE
+TP_IFACE_CHANNEL_TYPE_DBUS_TUBE
+TP_IFACE_CHANNEL_TYPE_STREAM_TUBE
+TP_IFACE_QUARK_CHANNEL_INTERFACE_TUBE
+TP_IFACE_QUARK_CHANNEL_TYPE_DBUS_TUBE
+TP_IFACE_QUARK_CHANNEL_TYPE_STREAM_TUBE
 TP_IFACE_CHANNEL_INTERFACE_CALL_STATE
 TP_IFACE_QUARK_CHANNEL_INTERFACE_CALL_STATE
 TP_IFACE_CHANNEL_INTERFACE_CHAT_STATE
@@ -1886,6 +1942,9 @@ tp_iface_quark_channel_type_room_list
 tp_iface_quark_channel_type_streamed_media
 tp_iface_quark_channel_type_text
 tp_iface_quark_channel_type_tubes
+tp_iface_quark_channel_interface_tube
+tp_iface_quark_channel_type_dbus_tube
+tp_iface_quark_channel_type_stream_tube
 tp_iface_quark_connection
 tp_iface_quark_connection_interface_aliasing
 tp_iface_quark_connection_interface_avatars
@@ -2285,6 +2344,34 @@ tp_cli_channel_type_tubes_signal_callback_tube_state_changed
 </SECTION>
 
 <SECTION>
+<FILE>channel-tube</FILE>
+<TITLE>channel-tube</TITLE>
+<INCLUDE>telepathy-glib/channel.h</INCLUDE>
+tp_cli_channel_interface_tube_connect_to_tube_channel_state_changed
+tp_cli_channel_interface_tube_signal_callback_tube_channel_state_changed
+tp_cli_channel_type_stream_tube_run_offer
+tp_cli_channel_type_stream_tube_run_accept
+tp_cli_channel_type_stream_tube_call_offer
+tp_cli_channel_type_stream_tube_call_accept
+tp_cli_channel_type_stream_tube_callback_for_offer
+tp_cli_channel_type_stream_tube_callback_for_accept
+tp_cli_channel_type_stream_tube_connect_to_new_remote_connection
+tp_cli_channel_type_stream_tube_connect_to_new_local_connection
+tp_cli_channel_type_stream_tube_connect_to_connection_closed
+tp_cli_channel_type_stream_tube_signal_callback_new_remote_connection
+tp_cli_channel_type_stream_tube_signal_callback_new_local_connection
+tp_cli_channel_type_stream_tube_signal_callback_connection_closed
+tp_cli_channel_type_dbus_tube_run_offer
+tp_cli_channel_type_dbus_tube_run_accept
+tp_cli_channel_type_dbus_tube_call_offer
+tp_cli_channel_type_dbus_tube_call_accept
+tp_cli_channel_type_dbus_tube_callback_for_offer
+tp_cli_channel_type_dbus_tube_callback_for_accept
+tp_cli_channel_type_dbus_tube_connect_to_dbus_names_changed
+tp_cli_channel_type_dbus_tube_signal_callback_dbus_names_changed
+</SECTION>
+
+<SECTION>
 <FILE>channel-roomlist</FILE>
 <TITLE>channel-roomlist</TITLE>
 <INCLUDE>telepathy-glib/channel.h</INCLUDE>
diff --git a/telepathy-glib/extra-gtkdoc.h b/telepathy-glib/extra-gtkdoc.h
index 0dd6523..cb637b0 100644
--- a/telepathy-glib/extra-gtkdoc.h
+++ b/telepathy-glib/extra-gtkdoc.h
@@ -141,6 +141,17 @@
  */
 
 /**
+ * SECTION:svc-channel-tube
+ * @title: Tube channels
+ * @short_description: service-side interface for the Tube channel interface,
+ *  StreamTube channel type and DBusTube channel type.
+ *
+ * A "tube" is a mechanism for arbitrary data transfer.
+ * This section documents the auto-generated C wrappers for the Tube
+ * channel interface, StreamTube channel type and DBusTube channel type.
+ */
+
+/**
  * SECTION:svc-channel-contactlist
  * @title: Contact List channels
  * @short_description: service-side interface for the Contact List channel type
@@ -371,6 +382,18 @@
  */
 
 /**
+ * SECTION:channel-tube
+ * @title: Tube channels
+ * @short_description: client-side wrappers for the Tube channel interface,
+ *  StreamTube channel type and DBusTube channel type.
+ * @see_also: channel-group
+ *
+ * A "tube" is a mechanism for arbitrary data transfer.
+ * This section documents the auto-generated C wrappers for the Tube
+ * channel interface, StreamTube channel type and DBusTube channel type.
+ */
+
+/**
  * SECTION:channel-roomlist
  * @title: Room List channels
  * @short_description: client-side wrappers for the Room List channel type
-- 
1.5.6.5

More information about the telepathy-commits mailing list