From 16cc05ec4f7663103e45a52ac06d292e6b75a8c0 Mon Sep 17 00:00:00 2001 From: Carlos Garcia Campos Date: Sun, 01 Feb 2009 16:43:51 +0000 Subject: Split API documentation into libdocument, libview and shell. Required 2009-02-01 Carlos Garcia Campos * 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 --- (limited to 'help/reference/shell') diff --git a/help/reference/shell/Makefile.am b/help/reference/shell/Makefile.am new file mode 100644 index 0000000..c62e204 --- /dev/null +++ b/help/reference/shell/Makefile.am @@ -0,0 +1,126 @@ +## 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 + +# 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 +CFILE_GLOB=$(top_srcdir)/shell/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= \ + ev-marshal.h \ + ev-marshal.c + +# 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)/shell \ + -DDATADIR=\"$(pkgdatadir)\" \ + -DGNOMEDATADIR=\"$(datadir)\" \ + -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_builddir)/libdocument \ + -I$(top_srcdir)/libview \ + -I$(top_builddir)/libview \ + -I$(top_srcdir)/properties \ + -DGNOMELOCALEDIR=\"$(datadir)/locale\" \ + -DGNOMEICONDIR=\""$(datadir)/pixmaps"\" \ + -DEVINCE_COMPILATION \ + $(SHELL_CFLAGS) \ + $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED) \ + $(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)/cut-n-paste/gedit-message-area/libgeditmsgarea.la \ + $(top_builddir)/cut-n-paste/evmountoperation/libevmountoperation.la \ + $(top_builddir)/cut-n-paste/gimpcellrenderertoggle/libgimpcellrenderertoggle.la \ + $(top_builddir)/cut-n-paste/smclient/libsmclient.la \ + $(top_builddir)/properties/libevproperties.la \ + $(top_builddir)/libdocument/libevdocument.la \ + $(top_builddir)/libview/libevview.la \ + $(SHELL_LIBS) \ + $(GTK_PRINT_LIBS) \ + $(filter-out ../../../shell/main.o,$(wildcard ../../../shell/*.o)) + +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/shell/evince-docs.sgml b/help/reference/shell/evince-docs.sgml new file mode 100644 index 0000000..a58fd51 --- /dev/null +++ b/help/reference/shell/evince-docs.sgml @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + ]> + + + Evince Programmer's Reference Manual + + + + + <phrase>Evince Frontend</phrase> + + + + + 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. + + + &ev-history; + &ev-metadata-manager; + &ev-navigation-action; + &ev-navigation-action-widget; + &ev-page-action; + &ev-page-action-widget; + &ev-password-view; + &ev-properties-dialog; + &ev-properties-fonts; + &ev-sidebar-attachments; + &ev-sidebar-links; + &ev-sidebar-page; + &ev-sidebar-thumbnails; + &ev-sidebar; + &ev-stock-icons; + &ev-utils; + &ev-window-title; + &ev-window; + + + + + diff --git a/help/reference/shell/evince.types b/help/reference/shell/evince.types new file mode 100644 index 0000000..ad3906d --- /dev/null +++ b/help/reference/shell/evince.types @@ -0,0 +1,15 @@ +#include "ev-application.h" +#include "ev-navigation-action.h" +#include "ev-navigation-action-widget.h" +#include "ev-page-action.h" +#include "ev-page-action-widget.h" +#include "ev-window.h" + +ev_application_get_type +ev_navigation_action_get_type +ev_navigation_action_widget_get_type +ev_navigation_action_widget_get_type +ev_page_action_get_type +ev_page_action_widget_get_type +ev_page_action_widget_get_type +ev_window_get_type diff --git a/help/reference/shell/tmpl/dummy.sgml b/help/reference/shell/tmpl/dummy.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/help/reference/shell/tmpl/dummy.sgml diff --git a/help/reference/shell/version.xml.in b/help/reference/shell/version.xml.in new file mode 100644 index 0000000..27323da --- /dev/null +++ b/help/reference/shell/version.xml.in @@ -0,0 +1 @@ +@VERSION@ \ No newline at end of file -- cgit v0.9.1