summaryrefslogtreecommitdiff
path: root/telepathy-glib/base-call-stream.c
diff options
context:
space:
mode:
authorXavier Claessens <xclaesse@gmail.com>2011-12-08 12:51:22 +0100
committerXavier Claessens <xavier.claessens@collabora.co.uk>2012-01-10 09:52:45 +0100
commit59fd037a2ec947d654696469ad4500f0a2b619b8 (patch)
tree85e510a4cc5eb7055ca4e9caa6c3379cf29c0df8 /telepathy-glib/base-call-stream.c
parent804623f4e43c39853e0c204cc7b1af7f0f9e7085 (diff)
downloadtelepathy-glib-59fd037a2ec947d654696469ad4500f0a2b619b8.tar.gz
Make some vmethod optional to implement, and document optionals/mandatory
Diffstat (limited to 'telepathy-glib/base-call-stream.c')
-rw-r--r--telepathy-glib/base-call-stream.c12
1 files changed, 7 insertions, 5 deletions
diff --git a/telepathy-glib/base-call-stream.c b/telepathy-glib/base-call-stream.c
index 909fe7266..f9e773729 100644
--- a/telepathy-glib/base-call-stream.c
+++ b/telepathy-glib/base-call-stream.c
@@ -48,10 +48,11 @@
* TpBaseCallStreamClass:
* @extra_interfaces: extra interfaces provided by this stream (this SHOULD NOT
* include %TP_IFACE_CALL_STREAM itself)
- * @request_receiving: virtual method called when user requested receiving from
- * the given remote contact.
- * @set_sending: virtual method called when user requested to start/stop
- * sending to remote contacts.
+ * @request_receiving: optional (see #TpBaseCallStream:can-request-receiving);
+ * virtual method called when user requested receiving from the given remote
+ * contact.
+ * @set_sending: mandatory; virtual method called when user requested to
+ * start/stop sending to remote contacts.
*
* The class structure for #TpBaseCallStream
*
@@ -396,7 +397,8 @@ tp_base_call_stream_class_init (TpBaseCallStreamClass *bsc_class)
* TpBaseCallStream:can-request-receiving:
*
* Whether or not user can request receiving from remote contact using the
- * RequestSending DBus method call.
+ * RequestSending DBus method call. The value is determined by whether or not
+ * #TpBaseCallStreamClass.request_receiving is implemented.
*
* Since: 0.UNRELEASED
*/