* Removed some old templates for old files
authorSergio Villar Senin <svillar@igalia.com>
Fri, 22 Dec 2006 15:37:36 +0000 (15:37 +0000)
committerSergio Villar Senin <svillar@igalia.com>
Fri, 22 Dec 2006 15:37:36 +0000 (15:37 +0000)
* Added a short description for all the objects

pmo-trunk-r579

38 files changed:
docs/reference/tmpl/modest-account-assistant.sgml
docs/reference/tmpl/modest-account-keys.sgml
docs/reference/tmpl/modest-account-mgr.sgml
docs/reference/tmpl/modest-account-view-window.sgml
docs/reference/tmpl/modest-account-view.sgml
docs/reference/tmpl/modest-combo-box.sgml
docs/reference/tmpl/modest-conf-keys.sgml
docs/reference/tmpl/modest-conf.sgml
docs/reference/tmpl/modest-edit-msg-window.sgml
docs/reference/tmpl/modest-edit-window.sgml [deleted file]
docs/reference/tmpl/modest-error.sgml
docs/reference/tmpl/modest-folder-view.sgml
docs/reference/tmpl/modest-formatter.sgml
docs/reference/tmpl/modest-header-view.sgml
docs/reference/tmpl/modest-icon-factory.sgml
docs/reference/tmpl/modest-icon-names.sgml
docs/reference/tmpl/modest-mail-operation-queue.sgml
docs/reference/tmpl/modest-mail-operation.sgml
docs/reference/tmpl/modest-main-window.sgml
docs/reference/tmpl/modest-msg-view.sgml
docs/reference/tmpl/modest-pair.sgml
docs/reference/tmpl/modest-presets.sgml
docs/reference/tmpl/modest-proto.sgml
docs/reference/tmpl/modest-protocol-mgr.sgml
docs/reference/tmpl/modest-store-widget.sgml
docs/reference/tmpl/modest-text-utils.sgml
docs/reference/tmpl/modest-tny-account-store.sgml
docs/reference/tmpl/modest-tny-folder-tree-view.sgml [deleted file]
docs/reference/tmpl/modest-tny-header-tree-view.sgml [deleted file]
docs/reference/tmpl/modest-tny-msg-view.sgml
docs/reference/tmpl/modest-tny-platform-factory.sgml
docs/reference/tmpl/modest-tny-stream-gtkhtml.sgml
docs/reference/tmpl/modest-toolbar.sgml
docs/reference/tmpl/modest-transport-widget.sgml
docs/reference/tmpl/modest-ui.sgml
docs/reference/tmpl/modest-widget-factory.sgml
docs/reference/tmpl/modest-widget-memory.sgml
docs/reference/tmpl/modest-window-mgr.sgml [deleted file]

index d142920..eb816cb 100644 (file)
@@ -2,7 +2,7 @@
 ModestAccountAssistant
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that displays a wizard to create new accounts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 1e4a518..8fc90bd 100644 (file)
@@ -2,7 +2,7 @@
 modest-account-keys
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Some configuration keys related to account management
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index bb0cec6..6fa8f2a 100644 (file)
@@ -2,7 +2,7 @@
 ModestAccountMgr
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Manages email accounts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 21e58a3..0f09541 100644 (file)
@@ -2,7 +2,7 @@
 ModestAccountViewWindow
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A window that shows the list of available accounts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 61fcfb1..a842b6b 100644 (file)
@@ -2,7 +2,7 @@
 ModestAccountView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows a list with the available accounts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 16c4866..1157267 100644 (file)
@@ -2,7 +2,7 @@
 ModestComboBox
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A wrapper for a #GtkComboBox that shows lists of #ModestPair objects
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 642163d..1913ecb 100644 (file)
@@ -2,7 +2,7 @@
 modest-conf-keys
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Some Modest configuration keys
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index f3d4a72..8de1cfe 100644 (file)
@@ -2,7 +2,7 @@
 ModestConf
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A wrapper to the underlying configuration system (currently GConf)
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 97e2654..91a8bf8 100644 (file)
@@ -2,7 +2,7 @@
 ModestEditMsgWindow
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A window used for composing messages
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
diff --git a/docs/reference/tmpl/modest-edit-window.sgml b/docs/reference/tmpl/modest-edit-window.sgml
deleted file mode 100644 (file)
index 0ae938d..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-ModestEditWindow
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
index 19e571a..e450e4b 100644 (file)
@@ -2,7 +2,7 @@
 modest-error
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Modest error stuff
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index a28a5a2..0d0bf02 100644 (file)
@@ -2,7 +2,7 @@
 ModestFolderView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows the list of folders of email accounts
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 9779f1e..7d1dd40 100644 (file)
@@ -2,7 +2,7 @@
 ModestFormatter
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that creates new emails from others
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index bd0c464..4035eaf 100644 (file)
@@ -2,7 +2,7 @@
 ModestHeaderView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows a list of email headers
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index f15a940..770f928 100644 (file)
@@ -2,7 +2,7 @@
 modest-icon-factory
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A factory that creates the icons for Modest
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 9e44b91..477cc0a 100644 (file)
@@ -2,7 +2,7 @@
 modest-icon-names
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Definitions for the Modest icons
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 15e970e..f2309e0 100644 (file)
@@ -2,7 +2,7 @@
 ModestMailOperationQueue
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that stores a queue of #ModestMailOperation
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 0face59..13490da 100644 (file)
@@ -2,7 +2,7 @@
 ModestMailOperation
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that performs mail operations
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 45fea64..c7e7f59 100644 (file)
@@ -2,7 +2,7 @@
 ModestMainWindow
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows the Modest main window
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 8ebb78e..fde7239 100644 (file)
@@ -2,7 +2,7 @@
 ModestMsgView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows the body of a message
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 66b40e6..17156a6 100644 (file)
@@ -2,7 +2,7 @@
 modest-pair
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that stores pairs of related objects
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 42352e7..f531829 100644 (file)
@@ -2,7 +2,7 @@
 modest-presets
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that manages Modest presest
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 6c2544d..807c492 100644 (file)
@@ -2,7 +2,7 @@
 modest-proto
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that provides lists with the supported email protocols
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index d8aea74..0e0fdf9 100644 (file)
@@ -2,7 +2,7 @@
 ModestProtocolMgr
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that manages the email protocols
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index f07392a..bdd6f69 100644 (file)
@@ -2,7 +2,7 @@
 ModestStoreWidget
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows the server information for a store account
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index bab1d21..cb283a4 100644 (file)
@@ -2,7 +2,7 @@
 modest-text-utils
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A library with text utility functions
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index dfc20c0..d6b5749 100644 (file)
@@ -2,7 +2,7 @@
 ModestTnyAccountStore
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An implementation of #TnyAccountStore
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
diff --git a/docs/reference/tmpl/modest-tny-folder-tree-view.sgml b/docs/reference/tmpl/modest-tny-folder-tree-view.sgml
deleted file mode 100644 (file)
index 64d5d4a..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-ModestTnyFolderTreeView
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
diff --git a/docs/reference/tmpl/modest-tny-header-tree-view.sgml b/docs/reference/tmpl/modest-tny-header-tree-view.sgml
deleted file mode 100644 (file)
index 1e1aec2..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-ModestTnyHeaderTreeView
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
index 4a7e33f..e047d7a 100644 (file)
@@ -2,7 +2,7 @@
 ModestTnyMsgView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that displays the body of a message
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index b95a37d..3a23c59 100644 (file)
@@ -2,7 +2,7 @@
 ModestTnyPlatformFactory
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An implementation of a #TnyPlatformFactory
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index d073ba4..fdb3a4d 100644 (file)
@@ -2,7 +2,7 @@
 ModestTnyStreamGtkhtml
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An implementation of a #TnyStream that uses a #GtkHTMLStream
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 9699dce..7df6bc3 100644 (file)
@@ -2,7 +2,7 @@
 ModestToolbar
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widgets that shows a toolbar in the Modest main window
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index eef2c1a..2bdb33e 100644 (file)
@@ -2,7 +2,7 @@
 ModestTransportWidget
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget that shows the server information for a transport account
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 9d0df49..2e265dc 100644 (file)
@@ -2,7 +2,7 @@
 ModestUI
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that creates the main window
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index a6520df..007a13e 100644 (file)
@@ -2,7 +2,7 @@
 ModestWidgetFactory
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A factory that creates the widgets of the UI
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
index 74f7955..e6f341c 100644 (file)
@@ -2,7 +2,7 @@
 modest-widget-memory
 
 <!-- ##### SECTION Short_Description ##### -->
-
+An object that stores preferences of the widgets
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
diff --git a/docs/reference/tmpl/modest-window-mgr.sgml b/docs/reference/tmpl/modest-window-mgr.sgml
deleted file mode 100644 (file)
index f2bdc71..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-ModestWindowMgr
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-