empathy r1210 - trunk/libempathy

[xclaesse svn gnome org]

Author: xclaesse
Date: Tue Jul  8 17:32:46 2008
New Revision: 1210
URL: http://svn.gnome.org/viewvc/empathy?rev=1210&view=rev

Log:
Document empathy_avatar_save_to_file (Guillaume Desmottes)


Modified:
   trunk/libempathy/empathy-contact.c
   trunk/libempathy/empathy-contact.h

Modified: trunk/libempathy/empathy-contact.c
==============================================================================
--- trunk/libempathy/empathy-contact.c	(original)
+++ trunk/libempathy/empathy-contact.c	Tue Jul  8 17:32:46 2008
@@ -931,6 +931,16 @@
 	return avatar;
 }
 
+/**
+ * empathy_avatar_save_to_file:
+ * @avatar: the avatar
+ * @filename: name of a file to write avatar to
+ * @error: return location for a GError, or NULL
+ *
+ * Save the avatar to a file named filename
+ *
+ * Returns: %TRUE on success, %FALSE if an error occurred 
+ */
 gboolean
 empathy_avatar_save_to_file (EmpathyAvatar *self,
                              const gchar *filename,

Modified: trunk/libempathy/empathy-contact.h
==============================================================================
--- trunk/libempathy/empathy-contact.h	(original)
+++ trunk/libempathy/empathy-contact.h	Tue Jul  8 17:32:46 2008
@@ -134,7 +134,7 @@
 EmpathyAvatar *     empathy_avatar_ref                 (EmpathyAvatar       *avatar);
 void                empathy_avatar_unref               (EmpathyAvatar       *avatar);
 
-gboolean empathy_avatar_save_to_file (EmpathyAvatar *self,
+gboolean empathy_avatar_save_to_file (EmpathyAvatar *avatar,
     const gchar *filename, GError **error);
 
 G_END_DECLS