aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2011-04-26 03:23:27 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-06-03 11:00:43 +0800
commita11639fcfc14f6361ce20c6c85a0cfa481e4b7bd (patch)
tree3a26da4f09f9c3790377644707d6a32e577fae9a /doc
parent328de3de78e9cd079f5e005835ce50832735ec36 (diff)
downloadgsoc2013-evolution-a11639fcfc14f6361ce20c6c85a0cfa481e4b7bd.tar.gz
gsoc2013-evolution-a11639fcfc14f6361ce20c6c85a0cfa481e4b7bd.tar.zst
gsoc2013-evolution-a11639fcfc14f6361ce20c6c85a0cfa481e4b7bd.zip
Adapt API documentation to the new ESource API.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/shell/eshell-docs.sgml4
-rw-r--r--doc/reference/shell/eshell-sections.txt213
-rw-r--r--doc/reference/shell/eshell.types2
-rw-r--r--doc/reference/shell/tmpl/e-mail-account-manager.sgml72
-rw-r--r--doc/reference/shell/tmpl/e-mail-account-tree-view.sgml90
-rw-r--r--doc/reference/shell/tmpl/e-mail-identity-combo-box.sgml56
6 files changed, 280 insertions, 157 deletions
diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml
index f29a277a8b..df6cd4354d 100644
--- a/doc/reference/shell/eshell-docs.sgml
+++ b/doc/reference/shell/eshell-docs.sgml
@@ -27,7 +27,6 @@
<chapter>
<title>Basic Utility Functions</title>
- <xi:include href="xml/e-account-utils.xml"/>
<xi:include href="xml/e-alert.xml"/>
<xi:include href="xml/e-bit-array.xml"/>
<xi:include href="xml/e-categories-config.xml"/>
@@ -38,9 +37,6 @@
<xi:include href="xml/e-poolv.xml"/>
<xi:include href="xml/e-print.xml"/>
<xi:include href="xml/e-selection.xml"/>
- <xi:include href="xml/e-signature.xml"/>
- <xi:include href="xml/e-signature-list.xml"/>
- <xi:include href="xml/e-signature-utils.xml"/>
<xi:include href="xml/e-util.xml"/>
<xi:include href="xml/e-xml-utils.xml"/>
</chapter>
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index f568705539..27fbe428c2 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -356,87 +356,6 @@ E_SHELL_WINDOW_ACTION_GROUP
</SECTION>
<SECTION>
-<FILE>e-account-combo-box</FILE>
-EAccountComboBox
-e_account_combo_box_new
-e_account_combo_box_set_session
-e_account_combo_box_get_account_list
-e_account_combo_box_set_account_list
-e_account_combo_box_get_active
-e_account_combo_box_set_active
-e_account_combo_box_get_active_name
-e_account_combo_box_set_active_name
-e_account_combo_box_count_displayed_accounts
-<SUBSECTION Standard>
-E_ACCOUNT_COMBO_BOX
-E_IS_ACCOUNT_COMBO_BOX
-E_TYPE_ACCOUNT_COMBO_BOX
-E_ACCOUNT_COMBO_BOX_CLASS
-E_IS_ACCOUNT_COMBO_BOX_CLASS
-E_ACCOUNT_COMBO_BOX_GET_CLASS
-EAccountComboBoxClass
-e_account_combo_box_get_type
-<SUBSECTION Private>
-EAccountComboBoxPrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-account-manager</FILE>
-e_account_manager_new
-e_account_manager_add_account
-e_account_manager_edit_account
-e_account_manager_delete_account
-e_account_manager_get_account_list
-e_account_manager_set_account_list
-e_account_manager_get_tree_view
-<SUBSECTION Standard>
-E_ACCOUNT_MANAGER
-E_IS_ACCOUNT_MANAGER
-E_TYPE_ACCOUNT_MANAGER
-E_ACCOUNT_MANAGER_CLASS
-E_IS_ACCOUNT_MANAGER_CLASS
-E_ACCOUNT_MANAGER_GET_CLASS
-e_account_manager_get_type
-<SUBSECTION Private>
-EAccountManagerPrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-account-tree-view</FILE>
-EAccountTreeView
-e_account_tree_view_new
-e_account_tree_view_enable_account
-e_account_tree_view_disable_account
-e_account_tree_view_get_account_list
-e_account_tree_view_set_account_list
-e_account_tree_view_get_selected
-e_account_tree_view_set_selected
-<SUBSECTION Standard>
-E_ACCOUNT_TREE_VIEW
-E_IS_ACCOUNT_TREE_VIEW
-E_TYPE_ACCOUNT_TREE_VIEW
-E_ACCOUNT_TREE_VIEW_CLASS
-E_IS_ACCOUNT_TREE_VIEW_CLASS
-E_ACCOUNT_TREE_VIEW_GET_CLASS
-EAccountTreeViewClass
-e_account_tree_view_get_type
-<SUBSECTION Private>
-EAccountTreeViewPrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-account-utils</FILE>
-<TITLE>Mail Accounts</TITLE>
-e_get_account_list
-e_get_default_account
-e_set_default_account
-e_get_account_by_name
-e_get_account_by_uid
-e_get_any_enabled_account
-e_get_default_transport
-</SECTION>
-
-<SECTION>
<FILE>e-action-combo-box</FILE>
EActionComboBox
e_action_combo_box_new
@@ -870,6 +789,68 @@ e_icon_factory_create_thumbnail
</SECTION>
<SECTION>
+<FILE>e-mail-account-manager</FILE>
+EMailAccountManager
+e_mail_account_manager_new
+e_mail_account_manager_add_account
+e_mail_account_manager_edit_account
+e_mail_account_manager_delete_account
+e_mail_account_manager_get_registry
+<SUBSECTION Standard>
+E_MAIL_ACCOUNT_MANAGER
+E_IS_MAIL_ACCOUNT_MANAGER
+E_TYPE_MAIL_ACCOUNT_MANAGER
+E_MAIL_ACCOUNT_MANAGER_CLASS
+E_IS_MAIL_ACCOUNT_MANAGER_CLASS
+E_MAIL_ACCOUNT_MANAGER_GET_CLASS
+e_mail_account_manager_get_type
+<SUBSECTION Private>
+EMailAccountManagerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>e-mail-account-tree-view</FILE>
+EMailAccountTreeView
+e_mail_account_tree_view_new
+e_mail_account_tree_view_refresh
+e_mail_account_tree_view_enable_selected
+e_mail_account_tree_view_disable_selected
+e_mail_account_tree_view_get_registry
+e_mail_account_tree_view_get_selected_source
+e_mail_account_tree_view_set_selected_source
+<SUBSECTION Standard>
+E_MAIL_ACCOUNT_TREE_VIEW
+E_IS_MAIL_ACCOUNT_TREE_VIEW
+E_TYPE_MAIL_ACCOUNT_TREE_VIEW
+E_MAIL_ACCOUNT_TREE_VIEW_CLASS
+E_IS_MAIL_ACCOUNT_TREE_VIEW_CLASS
+E_MAIL_ACCOUNT_TREE_VIEW_GET_CLASS
+EMailAccountTreeViewClass
+e_mail_account_tree_view_get_type
+<SUBSECTION Private>
+EMailAccountTreeViewPrivate
+</SECTION>
+
+<SECTION>
+<FILE>e-mail-identity-combo-box</FILE>
+EMailIdentityComboBox
+e_mail_identity_combo_box_new
+e_mail_identity_combo_box_refresh
+e_mail_identity_combo_box_get_registry
+<SUBSECTION Standard>
+E_MAIL_IDENTITY_COMBO_BOX
+E_IS_MAIL_IDENTITY_COMBO_BOX
+E_TYPE_MAIL_IDENTITY_COMBO_BOX
+E_MAIL_IDENTITY_COMBO_BOX_CLASS
+E_IS_MAIL_IDENTITY_COMBO_BOX_CLASS
+E_MAIL_IDENTITY_COMBO_BOX_GET_CLASS
+EMailIdentityComboBoxClass
+e_mail_identity_combo_box_get_type
+<SUBSECTION Private>
+EMailIdentityComboBoxPrivate
+</SECTION>
+
+<SECTION>
<FILE>e-poolv</FILE>
<TITLE>EPoolv</TITLE>
EPoolv
@@ -929,76 +910,6 @@ e_clipboard_wait_is_directory_available
</SECTION>
<SECTION>
-<FILE>e-signature</FILE>
-<TITLE>Personalized Signatures</TITLE>
-ESignature
-e_signature_new
-e_signature_new_from_xml
-e_signature_uid_from_xml
-e_signature_set_from_xml
-e_signature_to_xml
-e_signature_is_equal
-e_signature_get_autogenerated
-e_signature_set_autogenerated
-e_signature_get_filename
-e_signature_set_filename
-e_signature_get_is_html
-e_signature_set_is_html
-e_signature_get_is_script
-e_signature_set_is_script
-e_signature_get_name
-e_signature_set_name
-e_signature_get_uid
-e_signature_set_uid
-<SUBSECTION Standard>
-E_SIGNATURE
-E_IS_SIGNATURE
-E_TYPE_SIGNATURE
-E_SIGNATURE_CLASS
-E_IS_SIGNATURE_CLASS
-E_SIGNATURE_GET_CLASS
-ESignatureClass
-e_signature_get_type
-<SUBSECTION Private>
-ESignaturePrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-signature-list</FILE>
-<TITLE>Container for Signatures</TITLE>
-ESignatureList
-e_signature_list_new
-e_signature_list_construct
-e_signature_list_save
-e_signature_list_add
-e_signature_list_change
-e_signature_list_remove
-e_signature_list_find_by_name
-e_signature_list_find_by_uid
-<SUBSECTION Standard>
-E_SIGNATURE_LIST
-E_IS_SIGNATURE_LIST
-E_TYPE_SIGNATURE_LIST
-E_SIGNATURE_LIST_CLASS
-E_IS_SIGNATURE_LIST_CLASS
-ESignatureListClass
-e_signature_list_get_type
-<SUBSECTION Private>
-ESignatureListPrivate
-</SECTION>
-
-<SECTION>
-<FILE>e-signature-utils</FILE>
-<TITLE>More Signature Utilities</TITLE>
-e_get_signature_list
-e_get_signature_by_name
-e_get_signature_by_uid
-e_create_signature_file
-e_read_signature_file
-e_run_signature_script
-</SECTION>
-
-<SECTION>
EWebView
e_web_view_new
e_web_view_clear
diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types
index 4e01f342e8..0832576163 100644
--- a/doc/reference/shell/eshell.types
+++ b/doc/reference/shell/eshell.types
@@ -1,6 +1,4 @@
e_bit_array_get_type
-e_signature_get_type
-e_signature_list_get_type
e_shell_get_type
e_shell_backend_get_type
e_shell_content_get_type
diff --git a/doc/reference/shell/tmpl/e-mail-account-manager.sgml b/doc/reference/shell/tmpl/e-mail-account-manager.sgml
new file mode 100644
index 0000000000..49fe04bdf2
--- /dev/null
+++ b/doc/reference/shell/tmpl/e-mail-account-manager.sgml
@@ -0,0 +1,72 @@
+<!-- ##### SECTION Title ##### -->
+e-mail-account-manager
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT EMailAccountManager ##### -->
+<para>
+
+</para>
+
+@parent:
+@priv:
+
+<!-- ##### FUNCTION e_mail_account_manager_new ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION e_mail_account_manager_add_account ##### -->
+<para>
+
+</para>
+
+@manager:
+
+
+<!-- ##### FUNCTION e_mail_account_manager_edit_account ##### -->
+<para>
+
+</para>
+
+@manager:
+
+
+<!-- ##### FUNCTION e_mail_account_manager_delete_account ##### -->
+<para>
+
+</para>
+
+@manager:
+
+
+<!-- ##### FUNCTION e_mail_account_manager_get_registry ##### -->
+<para>
+
+</para>
+
+@manager:
+@Returns:
+
+
diff --git a/doc/reference/shell/tmpl/e-mail-account-tree-view.sgml b/doc/reference/shell/tmpl/e-mail-account-tree-view.sgml
new file mode 100644
index 0000000000..eaee2f12c5
--- /dev/null
+++ b/doc/reference/shell/tmpl/e-mail-account-tree-view.sgml
@@ -0,0 +1,90 @@
+<!-- ##### SECTION Title ##### -->
+e-mail-account-tree-view
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT EMailAccountTreeView ##### -->
+<para>
+
+</para>
+
+@parent:
+@priv:
+
+<!-- ##### FUNCTION e_mail_account_tree_view_new ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_refresh ##### -->
+<para>
+
+</para>
+
+@tree_view:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_enable_selected ##### -->
+<para>
+
+</para>
+
+@tree_view:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_disable_selected ##### -->
+<para>
+
+</para>
+
+@tree_view:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_get_registry ##### -->
+<para>
+
+</para>
+
+@tree_view:
+@Returns:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_get_selected_source ##### -->
+<para>
+
+</para>
+
+@tree_view:
+@Returns:
+
+
+<!-- ##### FUNCTION e_mail_account_tree_view_set_selected_source ##### -->
+<para>
+
+</para>
+
+@tree_view:
+@source:
+
+
diff --git a/doc/reference/shell/tmpl/e-mail-identity-combo-box.sgml b/doc/reference/shell/tmpl/e-mail-identity-combo-box.sgml
new file mode 100644
index 0000000000..fec8130b21
--- /dev/null
+++ b/doc/reference/shell/tmpl/e-mail-identity-combo-box.sgml
@@ -0,0 +1,56 @@
+<!-- ##### SECTION Title ##### -->
+e-mail-identity-combo-box
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT EMailIdentityComboBox ##### -->
+<para>
+
+</para>
+
+@parent:
+@priv:
+
+<!-- ##### FUNCTION e_mail_identity_combo_box_new ##### -->
+<para>
+
+</para>
+
+@registry:
+@Returns:
+
+
+<!-- ##### FUNCTION e_mail_identity_combo_box_refresh ##### -->
+<para>
+
+</para>
+
+@combo_box:
+
+
+<!-- ##### FUNCTION e_mail_identity_combo_box_get_registry ##### -->
+<para>
+
+</para>
+
+@combo_box:
+@Returns:
+
+