From cac0ba57e6c47acd94600b5add1930301df33c50 Mon Sep 17 00:00:00 2001 From: Bertrand Guiheneuf Date: Sun, 1 Aug 1999 13:38:28 +0000 Subject: merge a lot of work. Rough ChangeLog will follow svn path=/trunk/; revision=1052 --- devel-docs/camel/Makefile.am | 9 +++++---- devel-docs/camel/camel-docs.sgml | 4 +++- devel-docs/camel/camel-sections.txt | 13 +++++++++++-- devel-docs/camel/tmpl/camel-folder.sgml | 4 ++-- devel-docs/camel/tmpl/camel-store.sgml | 7 +++++-- 5 files changed, 26 insertions(+), 11 deletions(-) (limited to 'devel-docs/camel') diff --git a/devel-docs/camel/Makefile.am b/devel-docs/camel/Makefile.am index 810c5f5f7f..b32c5b9f69 100644 --- a/devel-docs/camel/Makefile.am +++ b/devel-docs/camel/Makefile.am @@ -20,7 +20,8 @@ HTML_DIR=$(datadir)/gnome/html TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) tmpl_sources = \ - tmpl/camel-service.sgml + tmpl/camel-service.sgml \ + tmpl/camel-data-wrapper.sgml \ tmpl/camel-store.sgml @@ -50,13 +51,13 @@ scan: camel-scan.c -CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE) gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -templates: camel-scan.c +templates: scan gtkdoc-mktmpl --module=$(DOC_MODULE) -sgml: templates +sgml: gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -html: sgml +html: if ! test -d html ; then mkdir html ; fi -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) diff --git a/devel-docs/camel/camel-docs.sgml b/devel-docs/camel/camel-docs.sgml index c91200eb2e..a510e93675 100644 --- a/devel-docs/camel/camel-docs.sgml +++ b/devel-docs/camel/camel-docs.sgml @@ -2,11 +2,12 @@ + ]> - Camel Mail Library Reference Manual + Camel Messaging Library Reference Manual @@ -14,5 +15,6 @@ &CamelFolder; &CamelService; &CamelStore; + &CamelDataWrapper; diff --git a/devel-docs/camel/camel-sections.txt b/devel-docs/camel/camel-sections.txt index f7b05529cb..81c9c205d4 100644 --- a/devel-docs/camel/camel-sections.txt +++ b/devel-docs/camel/camel-sections.txt @@ -1,6 +1,15 @@ gnome.h + +
+camel-data-wrapper +CamelDataWrapper +CamelDataWrapper +camel_data_wrapper_write_to_stream +
+ +
camel-folder CamelFolder @@ -41,8 +50,8 @@ CamelStore camel_store_get_separator camel_store_get_folder -CAMEL_SERVICE +CAMEL_STORE camel_store_get_type -CAMEL_SERVICE_CLASS +CAMEL_STORE_CLASS
diff --git a/devel-docs/camel/tmpl/camel-folder.sgml b/devel-docs/camel/tmpl/camel-folder.sgml index 7996505251..882d63499c 100644 --- a/devel-docs/camel/tmpl/camel-folder.sgml +++ b/devel-docs/camel/tmpl/camel-folder.sgml @@ -2,11 +2,11 @@ CamelFolder - +Represents a folder of messages on a store. - +CamelFolder represents a folder in a message store. diff --git a/devel-docs/camel/tmpl/camel-store.sgml b/devel-docs/camel/tmpl/camel-store.sgml index 69c98e18e5..25f9cc1283 100644 --- a/devel-docs/camel/tmpl/camel-store.sgml +++ b/devel-docs/camel/tmpl/camel-store.sgml @@ -3,10 +3,13 @@ CamelStore - +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 +store (for example an mbox-style store) or a distant server (for example an POP3 server). Messages are +not retreived or stored directly with a CamelStore object. Instead, a CamelFolder object must be +obtained from the store first. -- cgit v1.2.3