Split API documentation into libdocument, libview and shell. Required

2009-02-01  Carlos Garcia Campos  <carlosgc@gnome.org>

	* configure.ac:
	* help/reference/Makefile.am:
	* help/reference/libdocument/Makefile.am:
	* help/reference/libdocument/libevdocument-docs.sgml:
	* help/reference/libdocument/libevdocument.types:
	* help/reference/libdocument/version.xml.in:
	* help/reference/libview/Makefile.am:
	* help/reference/libview/libevview-docs.sgml:
	* help/reference/libview/libevview.types:
	* help/reference/libview/version.xml.in:
	* help/reference/shell/Makefile.am:
	* help/reference/shell/evince-docs.sgml:
	* help/reference/shell/evince.types:
	* help/reference/shell/tmpl/dummy.sgml:
	* help/reference/shell/version.xml.in:

	Split API documentation into libdocument, libview and
	shell. Required gtk-doc files has been added, but API docs still
	need to be completed and improved. Fixes bug #568465.

svn path=/trunk/; revision=3401

4 files changed, 219 insertions, 0 deletions

diff --git a/help/reference/libdocument/Makefile.am b/help/reference/libdocument/Makefile.am
new file mode 100644
index 0000000..7290360
--- /dev/null
+++ b/help/reference/libdocument/Makefile.am
@@ -0,0 +1,96 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=libevdocument
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../../libdocument
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/libdocument/*.h
+CFILE_GLOB=$(top_srcdir)/libdocument/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=  \
+	ev-debug.h	\
+	ev-module.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES= \
+	-I$(top_srcdir)					\
+	-I$(top_builddir)				\
+	-I$(top_srcdir)/libdocument 			\
+	-DDATADIR=\"$(pkgdatadir)\"			\
+	-DGNOMEDATADIR=\"$(datadir)\"			\
+	-DEVINCE_UIDIR=\"$(pkgdatadir)\" 		\
+	-DGNOMELOCALEDIR=\"$(datadir)/locale\"		\
+	-DEV_BACKENDSDIR=\"$(backenddir)\"		\
+	-DEVINCE_COMPILATION				\
+	$(AM_CFLAGS)					\
+	$(LIBDOCUMENT_CFLAGS)				\
+	$(WARN_CFLAGS)					\
+	$(DISABLE_DEPRECATED)
+
+GTKDOC_LIBS=						\
+	$(top_builddir)/libdocument/libevdocument.la	\
+	$(LIBDOCUMENT_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += version.xml.in
diff --git a/help/reference/libdocument/libevdocument-docs.sgml b/help/reference/libdocument/libevdocument-docs.sgml
new file mode 100644
index 0000000..53e4ad4
--- /dev/null
+++ b/help/reference/libdocument/libevdocument-docs.sgml
@@ -0,0 +1,74 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>libevdocument Reference Manual</title>
+    <releaseinfo>for Evince &version;</releaseinfo>
+  </bookinfo>
+
+  <part id="interfaces">
+    <title>Document Interfaces</title>
+    <partintro>
+      <para>
+	Provides support for writing Evince backends. For example
+	EvDocumentAttachments is used to represent document
+	attachments. The core have objects that represent various
+	document interfaces.
+      </para>
+    </partintro>
+    <xi:include href="xml/ev-async-renderer.xml"/>
+    <xi:include href="xml/ev-document-find.xml"/>
+    <xi:include href="xml/ev-document-fonts.xml"/>
+    <xi:include href="xml/ev-document-forms.xml"/>
+    <xi:include href="xml/ev-document-images.xml"/>
+    <xi:include href="xml/ev-document-links.xml"/>
+    <xi:include href="xml/ev-document-security.xml"/>
+    <xi:include href="xml/ev-document-thumbnails.xml"/>
+    <xi:include href="xml/ev-document-transition.xml"/>
+    <xi:include href="xml/ev-file-exporter.xml"/>
+    <xi:include href="xml/ev-document.xml"/>
+    <xi:include href="xml/ev-selection.xml"/>
+    <xi:include href="xml/ev-document-layers.xml"/>
+  </part>
+
+  <part id="data">
+    <title>Document data</title>
+    <partintro>
+      <para>
+	Helper objects related to document like attachments, links and
+	images.
+      </para>
+    </partintro>
+    <xi:include href="xml/ev-attachment.xml"/>
+    <xi:include href="xml/ev-document-info.xml"/>
+    <xi:include href="xml/ev-form-field.xml"/>
+    <xi:include href="xml/ev-image.xml"/>
+    <xi:include href="xml/ev-link-action.xml"/>
+    <xi:include href="xml/ev-link-dest.xml"/>
+    <xi:include href="xml/ev-link.xml"/>
+    <xi:include href="xml/ev-render-context.xml"/>
+    <xi:include href="xml/ev-layer.xml"/>
+    <xi:include href="xml/ev-page.xml"/>
+    <xi:include href="xml/ev-transition-effect.xml"/>
+  </part>
+
+  <part id="helper">
+    <title>Helper functions</title>
+    <partintro>
+      <para>
+	Helper functions common for backend implementation
+      </para>
+    </partintro>
+    <xi:include href="xml/ev-document-factory.xml"/>
+    <xi:include href="xml/ev-document-misc.xml"/>
+    <xi:include href="xml/ev-file-helpers.xml"/>
+    <xi:include href="xml/ev-backends-manager.xml"/>
+    <xi:include href="xml/ev-init.xml"/>
+  </part>
+
+</book>
diff --git a/help/reference/libdocument/libevdocument.types b/help/reference/libdocument/libevdocument.types
new file mode 100644
index 0000000..e8c3ef3
--- /dev/null
+++ b/help/reference/libdocument/libevdocument.types
@@ -0,0 +1,48 @@
+#include "evince-document.h"
+
+ev_async_renderer_get_type
+ev_attachment_get_type
+ev_document_find_get_type
+ev_document_fonts_get_type
+ev_document_forms_get_type
+ev_document_images_get_type
+ev_document_info_get_type
+ev_document_links_get_type
+ev_document_security_get_type
+ev_document_thumbnails_get_type
+ev_document_transition_get_type
+ev_file_exporter_get_type
+ev_form_field_get_type
+ev_form_field_text_get_type
+ev_form_field_button_get_type
+ev_form_field_choice_get_type
+ev_form_field_signature_get_type
+ev_image_get_type
+ev_link_action_get_type
+ev_link_dest_get_type
+ev_link_get_type
+ev_render_context_get_type
+ev_document_get_type
+ev_selection_get_type
+ev_document_error_get_type
+ev_document_layout_get_type
+ev_document_mode_get_type
+ev_document_ui_hints_get_type
+ev_document_permissions_get_type
+ev_document_info_fields_get_type
+ev_file_exporter_format_get_type
+ev_file_exporter_capabilities_get_type
+ev_compression_type_get_type
+ev_form_field_text_type_get_type
+ev_form_field_button_type_get_type
+ev_form_field_choice_type_get_type
+ev_link_action_type_get_type
+ev_link_dest_type_get_type
+ev_selection_style_get_type
+ev_transition_effect_type_get_type
+ev_transition_effect_alignment_get_type
+ev_transition_effect_direction_get_type
+ev_layer_get_type
+ev_page_get_type
+ev_transition_effect_get_type
+ev_document_layers_get_type
diff --git a/help/reference/libdocument/version.xml.in b/help/reference/libdocument/version.xml.in
new file mode 100644
index 0000000..27323da
--- /dev/null
+++ b/help/reference/libdocument/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
\ No newline at end of file