Mercurial > pidgin
changeset 22676:17d1054cea03
Super minor documentation improvement
| author | Mark Doliner <mark@kingant.net> |
|---|---|
| date | Wed, 16 Apr 2008 06:27:46 +0000 |
| parents | ac12e2598a03 |
| children | 3850c293ae8b |
| files | libpurple/blist.h libpurple/util.h |
| diffstat | 2 files changed, 9 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/blist.h Wed Apr 16 05:44:40 2008 +0000 +++ b/libpurple/blist.h Wed Apr 16 06:27:46 2008 +0000 @@ -475,7 +475,8 @@ * @param buddy The new buddy who gets added * @param contact The optional contact to place the buddy in. * @param group The group to add the new buddy to. - * @param node The insertion point + * @param node The insertion point. Pass in NULL to add the node as + * the last child in the given group. */ void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
--- a/libpurple/util.h Wed Apr 16 05:44:40 2008 +0000 +++ b/libpurple/util.h Wed Apr 16 06:27:46 2008 +0000 @@ -476,7 +476,8 @@ * * @param str The string to strip HTML from. * - * @return The new string without HTML. This must be freed. + * @return The new string without HTML. You must g_free this string + * when finished with it. */ char *purple_markup_strip_html(const char *str); @@ -485,7 +486,9 @@ * * @param str The string to linkify. * - * @return The linkified text. + * @return The new string with all URIs surrounded in standard + * HTML <a href="whatever"></a> tags. You must g_free this + * string when finished with it. */ char *purple_markup_linkify(const char *str); @@ -497,7 +500,8 @@ * * @param html The string in which to unescape any HTML entities * - * @return the text with HTML entities literalized + * @return The text with HTML entities literalized. You must g_free + * this string when finished with it. */ char *purple_unescape_html(const char *html);