From 922ee2a93ffaebb430d406d787abeb4687657b73 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Fri, 12 Jun 2009 12:54:15 -0500 Subject: Some comments describing the intentions of the functions. --- src/status-provider-pidgin.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src/status-provider-pidgin.c') diff --git a/src/status-provider-pidgin.c b/src/status-provider-pidgin.c index 1f5c5cc..600ee79 100644 --- a/src/status-provider-pidgin.c +++ b/src/status-provider-pidgin.c @@ -105,12 +105,22 @@ status_provider_pidgin_finalize (GObject *object) return; } +/** + status_provider_pidgin_new: + + Creates a new #StatusProviderPidgin object. No parameters or anything + like that. Just a convience function. + + Return value: A new instance of #StatusProviderPidgin +*/ StatusProvider * status_provider_pidgin_new (void) { return STATUS_PROVIDER(g_object_new(STATUS_PROVIDER_PIDGIN_TYPE, NULL)); } +/* Takes the status provided generically for Status providers + and turns it into a Pidgin status and sends it to Pidgin. */ static void set_status (StatusProvider * sp, StatusProviderStatus status) { @@ -121,6 +131,8 @@ set_status (StatusProvider * sp, StatusProviderStatus status) return; } +/* Takes the cached Pidgin status and makes it into the generic + Status provider status */ static StatusProviderStatus get_status (StatusProvider * sp) { -- cgit v1.2.3