aboutsummaryrefslogtreecommitdiffstats
path: root/devel-docs/camel
diff options
context:
space:
mode:
Diffstat (limited to 'devel-docs/camel')
-rw-r--r--devel-docs/camel/Makefile.am9
-rw-r--r--devel-docs/camel/camel-docs.sgml4
-rw-r--r--devel-docs/camel/camel-sections.txt13
-rw-r--r--devel-docs/camel/tmpl/camel-folder.sgml4
-rw-r--r--devel-docs/camel/tmpl/camel-store.sgml7
5 files changed, 26 insertions, 11 deletions
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 @@
<!entity CamelFolder SYSTEM "sgml/camel-folder.sgml">
<!entity CamelService SYSTEM "sgml/camel-service.sgml">
<!entity CamelStore SYSTEM "sgml/camel-store.sgml">
+<!entity CamelDataWrapper SYSTEM "sgml/camel-data-wrapper.sgml">
]>
<book>
<bookinfo>
- <title>Camel Mail Library Reference Manual</title>
+ <title>Camel Messaging Library Reference Manual</title>
</bookinfo>
<chapter id="camel-objects">
@@ -14,5 +15,6 @@
&CamelFolder;
&CamelService;
&CamelStore;
+ &CamelDataWrapper;
</chapter>
</book>
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 @@
<INCLUDE>gnome.h</INCLUDE>
+
+<SECTION>
+<FILE>camel-data-wrapper</FILE>
+CamelDataWrapper
+<TITLE>CamelDataWrapper</TITLE>
+camel_data_wrapper_write_to_stream
+</SECTION>
+
+
<SECTION>
<FILE>camel-folder</FILE>
CamelFolder
@@ -41,8 +50,8 @@ CamelStore
camel_store_get_separator
camel_store_get_folder
<SUBSECTION Standard>
-CAMEL_SERVICE
+CAMEL_STORE
camel_store_get_type
-CAMEL_SERVICE_CLASS
+CAMEL_STORE_CLASS
</SECTION>
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
<!-- ##### SECTION Short_Description ##### -->
-
+Represents a folder of messages on a store.
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+CamelFolder represents a folder in a message store.
</para>
<!-- ##### SECTION See_Also ##### -->
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
<!-- ##### SECTION Short_Description ##### -->
-
+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
+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.
</para>
<!-- ##### SECTION See_Also ##### -->