Sun Jan 1 15:32:08 2006 Jonathan Blandford <jrb@redhat.com>

        * glib/reference/*: More gtk-doc work.  Not enabled for building
        by default, but filled in.
parent 0fab1b71
......@@ -22,3 +22,4 @@ poppler-qt4.pc
poppler-splash.pc
poppler.pc
stamp-h1
gtk-doc.make
Sun Jan 1 15:32:08 2006 Jonathan Blandford <jrb@redhat.com>
* glib/reference/*: More gtk-doc work. Not enabled for building
by default, but filled in.
Fri Dec 30 21:08:33 2005 Jonathan Blandford <jrb@redhat.com>
* glib/*{cc,h}: Update inline doc comments. This is in
......
Makefile
Makefile.in
poppler-decl-list.txt
poppler-decl.txt
poppler-undocumented.txt
poppler-unused.txt
poppler.args
poppler.hierarchy
poppler.interfaces
poppler.prerequisites
poppler.signals
deprecated
html
xml
*.stamp
*.lo
.libs
version.xml
## 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=poppler
# 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=$(top_srcdir)/glib
# 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 --source-suffixes=c,cc,h
# 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)/glib/*.h
CFILE_GLOB=$(top_srcdir)/glib/*.cc
# 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)/glib -I$(top_builddir)/glib \
$(CAIRO_CFLAGS) \
$(POPPLER_GLIB_CFLAGS) \
$(FREETYPE_CFLAGS)
GTKDOC_LIBS=$(top_builddir)/poppler/libpoppler.la \
$(top_builddir)/glib/libpoppler-glib.la \
$(POPPLER_GLIB_LIBS) \
$(FREETYPE_LIBS) \
$(cairo_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 +=
<?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">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Poppler Reference Manual</title>
</bookinfo>
<chapter>
<title>Poppler</title>
<xi:include href="xml/poppler.xml"/>
<xi:include href="xml/poppler-document.xml"/>
<xi:include href="xml/poppler-page.xml"/>
<xi:include href="xml/poppler-action.xml"/>
<xi:include href="xml/poppler-enums.xml"/>
</chapter>
</book>
<SECTION>
<FILE>poppler-page</FILE>
poppler_page_render_to_pixbuf
poppler_page_get_size
poppler_page_get_index
poppler_page_get_thumbnail
poppler_page_get_thumbnail_size
poppler_page_find_text
poppler_page_render_to_ps
poppler_page_get_text
poppler_page_get_link_mapping
poppler_page_free_link_mapping
poppler_page_get_selection_region
poppler_page_render_selection
POPPLER_TYPE_RECTANGLE
PopplerRectangle
poppler_rectangle_get_type
poppler_rectangle_new
poppler_rectangle_copy
poppler_rectangle_free
POPPLER_TYPE_LINK_MAPPING
PopplerLinkMapping
poppler_link_mapping_get_type
poppler_link_mapping_new
poppler_link_mapping_copy
poppler_link_mapping_free
<SUBSECTION Standard>
POPPLER_PAGE
POPPLER_IS_PAGE
POPPLER_TYPE_PAGE
poppler_page_get_type
</SECTION>
<SECTION>
<FILE>poppler-document</FILE>
PopplerPageLayout
PopplerPageMode
PopplerFontType
PopplerViewerPreferences
PopplerPermissions
poppler_document_new_from_file
poppler_document_save
poppler_document_get_n_pages
poppler_document_get_page
poppler_document_get_page_by_label
poppler_index_iter_get_type
poppler_index_iter_new
poppler_index_iter_copy
poppler_index_iter_free
poppler_index_iter_get_child
poppler_index_iter_is_open
poppler_index_iter_get_action
poppler_index_iter_next
poppler_font_info_new
poppler_font_info_scan
poppler_font_info_free
poppler_fonts_iter_get_type
poppler_fonts_iter_copy
poppler_fonts_iter_free
poppler_fonts_iter_get_name
poppler_fonts_iter_get_full_name
poppler_fonts_iter_get_font_type
poppler_fonts_iter_is_embedded
poppler_fonts_iter_is_subset
poppler_fonts_iter_next
poppler_ps_file_new
poppler_ps_file_set_paper_size
poppler_ps_file_set_duplex
poppler_ps_file_free
<SUBSECTION Standard>
POPPLER_DOCUMENT
POPPLER_IS_DOCUMENT
POPPLER_TYPE_DOCUMENT
poppler_document_get_type
</SECTION>
<SECTION>
<FILE>poppler-action</FILE>
PopplerActionType
PopplerDestType
PopplerActionAny
PopplerActionGotoDest
PopplerActionGotoRemote
PopplerActionLaunch
PopplerActionUri
PopplerActionNamed
PopplerActionMovie
PopplerDest
PopplerAction
POPPLER_TYPE_ACTION
POPPLER_ACTION
poppler_action_get_type
poppler_action_free
poppler_action_copy
</SECTION>
<SECTION>
<FILE>poppler-enums</FILE>
POPPLER_TYPE_ACTION_TYPE
poppler_action_type_get_type
POPPLER_TYPE_DEST_TYPE
poppler_dest_type_get_type
POPPLER_TYPE_PAGE_LAYOUT
poppler_page_layout_get_type
POPPLER_TYPE_PAGE_MODE
poppler_page_mode_get_type
POPPLER_TYPE_FONT_TYPE
poppler_font_type_get_type
POPPLER_TYPE_VIEWER_PREFERENCES
poppler_viewer_preferences_get_type
POPPLER_TYPE_PERMISSIONS
poppler_permissions_get_type
POPPLER_TYPE_ERROR
poppler_error_get_type
POPPLER_TYPE_ORIENTATION
poppler_orientation_get_type
POPPLER_TYPE_BACKEND
poppler_backend_get_type
</SECTION>
<SECTION>
<FILE>poppler</FILE>
poppler_error_quark
POPPLER_ERROR
PopplerError
PopplerOrientation
PopplerDocument
PopplerIndexIter
PopplerFontsIter
PopplerRectangle
PopplerLinkMapping
PopplerPage
PopplerFontInfo
PopplerPSFile
PopplerBackend
poppler_get_backend
poppler_get_version
</SECTION>
<SECTION>
<FILE>poppler-private</FILE>
PopplerDocument
PopplerPSFile
PopplerFontInfo
PopplerPage
</SECTION>
<SECTION>
<FILE>stamp-poppler-enums</FILE>
</SECTION>
#include <poppler.h>
poppler_document_get_type
poppler_page_get_type
<!-- ##### SECTION Title ##### -->
poppler-action
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM PopplerActionType ##### -->
<para>
</para>
@POPPLER_ACTION_UNKNOWN:
@POPPLER_ACTION_GOTO_DEST:
@POPPLER_ACTION_GOTO_REMOTE:
@POPPLER_ACTION_LAUNCH:
@POPPLER_ACTION_URI:
@POPPLER_ACTION_NAMED:
@POPPLER_ACTION_MOVIE:
<!-- ##### ENUM PopplerDestType ##### -->
<para>
</para>
@POPPLER_DEST_UNKNOWN:
@POPPLER_DEST_XYZ:
@POPPLER_DEST_FIT:
@POPPLER_DEST_FITH:
@POPPLER_DEST_FITV:
@POPPLER_DEST_FITR:
@POPPLER_DEST_FITB:
@POPPLER_DEST_FITBH:
@POPPLER_DEST_FITBV:
<!-- ##### STRUCT PopplerActionAny ##### -->
<para>
</para>
@type:
@title:
<!-- ##### STRUCT PopplerActionGotoDest ##### -->
<para>
</para>
@type:
@title:
@dest:
<!-- ##### STRUCT PopplerActionGotoRemote ##### -->
<para>
</para>
@type:
@title:
@file_name:
@dest:
<!-- ##### STRUCT PopplerActionLaunch ##### -->
<para>
</para>
@type:
@title:
@file_name:
@params:
<!-- ##### STRUCT PopplerActionUri ##### -->
<para>
</para>
@type:
@title:
@uri:
<!-- ##### STRUCT PopplerActionNamed ##### -->
<para>
</para>
@type:
@title:
@named_dest:
<!-- ##### STRUCT PopplerActionMovie ##### -->
<para>
</para>
@type:
@title:
<!-- ##### STRUCT PopplerDest ##### -->
<para>
</para>
@type:
@page_num:
@left:
@bottom:
@right:
@top:
@zoom:
@change_left:
@change_top:
@change_zoom:
<!-- ##### UNION PopplerAction ##### -->
<para>
</para>
<!-- ##### MACRO POPPLER_TYPE_ACTION ##### -->
<para>
</para>
<!-- ##### MACRO POPPLER_ACTION ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION poppler_action_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION poppler_action_free ##### -->
<para>
</para>
@action:
<!-- ##### FUNCTION poppler_action_copy ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### SECTION Title ##### -->
PopplerDocument
<!-- ##### SECTION Short_Description ##### -->
Information about a document
<!-- ##### SECTION Long_Description ##### -->
<para>
The #PopplerDocument is an object used to refer to a main document.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM PopplerPageLayout ##### -->
<para>
</para>
@POPPLER_PAGE_LAYOUT_UNSET:
@POPPLER_PAGE_LAYOUT_SINGLE_PAGE:
@POPPLER_PAGE_LAYOUT_ONE_COLUMN:
@POPPLER_PAGE_LAYOUT_TWO_COLUMN_LEFT:
@POPPLER_PAGE_LAYOUT_TWO_COLUMN_RIGHT:
@POPPLER_PAGE_LAYOUT_TWO_PAGE_LEFT:
@POPPLER_PAGE_LAYOUT_TWO_PAGE_RIGHT:
<!-- ##### ENUM PopplerPageMode ##### -->
<para>
</para>
@POPPLER_PAGE_MODE_UNSET:
@POPPLER_PAGE_MODE_NONE:
@POPPLER_PAGE_MODE_USE_OUTLINES:
@POPPLER_PAGE_MODE_USE_THUMBS:
@POPPLER_PAGE_MODE_FULL_SCREEN:
@POPPLER_PAGE_MODE_USE_OC:
@POPPLER_PAGE_MODE_USE_ATTACHMENTS:
<!-- ##### ENUM PopplerFontType ##### -->
<para>
</para>
@POPPLER_FONT_TYPE_UNKNOWN:
@POPPLER_FONT_TYPE_TYPE1:
@POPPLER_FONT_TYPE_TYPE1C:
@POPPLER_FONT_TYPE_TYPE3:
@POPPLER_FONT_TYPE_TRUETYPE:
@POPPLER_FONT_TYPE_CID_TYPE0:
@POPPLER_FONT_TYPE_CID_TYPE0C:
@POPPLER_FONT_TYPE_CID_TYPE2:
<!-- ##### ENUM PopplerViewerPreferences ##### -->
<para>
</para>
@POPPLER_VIEWER_PREFERENCES_UNSET:
@POPPLER_VIEWER_PREFERENCES_HIDE_TOOLBAR:
@POPPLER_VIEWER_PREFERENCES_HIDE_MENUBAR:
@POPPLER_VIEWER_PREFERENCES_HIDE_WINDOWUI:
@POPPLER_VIEWER_PREFERENCES_FIT_WINDOW:
@POPPLER_VIEWER_PREFERENCES_CENTER_WINDOW:
@POPPLER_VIEWER_PREFERENCES_DISPLAY_DOC_TITLE:
@POPPLER_VIEWER_PREFERENCES_DIRECTION_RTL:
<!-- ##### ENUM PopplerPermissions ##### -->
<para>
</para>
@POPPLER_PERMISSIONS_OK_TO_PRINT:
@POPPLER_PERMISSIONS_OK_TO_MODIFY:
@POPPLER_PERMISSIONS_OK_TO_COPY:
@POPPLER_PERMISSIONS_OK_TO_ADD_NOTES:
@POPPLER_PERMISSIONS_FULL:
<!-- ##### FUNCTION poppler_document_new_from_file ##### -->
<para>
</para>
@uri:
@password:
@error:
@Returns:
<!-- ##### FUNCTION poppler_document_save ##### -->
<para>
</para>
@document:
@uri:
@error:
@Returns:
<!-- ##### FUNCTION poppler_document_get_n_pages ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION poppler_document_get_page ##### -->
<para>
</para>
@document:
@index:
@Returns:
<!-- # Unused Parameters # -->
@page:
<!-- ##### FUNCTION poppler_document_get_page_by_label ##### -->
<para>
</para>
@document:
@label:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION poppler_index_iter_new ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_copy ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_free ##### -->
<para>
</para>
@iter:
<!-- ##### FUNCTION poppler_index_iter_get_child ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_is_open ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_get_action ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_next ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_font_info_new ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION poppler_font_info_scan ##### -->
<para>
</para>
@font_info:
@n_pages:
@iter:
@Returns:
<!-- ##### FUNCTION poppler_font_info_free ##### -->
<para>
</para>
@font_info:
<!-- ##### FUNCTION poppler_fonts_iter_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_copy ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_free ##### -->
<para>
</para>
@iter:
<!-- ##### FUNCTION poppler_fonts_iter_get_name ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_get_full_name ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_get_font_type ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_is_embedded ##### -->
<para>
</para>
@iter:
@Returns:
<!-- ##### FUNCTION poppler_fonts_iter_is_subset ##### -->
<para>
</para>