From 3e7206e4700d2bb49daa3b11c9b87be9f8014665 Mon Sep 17 00:00:00 2001 From: Arne Zellentin Date: Wed, 31 May 2006 14:28:08 +0000 Subject: [PATCH] * doc updates / fixes pmo-trunk-r131 --- src/modest-conf.h | 8 ++++---- src/modest-tny-account-store.h | 10 ++++------ src/modest-tny-msg-actions.h | 21 ++++++++++++++++++++- src/modest-tny-msg-view.h | 11 ++++++++++- src/modest-tny-transport-actions.h | 15 +++++++++++++++ src/modest-ui.h | 5 +++-- 6 files changed, 56 insertions(+), 14 deletions(-) diff --git a/src/modest-conf.h b/src/modest-conf.h index 16cf275..60b5f29 100644 --- a/src/modest-conf.h +++ b/src/modest-conf.h @@ -55,7 +55,7 @@ GObject* modest_conf_new (void); /** * modest_conf_get_string: - * @self: self a ModestConf instance + * @self: a ModestConf instance * @key: the key of the value to retrieve * @err: a GError ptr, or NULL to ignore. * @@ -69,7 +69,7 @@ gchar* modest_conf_get_string (ModestConf* self, const gchar* key, GError /** * modest_conf_get_int: - * @self: self a ModestConf instance + * @self: a ModestConf instance * @key: the key of the value to retrieve * @err: a GError ptr, or NULL to ignore. * @@ -84,7 +84,7 @@ int modest_conf_get_int (ModestConf* self, const gchar* key, GError /** * modest_conf_get_bool: - * @self: self a ModestConf instance + * @self: a ModestConf instance * @key: the key of the value to retrieve * @err: a GError ptr, or NULL to ignore. * @@ -181,7 +181,7 @@ gboolean modest_conf_remove_key (ModestConf* self, const gchar* key, GError * * checks if the given key exists in the configuration system * - * Returns: TRUE if exists, FALSE otherwise. + * Returns: TRUE if it exists, FALSE otherwise. * @err gives details in case of error */ gboolean modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err); diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h index eb2e1dc..842e9cf 100644 --- a/src/modest-tny-account-store.h +++ b/src/modest-tny-account-store.h @@ -42,9 +42,7 @@ struct _ModestTnyAccountStoreClass { /** * modest_tny_account_store_get_type: * - * returns GType of account store ??? - * - * Returns: ??? + * Returns: GType of account store */ GType modest_tny_account_store_get_type (void) G_GNUC_CONST; @@ -52,19 +50,19 @@ 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 * - * creates new tiny account store for account manager modest_acc_mgr + * creates new (tinymail) account store for account manager modest_acc_mgr * * Returns: GObject of newly created account store */ GObject* modest_tny_account_store_new (ModestAccountMgr *modest_acc_mgr); /** - * modest_tny_account_store_get_accout_mgr: + * modest_tny_account_store_get_account_mgr: * @self: a TnyAccountStore instance * * retrieve the account manager associated with this account store. * - * Returns: the account manager for self. + * Returns: the account manager for @self. */ ModestAccountMgr *modest_tny_account_store_get_accout_mgr(ModestTnyAccountStore *self); diff --git a/src/modest-tny-msg-actions.h b/src/modest-tny-msg-actions.h index f25c5c2..7637eb6 100644 --- a/src/modest-tny-msg-actions.h +++ b/src/modest-tny-msg-actions.h @@ -9,8 +9,16 @@ /** * modest_tny_msg_actions_quote: * @self: the message to quote + * @from: the original sender of the message + * @sent_date: the date the original message was sent + * @limit: characters per line limit for the quoted message + * @to_quote: a string to quote instead of the message body * - * Returns: a string containing the quoted message + * reply-quotes a message or @to_quote if it's not NULL. + + * Note: @from and @sent_date may be eliminated from the API in future versions + * + * Returns: a newly allocated string containing the quoted message */ gchar *modest_tny_msg_actions_quote (const TnyMsgIface * self, @@ -18,6 +26,17 @@ gchar *modest_tny_msg_actions_quote (const TnyMsgIface * self, time_t sent_date, gint limit, gchar *to_quote); +/** + * modest_tny_msg_actions_find_body_part: + * @self: a message + * @mime_type: the mime type to find + * + * search a message for a body part of type @mime_type. @mime_type is a string + * like "text/plain". + * + * Returns: the TnyMsgMimePartIface for the found part, or NULL if no matching part is found + */ + TnyMsgMimePartIface *modest_tny_msg_actions_find_body_part (TnyMsgIface * self, const gchar * mime_type); diff --git a/src/modest-tny-msg-view.h b/src/modest-tny-msg-view.h index 2ef059a..acfd54c 100644 --- a/src/modest-tny-msg-view.h +++ b/src/modest-tny-msg-view.h @@ -65,7 +65,16 @@ GtkWidget* modest_tny_msg_view_new (TnyMsgIface *tny_msg); * */ void modest_tny_msg_view_set_message (ModestTnyMsgView *self, TnyMsgIface *tny_msg); - + + +/** + * modest_tny_msg_view_get_selected_text: + * @self: a ModestTnyMsgView instance + * + * get the user selected part of the message + * + * Returns: a newly allocated string of the user's selection or NULL if nothing is selected + */ gchar * modest_tny_msg_view_get_selected_text (ModestTnyMsgView *self); G_END_DECLS diff --git a/src/modest-tny-transport-actions.h b/src/modest-tny-transport-actions.h index 7fb6d51..0bc2801 100644 --- a/src/modest-tny-transport-actions.h +++ b/src/modest-tny-transport-actions.h @@ -40,6 +40,21 @@ GType modest_tny_transport_actions_get_type (void) G_GNUC_CONST; GObject* modest_tny_transport_actions_new (void); +/** + * modest_tny_transport_actions_send_message: + * @self: a ModestTnyTransportActions object + * @transport_account: the TnyTransportAccountIface to use for sending this message + * @from: the email address of the sender + * @to: the email address of the receiver + * @cc: the receivers of a copy of the message (comma-seperated) + * @bcc: the receivers of a blind copy of the message (comma-seperated) + * @subject: the Subject: of the message + * @body: a string containing the message body (text) + * + * send a email message to @to + * + * Returns: TRUE but this will change to whether sending was successful + */ gboolean modest_tny_transport_actions_send_message (ModestTnyTransportActions *self, TnyTransportAccountIface *transport_account, const gchar *from, diff --git a/src/modest-ui.h b/src/modest-ui.h index 2fa9089..fc487fc 100644 --- a/src/modest-ui.h +++ b/src/modest-ui.h @@ -55,9 +55,10 @@ GObject* modest_ui_new (ModestConf *modest_conf); /** * modest_ui_show_main_window: * @ui: a ModestUI instance - * - * Returns: TRUE if succeeded, FALSE otherwise * + * show the application's main window + * + * Returns: TRUE if succeeded, FALSE otherwise */ gboolean modest_ui_show_main_window (ModestUI *ui); -- 1.7.9.5