From 1202a762f5b577d900f7009442cac7ab7b45d57b Mon Sep 17 00:00:00 2001 From: Bertrand Guiheneuf Date: Wed, 21 Apr 1999 13:19:16 +0000 Subject: more documentation stuff svn path=/trunk/; revision=863 --- devel-docs/camel/Makefile.am | 95 ++++++++++++++++++++++++++++++++ devel-docs/camel/camel-docs.sgml | 16 ++++++ devel-docs/camel/camel-sections.txt | 25 +++++++++ devel-docs/camel/camel.types | 3 + devel-docs/camel/tmpl/camel-service.sgml | 24 ++++++++ devel-docs/camel/tmpl/camel-store.sgml | 43 +++++++++++++++ 6 files changed, 206 insertions(+) create mode 100644 devel-docs/camel/Makefile.am create mode 100644 devel-docs/camel/camel-docs.sgml create mode 100644 devel-docs/camel/camel-sections.txt create mode 100644 devel-docs/camel/camel.types create mode 100644 devel-docs/camel/tmpl/camel-service.sgml create mode 100644 devel-docs/camel/tmpl/camel-store.sgml (limited to 'devel-docs/camel') diff --git a/devel-docs/camel/Makefile.am b/devel-docs/camel/Makefile.am new file mode 100644 index 0000000000..810c5f5f7f --- /dev/null +++ b/devel-docs/camel/Makefile.am @@ -0,0 +1,95 @@ +## Process this file with automake to produce Makefile.in + +# The name of the module. +DOC_MODULE=camel + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=camel-docs.sgml + +# The directory containing the source code (if it contains documentation). +DOC_SOURCE_DIR=$(top_srcdir)/camel + +CFLAGS=`gtk-config --cflags gtk` +LDFLAGS="-lcamel `gtk-config --libs gtk` " + + +HTML_DIR=$(datadir)/gnome/html + + + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +tmpl_sources = \ + tmpl/camel-service.sgml + tmpl/camel-store.sgml + + +camel_docdir = $(HTML_DIR) +camel_doc_DATA = \ + camel.html \ + camel.hierarchy \ + camel.types \ + camel-scan.c \ + camel-decl.txt \ + camel-sections.txt + +EXTRA_DIST = $(camel_doc_DATA) + +camel.html: html/book1.html + -cd $(srcdir) && cp html/book1.html camel.html + +html/book1.html: sgml/camel-doc.bottom + $(MAKE) html + +sgml/camel-doc.bottom: $(tmpl_sources) + $(MAKE) sgml + +camel-scan.c: + +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 + gtkdoc-mktmpl --module=$(DOC_MODULE) + +sgml: templates + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) + +html: sgml + if ! test -d html ; then mkdir html ; fi + -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + +clean-local: + rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt camel.html + +maintainer-clean-local: clean + rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt Makefile.in + +install-data-local: + $(mkinstalldirs) $(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.html'; \ + then echo '-- Nothing to install' ; \ + else \ + for i in $$installfiles; do \ + echo '-- Installing '$$i ; \ + $(INSTALL_DATA) $$i $(TARGET_DIR); \ + done; \ + echo '-- Installing $(srcdir)/html/index.sgml' ; \ + $(INSTALL_DATA) $(srcdir)/html/index.sgml $(TARGET_DIR); \ + echo '-- Fixing Crossreferences' ; \ + gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \ + fi) + +dist-hook: + mkdir $(distdir)/html + mkdir $(distdir)/sgml + mkdir $(distdir)/tmpl + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml + -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + + +.PHONY : html sgml templates scan diff --git a/devel-docs/camel/camel-docs.sgml b/devel-docs/camel/camel-docs.sgml new file mode 100644 index 0000000000..a84fbd53b2 --- /dev/null +++ b/devel-docs/camel/camel-docs.sgml @@ -0,0 +1,16 @@ + + +]> + + + + Camel Mail Library Reference Manual + + + + Camel Objects + &CamelService; + &CamelStore; + + diff --git a/devel-docs/camel/camel-sections.txt b/devel-docs/camel/camel-sections.txt new file mode 100644 index 0000000000..e921f0cf8a --- /dev/null +++ b/devel-docs/camel/camel-sections.txt @@ -0,0 +1,25 @@ + +gnome.h + +
+camel-service +CamelService +CamelService + +CAMEL_SERVICE +camel_service_get_type +CAMEL_SERVICE_CLASS +
+ +
+camel-store +CamelStore +CamelStore +camel_store_get_separator +camel_store_get_folder + +CAMEL_SERVICE +camel_store_get_type +CAMEL_SERVICE_CLASS +
+ diff --git a/devel-docs/camel/camel.types b/devel-docs/camel/camel.types new file mode 100644 index 0000000000..90a40acea7 --- /dev/null +++ b/devel-docs/camel/camel.types @@ -0,0 +1,3 @@ +#include + +camel_service_get_type diff --git a/devel-docs/camel/tmpl/camel-service.sgml b/devel-docs/camel/tmpl/camel-service.sgml new file mode 100644 index 0000000000..9026b94652 --- /dev/null +++ b/devel-docs/camel/tmpl/camel-service.sgml @@ -0,0 +1,24 @@ + +CamelService + + + + + + + + + + + + + + + + + + + + + + diff --git a/devel-docs/camel/tmpl/camel-store.sgml b/devel-docs/camel/tmpl/camel-store.sgml new file mode 100644 index 0000000000..44b3796759 --- /dev/null +++ b/devel-docs/camel/tmpl/camel-store.sgml @@ -0,0 +1,43 @@ + +CamelStore + + + + + + + + + + + + + + + + + + + + + + + + + + + +@store: +@Returns: + + + + + + + +@store: +@folder_name: +@Returns: + + -- cgit