* modest-text-utils.[ch]:

[modest] / src / modest-text-utils.h

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index e07e682..405a231 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -106,12 +106,14 @@ gchar*   modest_text_utils_inline (const gchar *text,
 
 /**
  * modest_text_utils_remove_address
 
 /**
  * modest_text_utils_remove_address

- * @address_list: string with a comma-separated list of email addresses
- * @address: an specific e-mail address
+ * @address_list: none-NULL string with a comma-separated list of email addresses
+ * @address: an specific e-mail address 

  *
  *

- * remove a specific address from a list of email addresses
+ * remove a specific address from a list of email addresses; if @address
+ * is NULL, returns an unchanged @address_list

  * 
  * 

- * Returns: a newly allocated string containing the new list
+ * Returns: a newly allocated string containing the new list, or NULL
+ * in case of error or the original @address_list was NULL

  */
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);
  */
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);