[Pkg-telepathy-commits] [telepathy-glib-1] 129/212: TpChannel, TpChannelIface: disentangle their documentation
Simon McVittie
smcv at debian.org
Wed May 14 12:09:05 UTC 2014
This is an automated email from the git hooks/post-receive script.
smcv pushed a commit to branch debian
in repository telepathy-glib-1.
commit 7b66fe684c8cfea0c211e8fa0d099f22021c7415
Author: Simon McVittie <simon.mcvittie at collabora.co.uk>
Date: Mon Apr 7 13:56:01 2014 +0100
TpChannel, TpChannelIface: disentangle their documentation
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=77139
Reviewed-by: Xavier Claessens
---
telepathy-glib/channel-iface.c | 23 +----------------------
telepathy-glib/channel.c | 18 +++++++++---------
2 files changed, 10 insertions(+), 31 deletions(-)
diff --git a/telepathy-glib/channel-iface.c b/telepathy-glib/channel-iface.c
index f793741..d9774e7 100644
--- a/telepathy-glib/channel-iface.c
+++ b/telepathy-glib/channel-iface.c
@@ -61,13 +61,6 @@ tp_channel_iface_base_init (gpointer klass)
* The D-Bus interface representing the type of this channel. Read-only
* except during construction.
*
- * In #TpChannel this property is read-only except during construction;
- * if %NULL during construction (the default), we ask the remote D-Bus
- * object what its channel type is, and reading this property will yield
- * %NULL until a reply is received. This is not guaranteed to have happened
- * until tp_proxy_prepare_async() has finished preparing
- * %TP_CHANNEL_FEATURE_CORE.
- *
* In connection manager implementations, attempts to set this property
* during construction will usually be ignored or treated as an
* error.
@@ -84,15 +77,8 @@ tp_channel_iface_base_init (gpointer klass)
* The #TpEntityType of this channel's associated handle, or
* %TP_ENTITY_TYPE_NONE (which is numerically 0) if no handle.
*
- * In #TpChannel, if this is TP_UNKNOWN_ENTITY_TYPE
- * during construction, we ask the remote D-Bus object what its
- * entity type is; reading this property will yield TP_UNKNOWN_ENTITY_TYPE
- * until we get the reply. This is not guaranteed to be have happened
- * until tp_proxy_prepare_async() has finished preparing
- * %TP_CHANNEL_FEATURE_CORE.
- *
* In connection manager implementations, attempts to set this during
- * construction might also be ignored.
+ * construction might be ignored.
*/
param_spec = g_param_spec_uint ("entity-type", "Entity type",
"The TpEntityType of this channel's associated handle.",
@@ -106,13 +92,6 @@ tp_channel_iface_base_init (gpointer klass)
* This channel's associated handle, or 0 if no handle or unknown.
* Read-only except during construction.
*
- * In #TpChannel, if this is 0
- * during construction, and entity-type is not TP_ENTITY_TYPE_NONE (== 0),
- * we ask the remote D-Bus object what its entity type is; reading this
- * property will yield 0 until we get the reply, or if GetHandle()
- * fails. This is not guaranteed to be set until tp_proxy_prepare_async()
- * has finished preparing %TP_CHANNEL_FEATURE_CORE.
- *
* In connection manager implementations, attempts to set this during
* construction might be ignored, depending on the channel type.
*/
diff --git a/telepathy-glib/channel.c b/telepathy-glib/channel.c
index 2637a10..c18c305 100644
--- a/telepathy-glib/channel.c
+++ b/telepathy-glib/channel.c
@@ -129,8 +129,8 @@ G_DEFINE_TYPE (TpChannel, tp_channel, TP_TYPE_PROXY)
*
* Specifically, this implies that:
*
- * - #TpChannelIface:channel-type is set
- * - #TpChannelIface:entity-type and #TpChannelIface:handle are set
+ * - #TpChannel:channel-type is set
+ * - #TpChannel:entity-type and #TpChannel:handle are set
* - any extra interfaces will have been set up in TpProxy (i.e.
* #TpProxy:interfaces contains at least all extra Channel interfaces)
*
@@ -187,7 +187,7 @@ tp_channel_get_feature_quark_group (void)
* Get the D-Bus interface name representing this channel's type,
* if it has been discovered.
*
- * This is the same as the #TpChannelIface:channel-type property; it isn't
+ * This is the same as the #TpChannel:channel-type property; it isn't
* guaranteed to be non-%NULL until the %TP_CHANNEL_FEATURE_CORE feature has
* been prepared.
*
@@ -211,7 +211,7 @@ tp_channel_get_channel_type (TpChannel *self)
* Get the D-Bus interface name representing this channel's type, as a GQuark,
* if it has been discovered.
*
- * This is the same as the #TpChannelIface:channel-type property, except that it
+ * This is the same as the #TpChannel:channel-type property, except that it
* is a GQuark rather than a string. It isn't guaranteed to be nonzero until
* the %TP_CHANNEL_FEATURE_CORE property is ready.
*
@@ -237,7 +237,7 @@ tp_channel_get_channel_type_id (TpChannel *self)
* channel communicates for its whole lifetime, or 0 if there is no such
* handle or it has not yet been discovered.
*
- * This is the same as the #TpChannelIface:handle property. It isn't
+ * This is the same as the #TpChannel:handle property. It isn't
* guaranteed to have its final value until the %TP_CHANNEL_FEATURE_CORE
* feature is ready.
*
@@ -245,7 +245,7 @@ tp_channel_get_channel_type_id (TpChannel *self)
* This will be %TP_UNKNOWN_ENTITY_TYPE if the handle has not yet been
* discovered, or %TP_ENTITY_TYPE_NONE if there is no handle with which this
* channel will always communicate. This is the same as the
- * #TpChannelIface:entity-type property.
+ * #TpChannel:entity-type property.
*
* Returns: the handle
* Since: 0.7.12
@@ -1197,8 +1197,8 @@ tp_channel_class_init (TpChannelClass *klass)
* This channel's associated identifier, or the empty string if it has
* entity type %TP_ENTITY_TYPE_NONE.
*
- * For channels where #TpChannelIface:handle is non-zero, this is the result
- * of inspecting #TpChannelIface:handle.
+ * For channels where #TpChannel:handle is non-zero, this is the result
+ * of inspecting #TpChannel:handle.
*
* This is not guaranteed to be set until tp_proxy_prepare_async() has
* finished preparing %TP_CHANNEL_FEATURE_CORE; until then, it may be
@@ -1340,7 +1340,7 @@ tp_channel_class_init (TpChannelClass *klass)
* TpChannel:target-contact:
*
* If this channel is for communication with a single contact (that is,
- * #TpChannelIface:entity-type is %TP_ENTITY_TYPE_CONTACT), then a #TpContact
+ * #TpChannel:entity-type is %TP_ENTITY_TYPE_CONTACT), then a #TpContact
* representing the remote contact. For chat rooms, contact search channels and
* other channels without a single remote contact, %NULL.
*
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-telepathy/telepathy-glib-1.git
More information about the Pkg-telepathy-commits
mailing list