evolution-data-server r10092 - in branches/gnome-2-24/docs/reference/camel: . tmpl



Author: mbarnes
Date: Wed Feb 25 03:43:26 2009
New Revision: 10092
URL: http://svn.gnome.org/viewvc/evolution-data-server?rev=10092&view=rev

Log:
Update Camel API documentation.


Added:
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-search-sql-sexp.sgml
Modified:
   branches/gnome-2-24/docs/reference/camel/camel-docs.sgml
   branches/gnome-2-24/docs/reference/camel/camel-sections.txt
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-arg.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-search.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-summary.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-imap-message-cache.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-store.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-folder.sgml
   branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-summary.sgml

Modified: branches/gnome-2-24/docs/reference/camel/camel-docs.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/camel-docs.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/camel-docs.sgml	Wed Feb 25 03:43:26 2009
@@ -87,6 +87,7 @@
 <!ENTITY CamelSASLPlain SYSTEM "xml/camel-sasl-plain.xml">
 <!ENTITY CamelSASLPOPb4SMTP SYSTEM "xml/camel-sasl-popb4smtp.xml">
 <!ENTITY CamelSearchSQL SYSTEM "xml/camel-search-sql.xml">
+<!ENTITY CamelSearchSQLSexp SYSTEM "xml/camel-search-sql-sexp.xml">
 <!ENTITY CamelService SYSTEM "xml/camel-service.xml">
 <!ENTITY CamelSession SYSTEM "xml/camel-session.xml">
 <!ENTITY CamelSMIMEContext SYSTEM "xml/camel-smime-context.xml">
@@ -303,6 +304,7 @@
       &CamelMsgPort;
       &CamelNetUtils;
       &CamelSearchSQL;
+      &CamelSearchSQLSexp;
       &CamelStringUtils;
       &CamelTrie;
       &CamelUIDCache;

Modified: branches/gnome-2-24/docs/reference/camel/camel-sections.txt
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/camel-sections.txt	(original)
+++ branches/gnome-2-24/docs/reference/camel/camel-sections.txt	Wed Feb 25 03:43:26 2009
@@ -194,6 +194,9 @@
 <FILE>camel-db</FILE>
 <TITLE>CamelDB</TITLE>
 CAMEL_DB_FILE
+CAMEL_DB_IN_MEMORY_TABLE
+CAMEL_DB_IN_MEMORY_DB
+CAMEL_DB_IN_MEMORY_TABLE_LIMIT
 CAMEL_DB_FREE_CACHE_SIZE
 CAMEL_DB_SLEEP_INTERVAL
 CAMEL_DB_RELEASE_SQLITE_MEMORY
@@ -204,6 +207,7 @@
 CamelFIRecord
 CamelDBSelectCB
 camel_db_open
+camel_db_clone
 camel_db_close
 camel_db_command
 camel_db_transaction_command
@@ -216,12 +220,14 @@
 camel_db_delete_folder
 camel_db_delete_uid
 camel_db_delete_uids
+camel_db_delete_vuids
 camel_db_create_folders_table
 camel_db_select
 camel_db_write_folder_info_record
 camel_db_read_folder_info_record
 camel_db_prepare_message_info_table
 camel_db_write_message_info_record
+camel_db_write_fresh_message_info_record
 camel_db_read_message_info_records
 camel_db_read_message_info_record_with_uid
 camel_db_count_junk_message_info
@@ -231,6 +237,7 @@
 camel_db_count_visible_message_info
 camel_db_count_visible_unread_message_info
 camel_db_count_junk_not_deleted_message_info
+camel_db_count_message_info
 camel_db_camel_mir_free
 camel_db_create_vfolder
 camel_db_recreate_vfolder
@@ -240,6 +247,7 @@
 camel_db_add_to_vfolder
 camel_db_add_to_vfolder_transaction
 camel_db_get_folder_uids
+camel_db_get_folder_uids_flags
 camel_db_get_folder_junk_uids
 camel_db_get_folder_deleted_uids
 camel_db_sqlize_string
@@ -247,6 +255,10 @@
 camel_db_get_column_name
 camel_db_set_collate
 camel_db_migrate_vfolders_to_14
+camel_db_start_in_memory_transactions
+camel_db_flush_in_memory_transactions
+<SUBSECTION Private>
+CamelDBPrivate
 </SECTION>
 
 <SECTION>
@@ -397,14 +409,17 @@
 camel_folder_get_summary
 camel_folder_free_summary
 camel_folder_get_message
+camel_folder_sync_message
 camel_folder_delete_message
 camel_folder_get_uids
 camel_folder_free_uids
+camel_folder_get_uncached_uids
 camel_folder_sort_uids
 camel_folder_has_search_capability
 camel_folder_search_by_expression
 camel_folder_search_by_uids
 camel_folder_search_free
+camel_folder_count_by_expression
 camel_folder_get_message_info
 camel_folder_free_message_info
 camel_folder_ref_message_info
@@ -456,6 +471,7 @@
 camel_folder_search_set_body_index
 camel_folder_search_execute_expression
 camel_folder_search_search
+camel_folder_search_count
 camel_folder_search_free_result
 <SUBSECTION Standard>
 CAMEL_FOLDER_SEARCH
@@ -498,6 +514,7 @@
 camel_folder_summary_header_save_to_db
 camel_folder_summary_touch
 camel_folder_summary_add
+camel_folder_summary_peek_info
 camel_folder_summary_get_changed
 camel_folder_summary_cache_size
 camel_folder_summary_reload_from_db
@@ -524,6 +541,10 @@
 camel_folder_summary_uid_from_index
 camel_folder_summary_check_uid
 camel_folder_summary_array
+camel_folder_summary_get_hashtable
+camel_folder_summary_free_hashtable
+camel_folder_summary_get_flag_cache
+camel_folder_summary_update_flag_cache
 camel_folder_summary_encode_token
 camel_folder_summary_decode_token
 camel_flag_get
@@ -1577,6 +1598,11 @@
 </SECTION>
 
 <SECTION>
+<FILE>camel-search-sql-sexp</FILE>
+camel_sexp_to_sql_sexp
+</SECTION>
+
+<SECTION>
 <FILE>camel-seekable-stream</FILE>
 <TITLE>CamelSeekableStream</TITLE>
 CamelSeekableStream
@@ -1778,6 +1804,7 @@
 CAMEL_STORE_FILTER_INBOX
 CAMEL_STORE_VJUNK
 CAMEL_STORE_PROXY
+CAMEL_STORE_IS_MIGRATING
 CAMEL_STORE_FOLDER_CREATE
 CAMEL_STORE_FOLDER_EXCL
 CAMEL_STORE_FOLDER_BODY_INDEX
@@ -2096,6 +2123,8 @@
 camel_vee_folder_set_folders
 camel_vee_folder_rebuild_folder
 camel_vee_folder_set_expression
+camel_vee_folder_mask_event_folder_changed
+camel_vee_folder_unmask_event_folder_changed
 camel_vee_folder_hash_folder
 camel_vee_folder_sync_headers
 <SUBSECTION Standard>
@@ -2131,6 +2160,7 @@
 camel_vee_summary_new
 camel_vee_summary_add
 camel_vee_summary_get_ids
+camel_vee_summary_load_check_unread_vfolder
 <SUBSECTION Standard>
 CAMEL_VEE_SUMMARY
 CAMEL_IS_VEE_SUMMARY
@@ -2308,6 +2338,7 @@
 camel_imap_message_cache_clear
 camel_imap_message_cache_copy
 camel_imap_message_cache_delete
+camel_imap_message_cache_filter_cached
 <SUBSECTION Standard>
 CAMEL_IMAP_MESSAGE_CACHE
 CAMEL_IS_IMAP_MESSAGE_CACHE

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-arg.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-arg.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-arg.sgml	Wed Feb 25 03:43:26 2009
@@ -29,16 +29,12 @@
 
 </para>
 
- ap: 
- argc: 
- argv: 
 
 <!-- ##### STRUCT CamelArgGet ##### -->
 <para>
 
 </para>
 
- tag: 
 
 <!-- ##### STRUCT CamelArgGetV ##### -->
 <para>

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-search.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-search.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-search.sgml	Wed Feb 25 03:43:26 2009
@@ -99,6 +99,17 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_folder_search_count ##### -->
+<para>
+
+</para>
+
+ search: 
+ expr: 
+ ex: 
+ Returns: 
+
+
 <!-- ##### FUNCTION camel_folder_search_free_result ##### -->
 <para>
 

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-summary.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-summary.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder-summary.sgml	Wed Feb 25 03:43:26 2009
@@ -328,6 +328,16 @@
 @info: 
 
 
+<!-- ##### FUNCTION camel_folder_summary_peek_info ##### -->
+<para>
+
+</para>
+
+ s: 
+ uid: 
+ Returns: 
+
+
 <!-- ##### FUNCTION camel_folder_summary_get_changed ##### -->
 <para>
 
@@ -573,6 +583,42 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_folder_summary_get_hashtable ##### -->
+<para>
+
+</para>
+
+ s: 
+ Returns: 
+
+
+<!-- ##### FUNCTION camel_folder_summary_free_hashtable ##### -->
+<para>
+
+</para>
+
+ ht: 
+
+
+<!-- ##### FUNCTION camel_folder_summary_get_flag_cache ##### -->
+<para>
+
+</para>
+
+ summary: 
+ Returns: 
+
+
+<!-- ##### FUNCTION camel_folder_summary_update_flag_cache ##### -->
+<para>
+
+</para>
+
+ s: 
+ uid: 
+ flag: 
+
+
 <!-- ##### FUNCTION camel_folder_summary_encode_token ##### -->
 <para>
 

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-folder.sgml	Wed Feb 25 03:43:26 2009
@@ -321,6 +321,16 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_folder_sync_message ##### -->
+<para>
+
+</para>
+
+ folder: 
+ uid: 
+ ex: 
+
+
 <!-- ##### MACRO camel_folder_delete_message ##### -->
 <para>
 
@@ -348,6 +358,17 @@
 @array: 
 
 
+<!-- ##### FUNCTION camel_folder_get_uncached_uids ##### -->
+<para>
+
+</para>
+
+ Param1: 
+ uids: 
+ Param3: 
+ Returns: 
+
+
 <!-- ##### FUNCTION camel_folder_sort_uids ##### -->
 <para>
 
@@ -398,6 +419,17 @@
 @result: 
 
 
+<!-- ##### FUNCTION camel_folder_count_by_expression ##### -->
+<para>
+
+</para>
+
+ folder: 
+ expression: 
+ ex: 
+ Returns: 
+
+
 <!-- ##### FUNCTION camel_folder_get_message_info ##### -->
 <para>
 

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-imap-message-cache.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-imap-message-cache.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-imap-message-cache.sgml	Wed Feb 25 03:43:26 2009
@@ -146,3 +146,14 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_imap_message_cache_filter_cached ##### -->
+<para>
+
+</para>
+
+ Param1: 
+ uids: 
+ ex: 
+ Returns: 
+
+

Added: branches/gnome-2-24/docs/reference/camel/tmpl/camel-search-sql-sexp.sgml
==============================================================================
--- (empty file)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-search-sql-sexp.sgml	Wed Feb 25 03:43:26 2009
@@ -0,0 +1,30 @@
+<!-- ##### SECTION Title ##### -->
+camel-search-sql-sexp
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION camel_sexp_to_sql_sexp ##### -->
+<para>
+
+</para>
+
+ sexp: 
+ Returns: 
+
+

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-store.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-store.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-store.sgml	Wed Feb 25 03:43:26 2009
@@ -229,6 +229,13 @@
 
 
 
+<!-- ##### MACRO CAMEL_STORE_IS_MIGRATING ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### MACRO CAMEL_STORE_FOLDER_CREATE ##### -->
 <para>
 

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-folder.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-folder.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-folder.sgml	Wed Feb 25 03:43:26 2009
@@ -121,6 +121,24 @@
 @expr: 
 
 
+<!-- ##### FUNCTION camel_vee_folder_mask_event_folder_changed ##### -->
+<para>
+
+</para>
+
+ vf: 
+ sub: 
+
+
+<!-- ##### FUNCTION camel_vee_folder_unmask_event_folder_changed ##### -->
+<para>
+
+</para>
+
+ vf: 
+ sub: 
+
+
 <!-- ##### FUNCTION camel_vee_folder_hash_folder ##### -->
 <para>
 

Modified: branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-summary.sgml
==============================================================================
--- branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-summary.sgml	(original)
+++ branches/gnome-2-24/docs/reference/camel/tmpl/camel-vee-summary.sgml	Wed Feb 25 03:43:26 2009
@@ -66,3 +66,11 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_vee_summary_load_check_unread_vfolder ##### -->
+<para>
+
+</para>
+
+ vs: 
+
+



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]