Mercurial > pidgin.yaz
diff libpurple/smiley.h @ 26753:d58fa4c34987
disapproval of revision '6ddba69dc6d0bac552c512dd4495b255463c1c5c'
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Mon, 20 Apr 2009 00:02:16 +0000 |
parents | f22ecddd3eba |
children | 78ef23551355 |
line wrap: on
line diff
--- a/libpurple/smiley.h Thu Mar 12 05:32:25 2009 +0000 +++ b/libpurple/smiley.h Mon Apr 20 00:02:16 2009 +0000 @@ -61,35 +61,38 @@ /*@{*/ /** - * GObject-fu. + * GObject foo. * @internal. */ GType purple_smiley_get_type(void); /** - * Create a new custom smiley from a PurpleStoredImage. + * Creates a new custom smiley structure and populates it. * - * If a custom smiley with the given shortcut already exists, it + * If a custom smiley with the informed shortcut already exist, it * will be automaticaly returned. * * @param img The image associated with the smiley. - * @param shortcut The associated shortcut (e.g. "(homer)"). + * @param shortcut The custom smiley associated shortcut. * - * @return The custom smiley. + * @return The custom smiley structure filled up. */ PurpleSmiley * purple_smiley_new(PurpleStoredImage *img, const char *shortcut); /** - * Create a new custom smiley, reading the image data from a file. + * Creates a new custom smiley structure and populates it. * - * If a custom smiley with the given shortcut already exists, it + * The data is retrieved from an already existent file. + * + * If a custom smiley with the informed shortcut already exist, it * will be automaticaly returned. * - * @param shortcut The associated shortcut (e.g. "(homer)"). - * @param filepath The image file. + * @param shortcut The custom smiley associated shortcut. + * @param filepath The image file to be imported to a + * new custom smiley. * - * @return The custom smiley. + * @return The custom smiley structure filled up. */ PurpleSmiley * purple_smiley_new_from_file(const char *shortcut, const char *filepath); @@ -106,28 +109,32 @@ * Changes the custom smiley's shortcut. * * @param smiley The custom smiley. - * @param shortcut The new shortcut. A custom smiley with this shortcut - * cannot already be in use. + * @param shortcut The custom smiley associated shortcut. * - * @return TRUE if the shortcut was changed. FALSE otherwise. + * @return TRUE whether the shortcut is not associated with another + * custom smiley and the parameters are valid. FALSE otherwise. */ gboolean purple_smiley_set_shortcut(PurpleSmiley *smiley, const char *shortcut); /** - * Changes the custom smiley's image data. + * Changes the custom smiley's data. + * + * When the filename controling is made outside this API, the param + * #keepfilename must be TRUE. + * Otherwise, the file and filename will be regenerated, and the + * old one will be removed. * * @param smiley The custom smiley. - * @param smiley_data The custom smiley data, which the smiley code - * takes ownership of and will free. - * @param smiley_data_len The length of the data in @a smiley_data. + * @param smiley_data The custom smiley data. + * @param smiley_data_len The custom smiley data length. */ void purple_smiley_set_data(PurpleSmiley *smiley, guchar *smiley_data, size_t smiley_data_len); /** - * Returns the custom smiley's associated shortcut (e.g. "(homer)"). + * Returns the custom smiley's associated shortcut. * * @param smiley The custom smiley. * @@ -148,11 +155,11 @@ * Returns the PurpleStoredImage with the reference counter incremented. * * The returned PurpleStoredImage reference counter must be decremented - * when the caller is done using it. + * after use. * * @param smiley The custom smiley. * - * @return A PurpleStoredImage. + * @return A PurpleStoredImage reference. */ PurpleStoredImage *purple_smiley_get_stored_image(const PurpleSmiley *smiley); @@ -160,7 +167,7 @@ * Returns the custom smiley's data. * * @param smiley The custom smiley. - * @param len If not @c NULL, the length of the image data returned + * @param len If not @c NULL, the length of the icon data returned * will be set in the location pointed to by this. * * @return A pointer to the custom smiley data. @@ -187,8 +194,6 @@ * directly. If you find yourself wanting to use this function, think * very long and hard about it, and then don't. * - * Think some more. - * * @param smiley The custom smiley. * * @return A full path to the file, or @c NULL under various conditions. @@ -205,8 +210,7 @@ /*@{*/ /** - * Returns a list of all custom smileys. The caller is responsible for freeing - * the list. + * Returns a list of all custom smileys. The caller should free the list. * * @return A list of all custom smileys. */ @@ -214,21 +218,23 @@ purple_smileys_get_all(void); /** - * Returns a custom smiley given its shortcut. + * Returns the custom smiley given it's shortcut. * * @param shortcut The custom smiley's shortcut. * - * @return The custom smiley if found, or @c NULL if not found. + * @return The custom smiley (with a reference for the caller) if found, + * or @c NULL if not found. */ PurpleSmiley * purple_smileys_find_by_shortcut(const char *shortcut); /** - * Returns a custom smiley given its checksum. + * Returns the custom smiley given it's checksum. * * @param checksum The custom smiley's checksum. * - * @return The custom smiley if found, or @c NULL if not found. + * @return The custom smiley (with a reference for the caller) if found, + * or @c NULL if not found. */ PurpleSmiley * purple_smileys_find_by_checksum(const char *checksum); @@ -236,10 +242,10 @@ /** * Returns the directory used to store custom smiley cached files. * - * @return The directory to store custom smyles cached files to. + * The default directory is PURPLEDIR/smileys, unless otherwise specified + * by purple_buddy_icons_set_cache_dir(). * - * @deprecated This function isn't used and does nothing and will be - * removed in 3.0.0. + * @return The directory to store custom smyles cached files to. */ const char *purple_smileys_get_storing_dir(void);