diff options
author | Carlos Garcia Campos <carlosgc@gnome.org> | 2009-02-01 16:43:51 (GMT) |
---|---|---|
committer | Carlos Garcia Campos <carlosgc@src.gnome.org> | 2009-02-01 16:43:51 (GMT) |
commit | 16cc05ec4f7663103e45a52ac06d292e6b75a8c0 (patch) | |
tree | 3a63b645aa9ee63de9db62907cacb2f60872c9c0 /help/reference/libdocument/libevdocument-docs.sgml | |
parent | f28565d119b13be06615e377be67753a6be672ca (diff) |
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
Diffstat (limited to 'help/reference/libdocument/libevdocument-docs.sgml')
-rw-r--r-- | help/reference/libdocument/libevdocument-docs.sgml | 74 |
1 files changed, 74 insertions, 0 deletions
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> |