* revert to the in-place 'modest_text_utils_get_display_address',

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

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index 64a5a4a..5945c34 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -40,6 +40,8 @@
 
 #define _FM(str) dgettext("hildon-fm",str)
 #define _CS(str) dgettext("hildon-common-strings",str)
+#define _HL(str) dgettext("hildon-libs",str)
+#define _MD(str) dgettext("maemo-af-desktop",str)
 
 /* Forbidden char arrays */
 extern const gchar account_title_forbidden_chars[];
@@ -198,17 +200,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 <foo@bar.cx>" --> "Foo Bar"
+ * ie. removes "<...>" parts
+ * the change is in-place; removes leading whitespace
  * 
- * Returns: the new address of the string; this new string
- * is _NOT_ newly allocated, so should not be freed. (remember
- * the old address of the parameter if that one needs to be freed)
- * 
- * 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 (gchar *address);
+void modest_text_utils_get_display_address (gchar *address);
 
 /**
  * modest_text_utils_get_email_address:
@@ -382,7 +381,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__ */