[telepathy-glib/master] account: add docs about which properties can be listened to using the notify signal

[Jonny Lamb]

Signed-off-by: Jonny Lamb <jonny.lamb at collabora.co.uk>
---
 telepathy-glib/account.c |   68 ++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 68 insertions(+), 0 deletions(-)

diff --git a/telepathy-glib/account.c b/telepathy-glib/account.c
index b099af4..d6c3304 100644
--- a/telepathy-glib/account.c
+++ b/telepathy-glib/account.c
@@ -61,6 +61,10 @@
  * with the domain %TP_DBUS_ERRORS and the error code
  * %TP_DBUS_ERROR_OBJECT_REMOVED.
  *
+ * One can connect to the #GObject::notify signal to get change notifications
+ * for many of the properties on this object. Refer to each property's
+ * documentation for whether it can be used in this way.
+ *
  * Since: 0.7.32
  */
 
@@ -964,6 +968,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * Whether this account is enabled or not.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_ENABLED,
@@ -978,6 +986,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account connection's current presence type.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CURRENT_PRESENCE_TYPE,
@@ -994,6 +1006,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The current Status string of the account.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CURRENT_STATUS,
@@ -1008,6 +1024,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The current status message message of the account.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CURRENT_STATUS_MESSAGE,
@@ -1022,6 +1042,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account's connection status type.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CONNECTION_STATUS,
@@ -1038,6 +1062,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account's connection status reason.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CONNECTION_STATUS_REASON,
@@ -1055,6 +1083,10 @@ tp_account_class_init (TpAccountClass *klass)
    * The account's connection. This property returns the same as
    * tp_account_get_connection().
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CONNECTION,
@@ -1069,6 +1101,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account's display name.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_DISPLAY_NAME,
@@ -1112,6 +1148,10 @@ tp_account_class_init (TpAccountClass *klass)
    * The account's icon name. To change this propery, use
    * tp_account_set_icon_name_async().
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_ICON_NAME,
@@ -1127,6 +1167,10 @@ tp_account_class_init (TpAccountClass *klass)
    * Whether the account should connect automatically or not. To change this
    * property, use tp_account_set_connect_automatically_async().
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_CONNECT_AUTOMATICALLY,
@@ -1141,6 +1185,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * Whether this account has been online or not.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_HAS_BEEN_ONLINE,
@@ -1155,6 +1203,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * Whether this account is valid.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_VALID,
@@ -1169,6 +1221,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account's requested presence type.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_REQUESTED_PRESENCE_TYPE,
@@ -1185,6 +1241,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The requested Status string of the account.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_REQUESTED_STATUS,
@@ -1199,6 +1259,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The requested status message message of the account.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_REQUESTED_STATUS_MESSAGE,
@@ -1213,6 +1277,10 @@ tp_account_class_init (TpAccountClass *klass)
    *
    * The account's nickname.
    *
+   * One can receive change notifications on this property by connecting
+   * to the #GObject::notify signal and using this property as the signal
+   * detail.
+   *
    * Since: 0.7.UNRELEASED
    */
   g_object_class_install_property (object_class, PROP_NICKNAME,
-- 
1.5.6.5