Added gtk-doc based documentation for Evince. Still in initial state but I

2007-01-29  Nickolay V. Shmyrev  <shmyrev@shadow.teleton>

	* help/reference/* :
	* configure.ac:
	
	Added gtk-doc based documentation for Evince.
	Still in initial state but I hope it will
	grow.
	
	* configure.ac:
	
	Lower dbus requirement to 0.70



svn path=/trunk/; revision=2272

6 files changed, 186 insertions, 0 deletions

diff --git a/help/ChangeLog b/help/ChangeLog
index 0ead5a3..a73f99b 100644
--- a/help/ChangeLog
+++ b/help/ChangeLog
@@ -1,3 +1,12 @@
+2007-01-29  Nickolay V. Shmyrev  <shmyrev@shadow.teleton>
+
+	reviewed by: <delete if not using a buddy>
+
+	* reference/Makefile.am:
+	* reference/evince-docs.sgml:
+	* reference/evince.types:
+	* reference/version.xml.in:
+
 2007-01-17  Daniel Nylander <po@danielnylander.se>
 
 	* sv/sv.po: Updated Swedish translation.
diff --git a/help/reference/Makefile.am b/help/reference/Makefile.am
new file mode 100644
index 0000000..ecf70a8
--- /dev/null
+++ b/help/reference/Makefile.am
@@ -0,0 +1,121 @@
+## 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=evince
+
+# 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=../../shell --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)/shell/*.h $(top_srcdir)/libdocument/*.h
+CFILE_GLOB=$(top_srcdir)/shell/*.c $(top_srcdir)/libdocument/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=
+
+# 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)/shell \
+	-DDATADIR=\"$(pkgdatadir)\"			\
+	-DGNOMEDATADIR=\"$(datadir)\"			\
+	-I$(top_srcdir)/cut-n-paste/recent-files/   \
+	-I$(top_srcdir)/cut-n-paste/zoom-control/	\
+	-I$(top_srcdir)/cut-n-paste/toolbar-editor/	\
+	-I$(top_srcdir)/cut-n-paste/totem-screensaver/	\
+	-I$(top_srcdir)/libdocument			\
+	-I$(top_srcdir)/properties			\
+	-DGNOMELOCALEDIR=\"$(datadir)/locale\"		\
+	-DGNOMEICONDIR=\""$(datadir)/pixmaps"\" 	\
+	$(SHELL_CFLAGS)					\
+	$(WARN_CFLAGS)					\
+	$(DISABLE_DEPRECATED)				\
+	$(GNOME_PRINT_CFLAGS)				\
+	$(GTK_PRINT_CFLAGS)
+
+GTKDOC_LIBS= \
+	$(top_builddir)/cut-n-paste/zoom-control/libephyzoom.la		\
+	$(top_builddir)/cut-n-paste/toolbar-editor/libtoolbareditor.la	\
+	$(top_builddir)/cut-n-paste/totem-screensaver/libtotemscrsaver.la	\
+	$(top_builddir)/properties/libevproperties.la			\
+	$(top_builddir)/libdocument/libevbackend.la			\
+	$(SHELL_LIBS)							\
+	$(GNOME_PRINT_LIBS)						\
+	$(filter-out ../../shell/main.o,$(wildcard ../../shell/*.o))
+
+if HAVE_GTK_RECENT
+GTKDOC_LIBS +=
+else
+GTKDOC_LIBS += $(top_builddir)/cut-n-paste/recent-files/librecent.la
+endif
+
+if ENABLE_DJVU
+GTKDOC_LIBS +=	$(DJVU_LIBS)
+endif
+
+if ENABLE_DVI
+GTKDOC_LIBS +=	-lkpathsea
+endif
+
+if WITH_TYPE1_FONTS
+GTKDOC_LIBS += -lt1
+endif
+
+# 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/evince-docs.sgml b/help/reference/evince-docs.sgml
new file mode 100644
index 0000000..a90c772
--- /dev/null
+++ b/help/reference/evince-docs.sgml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+    <!ENTITY ev-attachment   			  SYSTEM "xml/ev-attachment.xml">
+    <!ENTITY ev-page-cache   			  SYSTEM "xml/ev-attachment.xml">
+    <!ENTITY ev-window   			  SYSTEM "xml/ev-window.xml">
+    <!ENTITY ev-view	   			  SYSTEM "xml/ev-view.xml">
+    <!ENTITY tree_index                           SYSTEM "xml/tree_index.sgml">
+    ]>
+<book id="index">
+  <bookinfo>
+    <title>Evince Programmer's Reference Manual</title>
+  </bookinfo>
+  
+  <part id="libdocument">
+    <para>
+	Provides support for writing Evince backends. For example 
+	EvAttachment is used to represent document attachments.
+    </para>
+    &ev-attachment;
+  </part>
+  
+  <part id="shell">
+  
+      <para>
+
+	Evince internals are rather simple. There are an application
+	singleton that maintains list of windows and provides common
+	services, each window shows loaded document, it has menus
+	sidebar, toolbar and main view.
+	
+      </para>
+
+	&ev-window; - Main window class
+	&ev-view; - View for document
+	&ev-page-cache; - Document page cache
+  </part>
+
+  <index/>
+
+</book>
diff --git a/help/reference/evince.types b/help/reference/evince.types
new file mode 100644
index 0000000..c3ca861
--- /dev/null
+++ b/help/reference/evince.types
@@ -0,0 +1,14 @@
+#include "ev-window.h"
+#include "ev-document.h"
+#include "ev-attachment.h"
+#include "ev-page-cache.h"
+#include "ev-application.h"
+#include "ev-view.h"
+#include "ev-view-private.h"
+
+ev_window_get_type
+ev_document_get_type
+ev_attachment_get_type
+ev_page_cache_get_type
+ev_application_get_type
+ev_view_get_type
diff --git a/help/reference/tmpl/dummy.sgml b/help/reference/tmpl/dummy.sgml
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/help/reference/tmpl/dummy.sgml
diff --git a/help/reference/version.xml.in b/help/reference/version.xml.in
new file mode 100644
index 0000000..27323da
--- /dev/null
+++ b/help/reference/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
\ No newline at end of file