From db89b1a62fb0fa1ed57a9cdd275c0a977630a56a Mon Sep 17 00:00:00 2001 From: bertrand Date: Fri, 6 Aug 1999 17:28:26 +0000 Subject: updated some autogen doc stuff. Still don't understand warnings :( 1999-08-06 bertrand * 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. svn path=/trunk/; revision=1092 --- devel-docs/camel/Makefile.am | 10 +- devel-docs/camel/camel-docs.sgml | 10 +- devel-docs/camel/camel-sections.txt | 84 +++++++++++ devel-docs/camel/camel.types | 8 +- devel-docs/camel/tmpl/camel-mime-message.sgml | 171 ++++++++++++++++++++++ devel-docs/camel/tmpl/camel-mime-part.sgml | 198 ++++++++++++++++++++++++++ devel-docs/camel/tmpl/camel-store.sgml | 3 +- devel-docs/camel/tmpl/camel-stream.sgml | 101 +++++++++++++ 8 files changed, 578 insertions(+), 7 deletions(-) create mode 100644 devel-docs/camel/tmpl/camel-mime-message.sgml create mode 100644 devel-docs/camel/tmpl/camel-mime-part.sgml create mode 100644 devel-docs/camel/tmpl/camel-stream.sgml (limited to 'devel-docs/camel') 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 @@ + + - + ]> @@ -12,9 +15,12 @@ Camel Objects - &CamelFolder; + &CamelMimeMessage; &CamelService; &CamelStore; + &CamelFolder; + &CamelMimePart; &CamelDataWrapper; + 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 @@ gnome.h +camel-data-wrapper.h
@@ -7,6 +8,68 @@ CamelDataWrapper CamelDataWrapper camel_data_wrapper_write_to_stream + +CAMEL_DATA_WRAPPER +camel_data_wrapper_get_type +CAMEL_DATA_WRAPPER_CLASS +
+ +
+camel-mime-part +CamelMimePart +CamelMimePart +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 + +CAMEL_MIME_PART +camel_mime_part_get_type +CAMEL_MIME_PART_CLASS +
+ + + +
+camel-mime-message +CamelMimeMessage +CamelMimeMessage +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 + +CAMEL_MIME_MESSAGE +camel_mime_message_get_type +CAMEL_MIME_MESSAGE_CLASS
@@ -55,3 +118,24 @@ camel_store_get_type CAMEL_STORE_CLASS + +
+camel-stream +CamelStream +CamelStream +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 + +CAMEL_STREAM +camel_stream_get_type +CAMEL_STREAM_CLASS +
+ + 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 - +#include +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 @@ + +CamelMimeMessage + + + + + + + + + + + + + + + + + + + + + + + + + +@mime_message: +@recipient_type: +@recipient: + + + + + + + +@mime_message: +@recipient_type: +@Returns: + + + + + + + +@mime_message: +@flag: +@value: + + + + + + + +@mime_message: +@subject: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@mime_message: +@reply_to: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@session: +@Returns: + + + + + + + +@mime_message: +@recipient_type: +@recipient: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@mime_message: +@from: + + + + + + + +@mime_message: +@flag: +@Returns: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@mime_message: +@Returns: + + + + + + + +@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 @@ + +CamelMimePart + + + + + + + + + + + + + + + + + + + +@mime_part: +@header_name: +@header_value: + + + + + + + +@mime_part: +@content: + + + + + + + +@mime_part: +@filename: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@header_lines: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@description: + + + + + + + +@camel_mime_part: +@text: + + + + + + + +@mime_part: +@encoding: + + + + + + + +@mime_part: +@disposition: + + + + + + + +@mime_part: +@header_name: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@content_languages: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@mime_part: +@Returns: + + + + + + + +@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 -A class representing a message (local or distant) repository +A class representing a message (local or distant) repository + 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 @@ + +CamelStream + + + + + + + + + + + + + + + + + + + +@stream: +@offset: +@policy: +@Returns: + + + + + + + +@stream: +@buffer: +@n: +@Returns: + + + + + + + +@stream: + + + + + + + +@stream: +@Returns: + + + + + + + +@stream: +@string: + + + + + + + +@stream: + + + + + + + +@stream: +@Varargs: + + + + + + + +@stream: +@buffer: +@n: +@Returns: + + + + + + + +@stream: +@Returns: + + -- cgit v1.2.3