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 --- diff --git a/ChangeLog b/ChangeLog index 71cda1b..b211aee 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,25 @@ +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. + 2009-02-01 Christian Persch * libdocument/ev-document.h: Don't make GTypeInfo static. Bug #570077. diff --git a/configure.ac b/configure.ac index 64482c0..5dc950e 100644 --- a/configure.ac +++ b/configure.ac @@ -512,7 +512,12 @@ data/icons/scalable/Makefile data/icons/scalable/apps/Makefile help/Makefile help/reference/Makefile -help/reference/version.xml +help/reference/libdocument/Makefile +help/reference/libdocument/version.xml +help/reference/libview/Makefile +help/reference/libview/version.xml +help/reference/shell/Makefile +help/reference/shell/version.xml libdocument/Makefile libdocument/ev-version.h libview/Makefile diff --git a/help/reference/Makefile.am b/help/reference/Makefile.am index f3ccc0f..6a042c8 100644 --- a/help/reference/Makefile.am +++ b/help/reference/Makefile.am @@ -1,130 +1 @@ -## 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 --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)/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= \ -ev-backend-marshal.c \ -ev-backend-marshalers.h \ -ev-backend-marshalers.c \ -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) \ - $(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)/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) \ - $(GNOME_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 +SUBDIRS = libdocument libview shell \ No newline at end of file diff --git a/help/reference/evince-docs.sgml b/help/reference/evince-docs.sgml deleted file mode 100644 index cbec8ed..0000000 --- a/help/reference/evince-docs.sgml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ]> - - - Evince Programmer's Reference Manual - - - - - <phrase>Document interfaces</phrase> - - - - Provides support for writing Evince backends. For example - EvAttachment is used to represent document attachments. - The core have objects that represent various document - interfaces. - - - &ev-document-factory; - &ev-document; - &ev-document-find; - &ev-document-fonts; - &ev-document-images; - &ev-document-info; - &ev-document-links; - &ev-document-misc; - &ev-document-security; - &ev-document-thumbnails; - &ev-document-transition; - - - - <phrase>Document data</phrase> - - - - Helper objects related to document like attachments, links and images. - - - &ev-attachment; - &ev-link; - &ev-link-action; - &ev-link-dest; - &ev-image; - &ev-render-context; - &ev-selection; - - - - <phrase>Helper functions</phrase> - - - - Helper functions common for backend implementation - - - &ev-async-renderer; - &ev-file-exporter; - &ev-file-helpers; - - - - <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-jobs; - &ev-metadata-manager; - &ev-navigation-action; - &ev-navigation-action-widget; - &ev-page-action; - &ev-page-action-widget; - &ev-page-cache; - &ev-password-view; - &ev-pixbuf-cache; - &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-view-accessible; - &ev-view; - &ev-window-title; - &ev-window; - - - - - diff --git a/help/reference/evince.types b/help/reference/evince.types deleted file mode 100644 index 7f5e03e..0000000 --- a/help/reference/evince.types +++ /dev/null @@ -1,41 +0,0 @@ -#include "ev-application.h" -#include "ev-async-renderer.h" -#include "ev-attachment.h" -#include "ev-document-find.h" -#include "ev-document.h" -#include "ev-document-links.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-page-cache.h" -#include "ev-view.h" -#include "ev-view-private.h" -#include "ev-view-type-builtins.h" -#include "ev-view-accessible.h" -#include "ev-window.h" - -ev_application_get_type -ev_async_renderer_get_type -ev_attachment_get_type -ev_document_find_get_type -ev_document_get_type -ev_document_links_get_type -ev_job_fonts_get_type -ev_job_links_get_type -ev_job_load_get_type -ev_job_priority_get_type -ev_job_render_get_type -ev_job_thumbnail_get_type -ev_link_action_get_type -ev_link_dest_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_page_cache_get_type -ev_view_accessible_factory_get_type -ev_view_get_type -ev_window_get_type 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 @@ + + + +]> + + + libevdocument Reference Manual + for Evince &version; + + + + Document Interfaces + + + Provides support for writing Evince backends. For example + EvDocumentAttachments is used to represent document + attachments. The core have objects that represent various + document interfaces. + + + + + + + + + + + + + + + + + + + Document data + + + Helper objects related to document like attachments, links and + images. + + + + + + + + + + + + + + + + + Helper functions + + + Helper functions common for backend implementation + + + + + + + + + + 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/version.xml.in b/help/reference/libdocument/version.xml.in index 27323da..27323da 100644 --- a/help/reference/version.xml.in +++ b/help/reference/libdocument/version.xml.in 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 @@ + + + +]> + + + libevview Reference Manual + for Evince &version; + + + + Evince View + + + + + + + + + + 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 + +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/version.xml.in b/help/reference/libview/version.xml.in index 27323da..27323da 100644 --- a/help/reference/version.xml.in +++ b/help/reference/libview/version.xml.in 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/tmpl/dummy.sgml b/help/reference/shell/tmpl/dummy.sgml index e69de29..e69de29 100644 --- a/help/reference/tmpl/dummy.sgml +++ b/help/reference/shell/tmpl/dummy.sgml diff --git a/help/reference/version.xml.in b/help/reference/shell/version.xml.in index 27323da..27323da 100644 --- a/help/reference/version.xml.in +++ b/help/reference/shell/version.xml.in -- cgit v0.9.1