* Added documentation to ModestFormatter

* Modified the modest docs documentation
* Added some missing paths do the documentation scan path

pmo-trunk-r574

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index e02b510..5b1c58c 100644 (file)
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -88,12 +88,14 @@ GTKDOC_LIBS=\
        ${top_builddir}/src/modest-marshal.o \
        ${top_builddir}/src/modest-tny-account-store.o \
        ${top_builddir}/src/modest-mail-operation.o \
+       ${top_builddir}/src/modest-mail-operation-queue.o \
        ${top_builddir}/src/modest-tny-msg-actions.o \
        ${top_builddir}/src/modest-tny-attachment.o \
        ${top_builddir}/src/modest-tny-stream-gtkhtml.o \
        ${top_builddir}/src/modest-widget-factory.o \
        ${top_builddir}/src/modest-widget-memory.o \
        ${top_builddir}/src/modest-icon-factory.o \
+       ${top_builddir}/src/modest-formatter.o \
        ${top_builddir}/src/modest-text-utils.o
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.

diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml
index 093e821..43160a9 100644 (file)
--- a/docs/reference/modest-docs.sgml
+++ b/docs/reference/modest-docs.sgml
@@ -1,7 +1,53 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
-          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+<!ENTITY ModestAccountKeys SYSTEM "xml/modest-account-keys.xml">
+<!ENTITY ModestAccountMgr SYSTEM "xml/modest-account-mgr.xml">
+<!ENTITY ModestConfKeys SYSTEM "xml/modest-conf-keys.xml">
+<!ENTITY ModestConf SYSTEM "xml/modest-conf.xml">
+<!ENTITY ModestError SYSTEM "xml/modest-error.xml">
+<!ENTITY ModestFormatter SYSTEM "xml/modest-formatter.xml">
+<!ENTITY ModestIconFactory SYSTEM "xml/modest-icon-factory.xml">
+<!ENTITY ModestIconNames SYSTEM "xml/modest-icon-names.xml">
+<!ENTITY ModestMailOperation SYSTEM "xml/modest-mail-operation.xml">
+<!ENTITY ModestMailOperationQueue SYSTEM "xml/modest-mail-operation-queue.xml">
+<!ENTITY ModestMarshal SYSTEM "xml/modest-marshal.xml">
+<!ENTITY ModestPair SYSTEM "xml/modest-pair.xml">
+<!ENTITY ModestPresets SYSTEM "xml/modest-presets.xml">
+<!ENTITY ModestProtocolMgr SYSTEM "xml/modest-protocol-mgr.xml">
+<!ENTITY ModestProto SYSTEM "xml/modest-proto.xml">
+<!ENTITY ModestTextUtils SYSTEM "xml/modest-text-utils.xml">
+<!ENTITY ModestTnyAccountStore SYSTEM "xml/modest-tny-account-store.xml">
+<!ENTITY ModestTnyAttachment SYSTEM "xml/modest-tny-attachment.xml">
+<!ENTITY ModestTnyMsgActions SYSTEM "xml/modest-tny-msg-actions.xml">
+<!ENTITY ModestTnyPlatformFactory SYSTEM "xml/modest-tny-platform-factory.xml">
+<!ENTITY ModestTnyStoreActions SYSTEM "xml/modest-tny-store-actions.xml">
+<!ENTITY ModestTnyStreamGtkhtml SYSTEM "xml/modest-tny-stream-gtkhtml.xml">
+<!ENTITY ModestWidgetFactory SYSTEM "xml/modest-widget-factory.xml">
+<!ENTITY ModestWidgetMemory SYSTEM "xml/modest-widget-memory.xml">
+
+<!ENTITY widgets-ModestAccountView SYSTEM "xml/modest-account-view.xml">
+<!ENTITY widgets-ModestComboBox SYSTEM "xml/modest-combo-box.xml">
+<!ENTITY widgets-ModestFolderView SYSTEM "xml/modest-folder-view.xml">
+<!ENTITY widgets-ModestHeaderView SYSTEM "xml/modest-header-view.xml">
+<!ENTITY widgets-ModestMsgView SYSTEM "xml/modest-msg-view.xml">
+<!ENTITY widgets-modestToolbar SYSTEM "xml/modest-toolbar.xml">
+
+<!ENTITY gtk-ModestAccountViewWindow SYSTEM "xml/modest-account-view-window.xml">
+<!ENTITY gtk-ModestAccountAssistant SYSTEM "xml/modest-account-assistant.xml">
+<!ENTITY gtk-ModestEditMsgWindow SYSTEM "xml/modest-edit-msg-window.xml">
+<!ENTITY gtk-ModestMainWindow SYSTEM "xml/modest-main-window.xml">
+<!ENTITY gtk-ModestStoreWidget SYSTEM "xml/modest-store-widget.xml">
+<!ENTITY gtk-modestTransportWidget SYSTEM "xml/modest-transport-widget.xml">
+<!ENTITY gtk-modestUi SYSTEM "xml/modest-ui.xml">
+
+<!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
+
+]>
+
+<!--<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">-->
+<book id="index">
   <bookinfo>
     <title>modest technical documentation</title>
     <copyright>
@@ -346,20 +392,38 @@
   
   <chapter>
     <title>API Reference</title>
-    <xi:include href="xml/modest-ui.xml"/>
-    <xi:include href="xml/modest-tny-header-tree-view.xml"/>
-    <xi:include href="xml/modest-tny-msg-view.xml"/>
-    <xi:include href="xml/modest-account-mgr.xml"/>
-    <xi:include href="xml/modest-conf.xml"/>
-    <xi:include href="xml/modest-window-mgr.xml"/>
-    <xi:include href="xml/modest-tny-folder-tree-view.xml"/>
-    <xi:include href="xml/modest-tny-account-store.xml"/>
-    <xi:include href="xml/modest-tny-transport-actions.xml"/>
-    <xi:include href="xml/modest-main-window.xml"/>
-    <xi:include href="xml/modest-editor-window.xml"/>
-    <xi:include href="xml/modest-viewer-window.xml"/>
-    <xi:include href="xml/modest-proto.xml"/>
-    <xi:include href="xml/modest-account-keys.xml"/>
-    <xi:include href="xml/modest-conf-keys.xml"/>
+      <chapter id="src">
+        <title>Modest</title>
+          &ModestAccountKeys;
+          &ModestAccountMgr;
+          &ModestConfKeys;
+          &ModestConf;
+          &ModestError;
+          &ModestFormatter;
+          &ModestIconFactory;
+          &ModestIconNames;
+          &ModestMailOperation;
+          &ModestMailOperationQueue;
+          &ModestMarshal;
+          &ModestPair;
+          &ModestPresets;
+          &ModestProtocolMgr;
+          &ModestProto;
+          &ModestTextUtils;
+          &ModestTnyAccountStore;
+          &ModestTnyAttachment;
+          &ModestTnyMsgActions;
+          &ModestTnyPlatformFactory;
+          &ModestTnyStoreActions;
+          &ModestTnyStreamGtkhtml;
+          &ModestWidgetFactory;
+          &ModestWidgetMemory;
+      </chapter>
+      <chapter id="gtk">
+        <title>Gtk</title>
+      </chapter>
+      <chapter id="widgets">
+        <title>Widgets</title>
+      </chapter>
   </chapter>
 </book>

diff --git a/docs/reference/modest-sections.txt b/docs/reference/modest-sections.txt
index 7135841..b997871 100644 (file)
--- a/docs/reference/modest-sections.txt
+++ b/docs/reference/modest-sections.txt
@@ -27,16 +27,6 @@ MODEST_TNY_ATTACHMENT_GET_CLASS
 <TITLE>ModestUI</TITLE>
 ModestUI
 modest_ui_new
-modest_ui_show_main_window
-modest_ui_new_edit_window
-modest_ui_new_editor_window
-modest_ui_editor_window_set_to_header
-modest_ui_editor_window_set_cc_header
-modest_ui_editor_window_set_bcc_header
-modest_ui_editor_window_set_subject_header
-modest_ui_editor_window_set_body
-modest_ui_editor_window_update_attachments
-modest_ui_new_viewer_window
 modest_ui_main_window
 <SUBSECTION Standard>
 MODEST_UI
@@ -68,10 +58,12 @@ modest_account_mgr_account_get_enabled
 modest_account_mgr_get_string
 modest_account_mgr_get_int
 modest_account_mgr_get_bool
+modest_account_mgr_get_list
 modest_account_mgr_set_string
 modest_account_mgr_set_int
 modest_account_mgr_set_bool
-modest_account_mgr_get_list
+modest_account_mgr_set_list
+modest_account_mgr_unset
 <SUBSECTION Standard>
 MODEST_ACCOUNT_MGR
 MODEST_IS_ACCOUNT_MGR
@@ -125,17 +117,17 @@ modest_conf_new
 modest_conf_get_string
 modest_conf_get_int
 modest_conf_get_bool
-modest_conf_get_string_or_default
-modest_conf_get_int_or_default
+modest_conf_get_list
 modest_conf_set_string
 modest_conf_set_int
 modest_conf_set_bool
+modest_conf_set_list
 modest_conf_list_subkeys
 modest_conf_remove_key
 modest_conf_key_exists
+modest_conf_key_is_valid
 modest_conf_key_escape
 modest_conf_key_unescape
-modest_conf_get_list
 <SUBSECTION Standard>
 MODEST_CONF
 MODEST_IS_CONF
@@ -153,6 +145,7 @@ ModestTnyPlatformFactory
 modest_tny_platform_factory_get_instance
 modest_tny_platform_factory_get_modest_account_mgr_instance
 modest_tny_platform_factory_get_modest_conf_instance
+modest_tny_platform_factory_get_modest_mail_operation_queue_instance
 <SUBSECTION Standard>
 MODEST_TNY_PLATFORM_FACTORY
 MODEST_IS_TNY_PLATFORM_FACTORY
@@ -164,6 +157,44 @@ MODEST_TNY_PLATFORM_FACTORY_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>modest-mail-operation-queue</FILE>
+<TITLE>ModestMailOperationQueue</TITLE>
+ModestMailOperationQueue
+modest_mail_operation_queue_new
+modest_mail_operation_queue_add
+modest_mail_operation_queue_remove
+modest_mail_operation_queue_cancel
+modest_mail_operation_queue_cancel_all
+<SUBSECTION Standard>
+MODEST_MAIL_OPERATION_QUEUE
+MODEST_IS_MAIL_OPERATION_QUEUE
+MODEST_TYPE_MAIL_OPERATION_QUEUE
+modest_mail_operation_queue_get_type
+MODEST_MAIL_OPERATION_QUEUE_CLASS
+MODEST_IS_MAIL_OPERATION_QUEUE_CLASS
+MODEST_MAIL_OPERATION_QUEUE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-formatter</FILE>
+<TITLE>ModestFormatter</TITLE>
+ModestFormatter
+modest_formatter_new
+modest_formatter_cite
+modest_formatter_quote
+modest_formatter_inline
+modest_formatter_attach
+<SUBSECTION Standard>
+MODEST_FORMATTER
+MODEST_IS_FORMATTER
+MODEST_TYPE_FORMATTER
+modest_formatter_get_type
+MODEST_FORMATTER_CLASS
+MODEST_IS_FORMATTER_CLASS
+MODEST_FORMATTER_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>modest-tny-stream-gtkhtml</FILE>
 <TITLE>ModestTnyStreamGtkhtml</TITLE>
 ModestTnyStreamGtkhtml
@@ -197,7 +228,12 @@ modest_mail_operation_remove_folder
 modest_mail_operation_rename_folder
 modest_mail_operation_move_folder
 modest_mail_operation_copy_folder
-modest_mail_operation_move_folder_to_trash
+modest_mail_operation_copy_msg
+modest_mail_operation_move_msg
+modest_mail_operation_remove_msg
+modest_mail_operation_get_task_done
+modest_mail_operation_get_task_total
+modest_mail_operation_is_finished
 modest_mail_operation_get_status
 modest_mail_operation_get_error
 modest_mail_operation_cancel
@@ -212,23 +248,6 @@ MODEST_MAIL_OPERATION_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>modest-tny-account-store</FILE>
-ModestTnyGetPassFunc
-<TITLE>ModestTnyAccountStore</TITLE>
-ModestTnyAccountStore
-modest_tny_account_store_new
-tny_account_store_get_session
-<SUBSECTION Standard>
-MODEST_TNY_ACCOUNT_STORE
-MODEST_IS_TNY_ACCOUNT_STORE
-MODEST_TYPE_TNY_ACCOUNT_STORE
-modest_tny_account_store_get_type
-MODEST_TNY_ACCOUNT_STORE_CLASS
-MODEST_IS_TNY_ACCOUNT_STORE_CLASS
-MODEST_TNY_ACCOUNT_STORE_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>modest-widget-factory</FILE>
 <TITLE>ModestWidgetFactory</TITLE>
 ModestWidgetFactory
@@ -256,6 +275,123 @@ MODEST_WIDGET_FACTORY_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>modest-tny-account-store</FILE>
+ModestTnyGetPassFunc
+<TITLE>ModestTnyAccountStore</TITLE>
+ModestTnyAccountStore
+modest_tny_account_store_new
+tny_account_store_get_session
+<SUBSECTION Standard>
+MODEST_TNY_ACCOUNT_STORE
+MODEST_IS_TNY_ACCOUNT_STORE
+MODEST_TYPE_TNY_ACCOUNT_STORE
+modest_tny_account_store_get_type
+MODEST_TNY_ACCOUNT_STORE_CLASS
+MODEST_IS_TNY_ACCOUNT_STORE_CLASS
+MODEST_TNY_ACCOUNT_STORE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-account-assistant</FILE>
+<TITLE>ModestAccountAssistant</TITLE>
+ModestAccountAssistant
+modest_account_assistant_new
+<SUBSECTION Standard>
+MODEST_ACCOUNT_ASSISTANT
+MODEST_IS_ACCOUNT_ASSISTANT
+MODEST_TYPE_ACCOUNT_ASSISTANT
+modest_account_assistant_get_type
+MODEST_ACCOUNT_ASSISTANT_CLASS
+MODEST_IS_ACCOUNT_ASSISTANT_CLASS
+MODEST_ACCOUNT_ASSISTANT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-account-view-window</FILE>
+<TITLE>ModestAccountViewWindow</TITLE>
+ModestAccountViewWindow
+modest_account_view_window_new
+<SUBSECTION Standard>
+MODEST_ACCOUNT_VIEW_WINDOW
+MODEST_IS_ACCOUNT_VIEW_WINDOW
+MODEST_TYPE_ACCOUNT_VIEW_WINDOW
+modest_account_view_window_get_type
+MODEST_ACCOUNT_VIEW_WINDOW_CLASS
+MODEST_IS_ACCOUNT_VIEW_WINDOW_CLASS
+MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-transport-widget</FILE>
+<TITLE>ModestTransportWidget</TITLE>
+ModestTransportWidget
+modest_transport_widget_new
+modest_transport_widget_get_remember_password
+modest_transport_widget_get_username
+modest_transport_widget_get_servername
+modest_transport_widget_get_proto
+<SUBSECTION Standard>
+MODEST_TRANSPORT_WIDGET
+MODEST_IS_TRANSPORT_WIDGET
+MODEST_TYPE_TRANSPORT_WIDGET
+modest_transport_widget_get_type
+MODEST_TRANSPORT_WIDGET_CLASS
+MODEST_IS_TRANSPORT_WIDGET_CLASS
+MODEST_TRANSPORT_WIDGET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-store-widget</FILE>
+<TITLE>ModestStoreWidget</TITLE>
+ModestStoreWidget
+modest_store_widget_new
+modest_store_widget_get_remember_password
+modest_store_widget_get_username
+modest_store_widget_get_servername
+modest_store_widget_get_proto
+<SUBSECTION Standard>
+MODEST_STORE_WIDGET
+MODEST_IS_STORE_WIDGET
+MODEST_TYPE_STORE_WIDGET
+modest_store_widget_get_type
+MODEST_STORE_WIDGET_CLASS
+MODEST_IS_STORE_WIDGET_CLASS
+MODEST_STORE_WIDGET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-edit-msg-window</FILE>
+<TITLE>ModestEditMsgWindow</TITLE>
+ModestEditMsgWindow
+ModestEditType
+modest_edit_msg_window_new
+modest_edit_msg_window_set_msg
+<SUBSECTION Standard>
+MODEST_EDIT_MSG_WINDOW
+MODEST_IS_EDIT_MSG_WINDOW
+MODEST_TYPE_EDIT_MSG_WINDOW
+modest_edit_msg_window_get_type
+MODEST_EDIT_MSG_WINDOW_CLASS
+MODEST_IS_EDIT_MSG_WINDOW_CLASS
+MODEST_EDIT_MSG_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-main-window</FILE>
+<TITLE>ModestMainWindow</TITLE>
+ModestMainWindow
+modest_main_window_new
+<SUBSECTION Standard>
+MODEST_MAIN_WINDOW
+MODEST_IS_MAIN_WINDOW
+MODEST_TYPE_MAIN_WINDOW
+modest_main_window_get_type
+MODEST_MAIN_WINDOW_CLASS
+MODEST_IS_MAIN_WINDOW_CLASS
+MODEST_MAIN_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>modest-account-assistant</FILE>
 <TITLE>ModestAccountAssistant</TITLE>
 ModestAccountAssistant
@@ -359,6 +495,7 @@ MODEST_MAIN_WINDOW_GET_CLASS
 <TITLE>ModestAccountView</TITLE>
 ModestAccountView
 modest_account_view_new
+modest_account_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_ACCOUNT_VIEW
 MODEST_IS_ACCOUNT_VIEW
@@ -371,13 +508,15 @@ MODEST_ACCOUNT_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-header-view</FILE>
-<TITLE>ModestHeaderView</TITLE>
-ModestHeaderView
+MODEST_HEADER_VIEW_COLUMN
 ModestHeaderViewColumn
 ModestHeaderViewStyle
 ModestItemType
+<TITLE>ModestHeaderView</TITLE>
+ModestHeaderView
 modest_header_view_new
 modest_header_view_set_folder
+modest_header_view_get_folder
 modest_header_view_set_columns
 modest_header_view_get_columns
 modest_header_view_set_style
@@ -395,9 +534,9 @@ MODEST_HEADER_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-toolbar</FILE>
+ModestToolbarButton
 <TITLE>ModestToolbar</TITLE>
 ModestToolbar
-ModestToolbarButton
 modest_toolbar_new
 <SUBSECTION Standard>
 MODEST_TOOLBAR
@@ -414,7 +553,9 @@ MODEST_TOOLBAR_GET_CLASS
 <TITLE>ModestFolderView</TITLE>
 ModestFolderView
 modest_folder_view_new
+modest_folder_view_set_title
 modest_folder_view_is_empty
+modest_folder_view_guess_folder_type
 modest_folder_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_FOLDER_VIEW
@@ -449,7 +590,6 @@ MODEST_COMBO_BOX_GET_CLASS
 ModestMsgView
 modest_msg_view_new
 modest_msg_view_set_message
-modest_msg_view_get_selected_text
 <SUBSECTION Standard>
 MODEST_MSG_VIEW
 MODEST_IS_MSG_VIEW
@@ -489,16 +629,6 @@ MODEST_TNY_ATTACHMENT_GET_CLASS
 <TITLE>ModestUI</TITLE>
 ModestUI
 modest_ui_new
-modest_ui_show_main_window
-modest_ui_new_edit_window
-modest_ui_new_editor_window
-modest_ui_editor_window_set_to_header
-modest_ui_editor_window_set_cc_header
-modest_ui_editor_window_set_bcc_header
-modest_ui_editor_window_set_subject_header
-modest_ui_editor_window_set_body
-modest_ui_editor_window_update_attachments
-modest_ui_new_viewer_window
 modest_ui_main_window
 <SUBSECTION Standard>
 MODEST_UI
@@ -530,10 +660,12 @@ modest_account_mgr_account_get_enabled
 modest_account_mgr_get_string
 modest_account_mgr_get_int
 modest_account_mgr_get_bool
+modest_account_mgr_get_list
 modest_account_mgr_set_string
 modest_account_mgr_set_int
 modest_account_mgr_set_bool
-modest_account_mgr_get_list
+modest_account_mgr_set_list
+modest_account_mgr_unset
 <SUBSECTION Standard>
 MODEST_ACCOUNT_MGR
 MODEST_IS_ACCOUNT_MGR
@@ -587,17 +719,17 @@ modest_conf_new
 modest_conf_get_string
 modest_conf_get_int
 modest_conf_get_bool
-modest_conf_get_string_or_default
-modest_conf_get_int_or_default
+modest_conf_get_list
 modest_conf_set_string
 modest_conf_set_int
 modest_conf_set_bool
+modest_conf_set_list
 modest_conf_list_subkeys
 modest_conf_remove_key
 modest_conf_key_exists
+modest_conf_key_is_valid
 modest_conf_key_escape
 modest_conf_key_unescape
-modest_conf_get_list
 <SUBSECTION Standard>
 MODEST_CONF
 MODEST_IS_CONF
@@ -615,6 +747,7 @@ ModestTnyPlatformFactory
 modest_tny_platform_factory_get_instance
 modest_tny_platform_factory_get_modest_account_mgr_instance
 modest_tny_platform_factory_get_modest_conf_instance
+modest_tny_platform_factory_get_modest_mail_operation_queue_instance
 <SUBSECTION Standard>
 MODEST_TNY_PLATFORM_FACTORY
 MODEST_IS_TNY_PLATFORM_FACTORY
@@ -626,6 +759,44 @@ MODEST_TNY_PLATFORM_FACTORY_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>modest-mail-operation-queue</FILE>
+<TITLE>ModestMailOperationQueue</TITLE>
+ModestMailOperationQueue
+modest_mail_operation_queue_new
+modest_mail_operation_queue_add
+modest_mail_operation_queue_remove
+modest_mail_operation_queue_cancel
+modest_mail_operation_queue_cancel_all
+<SUBSECTION Standard>
+MODEST_MAIL_OPERATION_QUEUE
+MODEST_IS_MAIL_OPERATION_QUEUE
+MODEST_TYPE_MAIL_OPERATION_QUEUE
+modest_mail_operation_queue_get_type
+MODEST_MAIL_OPERATION_QUEUE_CLASS
+MODEST_IS_MAIL_OPERATION_QUEUE_CLASS
+MODEST_MAIL_OPERATION_QUEUE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-formatter</FILE>
+<TITLE>ModestFormatter</TITLE>
+ModestFormatter
+modest_formatter_new
+modest_formatter_cite
+modest_formatter_quote
+modest_formatter_inline
+modest_formatter_attach
+<SUBSECTION Standard>
+MODEST_FORMATTER
+MODEST_IS_FORMATTER
+MODEST_TYPE_FORMATTER
+modest_formatter_get_type
+MODEST_FORMATTER_CLASS
+MODEST_IS_FORMATTER_CLASS
+MODEST_FORMATTER_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>modest-tny-stream-gtkhtml</FILE>
 <TITLE>ModestTnyStreamGtkhtml</TITLE>
 ModestTnyStreamGtkhtml
@@ -659,7 +830,12 @@ modest_mail_operation_remove_folder
 modest_mail_operation_rename_folder
 modest_mail_operation_move_folder
 modest_mail_operation_copy_folder
-modest_mail_operation_move_folder_to_trash
+modest_mail_operation_copy_msg
+modest_mail_operation_move_msg
+modest_mail_operation_remove_msg
+modest_mail_operation_get_task_done
+modest_mail_operation_get_task_total
+modest_mail_operation_is_finished
 modest_mail_operation_get_status
 modest_mail_operation_get_error
 modest_mail_operation_cancel
@@ -674,23 +850,6 @@ MODEST_MAIL_OPERATION_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>modest-tny-account-store</FILE>
-ModestTnyGetPassFunc
-<TITLE>ModestTnyAccountStore</TITLE>
-ModestTnyAccountStore
-modest_tny_account_store_new
-tny_account_store_get_session
-<SUBSECTION Standard>
-MODEST_TNY_ACCOUNT_STORE
-MODEST_IS_TNY_ACCOUNT_STORE
-MODEST_TYPE_TNY_ACCOUNT_STORE
-modest_tny_account_store_get_type
-MODEST_TNY_ACCOUNT_STORE_CLASS
-MODEST_IS_TNY_ACCOUNT_STORE_CLASS
-MODEST_TNY_ACCOUNT_STORE_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>modest-widget-factory</FILE>
 <TITLE>ModestWidgetFactory</TITLE>
 ModestWidgetFactory
@@ -718,6 +877,123 @@ MODEST_WIDGET_FACTORY_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>modest-tny-account-store</FILE>
+ModestTnyGetPassFunc
+<TITLE>ModestTnyAccountStore</TITLE>
+ModestTnyAccountStore
+modest_tny_account_store_new
+tny_account_store_get_session
+<SUBSECTION Standard>
+MODEST_TNY_ACCOUNT_STORE
+MODEST_IS_TNY_ACCOUNT_STORE
+MODEST_TYPE_TNY_ACCOUNT_STORE
+modest_tny_account_store_get_type
+MODEST_TNY_ACCOUNT_STORE_CLASS
+MODEST_IS_TNY_ACCOUNT_STORE_CLASS
+MODEST_TNY_ACCOUNT_STORE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-account-assistant</FILE>
+<TITLE>ModestAccountAssistant</TITLE>
+ModestAccountAssistant
+modest_account_assistant_new
+<SUBSECTION Standard>
+MODEST_ACCOUNT_ASSISTANT
+MODEST_IS_ACCOUNT_ASSISTANT
+MODEST_TYPE_ACCOUNT_ASSISTANT
+modest_account_assistant_get_type
+MODEST_ACCOUNT_ASSISTANT_CLASS
+MODEST_IS_ACCOUNT_ASSISTANT_CLASS
+MODEST_ACCOUNT_ASSISTANT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-account-view-window</FILE>
+<TITLE>ModestAccountViewWindow</TITLE>
+ModestAccountViewWindow
+modest_account_view_window_new
+<SUBSECTION Standard>
+MODEST_ACCOUNT_VIEW_WINDOW
+MODEST_IS_ACCOUNT_VIEW_WINDOW
+MODEST_TYPE_ACCOUNT_VIEW_WINDOW
+modest_account_view_window_get_type
+MODEST_ACCOUNT_VIEW_WINDOW_CLASS
+MODEST_IS_ACCOUNT_VIEW_WINDOW_CLASS
+MODEST_ACCOUNT_VIEW_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-transport-widget</FILE>
+<TITLE>ModestTransportWidget</TITLE>
+ModestTransportWidget
+modest_transport_widget_new
+modest_transport_widget_get_remember_password
+modest_transport_widget_get_username
+modest_transport_widget_get_servername
+modest_transport_widget_get_proto
+<SUBSECTION Standard>
+MODEST_TRANSPORT_WIDGET
+MODEST_IS_TRANSPORT_WIDGET
+MODEST_TYPE_TRANSPORT_WIDGET
+modest_transport_widget_get_type
+MODEST_TRANSPORT_WIDGET_CLASS
+MODEST_IS_TRANSPORT_WIDGET_CLASS
+MODEST_TRANSPORT_WIDGET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-store-widget</FILE>
+<TITLE>ModestStoreWidget</TITLE>
+ModestStoreWidget
+modest_store_widget_new
+modest_store_widget_get_remember_password
+modest_store_widget_get_username
+modest_store_widget_get_servername
+modest_store_widget_get_proto
+<SUBSECTION Standard>
+MODEST_STORE_WIDGET
+MODEST_IS_STORE_WIDGET
+MODEST_TYPE_STORE_WIDGET
+modest_store_widget_get_type
+MODEST_STORE_WIDGET_CLASS
+MODEST_IS_STORE_WIDGET_CLASS
+MODEST_STORE_WIDGET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-edit-msg-window</FILE>
+<TITLE>ModestEditMsgWindow</TITLE>
+ModestEditMsgWindow
+ModestEditType
+modest_edit_msg_window_new
+modest_edit_msg_window_set_msg
+<SUBSECTION Standard>
+MODEST_EDIT_MSG_WINDOW
+MODEST_IS_EDIT_MSG_WINDOW
+MODEST_TYPE_EDIT_MSG_WINDOW
+modest_edit_msg_window_get_type
+MODEST_EDIT_MSG_WINDOW_CLASS
+MODEST_IS_EDIT_MSG_WINDOW_CLASS
+MODEST_EDIT_MSG_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>modest-main-window</FILE>
+<TITLE>ModestMainWindow</TITLE>
+ModestMainWindow
+modest_main_window_new
+<SUBSECTION Standard>
+MODEST_MAIN_WINDOW
+MODEST_IS_MAIN_WINDOW
+MODEST_TYPE_MAIN_WINDOW
+modest_main_window_get_type
+MODEST_MAIN_WINDOW_CLASS
+MODEST_IS_MAIN_WINDOW_CLASS
+MODEST_MAIN_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>modest-account-assistant</FILE>
 <TITLE>ModestAccountAssistant</TITLE>
 ModestAccountAssistant
@@ -821,6 +1097,7 @@ MODEST_MAIN_WINDOW_GET_CLASS
 <TITLE>ModestAccountView</TITLE>
 ModestAccountView
 modest_account_view_new
+modest_account_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_ACCOUNT_VIEW
 MODEST_IS_ACCOUNT_VIEW
@@ -833,13 +1110,15 @@ MODEST_ACCOUNT_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-header-view</FILE>
-<TITLE>ModestHeaderView</TITLE>
-ModestHeaderView
+MODEST_HEADER_VIEW_COLUMN
 ModestHeaderViewColumn
 ModestHeaderViewStyle
 ModestItemType
+<TITLE>ModestHeaderView</TITLE>
+ModestHeaderView
 modest_header_view_new
 modest_header_view_set_folder
+modest_header_view_get_folder
 modest_header_view_set_columns
 modest_header_view_get_columns
 modest_header_view_set_style
@@ -857,9 +1136,9 @@ MODEST_HEADER_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-toolbar</FILE>
+ModestToolbarButton
 <TITLE>ModestToolbar</TITLE>
 ModestToolbar
-ModestToolbarButton
 modest_toolbar_new
 <SUBSECTION Standard>
 MODEST_TOOLBAR
@@ -876,7 +1155,9 @@ MODEST_TOOLBAR_GET_CLASS
 <TITLE>ModestFolderView</TITLE>
 ModestFolderView
 modest_folder_view_new
+modest_folder_view_set_title
 modest_folder_view_is_empty
+modest_folder_view_guess_folder_type
 modest_folder_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_FOLDER_VIEW
@@ -911,7 +1192,6 @@ MODEST_COMBO_BOX_GET_CLASS
 ModestMsgView
 modest_msg_view_new
 modest_msg_view_set_message
-modest_msg_view_get_selected_text
 <SUBSECTION Standard>
 MODEST_MSG_VIEW
 MODEST_IS_MSG_VIEW
@@ -996,6 +1276,7 @@ MODEST_STORE_WIDGET_GET_CLASS
 ModestEditMsgWindow
 ModestEditType
 modest_edit_msg_window_new
+modest_edit_msg_window_set_msg
 <SUBSECTION Standard>
 MODEST_EDIT_MSG_WINDOW
 MODEST_IS_EDIT_MSG_WINDOW
@@ -1026,6 +1307,7 @@ MODEST_MAIN_WINDOW_GET_CLASS
 <TITLE>ModestAccountView</TITLE>
 ModestAccountView
 modest_account_view_new
+modest_account_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_ACCOUNT_VIEW
 MODEST_IS_ACCOUNT_VIEW
@@ -1038,13 +1320,15 @@ MODEST_ACCOUNT_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-header-view</FILE>
-<TITLE>ModestHeaderView</TITLE>
-ModestHeaderView
+MODEST_HEADER_VIEW_COLUMN
 ModestHeaderViewColumn
 ModestHeaderViewStyle
 ModestItemType
+<TITLE>ModestHeaderView</TITLE>
+ModestHeaderView
 modest_header_view_new
 modest_header_view_set_folder
+modest_header_view_get_folder
 modest_header_view_set_columns
 modest_header_view_get_columns
 modest_header_view_set_style
@@ -1062,9 +1346,9 @@ MODEST_HEADER_VIEW_GET_CLASS
 
 <SECTION>
 <FILE>modest-toolbar</FILE>
+ModestToolbarButton
 <TITLE>ModestToolbar</TITLE>
 ModestToolbar
-ModestToolbarButton
 modest_toolbar_new
 <SUBSECTION Standard>
 MODEST_TOOLBAR
@@ -1081,7 +1365,9 @@ MODEST_TOOLBAR_GET_CLASS
 <TITLE>ModestFolderView</TITLE>
 ModestFolderView
 modest_folder_view_new
+modest_folder_view_set_title
 modest_folder_view_is_empty
+modest_folder_view_guess_folder_type
 modest_folder_view_get_selected_account
 <SUBSECTION Standard>
 MODEST_FOLDER_VIEW
@@ -1116,7 +1402,6 @@ MODEST_COMBO_BOX_GET_CLASS
 ModestMsgView
 modest_msg_view_new
 modest_msg_view_set_message
-modest_msg_view_get_selected_text
 <SUBSECTION Standard>
 MODEST_MSG_VIEW
 MODEST_IS_MSG_VIEW
@@ -1128,6 +1413,14 @@ MODEST_MSG_VIEW_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>modest-tny-store-actions</FILE>
+modest_tny_store_actions_create_folder
+modest_tny_store_actions_remove_folder
+modest_tny_store_actions_rename_folder
+modest_tny_store_actions_move_folder
+</SECTION>
+
+<SECTION>
 <FILE>modest-account-keys</FILE>
 MODEST_CONF_DEFAULT_ACCOUNT
 MODEST_ACCOUNT_NAMESPACE
@@ -1152,12 +1445,14 @@ MODEST_ACCOUNT_OPTIONS
 
 <SECTION>
 <FILE>modest-text-utils</FILE>
+modest_text_utils_derived_subject
 modest_text_utils_quote
-modest_text_utils_create_reply_subject
-modest_text_utils_create_forward_subject
-modest_text_utils_create_cited_text
-modest_text_utils_create_inlined_text
-modest_text_utils_remove_mail_from_mail_list
+modest_text_utils_cite
+modest_text_utils_inline
+modest_text_utils_remove_address
+modest_text_utils_convert_to_html
+modest_text_utils_strftime
+modest_text_utils_display_address
 </SECTION>
 
 <SECTION>
@@ -1241,31 +1536,69 @@ modest_proto_auth_protos
 
 <SECTION>
 <FILE>modest-widget-memory</FILE>
-modest_widget_memory_save_settings
-modest_widget_memory_restore_settings
+modest_widget_memory_save
+modest_widget_memory_restore
 </SECTION>
 
 <SECTION>
 <FILE>modest-tny-msg-actions</FILE>
-modest_tny_msg_actions_quote
 modest_tny_msg_actions_find_body_part
 modest_tny_msg_actions_find_nth_part
 modest_tny_msg_actions_find_body
-modest_tny_msg_actions_copy
-modest_tny_msg_actions_move
-modest_tny_msg_actions_remove
 </SECTION>
 
 <SECTION>
 <FILE>modest-marshal</FILE>
 modest_marshal_VOID__POINTER_POINTER
 modest_marshal_VOID__POINTER_POINTER_POINTER
+modest_marshal_VOID__POINTER_BOOLEAN
+modest_marshal_VOID__POINTER_BOOL
 modest_marshal_VOID__STRING_INT
+modest_marshal_VOID__STRING_INT_INT
 modest_marshal_VOID__STRING_BOOLEAN
 modest_marshal_VOID__STRING_BOOL
 modest_marshal_VOID__STRING_STRING_BOOLEAN
 modest_marshal_VOID__STRING_STRING_BOOL
-modest_marshal_VOID__STRING_POINTER_POINTER
+modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
+</SECTION>
+
+<SECTION>
+<FILE>modest-error</FILE>
+ModestErrorDomain
+ModestErrorCode
+</SECTION>
+
+<SECTION>
+<FILE>modest-icon-names</FILE>
+PIXMAP_PREFIX
+MODEST_APP_ICON
+MODEST_HEADER_ICON_READ
+MODEST_HEADER_ICON_UNREAD
+MODEST_HEADER_ICON_DELETED
+MODEST_HEADER_ICON_ATTACH
+MODEST_FOLDER_ICON_OPEN
+MODEST_FOLDER_ICON_CLOSED
+MODEST_FOLDER_ICON_ACCOUNT
+MODEST_FOLDER_ICON_INBOX
+MODEST_FOLDER_ICON_OUTBOX
+MODEST_FOLDER_ICON_SENT
+MODEST_FOLDER_ICON_TRASH
+MODEST_FOLDER_ICON_JUNK
+MODEST_FOLDER_ICON_DRAFTS
+MODEST_FOLDER_ICON_NORMAL
+MODEST_FOLDER_ICON_CONTACTS
+MODEST_FOLDER_ICON_NOTES
+MODEST_FOLDER_ICON_CALENDAR
+MODEST_TOOLBAR_ICON_MAIL_SEND
+MODEST_TOOLBAR_ICON_NEW_MAIL
+MODEST_TOOLBAR_ICON_SEND_RECEIVE
+MODEST_TOOLBAR_ICON_REPLY
+MODEST_TOOLBAR_ICON_REPLY_ALL
+MODEST_TOOLBAR_ICON_FORWARD
+MODEST_TOOLBAR_ICON_DELETE
+MODEST_TOOLBAR_ICON_NEXT
+MODEST_TOOLBAR_ICON_PREV
+MODEST_TOOLBAR_ICON_STOP
 </SECTION>
 
 <SECTION>
@@ -1278,6 +1611,7 @@ MODEST_HEADER_ICON_DELETED
 MODEST_HEADER_ICON_ATTACH
 MODEST_FOLDER_ICON_OPEN
 MODEST_FOLDER_ICON_CLOSED
+MODEST_FOLDER_ICON_ACCOUNT
 MODEST_FOLDER_ICON_INBOX
 MODEST_FOLDER_ICON_OUTBOX
 MODEST_FOLDER_ICON_SENT
@@ -1301,6 +1635,18 @@ MODEST_TOOLBAR_ICON_STOP
 </SECTION>
 
 <SECTION>
+<FILE>modest-header-view-priv</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>modest-tny-store-actions</FILE>
+modest_tny_store_actions_create_folder
+modest_tny_store_actions_remove_folder
+modest_tny_store_actions_rename_folder
+modest_tny_store_actions_move_folder
+</SECTION>
+
+<SECTION>
 <FILE>modest-account-keys</FILE>
 MODEST_CONF_DEFAULT_ACCOUNT
 MODEST_ACCOUNT_NAMESPACE
@@ -1325,12 +1671,14 @@ MODEST_ACCOUNT_OPTIONS
 
 <SECTION>
 <FILE>modest-text-utils</FILE>
+modest_text_utils_derived_subject
 modest_text_utils_quote
-modest_text_utils_create_reply_subject
-modest_text_utils_create_forward_subject
-modest_text_utils_create_cited_text
-modest_text_utils_create_inlined_text
-modest_text_utils_remove_mail_from_mail_list
+modest_text_utils_cite
+modest_text_utils_inline
+modest_text_utils_remove_address
+modest_text_utils_convert_to_html
+modest_text_utils_strftime
+modest_text_utils_display_address
 </SECTION>
 
 <SECTION>
@@ -1414,31 +1762,69 @@ modest_proto_auth_protos
 
 <SECTION>
 <FILE>modest-widget-memory</FILE>
-modest_widget_memory_save_settings
-modest_widget_memory_restore_settings
+modest_widget_memory_save
+modest_widget_memory_restore
 </SECTION>
 
 <SECTION>
 <FILE>modest-tny-msg-actions</FILE>
-modest_tny_msg_actions_quote
 modest_tny_msg_actions_find_body_part
 modest_tny_msg_actions_find_nth_part
 modest_tny_msg_actions_find_body
-modest_tny_msg_actions_copy
-modest_tny_msg_actions_move
-modest_tny_msg_actions_remove
 </SECTION>
 
 <SECTION>
 <FILE>modest-marshal</FILE>
 modest_marshal_VOID__POINTER_POINTER
 modest_marshal_VOID__POINTER_POINTER_POINTER
+modest_marshal_VOID__POINTER_BOOLEAN
+modest_marshal_VOID__POINTER_BOOL
 modest_marshal_VOID__STRING_INT
+modest_marshal_VOID__STRING_INT_INT
 modest_marshal_VOID__STRING_BOOLEAN
 modest_marshal_VOID__STRING_BOOL
 modest_marshal_VOID__STRING_STRING_BOOLEAN
 modest_marshal_VOID__STRING_STRING_BOOL
-modest_marshal_VOID__STRING_POINTER_POINTER
+modest_marshal_VOID__STRING_POINTER_POINTER_POINTER
+</SECTION>
+
+<SECTION>
+<FILE>modest-error</FILE>
+ModestErrorDomain
+ModestErrorCode
+</SECTION>
+
+<SECTION>
+<FILE>modest-icon-names</FILE>
+PIXMAP_PREFIX
+MODEST_APP_ICON
+MODEST_HEADER_ICON_READ
+MODEST_HEADER_ICON_UNREAD
+MODEST_HEADER_ICON_DELETED
+MODEST_HEADER_ICON_ATTACH
+MODEST_FOLDER_ICON_OPEN
+MODEST_FOLDER_ICON_CLOSED
+MODEST_FOLDER_ICON_ACCOUNT
+MODEST_FOLDER_ICON_INBOX
+MODEST_FOLDER_ICON_OUTBOX
+MODEST_FOLDER_ICON_SENT
+MODEST_FOLDER_ICON_TRASH
+MODEST_FOLDER_ICON_JUNK
+MODEST_FOLDER_ICON_DRAFTS
+MODEST_FOLDER_ICON_NORMAL
+MODEST_FOLDER_ICON_CONTACTS
+MODEST_FOLDER_ICON_NOTES
+MODEST_FOLDER_ICON_CALENDAR
+MODEST_TOOLBAR_ICON_MAIL_SEND
+MODEST_TOOLBAR_ICON_NEW_MAIL
+MODEST_TOOLBAR_ICON_SEND_RECEIVE
+MODEST_TOOLBAR_ICON_REPLY
+MODEST_TOOLBAR_ICON_REPLY_ALL
+MODEST_TOOLBAR_ICON_FORWARD
+MODEST_TOOLBAR_ICON_DELETE
+MODEST_TOOLBAR_ICON_NEXT
+MODEST_TOOLBAR_ICON_PREV
+MODEST_TOOLBAR_ICON_STOP
 </SECTION>
 
 <SECTION>
@@ -1451,6 +1837,7 @@ MODEST_HEADER_ICON_DELETED
 MODEST_HEADER_ICON_ATTACH
 MODEST_FOLDER_ICON_OPEN
 MODEST_FOLDER_ICON_CLOSED
+MODEST_FOLDER_ICON_ACCOUNT
 MODEST_FOLDER_ICON_INBOX
 MODEST_FOLDER_ICON_OUTBOX
 MODEST_FOLDER_ICON_SENT
@@ -1474,6 +1861,10 @@ MODEST_TOOLBAR_ICON_STOP
 </SECTION>
 
 <SECTION>
+<FILE>modest-header-view-priv</FILE>
+</SECTION>
+
+<SECTION>
 <FILE>modest-icon-names</FILE>
 PIXMAP_PREFIX
 MODEST_APP_ICON
@@ -1483,6 +1874,7 @@ MODEST_HEADER_ICON_DELETED
 MODEST_HEADER_ICON_ATTACH
 MODEST_FOLDER_ICON_OPEN
 MODEST_FOLDER_ICON_CLOSED
+MODEST_FOLDER_ICON_ACCOUNT
 MODEST_FOLDER_ICON_INBOX
 MODEST_FOLDER_ICON_OUTBOX
 MODEST_FOLDER_ICON_SENT
@@ -1505,3 +1897,7 @@ MODEST_TOOLBAR_ICON_PREV
 MODEST_TOOLBAR_ICON_STOP
 </SECTION>
 
+<SECTION>
+<FILE>modest-header-view-priv</FILE>
+</SECTION>
+

diff --git a/src/modest-formatter.c b/src/modest-formatter.c
index aa82ddf..0375b18 100644 (file)
--- a/src/modest-formatter.c
+++ b/src/modest-formatter.c
@@ -129,6 +129,11 @@ modest_formatter_do (ModestFormatter *self,
        gchar *body_text = NULL, *txt = NULL;
        ModestFormatterPrivate *priv;
 
+       g_return_val_if_fail (self, NULL);
+       g_return_val_if_fail (body, NULL);
+       g_return_val_if_fail (header, NULL);
+       g_return_val_if_fail (func, NULL);
+
        /* Build new part */
        new_msg = TNY_MSG (tny_camel_msg_new ());
        body_text = extract_text (self, body);

diff --git a/src/modest-formatter.h b/src/modest-formatter.h
index 92bb925..a74b54b 100644 (file)
--- a/src/modest-formatter.h
+++ b/src/modest-formatter.h
@@ -60,9 +60,110 @@ GType modest_formatter_get_type (void);
 
 ModestFormatter* modest_formatter_new (const gchar *content_type);
 
+/**
+ * modest_formatter_cite:
+ * @self: a #ModestFormatter
+ * @part: a non-NULL #TnyMimePart with the body of the original message
+ * @header: a non-NULL #TnyHeader of the original message
+ * 
+ * Creates a new message with a text body made from the body of the
+ * original message cited. This function is locale-sensitive.
+ *
+ * Example of cited message:
+ * <programlisting><para>
+ * Original message
+ * ----------------
+ * Date: 1970/01/01
+ * From: somemail@modest.org
+ * Body: "This is the body of the text"
+ * </para><para>
+ * Cited message
+ * -------------
+ * Body:
+ * On 1970/01/01 somemail@modest.org wrote:
+ * This is the body of the text
+ * </para></programlisting>
+ *
+ * Returns: a newly formatted #TnyMsg or NULL in case of error
+ **/
 TnyMsg * modest_formatter_cite   (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
+
+
+/**
+ * modest_formatter_quote:
+ * @self: a #ModestFormatter
+ * @part: a non-NULL #TnyMimePart with the body of the original message
+ * @header: a non-NULL #TnyHeader of the original message
+ * 
+ * Creates a new message with a text body made from the body of the
+ * original message quoted. This function is locale-sensitive.
+ *
+ * Example of cited message:
+ * <programlisting><para>
+ * Original message
+ * ----------------
+ * Date: 1970/01/01
+ * From: somemail@modest.org
+ * Body: "This is the body of the text"
+ * </para><para>
+ * Quoted message
+ * -------------
+ * Body:
+ * On 1970/01/01 somemail@modest.org wrote:
+ * > This is the body of the text
+ * </para></programlisting>
+ *
+ * Returns: a newly formatted #TnyMsg or NULL in case of error
+ **/
 TnyMsg * modest_formatter_quote  (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
+
+
+/**
+ * modest_formatter_inline:
+ * @self: a #ModestFormatter
+ * @part: a non-NULL #TnyMimePart with the body of the original message
+ * @header: a non-NULL #TnyHeader of the original message
+ * 
+ * Creates a new message with a text body made from the body of the
+ * original message inlined ready to be forwarded. This function is
+ * locale-sensitive.
+ *
+ * Example of cited message:
+ * <programlisting><para>
+ * Original message
+ * ----------------
+ * Date: 1970/01/01
+ * From: somemail@modest.org
+ * To: mymail@modest.org
+ * Subject: Mail subject
+ * Body: "This is the body of the text"
+ * </para><para>
+ * Inlined message
+ * -------------
+ * Body:
+ * -----Forwarded Message-----
+ * From: somemail@modest.org
+ * Sent: 1970/01/01
+ * To: mymail@modest.org
+ * Subject: Fw: Mail subject
+ * On 1970/01/01 somemail@modest.org wrote:
+ * This is the body of the text
+ * </para></programlisting>
+ *
+ * Returns: a newly formatted #TnyMsg or NULL in case of error
+ **/
 TnyMsg * modest_formatter_inline (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);
+
+/**
+ * modest_formatter_attach:
+ * @self: a #ModestFormatter
+ * @part: a non-NULL #TnyMimePart with the body of the original message
+ * @header: a non-NULL #TnyHeader of the original message
+ * 
+ * Creates a new message with the original message as attachment
+ *
+ * Returns: a newly formatted #TnyMsg or NULL in case of error
+ **/
 TnyMsg * modest_formatter_attach (ModestFormatter *self, TnyMimePart *part, TnyHeader *header);