From: Dirk-Jan C. Binnema <dirk-jan.binnema@nokia.com>
Date: Mon, 12 Nov 2007 15:44:29 +0000 (+0000)
Subject: * update for docs
X-Git-Tag: git_migration_finished~2116
X-Git-Url: http://git.maemo.org/git/?p=modest;a=commitdiff_plain;h=5cbd7e04707e97c222faa4f577ec1a7066ab887f

* update for docs

pmo-trunk-r3710
---

diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml
index 42a2f05..158c68f 100644
--- a/docs/reference/modest-docs.sgml
+++ b/docs/reference/modest-docs.sgml
@@ -2,29 +2,39 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
           "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
+<!ENTITY ModestAccountMgrHelpers SYSTEM "xml/modest-account-mgr-helpers.xml">
 <!ENTITY ModestAccountMgr SYSTEM "xml/modest-account-mgr.xml">
+<!ENTITY ModestAccountViewWindow SYSTEM "xml/modest-account-view-window.xml">
+<!ENTITY ModestAccountView SYSTEM "xml/modest-account-view.xml">
+<!ENTITY ModestCacheMgr SYSTEM "xml/modest-cache-mgr.xml">
+<!ENTITY ModestComboBox SYSTEM "xml/modest-combo-box.xml">
 <!ENTITY ModestConf SYSTEM "xml/modest-conf.xml">
-<!ENTITY ModestDefs SYSTEM "xml/modest-defs.xml">
 <!ENTITY ModestError SYSTEM "xml/modest-error.xml">
-<!ENTITY ModestFormatter SYSTEM "xml/modest-formatter.xml">
+<!ENTITY ModestFolderView SYSTEM "xml/modest-folder-view.xml">
+<!ENTITY ModestHeaderView SYSTEM "xml/modest-header-view.xml">
 <!ENTITY ModestIconNames SYSTEM "xml/modest-icon-names.xml">
-<!ENTITY ModestMailOperation SYSTEM "xml/modest-mail-operation.xml">
+<!ENTITY ModestLocalFolderInfo SYSTEM "xml/modest-local-folder-info.xml">
 <!ENTITY ModestMailOperationQueue SYSTEM "xml/modest-mail-operation-queue.xml">
-<!ENTITY ModestMarshal SYSTEM "xml/modest-marshal.xml">
+<!ENTITY ModestMailOperations SYSTEM "xml/modest-mail-operation.xml">
+<!ENTITY ModestMainWindow SYSTEM "xml/modest-main-window.xml">
+<!ENTITY ModestMsgEditWindow SYSTEM "xml/modest-msg-edit-window.xml">
+<!ENTITY ModestMsgViewWindow SYSTEM "xml/modest-msg-view-window.xml">
+<!ENTITY ModestMsgView SYSTEM "xml/modest-msg-view.xml">
 <!ENTITY ModestPair SYSTEM "xml/modest-pair.xml">
 <!ENTITY ModestProtocolInfo SYSTEM "xml/modest-protocol-info.xml">
+<!ENTITY ModestRuntime SYSTEM "xml/modest-runtime.xml">
+<!ENTITY ModestSingletons SYSTEM "xml/modest-singletons.xml">
 <!ENTITY ModestTextUtils SYSTEM "xml/modest-text-utils.xml">
 <!ENTITY ModestTnyAccountStore SYSTEM "xml/modest-tny-account-store.xml">
+<!ENTITY ModestTnyAccount SYSTEM "xml/modest-tny-account.xml">
 <!ENTITY ModestTnyFolder SYSTEM "xml/modest-tny-folder.xml">
+<!ENTITY ModestTnyMsg SYSTEM "xml/modest-tny-msg.xml">
 <!ENTITY ModestTnyPlatformFactory SYSTEM "xml/modest-tny-platform-factory.xml">
+<!ENTITY ModestTnySendQueue SYSTEM "xml/modest-tny-send-queue.xml">
+<!ENTITY ModestTnyStreamGtkHtml SYSTEM "xml/modest-tny-stream-gtkhtml.xml">
+<!ENTITY ModestUIActions SYSTEM "xml/modest-ui-actions.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-ModestMainWindow SYSTEM "xml/modest-main-window.xml">
-<!ENTITY widgets-ModestMsgView SYSTEM "xml/modest-msg-view.xml">
+<!ENTITY ModestWindow SYSTEM "xml/modest-window.xml">
 
 <!-- <!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml"> -->
 
@@ -60,42 +70,59 @@
 -->
   <reference>
     <title>API Reference</title>
-      <chapter id="src">
-        <title>Modest</title>
-          &ModestAccountMgr;
-          &ModestConf;
-	  &ModestDefs;
-          &ModestError;
-          &ModestFormatter;
-          &ModestIconNames;
-          &ModestMailOperation;
-          &ModestMailOperationQueue;
-          &ModestMarshal;
-          &ModestPair;
-          &ModestProtocolInfo;
-          &ModestTextUtils;
-          &ModestTnyAccountStore;
-          &ModestTnyFolder;
-          &ModestTnyPlatformFactory;
-          &ModestWidgetMemory;
+
+      <chapter id="core">
+        <title>Core/Runtime</title>
+	&ModestRuntime;
+	&ModestSingletons;
+<!-- 	&ModestPlatform; -->
+<!-- 	&ModestInit; -->
       </chapter>
+      
+      <chapter id="mail">
+        <title>Mail</title>
+	&ModestTnyMsg;
+	&ModestTnyFolder;
+	&ModestTnySendQueue;
+	&ModestTnyAccountStore;
+<!-- 	&ModestMailOperation; -->
+        &ModestMailOperationQueue;
+      </chapter>
+
+     
       <chapter id="widgets">
         <title>Widgets</title>
-          &widgets-ModestAccountView;
-          &widgets-ModestComboBox;
-          &widgets-ModestFolderView;
-          &widgets-ModestHeaderView;
-          &widgets-ModestMainWindow;
-          &widgets-ModestMsgView;
+        &ModestAccountView;
+	&ModestAccountViewWindow;
+        &ModestComboBox;
+        &ModestFolderView;
+        &ModestHeaderView;
+        &ModestMainWindow;
+        &ModestMsgView;
+	&ModestMsgViewWindow;
+	&ModestMsgEditWindow;
+	&ModestWindow;
       </chapter>
-      <chapter id="gtk">
-        <title>Gtk</title>
-          &gtk-ModestAccountViewWindow;
-          &gtk-ModestAccountAssistant;
-          &gtk-ModestMsgEditWindow;
-          &gtk-ModestStoreWidget;
-          &gtk-modestTransportWidget;
+
+      <chapter id="accmgmt_settings">
+        <title>Account Management and Settings</title>
+        &ModestAccountMgr;
+	&ModestAccountMgrHelpers;
+	&ModestConf;
+	&ModestWidgetMemory;
+      </chapter>
+      
+      <chapter id="other">
+        <title>Other</title>
+	&ModestCacheMgr;
+	&ModestError;
+	&ModestIconNames;
+	&ModestPair;
+	&ModestProtocolInfo;
+	&ModestLocalFolderInfo;
+	&ModestTextUtils;
       </chapter>
+
   </reference>
 
 
diff --git a/src/modest-account-mgr-helpers.h b/src/modest-account-mgr-helpers.h
index a7f120c..d0a7f58 100644
--- a/src/modest-account-mgr-helpers.h
+++ b/src/modest-account-mgr-helpers.h
@@ -391,7 +391,7 @@ void modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
  * @self: a #ModestAccountMgr instance
  * @name: the account name
  *
- * get the From: string for some account; ie. "Foo Bar" <foo.bar@cuux.yy>"
+ * get the From: string for some account; ie. "Foo Bar" &lt;foo.bar@cuux.yy&gt;"
  *
  * Returns: the newly allocated from-string, or NULL in case of error
  */
diff --git a/src/modest-cache-mgr.h b/src/modest-cache-mgr.h
index b656337..3577140 100644
--- a/src/modest-cache-mgr.h
+++ b/src/modest-cache-mgr.h
@@ -93,8 +93,7 @@ ModestCacheMgr*    modest_cache_mgr_new          (void);
  * 
  * get the cache (GHashTable) of the requested type
  * 
- * Returns: the requested cache (GHashTable) 
- * 
+ * Returns: the requested cache (GHashTable)  
  * the returned  hashtable should NOT be destroyed or unref'd.
  */
 GHashTable*     modest_cache_mgr_get_cache    (ModestCacheMgr* self, ModestCacheMgrCacheType type);
@@ -124,7 +123,7 @@ void            modest_cache_mgr_flush_all    (ModestCacheMgr *self);
  * @self: a valid cache mgr obj
  * @type: a valid cache mgr cache type
  *
- * get the size (number of <key,value>-pairs) in the cache
+ * get the size (number of [key,value]-pairs) in the cache
  * 
  * Returns: the size of the give cache type 
  */