* small fix for doc building

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

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index c51499b..4077bab 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -142,7 +142,7 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
 
 /**
  * modest_text_utils_address_range_at_position:
- * @address_list: utf8 string containing a list of addresses
+ * @address_list: non-NULL utf8 string containing a list of addresses
  * @position: a gint
  * @start: a gint pointer
  * @end: a gint pointer
@@ -153,10 +153,23 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
  * @end
  */
 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
-                                                     gint position,
-                                                     gint *start,
-                                                     gint *end);
-                                                     
+                                                     guint position,
+                                                     guint *start,
+                                                     guint *end);
+
+/**
+ * modest_text_utils_hyperlinkify_begin:
+ *
+ * begin a linkify block, compiling the caches to be reused.
+ */
+void modest_text_utils_hyperlinkify_begin (void);
+
+/**
+ * modest_text_utils_hyperlinkify_end:
+ *
+ * end a linkify block, freeing the caches to be reused.
+ */
+void modest_text_utils_hyperlinkify_end (void);
 
 /**
  * modest_text_utils_convert_to_html:
@@ -176,7 +189,7 @@ gchar*  modest_text_utils_convert_to_html (const gchar *txt);
  * 
  * Returns: a newly allocated string containing the html
  */
-gchar*  modest_text_utils_convert_to_html_body (const gchar *data);
+gchar*  modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify);
 
 
 /**
@@ -200,14 +213,14 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
- * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
- * ie. removes "<...>" and "(...)" parts
- * the change is in-place; removes leading/trailing whitespace
+ * "Foo Bar &lt;foo@bar.cx&gt;" --&gt; "Foo Bar"
+ * ie. removes "&lt;...&gt;" parts
+ * the change is in-place; removes leading whitespace
  * 
- * Returns: a new allocated string with the display address. NULL in
- * case of error or if address == NULL
+ * NOTE: for optimization reasons, this function changes @address
+ * in-place
  */
-gchar* modest_text_utils_get_display_address (const gchar *address);
+void modest_text_utils_get_display_address (gchar *address);
 
 /**
  * modest_text_utils_get_email_address:
@@ -257,10 +270,13 @@ gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean i
  *
  * get a string representation for a date.
  * 
- * Returns: the new display date, as a newly allocated string;
- * free with g_free
+ * Returns: the new display date, as a *static* string.
+ * This string should not be modified, and will change
+ * upon recalling this function. g_strdup it if you to
+ * do so.
+ * 
  */
-gchar* modest_text_utils_get_display_date (time_t date);
+const gchar* modest_text_utils_get_display_date (time_t date);
 
 
 /**
@@ -381,7 +397,18 @@ typedef enum {
        USER_NAME_FORBIDDEN_NAMES,
 } ModestTextUtilsForbiddenCharType;
 
+
+/**
+ * modest_text_utils_is_forbidden_char:
+ * @character: some character
+ * @type: the type of forbidden char (see #ModestTextUtilsForbiddenCharType)
+ * 
+ * check whether the given character is 'forbidden'
+ *
+ * Returns: TRUE if it's forbidden, FALSE otherwise
+ */
 gboolean     modest_text_utils_is_forbidden_char (const gchar character,
                                                  ModestTextUtilsForbiddenCharType type);
 
+
 #endif /* __MODEST_TEXT_UTILS_H__ */