diff options
| author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-02-24 13:59:45 +0100 |
|---|---|---|
| committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-02-24 15:19:27 +0100 |
| commit | fa86f4cc955eb74625170eba19b8d0e908dd699d (patch) | |
| tree | 92d5529524d7a6c1c31f8e71e4ef4feae38c158f /telepathy-glib/base-password-channel.c | |
| parent | 0c3e03b21cc825a483d9089bfbac47435c5a0460 (diff) | |
| download | telepathy-glib-fa86f4cc955eb74625170eba19b8d0e908dd699d.tar.gz | |
properly document TpBasePasswordChannel
Diffstat (limited to 'telepathy-glib/base-password-channel.c')
| -rw-r--r-- | telepathy-glib/base-password-channel.c | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/telepathy-glib/base-password-channel.c b/telepathy-glib/base-password-channel.c index b98488531..ac9692b71 100644 --- a/telepathy-glib/base-password-channel.c +++ b/telepathy-glib/base-password-channel.c @@ -35,6 +35,21 @@ * Since: 0.13.UNRELEASED */ +/** + * TpBasePasswordChannel: + * + * Data structure representing a channel implementing a SASL Authentication + * channel with the X-TELEPATHY-PASSWORD SASL mechanism. + * + * Since: 0.13.UNRELEASED + */ + +/** + * TpBasePasswordChannelClass: + * + * The class of a #TpBasePasswordChannel. + */ + #include "telepathy-glib/base-password-channel.h" #include <telepathy-glib/dbus.h> @@ -359,6 +374,21 @@ tp_base_password_channel_class_init (TpBasePasswordChannelClass *tp_base_passwor g_object_class_install_property (object_class, PROP_MAY_SAVE_RESPONSE, param_spec); + /** + * TpBasePasswordChannel::finished + * @password: the password provided by the user, or %NULL if the + * authentication has been aborted + * @domain: domain of a #GError indicating why the authentication has been + * aborted, or 0 + * @code: error code of a GError indicating why the authentication has been + * aborted, or 0 + * @message: a message associated with the error, or %NULL + * + * Emitted when either the password has been provided by the user or the + * authentication has been aborted. + * + * Since: 0.13.UNRELEASED + */ signals[FINISHED] = g_signal_new ("finished", G_TYPE_FROM_CLASS (object_class), G_SIGNAL_RUN_LAST, |