diff options
| author | Matthew Barnes <mbarnes@redhat.com> | 2010-04-24 16:35:29 -0400 |
|---|---|---|
| committer | Matthew Barnes <mbarnes@redhat.com> | 2010-04-30 11:46:48 -0400 |
| commit | bcd1f61f19fd7c7639874c25d48f04fc5d1b8001 (patch) | |
| tree | 11aafa8f48aa4401568e8485c4cbf8c240a5a985 /docs | |
| parent | a35ae0e6ef62124049908179c705a841dd450b55 (diff) | |
| download | evolution-data-server-bcd1f61f19fd7c7639874c25d48f04fc5d1b8001.tar.gz | |
Use GObject properties instead of CamelArg.
Persistent properties are implemented as normal GObject properties, but
with a special GParamFlag: CAMEL_PARAM_PERSISTENT.
Currently all persistent properties are of type boolean, so the state
file read/write logic has been scaled down to support only booleans.
Diffstat (limited to 'docs')
26 files changed, 881 insertions, 288 deletions
diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml index 79a836656..706ef6cbc 100644 --- a/docs/reference/camel/camel-docs.sgml +++ b/docs/reference/camel/camel-docs.sgml @@ -41,7 +41,6 @@ <chapter id="Fundamentals"> <title>Fundamentals</title> <xi:include href="xml/camel.xml"/> - <xi:include href="xml/camel-arg.xml"/> <xi:include href="xml/camel-debug.xml"/> <xi:include href="xml/camel-exception.xml"/> <xi:include href="xml/camel-object.xml"/> diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt index 8bfdeba57..88b3d2f86 100644 --- a/docs/reference/camel/camel-sections.txt +++ b/docs/reference/camel/camel-sections.txt @@ -111,6 +111,9 @@ camel_cert_set_hostname camel_cert_set_fingerprint camel_cert_get_trust camel_cert_set_trust +CamelCertDBLock +camel_certdb_lock +camel_certdb_unlock <SUBSECTION Standard> CAMEL_CERTDB CAMEL_IS_CERTDB @@ -175,6 +178,8 @@ camel_cipher_context_get_type <TITLE>CamelDataCache</TITLE> CamelDataCache camel_data_cache_new +camel_data_cache_get_path +camel_data_cache_set_path camel_data_cache_set_expire_age camel_data_cache_set_expire_access camel_data_cache_add @@ -207,6 +212,9 @@ camel_data_wrapper_get_mime_type_field camel_data_wrapper_set_mime_type_field camel_data_wrapper_construct_from_stream camel_data_wrapper_is_offline +CamelDataWrapperLock +camel_data_wrapper_lock +camel_data_wrapper_unlock <SUBSECTION Standard> CAMEL_DATA_WRAPPER CAMEL_IS_DATA_WRAPPER @@ -299,7 +307,6 @@ CamelDBPrivate <TITLE>CamelDiscoDiary</TITLE> CamelDiscoDiary CamelDiscoDiaryAction -CamelDiscoDiaryArgType camel_disco_diary_new camel_disco_diary_empty camel_disco_diary_log @@ -322,6 +329,8 @@ camel_disco_diary_get_type <FILE>camel-disco-folder</FILE> <TITLE>CamelDiscoFolder</TITLE> CamelDiscoFolder +camel_disco_folder_get_offline_sync +camel_disco_folder_set_offline_sync camel_disco_folder_expunge_uids camel_disco_folder_cache_message camel_disco_folder_prepare_for_offline @@ -334,6 +343,7 @@ CAMEL_IS_DISCO_FOLDER_CLASS CAMEL_DISCO_FOLDER_GET_CLASS CamelDiscoFolderClass <SUBSECTION Private> +CamelDiscoFolderPrivate camel_disco_folder_get_type </SECTION> @@ -404,14 +414,17 @@ CAMEL_FOLDER_HAS_BEEN_DELETED CAMEL_FOLDER_IS_TRASH CAMEL_FOLDER_IS_JUNK CAMEL_FOLDER_FILTER_JUNK -camel_folder_construct camel_folder_refresh_info camel_folder_sync camel_folder_set_lock_async camel_folder_get_parent_store camel_folder_expunge camel_folder_get_name +camel_folder_set_name camel_folder_get_full_name +camel_folder_set_full_name +camel_folder_get_description +camel_folder_set_description camel_folder_get_permanent_flags camel_folder_get_message_flags camel_folder_set_message_flags @@ -448,6 +461,7 @@ camel_folder_rename camel_folder_freeze camel_folder_thaw camel_folder_is_frozen +camel_folder_get_frozen_count camel_folder_get_quota_info camel_folder_quota_info_new camel_folder_quota_info_clone @@ -470,6 +484,9 @@ camel_folder_change_info_add_uid camel_folder_change_info_remove_uid camel_folder_change_info_change_uid camel_folder_change_info_recent_uid +CamelFolderLock +camel_folder_lock +camel_folder_unlock <SUBSECTION Standard> CAMEL_FOLDER CAMEL_IS_FOLDER @@ -480,6 +497,7 @@ CAMEL_FOLDER_GET_CLASS CamelFolderClass <SUBSECTION Private> CamelFolderPrivate +CamelFolderChangeInfoPrivate camel_folder_get_type </SECTION> @@ -542,9 +560,7 @@ 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 -camel_folder_summary_ensure_infos_loaded +camel_folder_summary_prepare_fetch_all camel_folder_summary_insert camel_folder_summary_remove_index_fast camel_folder_summary_remove_uid_fast @@ -623,6 +639,9 @@ camel_folder_summary_guess_content_info camel_content_info_dump camel_message_info_dump camel_folder_summary_migrate_infos +CamelFolderSummaryLock +camel_folder_summary_lock +camel_folder_summary_unlock <SUBSECTION Standard> CAMEL_FOLDER_SUMMARY CAMEL_IS_FOLDER_SUMMARY @@ -641,6 +660,7 @@ camel_folder_summary_get_type <TITLE>CamelGpgContext</TITLE> CamelGpgContext camel_gpg_context_new +camel_gpg_context_get_always_trust camel_gpg_context_set_always_trust <SUBSECTION Standard> CAMEL_GPG_CONTEXT @@ -722,6 +742,7 @@ CAMEL_INDEX_DELETED camel_index_new camel_index_construct camel_index_rename +camel_index_set_normalize camel_index_sync camel_index_compress camel_index_delete @@ -1427,18 +1448,16 @@ CamelObject CamelObjectHookID CamelObjectEventPrepFunc CamelObjectEventHookFunc +CamelParamFlags camel_object_class_add_event camel_object_hook_event camel_object_remove_event camel_object_unhook_event camel_object_trigger_event -camel_object_set -camel_object_setv -camel_object_get -camel_object_getv camel_object_state_read camel_object_state_write -camel_object_free +camel_object_get_state_filename +camel_object_set_state_filename CamelObjectBag CamelCopyFunc camel_object_bag_new @@ -1460,6 +1479,7 @@ CAMEL_IS_OBJECT_CLASS CAMEL_OBJECT_GET_CLASS CamelObjectClass <SUBSECTION Private> +CamelObjectPrivate camel_object_get_type </SECTION> @@ -1467,6 +1487,8 @@ camel_object_get_type <FILE>camel-offline-folder</FILE> <TITLE>CamelOfflineFolder</TITLE> CamelOfflineFolder +camel_offline_folder_get_offline_sync +camel_offline_folder_set_offline_sync camel_offline_folder_downsync <SUBSECTION Standard> CAMEL_OFFLINE_FOLDER @@ -1477,6 +1499,7 @@ CAMEL_IS_OFFLINE_FOLDER_CLASS CAMEL_OFFLINE_FOLDER_GET_CLASS CamelOfflineFolderClass <SUBSECTION Private> +CamelOfflineFolderPrivate camel_offline_folder_get_type </SECTION> @@ -1786,6 +1809,11 @@ CamelSasl camel_sasl_challenge camel_sasl_challenge_base64 camel_sasl_new +camel_sasl_get_authenticated +camel_sasl_set_authenticated +camel_sasl_get_mechanism +camel_sasl_get_service +camel_sasl_get_service_name camel_sasl_authtype_list camel_sasl_authtype <SUBSECTION Standard> @@ -1853,11 +1881,6 @@ camel_seekable_substream_get_type <FILE>camel-service</FILE> <TITLE>CamelService</TITLE> CamelService -CAMEL_SERVICE_USERNAME -CAMEL_SERVICE_AUTH -CAMEL_SERVICE_HOSTNAME -CAMEL_SERVICE_PORT -CAMEL_SERVICE_PATH CamelServiceConnectionStatus CamelServiceAuthType camel_service_construct @@ -1870,6 +1893,9 @@ camel_service_get_path camel_service_get_session camel_service_get_provider camel_service_query_auth_types +CamelServiceLock +camel_service_lock +camel_service_unlock <SUBSECTION Standard> CAMEL_SERVICE CAMEL_IS_SERVICE @@ -1916,6 +1942,9 @@ camel_session_get_junk_headers camel_session_set_junk_headers camel_session_lookup_addressbook camel_session_forward_to +CamelSessionLock +camel_session_lock +camel_session_unlock <SUBSECTION Standard> CAMEL_SESSION CAMEL_IS_SESSION @@ -1987,6 +2016,9 @@ camel_store_info_set_string camel_store_info_path camel_store_info_uri camel_store_info_name +CamelStoreSummaryLock +camel_store_summary_lock +camel_store_summary_unlock <SUBSECTION Standard> CAMEL_STORE_SUMMARY CAMEL_IS_STORE_SUMMARY @@ -2066,6 +2098,9 @@ camel_store_unsubscribe_folder camel_store_noop camel_store_folder_uri_equal camel_store_can_refresh_folder +CamelStoreLock +camel_store_lock +camel_store_unlock <SUBSECTION Standard> CAMEL_STORE CAMEL_IS_STORE @@ -2132,6 +2167,8 @@ camel_stream_buffer_get_type <FILE>camel-stream-filter</FILE> <TITLE>CamelStreamFilter</TITLE> CamelStreamFilter +camel_stream_filter_new +camel_stream_filter_get_source camel_stream_filter_add camel_stream_filter_remove <SUBSECTION Standard> @@ -2155,6 +2192,7 @@ camel_stream_fs_new_with_name camel_stream_fs_new_with_name_and_bounds camel_stream_fs_new_with_fd camel_stream_fs_new_with_fd_and_bounds +camel_stream_fs_get_fd <SUBSECTION Standard> CAMEL_STREAM_FS CAMEL_IS_STREAM_FS @@ -2176,6 +2214,7 @@ camel_stream_mem_new camel_stream_mem_new_with_byte_array camel_stream_mem_new_with_buffer camel_stream_mem_set_secure +camel_stream_mem_get_byte_array camel_stream_mem_set_byte_array camel_stream_mem_set_buffer <SUBSECTION Standard> @@ -2260,6 +2299,9 @@ CAMEL_IS_TCP_STREAM_RAW_CLASS CAMEL_TCP_STREAM_RAW_GET_CLASS CamelTcpStreamRawClass <SUBSECTION Private> +addrinfo +sockaddr +socklen_t camel_tcp_stream_raw_get_type </SECTION> @@ -2374,6 +2416,9 @@ camel_text_index_name_get_type <TITLE>CamelTransport</TITLE> CamelTransport camel_transport_send_to +CamelTransportLock +camel_transport_lock +camel_transport_unlock <SUBSECTION Standard> CAMEL_TRANSPORT CAMEL_IS_TRANSPORT @@ -2413,6 +2458,11 @@ camel_vee_folder_mask_event_folder_changed camel_vee_folder_unmask_event_folder_changed camel_vee_folder_hash_folder camel_vee_folder_sync_headers +camel_vee_folder_get_unread_vfolder +camel_vee_folder_set_unread_vfolder +CamelVeeFolderLock +camel_vee_folder_lock +camel_vee_folder_unlock <SUBSECTION Standard> CAMEL_VEE_FOLDER CAMEL_IS_VEE_FOLDER @@ -2487,26 +2537,6 @@ camel_vtrash_folder_get_type </SECTION> <SECTION> -<FILE>camel-arg</FILE> -CamelArg -CamelArgV -CamelArgGet -CamelArgGetV -ca_object -ca_int -ca_double -ca_str -ca_ptr -CAMEL_ARGV_MAX -camel_argv_start -camel_argv_end -camel_argv_build -camel_arggetv_build -camel_argv_ignore -CamelProperty -</SECTION> - -<SECTION> <FILE>camel-charset-map</FILE> CamelCharset camel_charset_init diff --git a/docs/reference/camel/tmpl/camel-arg.sgml b/docs/reference/camel/tmpl/camel-arg.sgml index 9f413efbe..d5184ae67 100644 --- a/docs/reference/camel/tmpl/camel-arg.sgml +++ b/docs/reference/camel/tmpl/camel-arg.sgml @@ -20,130 +20,3 @@ camel-arg <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT CamelArg ##### --> -<para> - -</para> - -@tag: - -<!-- ##### STRUCT CamelArgV ##### --> -<para> - -</para> - -@ap: -@argc: -@argv: - -<!-- ##### STRUCT CamelArgGet ##### --> -<para> - -</para> - -@tag: - -<!-- ##### STRUCT CamelArgGetV ##### --> -<para> - -</para> - -@ap: -@argc: -@argv: - -<!-- ##### MACRO ca_object ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ca_int ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ca_double ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ca_str ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ca_ptr ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CAMEL_ARGV_MAX ##### --> -<para> - -</para> - - - -<!-- ##### MACRO camel_argv_start ##### --> -<para> - -</para> - -@tv: -@last: - - -<!-- ##### MACRO camel_argv_end ##### --> -<para> - -</para> - -@tv: - - -<!-- ##### FUNCTION camel_argv_build ##### --> -<para> - -</para> - -@tv: -@Returns: - - -<!-- ##### FUNCTION camel_arggetv_build ##### --> -<para> - -</para> - -@tv: -@Returns: - - -<!-- ##### MACRO camel_argv_ignore ##### --> -<para> - -</para> - -@tv: -@i: - - -<!-- ##### STRUCT CamelProperty ##### --> -<para> - -</para> - -@tag: -@name: -@description: - diff --git a/docs/reference/camel/tmpl/camel-certdb.sgml b/docs/reference/camel/tmpl/camel-certdb.sgml index fc345dcf5..6ff021bca 100644 --- a/docs/reference/camel/tmpl/camel-certdb.sgml +++ b/docs/reference/camel/tmpl/camel-certdb.sgml @@ -292,3 +292,31 @@ CamelCertDB @trust: +<!-- ##### ENUM CamelCertDBLock ##### --> +<para> + +</para> + +@CCD_DB_LOCK: +@CCD_IO_LOCK: +@CCD_ALLOC_LOCK: +@CCD_REF_LOCK: + +<!-- ##### FUNCTION camel_certdb_lock ##### --> +<para> + +</para> + +@certdb: +@lock: + + +<!-- ##### FUNCTION camel_certdb_unlock ##### --> +<para> + +</para> + +@certdb: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-cipher-context.sgml b/docs/reference/camel/tmpl/camel-cipher-context.sgml index 292f721db..344d6d5db 100644 --- a/docs/reference/camel/tmpl/camel-cipher-context.sgml +++ b/docs/reference/camel/tmpl/camel-cipher-context.sgml @@ -331,6 +331,20 @@ CamelCipherContext @gpointer cert_data: @gpointer cert_data: @gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: +@gpointer cert_data: @gpointer cert_data: diff --git a/docs/reference/camel/tmpl/camel-data-cache.sgml b/docs/reference/camel/tmpl/camel-data-cache.sgml index ad3fef11d..0c2c3de74 100644 --- a/docs/reference/camel/tmpl/camel-data-cache.sgml +++ b/docs/reference/camel/tmpl/camel-data-cache.sgml @@ -41,6 +41,24 @@ CamelDataCache @Returns: +<!-- ##### FUNCTION camel_data_cache_get_path ##### --> +<para> + +</para> + +@cdc: +@Returns: + + +<!-- ##### FUNCTION camel_data_cache_set_path ##### --> +<para> + +</para> + +@cdc: +@path: + + <!-- ##### FUNCTION camel_data_cache_set_expire_age ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-data-wrapper.sgml b/docs/reference/camel/tmpl/camel-data-wrapper.sgml index f48475c6a..20426b883 100644 --- a/docs/reference/camel/tmpl/camel-data-wrapper.sgml +++ b/docs/reference/camel/tmpl/camel-data-wrapper.sgml @@ -110,3 +110,28 @@ CamelDataWrapper @Returns: +<!-- ##### ENUM CamelDataWrapperLock ##### --> +<para> + +</para> + +@CDW_STREAM_LOCK: + +<!-- ##### FUNCTION camel_data_wrapper_lock ##### --> +<para> + +</para> + +@data_wrapper: +@lock: + + +<!-- ##### FUNCTION camel_data_wrapper_unlock ##### --> +<para> + +</para> + +@data_wrapper: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-disco-diary.sgml b/docs/reference/camel/tmpl/camel-disco-diary.sgml index 15cccd77c..d098b55da 100644 --- a/docs/reference/camel/tmpl/camel-disco-diary.sgml +++ b/docs/reference/camel/tmpl/camel-disco-diary.sgml @@ -36,16 +36,6 @@ CamelDiscoDiary @CAMEL_DISCO_DIARY_FOLDER_APPEND: @CAMEL_DISCO_DIARY_FOLDER_TRANSFER: -<!-- ##### ENUM CamelDiscoDiaryArgType ##### --> -<para> - -</para> - -@CAMEL_DISCO_DIARY_ARG_NONE: -@CAMEL_DISCO_DIARY_ARG_FOLDER: -@CAMEL_DISCO_DIARY_ARG_UID: -@CAMEL_DISCO_DIARY_ARG_UID_LIST: - <!-- ##### FUNCTION camel_disco_diary_new ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-disco-folder.sgml b/docs/reference/camel/tmpl/camel-disco-folder.sgml index f3cad6237..468a4b0d0 100644 --- a/docs/reference/camel/tmpl/camel-disco-folder.sgml +++ b/docs/reference/camel/tmpl/camel-disco-folder.sgml @@ -26,6 +26,29 @@ CamelDiscoFolder </para> +<!-- ##### ARG CamelDiscoFolder:offline-sync ##### --> +<para> + +</para> + +<!-- ##### FUNCTION camel_disco_folder_get_offline_sync ##### --> +<para> + +</para> + +@disco_folder: +@Returns: + + +<!-- ##### FUNCTION camel_disco_folder_set_offline_sync ##### --> +<para> + +</para> + +@disco_folder: +@offline_sync: + + <!-- ##### FUNCTION camel_disco_folder_expunge_uids ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-folder-summary.sgml b/docs/reference/camel/tmpl/camel-folder-summary.sgml index 542349f80..b5a4235db 100644 --- a/docs/reference/camel/tmpl/camel-folder-summary.sgml +++ b/docs/reference/camel/tmpl/camel-folder-summary.sgml @@ -323,32 +323,12 @@ CamelFolderSummary @Returns: -<!-- ##### FUNCTION camel_folder_summary_cache_size ##### --> +<!-- ##### FUNCTION camel_folder_summary_prepare_fetch_all ##### --> <para> </para> @s: -@Returns: - - -<!-- ##### FUNCTION camel_folder_summary_reload_from_db ##### --> -<para> - -</para> - -@s: -@ex: -@Returns: - - -<!-- ##### FUNCTION camel_folder_summary_ensure_infos_loaded ##### --> -<para> - -</para> - -@s: -@at_least: @ex: @@ -1067,3 +1047,32 @@ CamelFolderSummary @Returns: +<!-- ##### ENUM CamelFolderSummaryLock ##### --> +<para> + +</para> + +@CFS_SUMMARY_LOCK: +@CFS_IO_LOCK: +@CFS_FILTER_LOCK: +@CFS_ALLOC_LOCK: +@CFS_REF_LOCK: + +<!-- ##### FUNCTION camel_folder_summary_lock ##### --> +<para> + +</para> + +@summary: +@lock: + + +<!-- ##### FUNCTION camel_folder_summary_unlock ##### --> +<para> + +</para> + +@summary: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-folder.sgml b/docs/reference/camel/tmpl/camel-folder.sgml index 00906955c..3cc749e8e 100644 --- a/docs/reference/camel/tmpl/camel-folder.sgml +++ b/docs/reference/camel/tmpl/camel-folder.sgml @@ -26,6 +26,26 @@ CamelFolder </para> +<!-- ##### ARG CamelFolder:description ##### --> +<para> + +</para> + +<!-- ##### ARG CamelFolder:full-name ##### --> +<para> + +</para> + +<!-- ##### ARG CamelFolder:name ##### --> +<para> + +</para> + +<!-- ##### ARG CamelFolder:parent-store ##### --> +<para> + +</para> + <!-- ##### STRUCT CamelFolderChangeInfo ##### --> <para> @@ -96,17 +116,6 @@ CamelFolder -<!-- ##### FUNCTION camel_folder_construct ##### --> -<para> - -</para> - -@folder: -@parent_store: -@full_name: -@name: - - <!-- ##### FUNCTION camel_folder_refresh_info ##### --> <para> @@ -165,6 +174,15 @@ CamelFolder @Returns: +<!-- ##### FUNCTION camel_folder_set_name ##### --> +<para> + +</para> + +@folder: +@name: + + <!-- ##### FUNCTION camel_folder_get_full_name ##### --> <para> @@ -174,6 +192,33 @@ CamelFolder @Returns: +<!-- ##### FUNCTION camel_folder_set_full_name ##### --> +<para> + +</para> + +@folder: +@full_name: + + +<!-- ##### FUNCTION camel_folder_get_description ##### --> +<para> + +</para> + +@folder: +@Returns: + + +<!-- ##### FUNCTION camel_folder_set_description ##### --> +<para> + +</para> + +@folder: +@description: + + <!-- ##### FUNCTION camel_folder_get_permanent_flags ##### --> <para> @@ -532,6 +577,15 @@ CamelFolder @Returns: +<!-- ##### FUNCTION camel_folder_get_frozen_count ##### --> +<para> + +</para> + +@folder: +@Returns: + + <!-- ##### FUNCTION camel_folder_get_quota_info ##### --> <para> @@ -730,3 +784,29 @@ CamelFolder @uid: +<!-- ##### ENUM CamelFolderLock ##### --> +<para> + +</para> + +@CF_CHANGE_LOCK: +@CF_REC_LOCK: + +<!-- ##### FUNCTION camel_folder_lock ##### --> +<para> + +</para> + +@folder: +@lock: + + +<!-- ##### FUNCTION camel_folder_unlock ##### --> +<para> + +</para> + +@folder: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-gpg-context.sgml b/docs/reference/camel/tmpl/camel-gpg-context.sgml index 4593441f3..0f8b2c8c8 100644 --- a/docs/reference/camel/tmpl/camel-gpg-context.sgml +++ b/docs/reference/camel/tmpl/camel-gpg-context.sgml @@ -40,6 +40,15 @@ CamelGpgContext @Returns: +<!-- ##### FUNCTION camel_gpg_context_get_always_trust ##### --> +<para> + +</para> + +@context: +@Returns: + + <!-- ##### FUNCTION camel_gpg_context_set_always_trust ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-index.sgml b/docs/reference/camel/tmpl/camel-index.sgml index 1a81adc30..445689fe6 100644 --- a/docs/reference/camel/tmpl/camel-index.sgml +++ b/docs/reference/camel/tmpl/camel-index.sgml @@ -143,6 +143,16 @@ CamelIndex @Returns: +<!-- ##### FUNCTION camel_index_set_normalize ##### --> +<para> + +</para> + +@index: +@func: +@data: + + <!-- ##### FUNCTION camel_index_sync ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-object.sgml b/docs/reference/camel/tmpl/camel-object.sgml index c5c14e166..bde393b21 100644 --- a/docs/reference/camel/tmpl/camel-object.sgml +++ b/docs/reference/camel/tmpl/camel-object.sgml @@ -26,6 +26,11 @@ CamelObject </para> +<!-- ##### ARG CamelObject:state-filename ##### --> +<para> + +</para> + <!-- ##### TYPEDEF CamelObjectHookID ##### --> <para> @@ -52,6 +57,13 @@ CamelObject @Param3: +<!-- ##### ENUM CamelParamFlags ##### --> +<para> + +</para> + +@CAMEL_PARAM_PERSISTENT: + <!-- ##### FUNCTION camel_object_class_add_event ##### --> <para> @@ -104,76 +116,40 @@ CamelObject @event_data: -<!-- ##### FUNCTION camel_object_set ##### --> -<para> - -</para> - -@obj: -@ex: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION camel_object_setv ##### --> -<para> - -</para> - -@obj: -@ex: -@Param3: -@Returns: - - -<!-- ##### FUNCTION camel_object_get ##### --> -<para> - -</para> - -@obj: -@ex: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION camel_object_getv ##### --> +<!-- ##### FUNCTION camel_object_state_read ##### --> <para> </para> -@obj: -@ex: -@Param3: +@object: @Returns: -<!-- ##### FUNCTION camel_object_state_read ##### --> +<!-- ##### FUNCTION camel_object_state_write ##### --> <para> </para> -@vo: +@object: @Returns: -<!-- ##### FUNCTION camel_object_state_write ##### --> +<!-- ##### FUNCTION camel_object_get_state_filename ##### --> <para> </para> -@vo: +@object: @Returns: -<!-- ##### FUNCTION camel_object_free ##### --> +<!-- ##### FUNCTION camel_object_set_state_filename ##### --> <para> </para> -@vo: -@tag: -@value: +@object: +@state_filename: <!-- ##### STRUCT CamelObjectBag ##### --> diff --git a/docs/reference/camel/tmpl/camel-offline-folder.sgml b/docs/reference/camel/tmpl/camel-offline-folder.sgml index d7ddf1b90..15bd22d91 100644 --- a/docs/reference/camel/tmpl/camel-offline-folder.sgml +++ b/docs/reference/camel/tmpl/camel-offline-folder.sgml @@ -26,6 +26,29 @@ CamelOfflineFolder </para> +<!-- ##### ARG CamelOfflineFolder:offline-sync ##### --> +<para> + +</para> + +<!-- ##### FUNCTION camel_offline_folder_get_offline_sync ##### --> +<para> + +</para> + +@offline: +@Returns: + + +<!-- ##### FUNCTION camel_offline_folder_set_offline_sync ##### --> +<para> + +</para> + +@offline: +@offline_sync: + + <!-- ##### FUNCTION camel_offline_folder_downsync ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-sasl.sgml b/docs/reference/camel/tmpl/camel-sasl.sgml index e6050d834..f44bc6bfa 100644 --- a/docs/reference/camel/tmpl/camel-sasl.sgml +++ b/docs/reference/camel/tmpl/camel-sasl.sgml @@ -79,6 +79,51 @@ CamelSasl @Returns: +<!-- ##### FUNCTION camel_sasl_get_authenticated ##### --> +<para> + +</para> + +@sasl: +@Returns: + + +<!-- ##### FUNCTION camel_sasl_set_authenticated ##### --> +<para> + +</para> + +@sasl: +@authenticated: + + +<!-- ##### FUNCTION camel_sasl_get_mechanism ##### --> +<para> + +</para> + +@sasl: +@Returns: + + +<!-- ##### FUNCTION camel_sasl_get_service ##### --> +<para> + +</para> + +@sasl: +@Returns: + + +<!-- ##### FUNCTION camel_sasl_get_service_name ##### --> +<para> + +</para> + +@sasl: +@Returns: + + <!-- ##### FUNCTION camel_sasl_authtype_list ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-service.sgml b/docs/reference/camel/tmpl/camel-service.sgml index 0720ac4a0..f6258118e 100644 --- a/docs/reference/camel/tmpl/camel-service.sgml +++ b/docs/reference/camel/tmpl/camel-service.sgml @@ -26,41 +26,6 @@ CamelService </para> -<!-- ##### MACRO CAMEL_SERVICE_USERNAME ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CAMEL_SERVICE_AUTH ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CAMEL_SERVICE_HOSTNAME ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CAMEL_SERVICE_PORT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CAMEL_SERVICE_PATH ##### --> -<para> - -</para> - - - <!-- ##### ENUM CamelServiceConnectionStatus ##### --> <para> @@ -179,3 +144,29 @@ CamelService @Returns: +<!-- ##### ENUM CamelServiceLock ##### --> +<para> + +</para> + +@CS_REC_CONNECT_LOCK: +@CS_CONNECT_OP_LOCK: + +<!-- ##### FUNCTION camel_service_lock ##### --> +<para> + +</para> + +@service: +@lock: + + +<!-- ##### FUNCTION camel_service_unlock ##### --> +<para> + +</para> + +@service: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-session.sgml b/docs/reference/camel/tmpl/camel-session.sgml index 002c8a6d6..124429bc5 100644 --- a/docs/reference/camel/tmpl/camel-session.sgml +++ b/docs/reference/camel/tmpl/camel-session.sgml @@ -327,3 +327,29 @@ CamelSession @ex: +<!-- ##### ENUM CamelSessionLock ##### --> +<para> + +</para> + +@CS_SESSION_LOCK: +@CS_THREAD_LOCK: + +<!-- ##### FUNCTION camel_session_lock ##### --> +<para> + +</para> + +@session: +@lock: + + +<!-- ##### FUNCTION camel_session_unlock ##### --> +<para> + +</para> + +@session: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-store-summary.sgml b/docs/reference/camel/tmpl/camel-store-summary.sgml index a59e8d871..f780a6395 100644 --- a/docs/reference/camel/tmpl/camel-store-summary.sgml +++ b/docs/reference/camel/tmpl/camel-store-summary.sgml @@ -321,3 +321,30 @@ CamelStoreSummary @i: +<!-- ##### ENUM CamelStoreSummaryLock ##### --> +<para> + +</para> + +@CSS_SUMMARY_LOCK: +@CSS_IO_LOCK: +@CSS_REF_LOCK: + +<!-- ##### FUNCTION camel_store_summary_lock ##### --> +<para> + +</para> + +@summary: +@lock: + + +<!-- ##### FUNCTION camel_store_summary_unlock ##### --> +<para> + +</para> + +@summary: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-store.sgml b/docs/reference/camel/tmpl/camel-store.sgml index 0ed8d9159..1ad8b7a1a 100644 --- a/docs/reference/camel/tmpl/camel-store.sgml +++ b/docs/reference/camel/tmpl/camel-store.sgml @@ -546,3 +546,28 @@ CamelStore @Returns: +<!-- ##### ENUM CamelStoreLock ##### --> +<para> + +</para> + +@CS_FOLDER_LOCK: + +<!-- ##### FUNCTION camel_store_lock ##### --> +<para> + +</para> + +@store: +@lock: + + +<!-- ##### FUNCTION camel_store_unlock ##### --> +<para> + +</para> + +@store: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-stream-filter.sgml b/docs/reference/camel/tmpl/camel-stream-filter.sgml index 4ca78d1c1..3eb7f938e 100644 --- a/docs/reference/camel/tmpl/camel-stream-filter.sgml +++ b/docs/reference/camel/tmpl/camel-stream-filter.sgml @@ -26,6 +26,24 @@ CamelStreamFilter </para> +<!-- ##### FUNCTION camel_stream_filter_new ##### --> +<para> + +</para> + +@source: +@Returns: + + +<!-- ##### FUNCTION camel_stream_filter_get_source ##### --> +<para> + +</para> + +@stream: +@Returns: + + <!-- ##### FUNCTION camel_stream_filter_add ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-stream-fs.sgml b/docs/reference/camel/tmpl/camel-stream-fs.sgml index fc7c11170..8d4a78735 100644 --- a/docs/reference/camel/tmpl/camel-stream-fs.sgml +++ b/docs/reference/camel/tmpl/camel-stream-fs.sgml @@ -70,3 +70,12 @@ CamelStreamFs @Returns: +<!-- ##### FUNCTION camel_stream_fs_get_fd ##### --> +<para> + +</para> + +@stream: +@Returns: + + diff --git a/docs/reference/camel/tmpl/camel-stream-mem.sgml b/docs/reference/camel/tmpl/camel-stream-mem.sgml index cc9b37532..293d25a73 100644 --- a/docs/reference/camel/tmpl/camel-stream-mem.sgml +++ b/docs/reference/camel/tmpl/camel-stream-mem.sgml @@ -62,6 +62,15 @@ CamelStreamMem @mem: +<!-- ##### FUNCTION camel_stream_mem_get_byte_array ##### --> +<para> + +</para> + +@mem: +@Returns: + + <!-- ##### FUNCTION camel_stream_mem_set_byte_array ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-transport.sgml b/docs/reference/camel/tmpl/camel-transport.sgml index 79b89e96c..cb8a6c8d5 100644 --- a/docs/reference/camel/tmpl/camel-transport.sgml +++ b/docs/reference/camel/tmpl/camel-transport.sgml @@ -39,3 +39,28 @@ CamelTransport @Returns: +<!-- ##### ENUM CamelTransportLock ##### --> +<para> + +</para> + +@CT_SEND_LOCK: + +<!-- ##### FUNCTION camel_transport_lock ##### --> +<para> + +</para> + +@transport: +@lock: + + +<!-- ##### FUNCTION camel_transport_unlock ##### --> +<para> + +</para> + +@transport: +@lock: + + diff --git a/docs/reference/camel/tmpl/camel-unused.sgml b/docs/reference/camel/tmpl/camel-unused.sgml index 0b60cb840..4f23646a2 100644 --- a/docs/reference/camel/tmpl/camel-unused.sgml +++ b/docs/reference/camel/tmpl/camel-unused.sgml @@ -54,6 +54,34 @@ address-data addresses +<!-- ##### SECTION ./tmpl/camel-arg.sgml:Image ##### --> + + + +<!-- ##### SECTION ./tmpl/camel-arg.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/camel-arg.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/camel-arg.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/camel-arg.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/camel-arg.sgml:Title ##### --> +camel-arg + + <!-- ##### SECTION ./tmpl/camel-digest-folder.sgml:Long_Description ##### --> <para> @@ -2226,6 +2254,12 @@ CamelTestSession streams +<!-- ##### MACRO CAMEL_ARGV_MAX ##### --> +<para> + +</para> + + <!-- ##### MACRO CAMEL_CHECK_CAST ##### --> <para> @@ -2550,6 +2584,36 @@ streams </para> +<!-- ##### MACRO CAMEL_SERVICE_AUTH ##### --> +<para> + +</para> + + +<!-- ##### MACRO CAMEL_SERVICE_HOSTNAME ##### --> +<para> + +</para> + + +<!-- ##### MACRO CAMEL_SERVICE_PATH ##### --> +<para> + +</para> + + +<!-- ##### MACRO CAMEL_SERVICE_PORT ##### --> +<para> + +</para> + + +<!-- ##### MACRO CAMEL_SERVICE_USERNAME ##### --> +<para> + +</para> + + <!-- ##### MACRO CAMEL_SMTP_TRANSPORT_8BITMIME ##### --> <para> @@ -2580,6 +2644,38 @@ streams </para> +<!-- ##### STRUCT CamelArg ##### --> +<para> + +</para> + +@tag: + +<!-- ##### STRUCT CamelArgGet ##### --> +<para> + +</para> + +@tag: + +<!-- ##### STRUCT CamelArgGetV ##### --> +<para> + +</para> + +@ap: +@argc: +@argv: + +<!-- ##### STRUCT CamelArgV ##### --> +<para> + +</para> + +@ap: +@argc: +@argv: + <!-- ##### STRUCT CamelDigestFolder ##### --> <para> @@ -2602,6 +2698,16 @@ streams @parent_object: +<!-- ##### ENUM CamelDiscoDiaryArgType ##### --> +<para> + +</para> + +@CAMEL_DISCO_DIARY_ARG_NONE: +@CAMEL_DISCO_DIARY_ARG_FOLDER: +@CAMEL_DISCO_DIARY_ARG_UID: +@CAMEL_DISCO_DIARY_ARG_UID_LIST: + <!-- ##### STRUCT CamelGroupwiseFolder ##### --> <para> @@ -3651,6 +3757,15 @@ streams @lineptr: @lineend: +<!-- ##### STRUCT CamelProperty ##### --> +<para> + +</para> + +@tag: +@name: +@description: + <!-- ##### STRUCT CamelSendmailTransport ##### --> <para> @@ -4167,6 +4282,75 @@ streams @ai_canonname: @ai_next: +<!-- ##### MACRO ca_double ##### --> +<para> + +</para> + + +<!-- ##### MACRO ca_int ##### --> +<para> + +</para> + + +<!-- ##### MACRO ca_object ##### --> +<para> + +</para> + + +<!-- ##### MACRO ca_ptr ##### --> +<para> + +</para> + + +<!-- ##### MACRO ca_str ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION camel_arggetv_build ##### --> +<para> + +</para> + +@tv: +@Returns: + +<!-- ##### FUNCTION camel_argv_build ##### --> +<para> + +</para> + +@tv: +@Returns: + +<!-- ##### MACRO camel_argv_end ##### --> +<para> + +</para> + +@tv: + +<!-- ##### MACRO camel_argv_ignore ##### --> +<para> + +</para> + +@tv: +@i: + +<!-- ##### MACRO camel_argv_start ##### --> +<para> + +</para> + +@tv: +@last: + <!-- ##### FUNCTION camel_base64_decode_simple ##### --> <para> @@ -4328,6 +4512,16 @@ streams @n: @Returns: +<!-- ##### FUNCTION camel_folder_construct ##### --> +<para> + +</para> + +@folder: +@parent_store: +@full_name: +@name: + <!-- ##### FUNCTION camel_folder_summary_array_free ##### --> <para> @@ -4336,6 +4530,32 @@ streams @summary: @array: +<!-- ##### FUNCTION camel_folder_summary_cache_size ##### --> +<para> + +</para> + +@s: +@Returns: + +<!-- ##### FUNCTION camel_folder_summary_ensure_infos_loaded ##### --> +<para> + +</para> + +@s: +@at_least: +@ex: + +<!-- ##### FUNCTION camel_folder_summary_reload_from_db ##### --> +<para> + +</para> + +@s: +@ex: +@Returns: + <!-- ##### FUNCTION camel_groupwise_journal_append ##### --> <para> @@ -6689,6 +6909,25 @@ streams @ctype: @Returns: +<!-- ##### FUNCTION camel_object_free ##### --> +<para> + +</para> + +@vo: +@tag: +@value: + +<!-- ##### FUNCTION camel_object_get ##### --> +<para> + +</para> + +@obj: +@ex: +@Varargs: +@Returns: + <!-- ##### FUNCTION camel_object_get_int ##### --> <para> @@ -6718,6 +6957,16 @@ streams @tag: @Returns: +<!-- ##### FUNCTION camel_object_getv ##### --> +<para> + +</para> + +@obj: +@ex: +@Param3: +@Returns: + <!-- ##### FUNCTION camel_object_is ##### --> <para> @@ -6770,6 +7019,26 @@ streams @Param1: @Returns: +<!-- ##### FUNCTION camel_object_set ##### --> +<para> + +</para> + +@obj: +@ex: +@Varargs: +@Returns: + +<!-- ##### FUNCTION camel_object_setv ##### --> +<para> + +</para> + +@obj: +@ex: +@Param3: +@Returns: + <!-- ##### VARIABLE camel_object_type ##### --> <para> diff --git a/docs/reference/camel/tmpl/camel-vee-folder.sgml b/docs/reference/camel/tmpl/camel-vee-folder.sgml index 78d43b05c..b23a34b96 100644 --- a/docs/reference/camel/tmpl/camel-vee-folder.sgml +++ b/docs/reference/camel/tmpl/camel-vee-folder.sgml @@ -50,9 +50,6 @@ CamelVeeFolder </para> @vf: -@parent_store: -@full: -@name: @flags: @@ -150,3 +147,48 @@ CamelVeeFolder @ex: +<!-- ##### FUNCTION camel_vee_folder_get_unread_vfolder ##### --> +<para> + +</para> + +@folder: +@Returns: + + +<!-- ##### FUNCTION camel_vee_folder_set_unread_vfolder ##### --> +<para> + +</para> + +@folder: +@unread_vfolder: + + +<!-- ##### ENUM CamelVeeFolderLock ##### --> +<para> + +</para> + +@CVF_SUMMARY_LOCK: +@CVF_SUBFOLDER_LOCK: +@CVF_CHANGED_LOCK: + +<!-- ##### FUNCTION camel_vee_folder_lock ##### --> +<para> + +</para> + +@folder: +@lock: + + +<!-- ##### FUNCTION camel_vee_folder_unlock ##### --> +<para> + +</para> + +@folder: +@lock: + + |