[telepathy-glib/master] Document the generated Location code

Simon McVittie simon.mcvittie at collabora.co.uk
Sun Aug 16 07:19:44 PDT 2009


---
 docs/reference/telepathy-glib-sections.txt |   45 ++++++++++++++++++++++++++++
 telepathy-glib/extra-gtkdoc.h              |   14 ++++++++
 2 files changed, 59 insertions(+), 0 deletions(-)

diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
index c303302..6951efd 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib-sections.txt
@@ -915,6 +915,25 @@ TP_IS_SVC_CONNECTION_INTERFACE_CAPABILITIES
 TP_TYPE_SVC_CONNECTION_INTERFACE_CAPABILITIES
 tp_svc_connection_interface_capabilities_get_type
 TP_SVC_CONNECTION_INTERFACE_CAPABILITIES_GET_CLASS
+<SUBSECTION>
+TpSvcConnectionInterfaceLocation
+TpSvcConnectionInterfaceLocationClass
+tp_svc_connection_interface_location_emit_location_updated
+tp_svc_connection_interface_location_get_locations_impl
+tp_svc_connection_interface_location_return_from_get_locations
+tp_svc_connection_interface_location_implement_get_locations
+tp_svc_connection_interface_location_request_location_impl
+tp_svc_connection_interface_location_return_from_request_location
+tp_svc_connection_interface_location_implement_request_location
+tp_svc_connection_interface_location_set_location_impl
+tp_svc_connection_interface_location_return_from_set_location
+tp_svc_connection_interface_location_implement_set_location
+<SUBSECTION Standard>
+TP_IS_SVC_CONNECTION_INTERFACE_LOCATION
+TP_SVC_CONNECTION_INTERFACE_LOCATION
+TP_SVC_CONNECTION_INTERFACE_LOCATION_GET_CLASS
+TP_TYPE_SVC_CONNECTION_INTERFACE_LOCATION
+tp_svc_connection_interface_location_get_type
 </SECTION>
 
 <SECTION>
@@ -1124,6 +1143,10 @@ TP_HASH_TYPE_STATUS_SPEC_MAP
 TP_STRUCT_TYPE_LAST_ACTIVITY_AND_STATUSES
 TP_STRUCT_TYPE_STATUS_SPEC
 <SUBSECTION>
+# Connection - Location
+TP_HASH_TYPE_LOCATION
+TP_HASH_TYPE_CONTACT_LOCATIONS
+<SUBSECTION>
 # Channel - Group
 TP_STRUCT_TYPE_LOCAL_PENDING_INFO
 TP_ARRAY_TYPE_LOCAL_PENDING_INFO_LIST
@@ -1913,6 +1936,8 @@ TP_IFACE_CONNECTION_INTERFACE_SIMPLE_PRESENCE
 TP_IFACE_QUARK_CONNECTION_INTERFACE_SIMPLE_PRESENCE
 TP_IFACE_CONNECTION_INTERFACE_PRESENCE
 TP_IFACE_QUARK_CONNECTION_INTERFACE_PRESENCE
+TP_IFACE_CONNECTION_INTERFACE_LOCATION
+TP_IFACE_QUARK_CONNECTION_INTERFACE_LOCATION
 TP_IFACE_CHANNEL
 TP_IFACE_QUARK_CHANNEL
 TP_IFACE_CHANNEL_TYPE_CONTACT_LIST
@@ -2017,6 +2042,7 @@ tp_iface_quark_connection_interface_capabilities
 tp_iface_quark_connection_interface_requests
 tp_iface_quark_connection_interface_simple_presence
 tp_iface_quark_connection_interface_presence
+tp_iface_quark_connection_interface_location
 tp_iface_quark_connection_manager
 tp_iface_quark_dbus_daemon
 tp_iface_quark_media_session_handler
@@ -2642,6 +2668,25 @@ tp_cli_connection_interface_simple_presence_signal_callback_presences_changed
 </SECTION>
 
 <SECTION>
+<FILE>connection-location</FILE>
+<TITLE>connection-location</TITLE>
+<INCLUDE>telepathy-glib/connection.h</INCLUDE>
+tp_cli_connection_interface_location_connect_to_location_updated
+tp_cli_connection_interface_location_signal_callback_location_updated
+tp_cli_connection_interface_location_call_get_locations
+tp_cli_connection_interface_location_callback_for_get_locations
+tp_cli_connection_interface_location_call_request_location
+tp_cli_connection_interface_location_callback_for_request_location
+tp_cli_connection_interface_location_call_set_location
+tp_cli_connection_interface_location_callback_for_set_location
+<SUBSECTION Private>
+# Omit these from the docs as a mild form of deprecation...
+tp_cli_connection_interface_location_run_get_locations
+tp_cli_connection_interface_location_run_request_location
+tp_cli_connection_interface_location_run_set_location
+</SECTION>
+
+<SECTION>
 <FILE>connection-presence</FILE>
 <TITLE>connection-presence</TITLE>
 <INCLUDE>telepathy-glib/connection.h</INCLUDE>
diff --git a/telepathy-glib/extra-gtkdoc.h b/telepathy-glib/extra-gtkdoc.h
index 29d6591..b0abc5b 100644
--- a/telepathy-glib/extra-gtkdoc.h
+++ b/telepathy-glib/extra-gtkdoc.h
@@ -600,3 +600,17 @@
  * This section documents the auto-generated C wrappers for the
  * Presence interface, used with #TpConnection objects.
  */
+
+/**
+ * SECTION:connection-location
+ * @title: Connection Location interface
+ * @short_description: client-side wrappers for the Location interface
+ * @see_also: #TpConnection
+ *
+ * Some instant messaging protocols support "rich presence" functionality,
+ * such as geolocation (advertising the user's location to authorized
+ * contacts, and receiving contacts' locations).
+ *
+ * This section documents the auto-generated C wrappers for the
+ * Location interface, used with #TpConnection objects.
+ */
-- 
1.5.6.5




More information about the telepathy-commits mailing list