summaryrefslogtreecommitdiff
path: root/telepathy-glib/base-protocol.c
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2010-10-26 16:16:42 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2010-10-26 16:16:42 +0100
commit2cde97db8804773e0da61774a4b4ee11ea0656dc (patch)
treebe7a2650697359393f01e71cde5e99c34258c7b3 /telepathy-glib/base-protocol.c
parentac1e468dbf4ca625bad3b23702de34be6c04afeb (diff)
downloadtelepathy-glib-2cde97db8804773e0da61774a4b4ee11ea0656dc.tar.gz
Document tp_base_protocol_get_statuses
Diffstat (limited to 'telepathy-glib/base-protocol.c')
-rw-r--r--telepathy-glib/base-protocol.c14
1 files changed, 9 insertions, 5 deletions
diff --git a/telepathy-glib/base-protocol.c b/telepathy-glib/base-protocol.c
index ee095d25b..1a190ba4b 100644
--- a/telepathy-glib/base-protocol.c
+++ b/telepathy-glib/base-protocol.c
@@ -410,7 +410,7 @@ tp_cm_param_filter_string_nonempty (const TpCMParamSpec *paramspec,
* properties that represent details of the connections provided by this
* protocol
* @get_statuses: a callback used to implement the Protocol.Interface.Presence
- * interface's Statuses property.
+ * interface's Statuses property. Since 0.13.UNRELEASED
*
* The class of a #TpBaseProtocol.
*
@@ -905,14 +905,18 @@ tp_base_protocol_init (TpBaseProtocol *self)
* tp_base_protocol_get_statuses:
* @self: a Protocol object
*
+ * Get the statuses supported by this object. Subclasses implement this via
+ * the #TpBaseProtocolClass.get_statuses virtual method.
+ *
* If the object does not implement the Protocol.Interface.Presences
- * interface, it need not set this callback.
+ * interface, it need not implement this virtual method.
*
* Returns: an array of #TpPresenceStatusSpec structs describing the
- * standard statuses supported by this protocol, with a final element
- * whose name element is guaranteed to be %NULL.
+ * standard statuses supported by this protocol, with a final element
+ * whose name element is guaranteed to be %NULL. The array must remain
+ * valid at least as long as @self does.
*
- * Since: FIXME
+ * Since: 0.13.UNRELEASED
*/
const TpPresenceStatusSpec *
tp_base_protocol_get_statuses (TpBaseProtocol *self)