From: Florian Boor Date: Mon, 15 May 2006 16:09:16 +0000 (+0000) Subject: Add documentation template files in order to add some global documentation. X-Git-Tag: git_migration_finished~4790 X-Git-Url: http://git.maemo.org/git/?p=modest;a=commitdiff_plain;h=ff64ef71c1a3701dafafa4078a90f0b55a127a05 Add documentation template files in order to add some global documentation. pmo-trunk-r59 --- diff --git a/docs/reference/tmpl/modest-account-keys.sgml b/docs/reference/tmpl/modest-account-keys.sgml new file mode 100644 index 0000000..beab9ca --- /dev/null +++ b/docs/reference/tmpl/modest-account-keys.sgml @@ -0,0 +1,96 @@ + +modest-account-keys + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/tmpl/modest-account-mgr.sgml b/docs/reference/tmpl/modest-account-mgr.sgml new file mode 100644 index 0000000..daf8652 --- /dev/null +++ b/docs/reference/tmpl/modest-account-mgr.sgml @@ -0,0 +1,279 @@ + +ModestAccountMgr + + +Manage user and server accounts + + + +This module is used to add/remove modest mail accounts and the server accounts +assigned to them. It is used to change account details and provides a complete +abstraction of the configuration backend used to store the account data. + + + + + + + + + + + + + + + +@parent: + + + + + + +@modest_conf: +@Returns: + + + + + + + +@self: +@name: +@store_name: +@transport_name: +@err: +@Returns: + + + + + + + +@self: +@name: +@err: +@Returns: + + + + + + + +@self: +@name: +@hostname: +@username: +@password: +@proto: +@Returns: + + + + + + + +@self: +@name: +@err: +@Returns: + + + + + + + +@self: +@err: +@Returns: + + + + + + + +@self: +@account_name: +@type: +@proto: +@only_enabled: +@Returns: + + + + + + + +@self: +@name: +@err: +@Returns: + + + + + + + +@self: +@name: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@name: +@key: +@val: +@err: +@Returns: diff --git a/docs/reference/tmpl/modest-conf-keys.sgml b/docs/reference/tmpl/modest-conf-keys.sgml new file mode 100644 index 0000000..2eed751 --- /dev/null +++ b/docs/reference/tmpl/modest-conf-keys.sgml @@ -0,0 +1,96 @@ + +modest-conf-keys + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/tmpl/modest-conf.sgml b/docs/reference/tmpl/modest-conf.sgml new file mode 100644 index 0000000..7b6bb96 --- /dev/null +++ b/docs/reference/tmpl/modest-conf.sgml @@ -0,0 +1,136 @@ + +ModestConf + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + + + + + + +@self: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@key: +@val: +@err: +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + + + + + + +@self: +@key: +@err: +@Returns: + + diff --git a/docs/reference/tmpl/modest-edit-window.sgml b/docs/reference/tmpl/modest-edit-window.sgml new file mode 100644 index 0000000..928e777 --- /dev/null +++ b/docs/reference/tmpl/modest-edit-window.sgml @@ -0,0 +1,40 @@ + +ModestEditWindow + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@to: +@cc: +@bcc: +@subject: +@body: +@attachments: +@Returns: + + diff --git a/docs/reference/tmpl/modest-main-window.sgml b/docs/reference/tmpl/modest-main-window.sgml new file mode 100644 index 0000000..f29e1ab --- /dev/null +++ b/docs/reference/tmpl/modest-main-window.sgml @@ -0,0 +1,36 @@ + +ModestMainWindow + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@modest_conf: +@modest_acc_mgr: +@Returns: + + diff --git a/docs/reference/tmpl/modest-proto.sgml b/docs/reference/tmpl/modest-proto.sgml new file mode 100644 index 0000000..764d452 --- /dev/null +++ b/docs/reference/tmpl/modest-proto.sgml @@ -0,0 +1,71 @@ + +modest-proto + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@proto: +@Returns: + + + + + + + +@proto: +@Returns: + + diff --git a/docs/reference/tmpl/modest-tny-account-store.sgml b/docs/reference/tmpl/modest-tny-account-store.sgml new file mode 100644 index 0000000..a5337b1 --- /dev/null +++ b/docs/reference/tmpl/modest-tny-account-store.sgml @@ -0,0 +1,44 @@ + +ModestTnyAccountStore + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@modest_acc_mgr: +@Returns: + + + + + + + +@self: +@Returns: + + diff --git a/docs/reference/tmpl/modest-tny-folder-tree-view.sgml b/docs/reference/tmpl/modest-tny-folder-tree-view.sgml new file mode 100644 index 0000000..fe8939c --- /dev/null +++ b/docs/reference/tmpl/modest-tny-folder-tree-view.sgml @@ -0,0 +1,44 @@ + +ModestTnyFolderTreeView + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@iface: +@Returns: + + + + + + + +@self: +@Returns: + + diff --git a/docs/reference/tmpl/modest-tny-header-tree-view.sgml b/docs/reference/tmpl/modest-tny-header-tree-view.sgml new file mode 100644 index 0000000..ff18a4c --- /dev/null +++ b/docs/reference/tmpl/modest-tny-header-tree-view.sgml @@ -0,0 +1,45 @@ + +ModestTnyHeaderTreeView + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@folder: +@Returns: + + + + + + + +@self: +@folder: +@Returns: + + diff --git a/docs/reference/tmpl/modest-tny-msg-view.sgml b/docs/reference/tmpl/modest-tny-msg-view.sgml new file mode 100644 index 0000000..014141d --- /dev/null +++ b/docs/reference/tmpl/modest-tny-msg-view.sgml @@ -0,0 +1,44 @@ + +ModestTnyMsgView + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@tny_msg: +@Returns: + + + + + + + +@self: +@tny_msg: + + diff --git a/docs/reference/tmpl/modest-tny-transport-actions.sgml b/docs/reference/tmpl/modest-tny-transport-actions.sgml new file mode 100644 index 0000000..c647d9f --- /dev/null +++ b/docs/reference/tmpl/modest-tny-transport-actions.sgml @@ -0,0 +1,50 @@ + +ModestTnyTransportActions + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@Returns: + + + + + + + +@self: +@transport_account: +@from: +@to: +@cc: +@bcc: +@subject: +@body: +@Returns: + + diff --git a/docs/reference/tmpl/modest-ui.sgml b/docs/reference/tmpl/modest-ui.sgml new file mode 100644 index 0000000..75f3726 --- /dev/null +++ b/docs/reference/tmpl/modest-ui.sgml @@ -0,0 +1,59 @@ + +ModestUI + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@modest_conf: +@Returns: + + + + + + + +@ui: +@Returns: + + + + + + + +@ui: +@to: +@cc: +@bcc: +@subject: +@body: +@att: +@Returns: + + diff --git a/docs/reference/tmpl/modest-unused.sgml b/docs/reference/tmpl/modest-unused.sgml new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/tmpl/modest-window-mgr.sgml b/docs/reference/tmpl/modest-window-mgr.sgml new file mode 100644 index 0000000..de25fba --- /dev/null +++ b/docs/reference/tmpl/modest-window-mgr.sgml @@ -0,0 +1,91 @@ + +ModestWindowMgr + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@win: +@type: +@id: + + + + + + +@parent: + + + + + + +@Returns: + + + + + + + +@self: +@win: +@type: +@window_id: +@Returns: + + + + + + + +@self: +@win: +@Returns: + + + + + + + +@self: +@type: +@Returns: + + + + + + + +@self: +@window_id: +@Returns: + + diff --git a/docs/reference/tmpl/modest.glade.sgml b/docs/reference/tmpl/modest.glade.sgml new file mode 100644 index 0000000..7a5412f --- /dev/null +++ b/docs/reference/tmpl/modest.glade.sgml @@ -0,0 +1,19 @@ + +modest.glade + + + + + + + + + + + + + + + + +