diff options
| -rw-r--r-- | ChangeLog | 20 | ||||
| -rw-r--r-- | camel/camel-data-wrapper.c | 4 | ||||
| -rw-r--r-- | camel/camel-folder.c | 42 | ||||
| -rw-r--r-- | camel/camel-folder.h | 2 | ||||
| -rw-r--r-- | camel/camel-service.c | 68 | ||||
| -rw-r--r-- | camel/camel-store.c | 22 | ||||
| -rw-r--r-- | camel/gmime-content-field.c | 6 | ||||
| -rw-r--r-- | camel/providers/MH/camel-mh-store.c | 2 | ||||
| -rw-r--r-- | camel/url-util.c | 2 | ||||
| -rw-r--r-- | devel-docs/camel/Makefile.am | 10 | ||||
| -rw-r--r-- | devel-docs/camel/camel-docs.sgml | 10 | ||||
| -rw-r--r-- | devel-docs/camel/camel-sections.txt | 84 | ||||
| -rw-r--r-- | devel-docs/camel/camel.types | 8 | ||||
| -rw-r--r-- | devel-docs/camel/tmpl/camel-mime-message.sgml | 171 | ||||
| -rw-r--r-- | devel-docs/camel/tmpl/camel-mime-part.sgml | 198 | ||||
| -rw-r--r-- | devel-docs/camel/tmpl/camel-store.sgml | 3 | ||||
| -rw-r--r-- | devel-docs/camel/tmpl/camel-stream.sgml | 101 |
17 files changed, 685 insertions, 68 deletions
@@ -1,3 +1,22 @@ +1999-08-06 bertrand <Bertrand.Guiheneuf@aful.org> + + * devel-docs/camel/: + updated some autogen doc stuff. + Still don't understand warnings :( + + * camel/camel-data-wrapper.c: + * camel/providers/MH/camel-mh-store.c: + * camel/url-util.c: + * camel/gmime-content-field.c: + * camel/camel-store.c: + various inline doc corrections. + + * camel/camel-folder.c (get_message_count): + new method. Returns the number of message + in the folder. + + + 1999-08-06 Robert Brady <rwb197@ecs.soton.ac.uk> * tests/test6.c: encoder test. @@ -5,6 +24,7 @@ * camel/gmime-rfc2047.c: Fixed decoder bug : sequence ?= is not always the terminator for an encoded-string. + 1999-08-06 bertrand <Bertrand.Guiheneuf@aful.org> * camel/providers/MH/camel-mh-folder.c (_list_subfolders): diff --git a/camel/camel-data-wrapper.c b/camel/camel-data-wrapper.c index b6a9f9ea3e..ef8c325293 100644 --- a/camel/camel-data-wrapper.c +++ b/camel/camel-data-wrapper.c @@ -100,7 +100,7 @@ camel_data_wrapper_get_type (void) /** * _write_to_stream: write data content in a byte stream * @data_wrapper: the data wrapper object - * @stre:m byte stream where data will be written + * @stream byte stream where data will be written * * This method must be overriden by subclasses * Data must be written in the bytes stream @@ -121,7 +121,7 @@ _write_to_stream (CamelDataWrapper *data_wrapper, CamelStream *stream) /** * camel_data_wrapper_write_to_stream: write data in a stream - * @data_wrappewr: the data wrapper object + * @data_wrapper: the data wrapper object * @stream: byte stream where data will be written * * Write data content in a stream. Data is stored in a machine diff --git a/camel/camel-folder.c b/camel/camel-folder.c index bdd1a75a17..5fa22a5b72 100644 --- a/camel/camel-folder.c +++ b/camel/camel-folder.c @@ -50,6 +50,7 @@ static CamelFolderOpenMode _get_mode (CamelFolder *folder); static GList *_list_subfolders (CamelFolder *folder); static GList *_expunge (CamelFolder *folder); static CamelMimeMessage *_get_message (CamelFolder *folder, gint number); +static gint _get_message_count (CamelFolder *folder); static void camel_folder_class_init (CamelFolderClass *camel_folder_class) @@ -76,6 +77,8 @@ camel_folder_class_init (CamelFolderClass *camel_folder_class) camel_folder_class->list_subfolders = _list_subfolders; camel_folder_class->expunge = _expunge; camel_folder_class->get_message = _get_message; + camel_folder_class->get_message_count = _get_message_count; + /* virtual method overload */ } @@ -383,19 +386,19 @@ _get_folder (CamelFolder *folder, const gchar *folder_name) return new_folder; } -/** - * camel_folder_get_folder: return the (sub)folder object that is specified. - * - * @folder : the folder - * @folder_name: subfolder path. - * + + +/** + * camel_folder_get_folder: return the (sub)folder object that is specified + * @folder: the folder + * @folder_name: subfolder path + * * This method returns a folder objects. This folder * is necessarily a subfolder of the current folder. * It is an error to ask a folder begining with the * folder separator character. * - * Return value: Required folder. NULL if the subfolder object - * could not be obtained + * Return value: Required folder. NULL if the subfolder object could not be obtained **/ CamelFolder * camel_folder_get_folder (CamelFolder *folder, gchar *folder_name) @@ -758,3 +761,26 @@ camel_folder_get_message (CamelFolder *folder, gint number) return CF_CLASS (folder)->get_message (folder, number); } + +static gint +_get_message_count (CamelFolder *folder) +{ + return -1; +} + + + +/** + * camel_folder_get_message_count: get the number of messages in the folder + * @folder: A CamelFolder object + * + * Returns the number of messages in the folder. + * + * Return value: the number of messages or -1 if unknown. + **/ +gint +camel_folder_get_message_count (CamelFolder *folder) +{ + return CF_CLASS (folder)->get_message_count (folder); +} + diff --git a/camel/camel-folder.h b/camel/camel-folder.h index 6c17c331e2..2fd40a2591 100644 --- a/camel/camel-folder.h +++ b/camel/camel-folder.h @@ -99,6 +99,8 @@ typedef struct { GList * (*list_subfolders) (CamelFolder *folder); GList * (*expunge) (CamelFolder *folder); CamelMimeMessage * (*get_message) (CamelFolder *folder, gint number); + gint (*get_message_count) (CamelFolder *folder); + } CamelFolderClass; diff --git a/camel/camel-service.c b/camel/camel-service.c index c0f436bb89..0a27eb78fe 100644 --- a/camel/camel-service.c +++ b/camel/camel-service.c @@ -101,14 +101,15 @@ _connect (CamelService *service) } + /** - * camel_service_connect : connect to a service - * + * camel_service_connect:connect to a service + * @service: CamelService object + * * connect to the service using the parameters * stored in the session it is initialized with * WARNING: session not implemented for the moment - * - * @service: object to connect to + * **/ void camel_service_connect (CamelService *service) @@ -137,10 +138,10 @@ _connect_to_with_login_passwd (CamelService *service, gchar *host, gchar *login, /** * camel_service_connect_to_with_login_passwd: connect a service - * @service: the service to connect + * @service: the service to connect * @host: host to connect to * @login: login to connect with - * @passwd: password to connect with + * @passwd: password to connect with * * Connect to a service, but do not use the session * default parameters to retrieve server's address @@ -154,21 +155,19 @@ camel_service_connect_to_with_login_passwd (CamelService *service, gchar *host, + /** - * _connect_to:login:password : connect to the specified address - * - * Connect to the service, but do not use the session - * default parameters to retrieve server's address - * - * @service: object to connect - * @host: host to connect to - * @login: user name used to log in + * _connect_to_with_login_passwd_port: connect to the specified address + * @service: service to connect + * @host: host to connect to + * @login: user name used to log in * @passwd: password used to log in * @port: port to connect to - * + * + * **/ static void -_connect_to_with_login_passwd_port(CamelService *service, gchar *host, gchar *login, gchar *passwd, guint port) +_connect_to_with_login_passwd_port (CamelService *service, gchar *host, gchar *login, gchar *passwd, guint port) { CSERV_CLASS(service)->set_connected(service, TRUE); } @@ -176,11 +175,11 @@ _connect_to_with_login_passwd_port(CamelService *service, gchar *host, gchar *lo /** * camel_service_connect_to_with_login_passwd_port: connect a service - * @service: the service to connect - * @host: host to connect to - * @login: login to connect with - * @passwd: password to connect with - * @port: port to connect to + * @service: service to connect + * @host: host to connect to + * @login: user name used to log in + * @passwd: password used to log in + * @port: port to connect to * * Connect to a service, but do not use the session * default parameters to retrieve server's address @@ -197,10 +196,11 @@ camel_service_connect_to_with_login_passwd_port (CamelService *service, gchar *h /** * _is_connected: test if the service object is connected - * - * * @service: object to test - * + * + * + * + * Return value: **/ static gboolean _is_connected (CamelService *service) @@ -210,13 +210,12 @@ _is_connected (CamelService *service) /** - * camel_service_is_connected: test if a service object is connected - * - * @service: the service + * camel_service_is_connected: test if the service object is connected + * @service: object to test * * * - * Return value: TRUE is the service is connected + * Return value: **/ gboolean camel_service_is_connected (CamelService *service) @@ -225,16 +224,16 @@ camel_service_is_connected (CamelService *service) } + /** - * _set_connected: set the connected state + * _set_connected:set the connected state + * @service: object to set the state of + * @state: connected/disconnected * * This routine has to be called by providers to set the * connection state, mainly when the service is disconnected * wheras the close() method has not been called. - * - * @service: object to set the state of - * @state: connected/disconnected - * + * **/ static void _set_connected (CamelService *service, gboolean state) @@ -251,6 +250,7 @@ _set_connected (CamelService *service, gboolean state) * This method merely returns the "url" field. Subclasses * may provide more active implementations. * + * * Return value: **/ static const gchar * @@ -264,7 +264,7 @@ _get_url (CamelService *service) * @service: the service * * returns the URL representing a service. For security reasons - * This routine may not always return the password. + * This routine may not always return the password. * * Return value: the url name **/ diff --git a/camel/camel-store.c b/camel/camel-store.c index 56faca9a35..a6fb1a303e 100644 --- a/camel/camel-store.c +++ b/camel/camel-store.c @@ -104,8 +104,7 @@ camel_store_init (CamelStore *store, CamelSession *session, gchar *url_name) /** - * init: method called by a session object to - * initialize a store object + * init: method called by a session object to initialize a store object * @store: the store to initialize * @session: session which instantiates the store * @url_name: URL defining the store @@ -130,8 +129,7 @@ _init (CamelStore *store, CamelSession *session, gchar *url_name) /** - * camel_store_set_separator: set the character which separates this folder - * path from the folders names in a lower level of hierarchy. + * camel_store_set_separator: set the character which separates this folder path from the folders names in a lower level of hierarchy. * * @store: * @sep: @@ -155,12 +153,14 @@ _get_separator (CamelStore *store) } -/** - * camel_store_get_separator: return the character which separates this folder - * path from the folders names in a lower level of hierarchy. - * + +/** + * camel_store_get_separator: return the character which separates this folder path from the folders names in a lower level of hierarchy. * @store: store - * + * + * + * + * Return value: the separator **/ gchar camel_store_get_separator (CamelStore *store) @@ -183,6 +183,8 @@ _get_folder (CamelStore *store, const gchar *folder_name) /** * camel_store_get_folder: return the folder corresponding to a path. + * @store: store + * @folder_name: name of the folder to get * * Returns the folder corresponding to the path "name". * If the path begins with the separator caracter, it @@ -193,8 +195,6 @@ _get_folder (CamelStore *store, const gchar *folder_name) * If it does not exist, you can create it with its * "create" method. * - * @store: store - * @folder_name: name of the folder to get * * Return value: the folder **/ diff --git a/camel/gmime-content-field.c b/camel/gmime-content-field.c index caa8237290..285926e702 100644 --- a/camel/gmime-content-field.c +++ b/camel/gmime-content-field.c @@ -91,8 +91,7 @@ gmime_content_field_set_parameter (GMimeContentField *content_field, const gchar /** - * _print_parameter: print a parameter/value pair to a stream as - * described in RFC 2045 + * _print_parameter: print a parameter/value pair to a stream as described in RFC 2045 * @name: name of the parameter * @value: value of the parameter * @user_data: CamelStream object to write the text to. @@ -213,8 +212,7 @@ gmime_content_field_get_parameter (GMimeContentField *content_field, const gchar /** - * gmime_content_field_construct_from_string: construct a ContentType object - * by parsing a string. + * gmime_content_field_construct_from_string: construct a ContentType object by parsing a string. * * @content_field: content type object to construct * @string: string containing the content type field diff --git a/camel/providers/MH/camel-mh-store.c b/camel/providers/MH/camel-mh-store.c index 0e382fa913..bb27e37620 100644 --- a/camel/providers/MH/camel-mh-store.c +++ b/camel/providers/MH/camel-mh-store.c @@ -90,7 +90,7 @@ camel_mh_store_get_type (void) -/** These evil public functions are here for test only **/ +/* These evil public functions are here for test only */ void camel_mh_store_set_toplevel_dir (CamelMhStore *store, const gchar *toplevel) { diff --git a/camel/url-util.c b/camel/url-util.c index 43f51fe365..98eeaafddd 100644 --- a/camel/url-util.c +++ b/camel/url-util.c @@ -137,7 +137,7 @@ g_url_free (Gurl *url) /**** PARSING FUNCTIONS ****/ -/** So, yes, I must admit there would have been more elegant +/* So, yes, I must admit there would have been more elegant ways to do this, but it works, and quite well :) */ diff --git a/devel-docs/camel/Makefile.am b/devel-docs/camel/Makefile.am index b32c5b9f69..176a06b879 100644 --- a/devel-docs/camel/Makefile.am +++ b/devel-docs/camel/Makefile.am @@ -20,9 +20,13 @@ HTML_DIR=$(datadir)/gnome/html TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) tmpl_sources = \ - tmpl/camel-service.sgml \ tmpl/camel-data-wrapper.sgml \ - tmpl/camel-store.sgml + tmpl/camel-folder.sgml \ + tmpl/camel-mime-message.sgml \ + tmpl/camel-mime-part.sgml \ + tmpl/camel-service.sgml \ + tmpl/camel-store.sgml \ + tmpl/camel-stream.sgml camel_docdir = $(HTML_DIR) @@ -48,7 +52,7 @@ sgml/camel-doc.bottom: $(tmpl_sources) camel-scan.c: scan: camel-scan.c - -CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE) + CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE) gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) templates: scan diff --git a/devel-docs/camel/camel-docs.sgml b/devel-docs/camel/camel-docs.sgml index a510e93675..ecbed2c093 100644 --- a/devel-docs/camel/camel-docs.sgml +++ b/devel-docs/camel/camel-docs.sgml @@ -1,8 +1,11 @@ <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ +<!entity CamelDataWrapper SYSTEM "sgml/camel-data-wrapper.sgml"> <!entity CamelFolder SYSTEM "sgml/camel-folder.sgml"> +<!entity CamelMimeMessage SYSTEM "sgml/camel-mime-message.sgml"> +<!entity CamelMimePart SYSTEM "sgml/camel-mime-part.sgml"> <!entity CamelService SYSTEM "sgml/camel-service.sgml"> <!entity CamelStore SYSTEM "sgml/camel-store.sgml"> -<!entity CamelDataWrapper SYSTEM "sgml/camel-data-wrapper.sgml"> +<!entity CamelStream SYSTEM "sgml/camel-stream.sgml"> ]> <book> @@ -12,9 +15,12 @@ <chapter id="camel-objects"> <title>Camel Objects</title> - &CamelFolder; + &CamelMimeMessage; &CamelService; &CamelStore; + &CamelFolder; + &CamelMimePart; &CamelDataWrapper; + </chapter> </book> diff --git a/devel-docs/camel/camel-sections.txt b/devel-docs/camel/camel-sections.txt index 81c9c205d4..4b0a36f9cc 100644 --- a/devel-docs/camel/camel-sections.txt +++ b/devel-docs/camel/camel-sections.txt @@ -1,5 +1,6 @@ <INCLUDE>gnome.h</INCLUDE> +<INCLUDE>camel-data-wrapper.h</INCLUDE> <SECTION> @@ -7,6 +8,68 @@ CamelDataWrapper <TITLE>CamelDataWrapper</TITLE> camel_data_wrapper_write_to_stream +<SUBSECTION Standard> +CAMEL_DATA_WRAPPER +camel_data_wrapper_get_type +CAMEL_DATA_WRAPPER_CLASS +</SECTION> + +<SECTION> +<FILE>camel-mime-part</FILE> +CamelMimePart +<TITLE>CamelMimePart</TITLE> +camel_mime_part_add_header +camel_mime_part_set_content_object +camel_mime_part_set_filename +camel_mime_part_get_disposition +camel_mime_part_get_content_MD5 +camel_mime_part_get_encoding +camel_mime_part_set_header_lines +camel_mime_part_get_content_object +camel_mime_part_get_content_id +camel_mime_part_set_description +camel_mime_part_set_text +camel_mime_part_set_encoding +camel_mime_part_set_disposition +camel_mime_part_remove_header +camel_mime_part_get_filename +camel_mime_part_get_content_languages +camel_mime_part_set_content_languages +camel_mime_part_get_header_lines +camel_mime_part_get_description +camel_mime_part_get_header +<SUBSECTION Standard> +CAMEL_MIME_PART +camel_mime_part_get_type +CAMEL_MIME_PART_CLASS +</SECTION> + + + +<SECTION> +<FILE>camel-mime-message</FILE> +CamelMimeMessage +<TITLE>CamelMimeMessage</TITLE> +camel_mime_message_remove_recipient +camel_mime_message_get_recipients +camel_mime_message_set_flag +camel_mime_message_set_subject +camel_mime_message_get_reply_to +camel_mime_message_get_from +camel_mime_message_set_reply_to +camel_mime_message_get_sent_date +camel_mime_message_new_with_session +camel_mime_message_add_recipient +camel_mime_message_get_subject +camel_mime_message_set_from +camel_mime_message_get_flag +camel_mime_message_get_message_number +camel_mime_message_get_received_date +camel_mime_message_set_received_date +<SUBSECTION Standard> +CAMEL_MIME_MESSAGE +camel_mime_message_get_type +CAMEL_MIME_MESSAGE_CLASS </SECTION> @@ -55,3 +118,24 @@ camel_store_get_type CAMEL_STORE_CLASS </SECTION> + +<SECTION> +<FILE>camel-stream</FILE> +CamelStream +<TITLE>CamelStream</TITLE> +camel_stream_seek +camel_stream_write +camel_stream_flush +camel_stream_eos +camel_stream_write_string +camel_stream_close +camel_stream_write_strings +camel_stream_read +camel_stream_available +<SUBSECTION Standard> +CAMEL_STREAM +camel_stream_get_type +CAMEL_STREAM_CLASS +</SECTION> + + diff --git a/devel-docs/camel/camel.types b/devel-docs/camel/camel.types index 90a40acea7..93142d8692 100644 --- a/devel-docs/camel/camel.types +++ b/devel-docs/camel/camel.types @@ -1,3 +1,9 @@ #include <gtk/gtk.h> - +#include <camel/camel-data-wrapper.h> +camel_data_wrapper_get_type +camel_folder_get_type +camel_mime_message_get_type +camel_mime_part_get_type camel_service_get_type +camel_store_get_type +camel_stream_get_type diff --git a/devel-docs/camel/tmpl/camel-mime-message.sgml b/devel-docs/camel/tmpl/camel-mime-message.sgml new file mode 100644 index 0000000000..704f3d3572 --- /dev/null +++ b/devel-docs/camel/tmpl/camel-mime-message.sgml @@ -0,0 +1,171 @@ +<!-- ##### SECTION Title ##### --> +CamelMimeMessage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT CamelMimeMessage ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION camel_mime_message_remove_recipient ##### --> +<para> + +</para> + +@mime_message: +@recipient_type: +@recipient: + + +<!-- ##### FUNCTION camel_mime_message_get_recipients ##### --> +<para> + +</para> + +@mime_message: +@recipient_type: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_set_flag ##### --> +<para> + +</para> + +@mime_message: +@flag: +@value: + + +<!-- ##### FUNCTION camel_mime_message_set_subject ##### --> +<para> + +</para> + +@mime_message: +@subject: + + +<!-- ##### FUNCTION camel_mime_message_get_reply_to ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_get_from ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_set_reply_to ##### --> +<para> + +</para> + +@mime_message: +@reply_to: + + +<!-- ##### FUNCTION camel_mime_message_get_sent_date ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_new_with_session ##### --> +<para> + +</para> + +@session: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_add_recipient ##### --> +<para> + +</para> + +@mime_message: +@recipient_type: +@recipient: + + +<!-- ##### FUNCTION camel_mime_message_get_subject ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_set_from ##### --> +<para> + +</para> + +@mime_message: +@from: + + +<!-- ##### FUNCTION camel_mime_message_get_flag ##### --> +<para> + +</para> + +@mime_message: +@flag: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_get_message_number ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_get_received_date ##### --> +<para> + +</para> + +@mime_message: +@Returns: + + +<!-- ##### FUNCTION camel_mime_message_set_received_date ##### --> +<para> + +</para> + +@mime_message: +@received_date: + + diff --git a/devel-docs/camel/tmpl/camel-mime-part.sgml b/devel-docs/camel/tmpl/camel-mime-part.sgml new file mode 100644 index 0000000000..c680a24faf --- /dev/null +++ b/devel-docs/camel/tmpl/camel-mime-part.sgml @@ -0,0 +1,198 @@ +<!-- ##### SECTION Title ##### --> +CamelMimePart + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION camel_mime_part_add_header ##### --> +<para> + +</para> + +@mime_part: +@header_name: +@header_value: + + +<!-- ##### FUNCTION camel_mime_part_set_content_object ##### --> +<para> + +</para> + +@mime_part: +@content: + + +<!-- ##### FUNCTION camel_mime_part_set_filename ##### --> +<para> + +</para> + +@mime_part: +@filename: + + +<!-- ##### FUNCTION camel_mime_part_get_disposition ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_content_MD5 ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_encoding ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_set_header_lines ##### --> +<para> + +</para> + +@mime_part: +@header_lines: + + +<!-- ##### FUNCTION camel_mime_part_get_content_object ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_content_id ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_set_description ##### --> +<para> + +</para> + +@mime_part: +@description: + + +<!-- ##### FUNCTION camel_mime_part_set_text ##### --> +<para> + +</para> + +@camel_mime_part: +@text: + + +<!-- ##### FUNCTION camel_mime_part_set_encoding ##### --> +<para> + +</para> + +@mime_part: +@encoding: + + +<!-- ##### FUNCTION camel_mime_part_set_disposition ##### --> +<para> + +</para> + +@mime_part: +@disposition: + + +<!-- ##### FUNCTION camel_mime_part_remove_header ##### --> +<para> + +</para> + +@mime_part: +@header_name: + + +<!-- ##### FUNCTION camel_mime_part_get_filename ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_content_languages ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_set_content_languages ##### --> +<para> + +</para> + +@mime_part: +@content_languages: + + +<!-- ##### FUNCTION camel_mime_part_get_header_lines ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_description ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION camel_mime_part_get_header ##### --> +<para> + +</para> + +@mime_part: +@header_name: +@Returns: + + diff --git a/devel-docs/camel/tmpl/camel-store.sgml b/devel-docs/camel/tmpl/camel-store.sgml index 25f9cc1283..2882c09986 100644 --- a/devel-docs/camel/tmpl/camel-store.sgml +++ b/devel-docs/camel/tmpl/camel-store.sgml @@ -3,7 +3,8 @@ CamelStore <!-- ##### SECTION Short_Description ##### --> -A class representing a message (local or distant) repository +A class representing a message (local or distant) repository + <!-- ##### SECTION Long_Description ##### --> <para> The store class models a place where messages can be stored and retreived. It can be a local diff --git a/devel-docs/camel/tmpl/camel-stream.sgml b/devel-docs/camel/tmpl/camel-stream.sgml new file mode 100644 index 0000000000..e965db2e45 --- /dev/null +++ b/devel-docs/camel/tmpl/camel-stream.sgml @@ -0,0 +1,101 @@ +<!-- ##### SECTION Title ##### --> +CamelStream + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION camel_stream_seek ##### --> +<para> + +</para> + +@stream: +@offset: +@policy: +@Returns: + + +<!-- ##### FUNCTION camel_stream_write ##### --> +<para> + +</para> + +@stream: +@buffer: +@n: +@Returns: + + +<!-- ##### FUNCTION camel_stream_flush ##### --> +<para> + +</para> + +@stream: + + +<!-- ##### FUNCTION camel_stream_eos ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### MACRO camel_stream_write_string ##### --> +<para> + +</para> + +@stream: +@string: + + +<!-- ##### FUNCTION camel_stream_close ##### --> +<para> + +</para> + +@stream: + + +<!-- ##### FUNCTION camel_stream_write_strings ##### --> +<para> + +</para> + +@stream: +@Varargs: + + +<!-- ##### FUNCTION camel_stream_read ##### --> +<para> + +</para> + +@stream: +@buffer: +@n: +@Returns: + + +<!-- ##### FUNCTION camel_stream_available ##### --> +<para> + +</para> + +@stream: +@Returns: + + |