* Added a short description for all the objects
pmo-trunk-r579
38 files changed:
ModestAccountAssistant
<!-- ##### SECTION Short_Description ##### -->
ModestAccountAssistant
<!-- ##### SECTION Short_Description ##### -->
+A widget that displays a wizard to create new accounts
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-account-keys
<!-- ##### SECTION Short_Description ##### -->
modest-account-keys
<!-- ##### SECTION Short_Description ##### -->
+Some configuration keys related to account management
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestAccountMgr
<!-- ##### SECTION Short_Description ##### -->
ModestAccountMgr
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestAccountViewWindow
<!-- ##### SECTION Short_Description ##### -->
ModestAccountViewWindow
<!-- ##### SECTION Short_Description ##### -->
+A window that shows the list of available accounts
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestAccountView
<!-- ##### SECTION Short_Description ##### -->
ModestAccountView
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows a list with the available accounts
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestComboBox
<!-- ##### SECTION Short_Description ##### -->
ModestComboBox
<!-- ##### SECTION Short_Description ##### -->
+A wrapper for a #GtkComboBox that shows lists of #ModestPair objects
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-conf-keys
<!-- ##### SECTION Short_Description ##### -->
modest-conf-keys
<!-- ##### SECTION Short_Description ##### -->
+Some Modest configuration keys
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestConf
<!-- ##### SECTION Short_Description ##### -->
ModestConf
<!-- ##### SECTION Short_Description ##### -->
+A wrapper to the underlying configuration system (currently GConf)
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestEditMsgWindow
<!-- ##### SECTION Short_Description ##### -->
ModestEditMsgWindow
<!-- ##### SECTION Short_Description ##### -->
+A window used for composing messages
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-ModestEditWindow
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
modest-error
<!-- ##### SECTION Short_Description ##### -->
modest-error
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestFolderView
<!-- ##### SECTION Short_Description ##### -->
ModestFolderView
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows the list of folders of email accounts
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestFormatter
<!-- ##### SECTION Short_Description ##### -->
ModestFormatter
<!-- ##### SECTION Short_Description ##### -->
+An object that creates new emails from others
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestHeaderView
<!-- ##### SECTION Short_Description ##### -->
ModestHeaderView
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows a list of email headers
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-icon-factory
<!-- ##### SECTION Short_Description ##### -->
modest-icon-factory
<!-- ##### SECTION Short_Description ##### -->
+A factory that creates the icons for Modest
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-icon-names
<!-- ##### SECTION Short_Description ##### -->
modest-icon-names
<!-- ##### SECTION Short_Description ##### -->
+Definitions for the Modest icons
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestMailOperationQueue
<!-- ##### SECTION Short_Description ##### -->
ModestMailOperationQueue
<!-- ##### SECTION Short_Description ##### -->
+An object that stores a queue of #ModestMailOperation
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestMailOperation
<!-- ##### SECTION Short_Description ##### -->
ModestMailOperation
<!-- ##### SECTION Short_Description ##### -->
+An object that performs mail operations
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestMainWindow
<!-- ##### SECTION Short_Description ##### -->
ModestMainWindow
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows the Modest main window
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestMsgView
<!-- ##### SECTION Short_Description ##### -->
ModestMsgView
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows the body of a message
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-pair
<!-- ##### SECTION Short_Description ##### -->
modest-pair
<!-- ##### SECTION Short_Description ##### -->
+An object that stores pairs of related objects
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-presets
<!-- ##### SECTION Short_Description ##### -->
modest-presets
<!-- ##### SECTION Short_Description ##### -->
+An object that manages Modest presest
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-proto
<!-- ##### SECTION Short_Description ##### -->
modest-proto
<!-- ##### SECTION Short_Description ##### -->
+An object that provides lists with the supported email protocols
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestProtocolMgr
<!-- ##### SECTION Short_Description ##### -->
ModestProtocolMgr
<!-- ##### SECTION Short_Description ##### -->
+An object that manages the email protocols
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestStoreWidget
<!-- ##### SECTION Short_Description ##### -->
ModestStoreWidget
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows the server information for a store account
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-text-utils
<!-- ##### SECTION Short_Description ##### -->
modest-text-utils
<!-- ##### SECTION Short_Description ##### -->
+A library with text utility functions
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestTnyAccountStore
<!-- ##### SECTION Short_Description ##### -->
ModestTnyAccountStore
<!-- ##### SECTION Short_Description ##### -->
+An implementation of #TnyAccountStore
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-ModestTnyFolderTreeView
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-ModestTnyHeaderTreeView
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
ModestTnyMsgView
<!-- ##### SECTION Short_Description ##### -->
ModestTnyMsgView
<!-- ##### SECTION Short_Description ##### -->
+A widget that displays the body of a message
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestTnyPlatformFactory
<!-- ##### SECTION Short_Description ##### -->
ModestTnyPlatformFactory
<!-- ##### SECTION Short_Description ##### -->
+An implementation of a #TnyPlatformFactory
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestTnyStreamGtkhtml
<!-- ##### SECTION Short_Description ##### -->
ModestTnyStreamGtkhtml
<!-- ##### SECTION Short_Description ##### -->
+An implementation of a #TnyStream that uses a #GtkHTMLStream
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestToolbar
<!-- ##### SECTION Short_Description ##### -->
ModestToolbar
<!-- ##### SECTION Short_Description ##### -->
+A widgets that shows a toolbar in the Modest main window
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestTransportWidget
<!-- ##### SECTION Short_Description ##### -->
ModestTransportWidget
<!-- ##### SECTION Short_Description ##### -->
+A widget that shows the server information for a transport account
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestUI
<!-- ##### SECTION Short_Description ##### -->
ModestUI
<!-- ##### SECTION Short_Description ##### -->
+An object that creates the main window
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
ModestWidgetFactory
<!-- ##### SECTION Short_Description ##### -->
ModestWidgetFactory
<!-- ##### SECTION Short_Description ##### -->
+A factory that creates the widgets of the UI
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
modest-widget-memory
<!-- ##### SECTION Short_Description ##### -->
modest-widget-memory
<!-- ##### SECTION Short_Description ##### -->
+An object that stores preferences of the widgets
<!-- ##### SECTION Long_Description ##### -->
<para>
<!-- ##### SECTION Long_Description ##### -->
<para>
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-ModestWindowMgr
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-