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/libview | |
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/libview')
-rw-r--r-- | help/reference/libview/Makefile.am | 102 | ||||
-rw-r--r-- | help/reference/libview/libevview-docs.sgml | 25 | ||||
-rw-r--r-- | help/reference/libview/libevview.types | 20 | ||||
-rw-r--r-- | help/reference/libview/version.xml.in | 1 |
4 files changed, 148 insertions, 0 deletions
diff --git a/help/reference/libview/Makefile.am b/help/reference/libview/Makefile.am new file mode 100644 index 0000000..efa9407 --- /dev/null +++ b/help/reference/libview/Makefile.am @@ -0,0 +1,102 @@ +## 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=libevview + +# 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=../../../libview + +# 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)/libview/*.h +CFILE_GLOB=$(top_srcdir)/libview/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= \ + ev-pixbuf-cache.h \ + ev-timeline.h \ + ev-transition-animation.h \ + ev-view-accessible.h \ + ev-view-marshal.h \ + ev-view-private.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)/libview \ + -DDATADIR=\"$(pkgdatadir)\" \ + -DGNOMEDATADIR=\"$(datadir)\" \ + -DEVINCE_UIDIR=\"$(pkgdatadir)\" \ + -DGNOMELOCALEDIR=\"$(datadir)/locale\" \ + -DEVINCE_COMPILATION \ + -I$(top_srcdir)/libdocument \ + -I$(top_builddir)/libdocument \ + $(AM_CFLAGS) \ + $(LIBVIEW_CFLAGS) \ + $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED) + +GTKDOC_LIBS= \ + $(top_builddir)/libview/libevview.la \ + $(top_builddir)/libdocument/libevdocument.la \ + $(LIBVIEW_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/libview/libevview-docs.sgml b/help/reference/libview/libevview-docs.sgml new file mode 100644 index 0000000..ee04d5f --- /dev/null +++ b/help/reference/libview/libevview-docs.sgml @@ -0,0 +1,25 @@ +<?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>libevview Reference Manual</title> + <releaseinfo>for Evince &version;</releaseinfo> + </bookinfo> + + <chapter> + <title>Evince View</title> + <partintro> + <para> + </para> + </partintro> + <xi:include href="xml/ev-jobs.xml"/> + <xi:include href="xml/ev-page-cache.xml"/> + <xi:include href="xml/ev-view.xml"/> + <xi:include href="xml/ev-job-scheduler.xml"/> + </chapter> +</book> diff --git a/help/reference/libview/libevview.types b/help/reference/libview/libevview.types new file mode 100644 index 0000000..99c7243 --- /dev/null +++ b/help/reference/libview/libevview.types @@ -0,0 +1,20 @@ +#include <evince-view.h> + +ev_job_get_type +ev_job_links_get_type +ev_job_attachments_get_type +ev_job_render_get_type +ev_job_thumbnail_get_type +ev_job_fonts_get_type +ev_job_load_get_type +ev_job_save_get_type +ev_job_find_get_type +ev_job_layers_get_type +ev_job_export_get_type +ev_page_cache_get_type +ev_view_get_type +ev_job_run_mode_get_type +ev_render_flags_get_type +ev_job_priority_get_type +ev_sizing_mode_get_type +ev_view_selection_mode_get_type diff --git a/help/reference/libview/version.xml.in b/help/reference/libview/version.xml.in new file mode 100644 index 0000000..27323da --- /dev/null +++ b/help/reference/libview/version.xml.in @@ -0,0 +1 @@ +@VERSION@
\ No newline at end of file |