From b514a9816530ec797b0f9b8b026d557695d4870d Mon Sep 17 00:00:00 2001 From: Sergio Villar Senin Date: Fri, 22 Dec 2006 13:21:58 +0000 Subject: [PATCH] * Fixed comments with errors * Removed gtkdocize call from autogen.sh * Added an index to the generated documentation * Added widgets and gtk directories to the documentation pmo-trunk-r577 --- autogen.sh | 8 +- configure.ac | 2 +- docs/reference/Makefile.am | 4 +- docs/reference/modest-docs.sgml | 21 +++- docs/reference/modest-sections.txt | 52 ++++----- docs/reference/tmpl/modest-account-mgr.sgml | 57 +++++++--- docs/reference/tmpl/modest-conf.sgml | 43 ++++--- docs/reference/tmpl/modest-tny-account-store.sgml | 26 +++-- docs/reference/tmpl/modest-ui.sgml | 105 ----------------- docs/reference/tmpl/modest-unused.sgml | 115 +++++++++++++++++++ src/modest-account-mgr.h | 2 +- src/modest-mail-operation.c | 126 ++++++++++----------- src/modest-mail-operation.h | 4 +- src/modest-pair.h | 2 +- src/modest-presets.h | 6 +- src/modest-text-utils.h | 4 +- src/modest-tny-account-store.h | 2 +- src/modest-tny-platform-factory.h | 1 - src/modest-widget-factory.h | 3 - src/modest-widget-memory.h | 4 +- src/widgets/modest-header-view.h | 1 - 21 files changed, 317 insertions(+), 271 deletions(-) diff --git a/autogen.sh b/autogen.sh index a795a83..4d7086c 100755 --- a/autogen.sh +++ b/autogen.sh @@ -17,10 +17,4 @@ which gnome-autogen.sh || { echo "You need to install gnome-common from GNOME CVS" exit 1 } -USE_GNOME2_MACROS=1 . gnome-autogen.sh - -gtkdocize || { - echo -n "**Error**: gtkdoc not found. Please install" - exit 1 -} - +USE_GNOME2_MACROS=1 . gnome-autogen.sh \ No newline at end of file diff --git a/configure.ac b/configure.ac index 56b919b..6fac77c 100644 --- a/configure.ac +++ b/configure.ac @@ -111,7 +111,7 @@ AC_HELP_STRING([--enable-docs], esac],[build_docs=false]) AM_CONDITIONAL(BUILD_DOCS, test x$build_docs = xtrue) -dnl ## is the check package installed? +dnl ## gtk-doc GTK_DOC_CHECK([1.0]) diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 5b1c58c..810515f 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -9,7 +9,7 @@ DOC_MODULE=modest # The top-level SGML file. You can change this if you want to. -DOC_MAIN_SGML_FILE=modest-docs.sgml +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # The directory containing the source code. Relative to $(srcdir). # gtk-doc will search all .c & .h files beneath here for inline comments @@ -55,7 +55,7 @@ HTML_IMAGES= # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files=#xml/tree_index.sgml +content_files=xml/tree_index.sgml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml index 232583c..2b1caac 100644 --- a/docs/reference/modest-docs.sgml +++ b/docs/reference/modest-docs.sgml @@ -46,7 +46,6 @@ ]> - modest technical documentation @@ -388,6 +387,7 @@ Object Index + &index-Object-Tree; @@ -421,9 +421,28 @@ Gtk + >k-ModestAccountViewWindow; + >k-ModestAccountAssistant; + >k-ModestEditMsgWindow; + >k-ModestMainWindow; + >k-ModestStoreWidget; + >k-modestTransportWidget; + >k-modestUi; Widgets + &widgets-ModestAccountView; + &widgets-ModestComboBox; + &widgets-ModestFolderView; + &widgets-ModestHeaderView; + &widgets-ModestMsgView; + &widgets-modestToolbar; + + + + Index + + diff --git a/docs/reference/modest-sections.txt b/docs/reference/modest-sections.txt index b997871..b645a97 100644 --- a/docs/reference/modest-sections.txt +++ b/docs/reference/modest-sections.txt @@ -1535,19 +1535,6 @@ modest_proto_auth_protos
-modest-widget-memory -modest_widget_memory_save -modest_widget_memory_restore -
- -
-modest-tny-msg-actions -modest_tny_msg_actions_find_body_part -modest_tny_msg_actions_find_nth_part -modest_tny_msg_actions_find_body -
- -
modest-marshal modest_marshal_VOID__POINTER_POINTER modest_marshal_VOID__POINTER_POINTER_POINTER @@ -1563,6 +1550,19 @@ modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
+modest-widget-memory +modest_widget_memory_save +modest_widget_memory_restore +
+ +
+modest-tny-msg-actions +modest_tny_msg_actions_find_body_part +modest_tny_msg_actions_find_nth_part +modest_tny_msg_actions_find_body +
+ +
modest-error ModestErrorDomain ModestErrorCode @@ -1761,19 +1761,6 @@ modest_proto_auth_protos
-modest-widget-memory -modest_widget_memory_save -modest_widget_memory_restore -
- -
-modest-tny-msg-actions -modest_tny_msg_actions_find_body_part -modest_tny_msg_actions_find_nth_part -modest_tny_msg_actions_find_body -
- -
modest-marshal modest_marshal_VOID__POINTER_POINTER modest_marshal_VOID__POINTER_POINTER_POINTER @@ -1789,6 +1776,19 @@ modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
+modest-widget-memory +modest_widget_memory_save +modest_widget_memory_restore +
+ +
+modest-tny-msg-actions +modest_tny_msg_actions_find_body_part +modest_tny_msg_actions_find_nth_part +modest_tny_msg_actions_find_body +
+ +
modest-error ModestErrorDomain ModestErrorCode diff --git a/docs/reference/tmpl/modest-account-mgr.sgml b/docs/reference/tmpl/modest-account-mgr.sgml index 6d358b4..0c8a6a2 100644 --- a/docs/reference/tmpl/modest-account-mgr.sgml +++ b/docs/reference/tmpl/modest-account-mgr.sgml @@ -30,38 +30,38 @@ ModestAccountMgr -@modestaccountmgr: the object which received the signal. -@arg1: -@arg2: -@arg3: +@: +@: +@: +@: -@modestaccountmgr: the object which received the signal. -@arg1: -@arg2: +@: +@: +@: -@modestaccountmgr: the object which received the signal. -@arg1: -@arg2: -@arg3: +@: +@: +@: +@: -@modestaccountmgr: the object which received the signal. -@arg1: -@arg2: +@: +@: +@: @@ -247,6 +247,20 @@ ModestAccountMgr @Returns: + + + + + +@self: +@name: +@key: +@list_type: +@server_account: +@err: +@Returns: + + @@ -289,7 +303,7 @@ ModestAccountMgr @Returns: - + @@ -297,9 +311,22 @@ ModestAccountMgr @self: @name: @key: +@val: @list_type: @server_account: @err: + + + + + + + +@self: +@name: +@key: +@server_account: +@err: @Returns: diff --git a/docs/reference/tmpl/modest-conf.sgml b/docs/reference/tmpl/modest-conf.sgml index 9ff68a6..bc6dde9 100644 --- a/docs/reference/tmpl/modest-conf.sgml +++ b/docs/reference/tmpl/modest-conf.sgml @@ -48,18 +48,18 @@ ModestConf -@: -@: -@: +@modestconf: the object which received the signal. +@arg1: +@arg2: -@: -@: -@: +@modestconf: the object which received the signal. +@arg1: +@arg2: @@ -102,29 +102,31 @@ ModestConf @Returns: - + @self: @key: -@defaultval: +@list_type: +@err: @Returns: - + @self: @key: -@defaultval: +@val: +@err: @Returns: - + @@ -136,7 +138,7 @@ ModestConf @Returns: - + @@ -148,7 +150,7 @@ ModestConf @Returns: - + @@ -156,8 +158,8 @@ ModestConf @self: @key: @val: +@list_type: @err: -@Returns: @@ -193,35 +195,30 @@ ModestConf @Returns: - + -@self: @str: @Returns: - + -@self: @str: @Returns: - + -@self: -@key: -@list_type: -@err: +@str: @Returns: diff --git a/docs/reference/tmpl/modest-tny-account-store.sgml b/docs/reference/tmpl/modest-tny-account-store.sgml index ce81cd2..7472858 100644 --- a/docs/reference/tmpl/modest-tny-account-store.sgml +++ b/docs/reference/tmpl/modest-tny-account-store.sgml @@ -36,36 +36,38 @@ ModestTnyAccountStore -@modesttnyaccountstore: the object which received the signal. -@arg1: +@: +@: -@modesttnyaccountstore: the object which received the signal. -@arg1: -@arg2: -@arg3: +@: +@: +@: +@: +@Param5: -@modesttnyaccountstore: the object which received the signal. -@arg1: +@: +@: -@modesttnyaccountstore: the object which received the signal. -@arg1: -@arg2: -@arg3: +@: +@: +@: +@: +@Param5: diff --git a/docs/reference/tmpl/modest-ui.sgml b/docs/reference/tmpl/modest-ui.sgml index b7c6913..9d0df49 100644 --- a/docs/reference/tmpl/modest-ui.sgml +++ b/docs/reference/tmpl/modest-ui.sgml @@ -33,111 +33,6 @@ ModestUI @Returns: - - - - - -@ui: -@Returns: - - - - - - - -@ui: -@to: -@cc: -@bcc: -@subject: -@body: -@att: -@Returns: - - - - - - - -@modest_ui: -@user_data: -@Returns: - - - - - - - -@to: -@window_data: -@Returns: - - - - - - - -@cc: -@window_data: -@Returns: - - - - - - - -@bcc: -@window_data: -@Returns: - - - - - - - -@subject: -@window_data: -@Returns: - - - - - - - -@body: -@window_data: -@Returns: - - - - - - - -@window_data: -@Returns: - - - - - - - -@modest_ui: -@msg_view: -@msg: -@user_data: -@Returns: - - diff --git a/docs/reference/tmpl/modest-unused.sgml b/docs/reference/tmpl/modest-unused.sgml index faf8a41..5f36a11 100644 --- a/docs/reference/tmpl/modest-unused.sgml +++ b/docs/reference/tmpl/modest-unused.sgml @@ -453,6 +453,26 @@ modest.glade @err: @Returns: + + + + + +@self: +@key: +@defaultval: +@Returns: + + + + + + +@self: +@key: +@defaultval: +@Returns: + @@ -617,6 +637,93 @@ modest.glade @attachments_list: @Returns: + + + + + +@bcc: +@window_data: +@Returns: + + + + + + +@body: +@window_data: +@Returns: + + + + + + +@cc: +@window_data: +@Returns: + + + + + + +@subject: +@window_data: +@Returns: + + + + + + +@to: +@window_data: +@Returns: + + + + + + +@window_data: +@Returns: + + + + + + +@ui: +@to: +@cc: +@bcc: +@subject: +@body: +@att: +@Returns: + + + + + + +@modest_ui: +@user_data: +@Returns: + + + + + + +@modest_ui: +@msg_view: +@msg: +@user_data: +@Returns: + @@ -631,6 +738,14 @@ modest.glade @att: @Returns: + + + + + +@ui: +@Returns: + diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index 2e0e418..2ae7a21 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -413,7 +413,7 @@ gboolean modest_account_mgr_set_bool (ModestAccountMgr *self, * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to set - * @key: the list with the values to set + * @val: the list with the values to set * @list_type: the type of the members of the list * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. diff --git a/src/modest-mail-operation.c b/src/modest-mail-operation.c index eef2204..705cb9a 100644 --- a/src/modest-mail-operation.c +++ b/src/modest-mail-operation.c @@ -78,17 +78,17 @@ static TnyMimePart * add_body_part (TnyMsg *msg, gboolean has_attachments); -static void modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, +static void modest_mail_operation_xfer_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent, gboolean delete_original); -static void modest_mail_operation_xfer_msg (ModestMailOperation *mail_op, +static void modest_mail_operation_xfer_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder, gboolean delete_original); -static TnyFolder * modest_mail_operation_find_trash_folder (ModestMailOperation *mail_op, +static TnyFolder * modest_mail_operation_find_trash_folder (ModestMailOperation *self, TnyStoreAccount *store_account); @@ -216,18 +216,18 @@ modest_mail_operation_new (void) void -modest_mail_operation_send_mail (ModestMailOperation *mail_op, +modest_mail_operation_send_mail (ModestMailOperation *self, TnyTransportAccount *transport_account, TnyMsg* msg) { - g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (self)); g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (transport_account)); tny_transport_account_send (transport_account, msg, NULL); /* FIXME */ } void -modest_mail_operation_send_new_mail (ModestMailOperation *mail_op, +modest_mail_operation_send_new_mail (ModestMailOperation *self, TnyTransportAccount *transport_account, const gchar *from, const gchar *to, @@ -242,10 +242,10 @@ modest_mail_operation_send_new_mail (ModestMailOperation *mail_op, gchar *content_type; ModestMailOperationPrivate *priv = NULL; - g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (self)); g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (transport_account)); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE(mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self); /* Check parametters */ if (to == NULL) { @@ -455,13 +455,13 @@ status_update_cb (TnyFolder *folder, const gchar *what, gint status, gint oftota static void folder_refresh_cb (TnyFolder *folder, gboolean canceled, GError **err, gpointer user_data) { - ModestMailOperation *mail_op = NULL; + ModestMailOperation *self = NULL; ModestMailOperationPrivate *priv = NULL; RefreshFolderAsyncHelper *helper; helper = (RefreshFolderAsyncHelper *) user_data; - mail_op = MODEST_MAIL_OPERATION (helper->mail_op); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE(mail_op); + self = MODEST_MAIL_OPERATION (helper->mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self); if ((canceled && *err) || *err) { priv->error = g_error_copy (*err); @@ -499,20 +499,20 @@ folder_refresh_cb (TnyFolder *folder, gboolean canceled, GError **err, gpointer status_update_cb, helper); } - g_signal_emit (G_OBJECT (mail_op), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL); + g_signal_emit (G_OBJECT (self), signals[PROGRESS_CHANGED_SIGNAL], 0, NULL); } static void -update_folders_cb (TnyFolderStore *self, TnyList *list, GError **err, gpointer user_data) +update_folders_cb (TnyFolderStore *folder_store, TnyList *list, GError **err, gpointer user_data) { - ModestMailOperation *mail_op; + ModestMailOperation *self; ModestMailOperationPrivate *priv; TnyList *folders; RefreshFolderAsyncHelper *helper; - mail_op = MODEST_MAIL_OPERATION (user_data); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + self = MODEST_MAIL_OPERATION (user_data); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); if (*err) { priv->error = g_error_copy (*err); @@ -525,7 +525,7 @@ update_folders_cb (TnyFolderStore *self, TnyList *list, GError **err, gpointer u priv->status = MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS; helper = g_slice_new0 (RefreshFolderAsyncHelper); - helper->mail_op = mail_op; + helper->mail_op = self; helper->iter = tny_list_create_iterator (list); helper->failed = 0; helper->canceled = 0; @@ -538,51 +538,51 @@ update_folders_cb (TnyFolderStore *self, TnyList *list, GError **err, gpointer u } gboolean -modest_mail_operation_update_account (ModestMailOperation *mail_op, +modest_mail_operation_update_account (ModestMailOperation *self, TnyStoreAccount *store_account) { ModestMailOperationPrivate *priv; TnyList *folders; TnyFolderStoreQuery *query; - g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (mail_op), FALSE); + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), FALSE); g_return_val_if_fail (TNY_IS_STORE_ACCOUNT(store_account), FALSE); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE(mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE(self); /* Get subscribed folders & refresh them */ folders = TNY_LIST (tny_simple_list_new ()); query = tny_folder_store_query_new (); tny_folder_store_query_add_item (query, NULL, TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED); tny_folder_store_get_folders_async (TNY_FOLDER_STORE (store_account), - folders, update_folders_cb, query, mail_op); + folders, update_folders_cb, query, self); g_object_unref (query); return TRUE; } ModestMailOperationStatus -modest_mail_operation_get_status (ModestMailOperation *mail_op) +modest_mail_operation_get_status (ModestMailOperation *self) { ModestMailOperationPrivate *priv; - g_return_val_if_fail (mail_op, MODEST_MAIL_OPERATION_STATUS_INVALID); - g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (mail_op), + g_return_val_if_fail (self, MODEST_MAIL_OPERATION_STATUS_INVALID); + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), MODEST_MAIL_OPERATION_STATUS_INVALID); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); return priv->status; } const GError * -modest_mail_operation_get_error (ModestMailOperation *mail_op) +modest_mail_operation_get_error (ModestMailOperation *self) { ModestMailOperationPrivate *priv; - g_return_val_if_fail (mail_op, NULL); - g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (mail_op), NULL); + g_return_val_if_fail (self, NULL); + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), NULL); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); return priv->error; } @@ -594,39 +594,39 @@ modest_mail_operation_cancel (ModestMailOperation *self) } guint -modest_mail_operation_get_task_done (ModestMailOperation *mail_op) +modest_mail_operation_get_task_done (ModestMailOperation *self) { ModestMailOperationPrivate *priv; - g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (mail_op), 0); + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); return priv->done; } guint -modest_mail_operation_get_task_total (ModestMailOperation *mail_op) +modest_mail_operation_get_task_total (ModestMailOperation *self) { ModestMailOperationPrivate *priv; - g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (mail_op), 0); + g_return_val_if_fail (MODEST_IS_MAIL_OPERATION (self), 0); - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); return priv->total; } gboolean -modest_mail_operation_is_finished (ModestMailOperation *mail_op) +modest_mail_operation_is_finished (ModestMailOperation *self) { ModestMailOperationPrivate *priv; gboolean retval = FALSE; - if (!MODEST_IS_MAIL_OPERATION (mail_op)) { + if (!MODEST_IS_MAIL_OPERATION (self)) { g_warning ("%s: invalid parametter", G_GNUC_FUNCTION); return retval; } - priv = MODEST_MAIL_OPERATION_GET_PRIVATE (mail_op); + priv = MODEST_MAIL_OPERATION_GET_PRIVATE (self); if (priv->status == MODEST_MAIL_OPERATION_STATUS_SUCCESS || priv->status == MODEST_MAIL_OPERATION_STATUS_FAILED || @@ -646,7 +646,7 @@ modest_mail_operation_is_finished (ModestMailOperation *mail_op) TnyFolder * -modest_mail_operation_create_folder (ModestMailOperation *mail_op, +modest_mail_operation_create_folder (ModestMailOperation *self, TnyFolderStore *parent, const gchar *name) { @@ -672,7 +672,7 @@ modest_mail_operation_create_folder (ModestMailOperation *mail_op, } void -modest_mail_operation_remove_folder (ModestMailOperation *mail_op, +modest_mail_operation_remove_folder (ModestMailOperation *self, TnyFolder *folder, gboolean remove_to_trash) { @@ -687,11 +687,11 @@ modest_mail_operation_remove_folder (ModestMailOperation *mail_op, if (remove_to_trash) { TnyFolder *trash_folder; - trash_folder = modest_mail_operation_find_trash_folder (mail_op, + trash_folder = modest_mail_operation_find_trash_folder (self, TNY_STORE_ACCOUNT (folder_store)); /* TODO: error_handling */ - modest_mail_operation_move_folder (mail_op, + modest_mail_operation_move_folder (self, folder, TNY_FOLDER_STORE (trash_folder)); } else { @@ -704,11 +704,11 @@ modest_mail_operation_remove_folder (ModestMailOperation *mail_op, } void -modest_mail_operation_rename_folder (ModestMailOperation *mail_op, +modest_mail_operation_rename_folder (ModestMailOperation *self, TnyFolder *folder, const gchar *name) { - g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (self)); g_return_if_fail (TNY_IS_FOLDER_STORE (folder)); g_return_if_fail (name); @@ -721,31 +721,31 @@ modest_mail_operation_rename_folder (ModestMailOperation *mail_op, } void -modest_mail_operation_move_folder (ModestMailOperation *mail_op, +modest_mail_operation_move_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent) { - g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (self)); g_return_if_fail (TNY_IS_FOLDER_STORE (parent)); g_return_if_fail (TNY_IS_FOLDER (folder)); - modest_mail_operation_xfer_folder (mail_op, folder, parent, TRUE); + modest_mail_operation_xfer_folder (self, folder, parent, TRUE); } void -modest_mail_operation_copy_folder (ModestMailOperation *mail_op, +modest_mail_operation_copy_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent) { - g_return_if_fail (MODEST_IS_MAIL_OPERATION (mail_op)); + g_return_if_fail (MODEST_IS_MAIL_OPERATION (self)); g_return_if_fail (TNY_IS_FOLDER_STORE (parent)); g_return_if_fail (TNY_IS_FOLDER (folder)); - modest_mail_operation_xfer_folder (mail_op, folder, parent, FALSE); + modest_mail_operation_xfer_folder (self, folder, parent, FALSE); } static void -modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, +modest_mail_operation_xfer_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent, gboolean delete_original) @@ -760,7 +760,7 @@ modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, /* Create the destination folder */ folder_name = tny_folder_get_name (folder); - dest_folder = modest_mail_operation_create_folder (mail_op, + dest_folder = modest_mail_operation_create_folder (self, parent, folder_name); /* Transfer messages */ @@ -776,7 +776,7 @@ modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, while (!tny_iterator_is_done (iter)) { child = TNY_FOLDER (tny_iterator_get_current (iter)); - modest_mail_operation_xfer_folder (mail_op, child, + modest_mail_operation_xfer_folder (self, child, TNY_FOLDER_STORE (dest_folder), delete_original); tny_iterator_next (iter); @@ -784,7 +784,7 @@ modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, /* Delete source folder (if needed) */ if (delete_original) - modest_mail_operation_remove_folder (mail_op, folder, FALSE); + modest_mail_operation_remove_folder (self, folder, FALSE); /* Clean up */ g_object_unref (G_OBJECT (dest_folder)); @@ -797,7 +797,7 @@ modest_mail_operation_xfer_folder (ModestMailOperation *mail_op, /* FIXME: this method should be rewritten when the policy for the Trash folder becomes clearer */ static TnyFolder * -modest_mail_operation_find_trash_folder (ModestMailOperation *mail_op, +modest_mail_operation_find_trash_folder (ModestMailOperation *self, TnyStoreAccount *store_account) { TnyList *folders; @@ -838,29 +838,29 @@ modest_mail_operation_find_trash_folder (ModestMailOperation *mail_op, /* ******************************************************************* */ void -modest_mail_operation_copy_msg (ModestMailOperation *mail_op, +modest_mail_operation_copy_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder) { g_return_if_fail (TNY_IS_HEADER (header)); g_return_if_fail (TNY_IS_FOLDER (folder)); - modest_mail_operation_xfer_msg (mail_op, header, folder, FALSE); + modest_mail_operation_xfer_msg (self, header, folder, FALSE); } void -modest_mail_operation_move_msg (ModestMailOperation *mail_op, +modest_mail_operation_move_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder) { g_return_if_fail (TNY_IS_HEADER (header)); g_return_if_fail (TNY_IS_FOLDER (folder)); - modest_mail_operation_xfer_msg (mail_op, header, folder, TRUE); + modest_mail_operation_xfer_msg (self, header, folder, TRUE); } void -modest_mail_operation_remove_msg (ModestMailOperation *mail_op, +modest_mail_operation_remove_msg (ModestMailOperation *self, TnyHeader *header, gboolean remove_to_trash) { @@ -876,9 +876,9 @@ modest_mail_operation_remove_msg (ModestMailOperation *mail_op, TnyStoreAccount *store_account; store_account = TNY_STORE_ACCOUNT (tny_folder_get_account (folder)); - trash_folder = modest_mail_operation_find_trash_folder (mail_op, store_account); + trash_folder = modest_mail_operation_find_trash_folder (self, store_account); - modest_mail_operation_move_msg (mail_op, header, trash_folder); + modest_mail_operation_move_msg (self, header, trash_folder); g_object_unref (G_OBJECT (store_account)); } else { @@ -891,7 +891,7 @@ modest_mail_operation_remove_msg (ModestMailOperation *mail_op, } static void -modest_mail_operation_xfer_msg (ModestMailOperation *mail_op, +modest_mail_operation_xfer_msg (ModestMailOperation *self, TnyHeader *header, TnyFolder *folder, gboolean delete_original) diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index 4555b57..cf2169c 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -107,7 +107,7 @@ ModestMailOperation* modest_mail_operation_new (void); * #TnyTransportAccount. This operation is synchronous, so the * #ModestMailOperation should not be added to any * #ModestMailOperationQueue - **/ + **/ void modest_mail_operation_send_mail (ModestMailOperation *self, TnyTransportAccount *transport_account, TnyMsg* msg); @@ -128,7 +128,7 @@ void modest_mail_operation_send_mail (ModestMailOperation *self, * #TnyTransportAccount. This operation is synchronous, so the * #ModestMailOperation should not be added to any * #ModestMailOperationQueue - **/ + **/ void modest_mail_operation_send_new_mail (ModestMailOperation *self, TnyTransportAccount *transport_account, const gchar *from, diff --git a/src/modest-pair.h b/src/modest-pair.h index 4e23d14..d573c99 100644 --- a/src/modest-pair.h +++ b/src/modest-pair.h @@ -63,7 +63,7 @@ ModestPair* modest_pair_new (gpointer first, gpointer second, gboolean * destroy a ModestPair instance. If it was created with own==TRUE, the elements * will be g_free'd as well. If pair==NULL, nothing will be done. */ -void modest_pair_destroy (ModestPair *pair); +void modest_pair_destroy (ModestPair *self); /** diff --git a/src/modest-presets.h b/src/modest-presets.h index d10bb0a..5f316e1 100644 --- a/src/modest-presets.h +++ b/src/modest-presets.h @@ -85,7 +85,8 @@ gchar ** modest_presets_get_providers (ModestPresets *self, g * modest_presets_get_server: * @self: a valid ModestPresets instance * @provider: name of the provider - * @incoming: get the incoming mailserver if TRUE, get the outgoing server otherwise + * @incoming_server: get the incoming mailserver if TRUE, get the + * outgoing server otherwise * * get the name of a incoming or outgoing mailserver * @@ -100,7 +101,8 @@ gchar * modest_presets_get_server (ModestPresets *self, * modest_presets_get_info: * @self: a valid ModestPresets instance * @provider: name of the provider - * @incoming: get the incoming mailserver if TRUE, get the outgoing server otherwise + * @incoming_server: get the incoming mailserver if TRUE, get the + * outgoing server otherwise * * get information about some incoming or outgoing mailserver * diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 405a231..74a2867 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -53,7 +53,7 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, /** * modest_text_utils_quote: - * @buf: a string which contains the message to quote + * @text: a string which contains the message to quote * @from: the sender of the original message * @sent_date: sent date/time of the original message * @limit: specifies the maximum characters per line in the quoted text @@ -126,7 +126,7 @@ gchar* modest_text_utils_remove_address (const gchar *address_list, * * Returns: a newly allocated string containing the html */ -gchar* modest_text_utils_convert_to_html (const gchar *data); +gchar* modest_text_utils_convert_to_html (const gchar *txt); /** diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h index 8e93e61..d1f674a 100644 --- a/src/modest-tny-account-store.h +++ b/src/modest-tny-account-store.h @@ -83,7 +83,7 @@ GType modest_tny_account_store_get_type (void) G_GNUC_CONST; /** * modest_tny_account_store_new: - * @modest_acc_mgr: account manager to use for new account store + * @account_mgr: account manager to use for new account store * * creates new (tinymail) account store for account manager modest_acc_mgr * diff --git a/src/modest-tny-platform-factory.h b/src/modest-tny-platform-factory.h index 3686cfb..053b821 100644 --- a/src/modest-tny-platform-factory.h +++ b/src/modest-tny-platform-factory.h @@ -65,7 +65,6 @@ GType modest_tny_platform_factory_get_type (void) G_GNUC_CONST; /** * modest_tny_platform_factory_get_instance: - * @void: * * Gets a new instance of the platform factory if it is the first call * to the function, or the current one otherwise. This object is diff --git a/src/modest-widget-factory.h b/src/modest-widget-factory.h index 99c828c..07a3fe7 100644 --- a/src/modest-widget-factory.h +++ b/src/modest-widget-factory.h @@ -85,9 +85,6 @@ GType modest_widget_factory_get_type (void) G_GNUC_CONST; /** * modest_widget_factory_new - * @conf: a modest conf instance - * @acc_store: a modest account store instance - * @acc_mgr: a modest account mgr instance * * instantiates a ModestWidgetFactory * diff --git a/src/modest-widget-memory.h b/src/modest-widget-memory.h index bb746c9..13fb2d1 100644 --- a/src/modest-widget-memory.h +++ b/src/modest-widget-memory.h @@ -37,7 +37,7 @@ G_BEGIN_DECLS /** * modest_widget_memory_save: - * @self: a ModestConf instance + * @conf: a ModestConf instance * @widget: the widget to save the settings for * @name: the unique name for this widget * @@ -49,7 +49,7 @@ gboolean modest_widget_memory_save (ModestConf *conf, GObject *widget, const gch /** * modest_widget_memory_restore: - * @self: a ModestConf instance + * @conf: a ModestConf instance * @widget: the widget to save the settings for * @name: the unique name for this widget * diff --git a/src/widgets/modest-header-view.h b/src/widgets/modest-header-view.h index a8d854a..c8abdf0 100644 --- a/src/widgets/modest-header-view.h +++ b/src/widgets/modest-header-view.h @@ -165,7 +165,6 @@ gboolean modest_header_view_set_columns (ModestHeaderView *self, /** * modest_header_view_get_columns: * @self: a ModestHeaderView instance - * @folder: a TnyFolder object * * get the GtkTreeColumns for this ModestHeaderView. Each one of the * tree columns will have property than can be retrieved -- 1.7.9.5