* src/maemo/modest-msg-edit-window.c:
[modest] / src / modest-conf.h
index 699a74d..0008272 100644 (file)
@@ -46,14 +46,14 @@ G_BEGIN_DECLS
 typedef struct _ModestConf        ModestConf;
 typedef struct _ModestConfClass   ModestConfClass;
 
-typedef enum _ModestConfValueType {
+typedef enum {
        MODEST_CONF_VALUE_INT,
        MODEST_CONF_VALUE_BOOL,
        MODEST_CONF_VALUE_FLOAT,
        MODEST_CONF_VALUE_STRING
 } ModestConfValueType;
 
-typedef enum _ModestConfEvent {
+typedef enum {
        MODEST_CONF_EVENT_KEY_CHANGED,
        MODEST_CONF_EVENT_KEY_UNSET
 } ModestConfEvent;
@@ -70,9 +70,9 @@ struct _ModestConfClass {
 /**
  * modest_conf_get_type:
  * 
- * get the GType for ModestConf
+ * get the #GType for #ModestConf
  *  
- * Returns: the GType
+ * Returns: the #GType
  */
 GType        modest_conf_get_type    (void) G_GNUC_CONST;
 
@@ -80,9 +80,9 @@ GType        modest_conf_get_type    (void) G_GNUC_CONST;
 /**
  * modest_conf_new:
  * 
- * create a new modest ModestConf object. 
+ * create a new modest #ModestConf object. 
  * 
- * Returns: a new ModestConf instance, or NULL in case
+ * Returns: a new #ModestConf instance, or NULL in case
  * of any error
  */
 ModestConf*     modest_conf_new         (void);
@@ -144,7 +144,7 @@ gboolean     modest_conf_get_bool    (ModestConf* self, const gchar* key, GError
  * Returns: a list with the values for the key, or NULL in case of error
  * @err gives details in case of error
  */
-GSList *     modest_conf_get_list    (ModestConf* self, const gchar* key, 
+GSList*     modest_conf_get_list    (ModestConf* self, const gchar* key, 
                                      ModestConfValueType list_type, GError **err);
 
 /**
@@ -202,9 +202,11 @@ gboolean     modest_conf_set_bool    (ModestConf* self, const gchar* key, gboole
  * @err: a GError ptr, or NULL to ignore.
  * 
  * set a list of values in the configuration system
+ *
+ * Returns: TRUE if succeeded or FALSE in case of error.
  * @err gives details in case of error
  */
-void         modest_conf_set_list    (ModestConf* self, const gchar* key, 
+gboolean     modest_conf_set_list    (ModestConf* self, const gchar* key, 
                                      GSList *val, ModestConfValueType list_type, 
                                      GError **err);
 
@@ -269,7 +271,7 @@ gboolean modest_conf_key_is_valid (const gchar* str);
 
 /**
  * modest_conf_key_escape:
- * @str: a string to escape
+ * @str: a non-empty string to escape
  *
  * returns an escaped version of @str, ie. something suitable as a key
  * This is a *class* function, and therefore does not require a ModestConf