* Now modest_plugin_ui_actions methods disappear, and we export

[modest] / src / modest-plugin-ui-actions.h

diff --git a/src/modest-plugin-ui-actions.h b/src/modest-plugin-ui-actions.h
index e5b6ac3..775687e 100644 (file)
--- a/src/modest-plugin-ui-actions.h
+++ b/src/modest-plugin-ui-actions.h
@@ -39,8 +39,21 @@
 
 G_BEGIN_DECLS
 
-gboolean modest_plugin_ui_actions_on_delete_account (GtkWindow *parent_window,
-                                                    const gchar *account_name,
-                                                    const gchar *account_display_name);
+/**
+ * modest_ui_actions_on_delete_account:
+ * @parent_window: the parent #GtkWindow of the dialog that will be shown
+ * @account_name: the modest name for the account to be deleted
+ * @account_display_name: the display name that will be used in the dialog
+ *
+ * This function will perform the actions required to delete an
+ * account. This function assumes that the account to be deleted is
+ * already disconnected, so the caller must verify that this is the
+ * case. Otherwise weird behaviours could happen
+ *
+ * Returns: TRUE if the account was successfully deleted, FALSE otherwise
+ **/
+gboolean modest_ui_actions_on_delete_account (GtkWindow *parent_window,
+                                             const gchar *account_name,
+                                             const gchar *account_display_name);
 G_END_DECLS
 #endif /* __MODEST_PLUGIN_UI_ACTIONS_H__ */