diff options
author | bertrand <Bertrand.Guiheneuf@aful.org> | 1999-08-07 01:28:26 +0800 |
---|---|---|
committer | Bertrand Guiheneuf <bertrand@src.gnome.org> | 1999-08-07 01:28:26 +0800 |
commit | db89b1a62fb0fa1ed57a9cdd275c0a977630a56a (patch) | |
tree | a6e43ba18be9f88e70b9cc8dd9441085d322049e /devel-docs/camel | |
parent | 85067acb32a4992410e337352f8c54b61b78709b (diff) | |
download | gsoc2013-evolution-db89b1a62fb0fa1ed57a9cdd275c0a977630a56a.tar.gz gsoc2013-evolution-db89b1a62fb0fa1ed57a9cdd275c0a977630a56a.tar.zst gsoc2013-evolution-db89b1a62fb0fa1ed57a9cdd275c0a977630a56a.zip |
updated some autogen doc stuff. Still don't understand warnings :(
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.
svn path=/trunk/; revision=1092
Diffstat (limited to 'devel-docs/camel')
-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 |
8 files changed, 578 insertions, 7 deletions
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: + + |