[cairo-commit] goocanvas/docs .cvsignore, NONE, 1.1 Makefile.am, NONE, 1.1 goocanvas-docs.sgml, NONE, 1.1 goocanvas-overrides.txt, NONE, 1.1 goocanvas-sections.txt, NONE, 1.1 goocanvas.types, NONE, 1.1

Damon Chaplin commit at pdx.freedesktop.org
Wed Apr 12 03:42:22 PDT 2006


Committed by: damon

Update of /cvs/cairo/goocanvas/docs
In directory kemper:/tmp/cvs-serv28871/docs

Added Files:
	.cvsignore Makefile.am goocanvas-docs.sgml 
	goocanvas-overrides.txt goocanvas-sections.txt goocanvas.types 
Log Message:
2006-04-12  Damon Chaplin  <damon at gnome.org>

	* autogen.sh: 
	* configure.in: 
	* Makefile.am: setup to use gtk-doc.

	* src/Makefile.am: build libgoocanvas as a library now, so we can
	document it with gtk-doc. The demo will be moved to a separate
	directory.

	* src/goocanvastext.h: 
	* src/goocanvasitem.h: rename a few parameters to match the sources,
	since gtk-doc complains if they are different.



--- NEW FILE: .cvsignore ---
Makefile
Makefile.in
goocanvas-decl-list.txt
goocanvas-decl.txt
goocanvas-undocumented.txt
goocanvas-unused.txt
goocanvas.args
goocanvas.hierarchy
goocanvas.interfaces
goocanvas.prerequisites
goocanvas.signals
html
xml
*.stamp
*.lo
.libs

--- NEW FILE: Makefile.am ---
## 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=goocanvas

# 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=../src

# 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)/src/*.h
CFILE_GLOB=$(top_srcdir)/src/*.c

# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=goocanvasmarshal.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)/src -I$(top_builddir)/src @PACKAGE_CFLAGS@
GTKDOC_LIBS=@PACKAGE_LIBS@ $(top_builddir)/src/libgoocanvas.la

# 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 += 

--- NEW FILE: goocanvas-docs.sgml ---
<?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>GooCanvas Reference Manual</title>
  </bookinfo>

  <chapter>
    <title>GooCanvas</title>

    <xi:include href="xml/goocanvasview.xml"/>
    <xi:include href="xml/goocanvasmodel.xml"/>
    <xi:include href="xml/goocanvasmodelsimple.xml"/>

    <xi:include href="xml/goocanvasitem.xml"/>
    <xi:include href="xml/goocanvasitemsimple.xml"/>
    <xi:include href="xml/goocanvasitemview.xml"/>

    <xi:include href="xml/goocanvasgroup.xml"/>
    <xi:include href="xml/goocanvasgroupview.xml"/>
  </chapter>

  <chapter>
    <title>Canvas Items</title>
    <xi:include href="xml/goocanvasellipse.xml"/>
    <xi:include href="xml/goocanvasimage.xml"/>
    <xi:include href="xml/goocanvaspath.xml"/>
    <xi:include href="xml/goocanvaspolyline.xml"/>
    <xi:include href="xml/goocanvasrect.xml"/>
    <xi:include href="xml/goocanvastext.xml"/>
  </chapter>

  <chapter>
    <title>Canvas Item Views</title>
    <xi:include href="xml/goocanvasellipseview.xml"/>
    <xi:include href="xml/goocanvasimageview.xml"/>
    <xi:include href="xml/goocanvaspathview.xml"/>
    <xi:include href="xml/goocanvaspolylineview.xml"/>
    <xi:include href="xml/goocanvasrectview.xml"/>
    <xi:include href="xml/goocanvastextview.xml"/>
  </chapter>

  <chapter>
    <title>Utilities</title>
    <xi:include href="xml/goocanvasutils.xml"/>
  </chapter>
</book>

--- NEW FILE: goocanvas-overrides.txt ---

--- NEW FILE: goocanvas-sections.txt ---
<SECTION>
<FILE>goocanvasrect</FILE>
<TITLE>GooCanvasRect</TITLE>
GooCanvasRect
goo_canvas_rect_new
<SUBSECTION Standard>
GOO_CANVAS_RECT
GOO_IS_CANVAS_RECT
GOO_TYPE_CANVAS_RECT
goo_canvas_rect_get_type
GOO_CANVAS_RECT_CLASS
GOO_IS_CANVAS_RECT_CLASS
GOO_CANVAS_RECT_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasitem</FILE>
<TITLE>GooCanvasItem</TITLE>
GooCanvasVisibility
GooCanvasAnimateType
GooCanvasBounds
GooCanvasItem
GooCanvasItemIface
goo_canvas_item_new
goo_canvas_item_get_n_children
goo_canvas_item_get_child
goo_canvas_item_add_child
goo_canvas_item_move_child
goo_canvas_item_remove_child
goo_canvas_item_find_child
goo_canvas_item_get_model
goo_canvas_item_get_parent
goo_canvas_item_set_parent
goo_canvas_item_is_container
goo_canvas_item_raise
goo_canvas_item_lower
goo_canvas_item_get_transform
goo_canvas_item_set_transform
goo_canvas_item_translate
goo_canvas_item_scale
goo_canvas_item_rotate
goo_canvas_item_skew_x
goo_canvas_item_skew_y
goo_canvas_item_animate
goo_canvas_item_stop_animation
<SUBSECTION Standard>
GOO_CANVAS_ITEM
GOO_IS_CANVAS_ITEM
GOO_TYPE_CANVAS_ITEM
goo_canvas_item_get_type
GOO_CANVAS_ITEM_CLASS
GOO_CANVAS_ITEM_GET_IFACE
</SECTION>

<SECTION>
<FILE>goocanvastextview</FILE>
<TITLE>GooCanvasTextView</TITLE>
GooCanvasTextView
goo_canvas_text_view_new
<SUBSECTION Standard>
GOO_CANVAS_TEXT_VIEW
GOO_IS_CANVAS_TEXT_VIEW
GOO_TYPE_CANVAS_TEXT_VIEW
goo_canvas_text_view_get_type
GOO_CANVAS_TEXT_VIEW_CLASS
GOO_IS_CANVAS_TEXT_VIEW_CLASS
GOO_CANVAS_TEXT_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasitemview</FILE>
<TITLE>GooCanvasItemView</TITLE>
GooCanvasItemView
GooCanvasItemViewIface
goo_canvas_item_view_get_n_children
goo_canvas_item_view_get_child
goo_canvas_item_view_request_update
goo_canvas_item_view_get_canvas_view
goo_canvas_item_view_get_parent_view
goo_canvas_item_view_set_parent_view
goo_canvas_item_view_is_container
goo_canvas_item_view_get_item
goo_canvas_item_view_get_bounds
goo_canvas_item_view_get_item_at
goo_canvas_item_view_ensure_updated
goo_canvas_item_view_update
goo_canvas_item_view_paint
<SUBSECTION Standard>
GOO_CANVAS_ITEM_VIEW
GOO_IS_CANVAS_ITEM_VIEW
GOO_TYPE_CANVAS_ITEM_VIEW
goo_canvas_item_view_get_type
GOO_CANVAS_ITEM_VIEW_CLASS
GOO_CANVAS_ITEM_VIEW_GET_IFACE
</SECTION>

<SECTION>
<FILE>goocanvasgroup</FILE>
<TITLE>GooCanvasGroup</TITLE>
GooCanvasGroup
goo_canvas_group_new
<SUBSECTION Standard>
GOO_CANVAS_GROUP
GOO_IS_CANVAS_GROUP
GOO_TYPE_CANVAS_GROUP
goo_canvas_group_get_type
GOO_CANVAS_GROUP_CLASS
GOO_IS_CANVAS_GROUP_CLASS
GOO_CANVAS_GROUP_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvaspath</FILE>
GooCanvasPathCommandType
GooCanvasPathCommand
<TITLE>GooCanvasPath</TITLE>
GooCanvasPath
goo_canvas_path_new
<SUBSECTION Standard>
GOO_CANVAS_PATH
GOO_IS_CANVAS_PATH
GOO_TYPE_CANVAS_PATH
goo_canvas_path_get_type
GOO_CANVAS_PATH_CLASS
GOO_IS_CANVAS_PATH_CLASS
GOO_CANVAS_PATH_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasgroupview</FILE>
<TITLE>GooCanvasGroupView</TITLE>
GooCanvasGroupView
goo_canvas_group_view_new
<SUBSECTION Standard>
GOO_CANVAS_GROUP_VIEW
GOO_IS_CANVAS_GROUP_VIEW
GOO_TYPE_CANVAS_GROUP_VIEW
goo_canvas_group_view_get_type
GOO_CANVAS_GROUP_VIEW_CLASS
GOO_IS_CANVAS_GROUP_VIEW_CLASS
GOO_CANVAS_GROUP_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasellipseview</FILE>
<TITLE>GooCanvasEllipseView</TITLE>
GooCanvasEllipseView
goo_canvas_ellipse_view_new
<SUBSECTION Standard>
GOO_CANVAS_ELLIPSE_VIEW
GOO_IS_CANVAS_ELLIPSE_VIEW
GOO_TYPE_CANVAS_ELLIPSE_VIEW
goo_canvas_ellipse_view_get_type
GOO_CANVAS_ELLIPSE_VIEW_CLASS
GOO_IS_CANVAS_ELLIPSE_VIEW_CLASS
GOO_CANVAS_ELLIPSE_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasview</FILE>
<TITLE>GooCanvasView</TITLE>
GooCanvasView
goo_canvas_view_new
goo_canvas_view_set_model
goo_canvas_view_set_scale
goo_canvas_view_set_anchor
goo_canvas_view_set_bounds
goo_canvas_view_scroll_to
goo_canvas_view_grab_focus
goo_canvas_view_render
goo_canvas_view_convert_to_pixels
goo_canvas_view_convert_from_pixels
goo_canvas_view_convert_to_item_space
goo_canvas_view_convert_from_item_space
goo_canvas_view_pointer_grab
goo_canvas_view_pointer_ungrab
goo_canvas_view_keyboard_grab
goo_canvas_view_keyboard_ungrab
goo_canvas_view_create_item_view
goo_canvas_view_update
goo_canvas_view_request_update
goo_canvas_view_request_redraw
<SUBSECTION Standard>
GOO_CANVAS_VIEW
GOO_IS_CANVAS_VIEW
GOO_TYPE_CANVAS_VIEW
goo_canvas_view_get_type
GOO_CANVAS_VIEW_CLASS
GOO_IS_CANVAS_VIEW_CLASS
GOO_CANVAS_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasellipse</FILE>
<TITLE>GooCanvasEllipse</TITLE>
GooCanvasEllipse
goo_canvas_ellipse_new
<SUBSECTION Standard>
GOO_CANVAS_ELLIPSE
GOO_IS_CANVAS_ELLIPSE
GOO_TYPE_CANVAS_ELLIPSE
goo_canvas_ellipse_get_type
GOO_CANVAS_ELLIPSE_CLASS
GOO_IS_CANVAS_ELLIPSE_CLASS
GOO_CANVAS_ELLIPSE_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasmodel</FILE>
<TITLE>GooCanvasModel</TITLE>
GooCanvasModel
GooCanvasModelIface
goo_canvas_model_get_root_item
<SUBSECTION Standard>
GOO_CANVAS_MODEL
GOO_IS_CANVAS_MODEL
GOO_TYPE_CANVAS_MODEL
goo_canvas_model_get_type
GOO_CANVAS_MODEL_CLASS
GOO_CANVAS_MODEL_GET_IFACE
</SECTION>

<SECTION>
<FILE>goocanvastext</FILE>
<TITLE>GooCanvasText</TITLE>
GooCanvasText
goo_canvas_text_new
<SUBSECTION Standard>
GOO_CANVAS_TEXT
GOO_IS_CANVAS_TEXT
GOO_TYPE_CANVAS_TEXT
goo_canvas_text_get_type
GOO_CANVAS_TEXT_CLASS
GOO_IS_CANVAS_TEXT_CLASS
GOO_CANVAS_TEXT_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasrectview</FILE>
<TITLE>GooCanvasRectView</TITLE>
GooCanvasRectView
goo_canvas_rect_view_new
<SUBSECTION Standard>
GOO_CANVAS_RECT_VIEW
GOO_IS_CANVAS_RECT_VIEW
GOO_TYPE_CANVAS_RECT_VIEW
goo_canvas_rect_view_get_type
GOO_CANVAS_RECT_VIEW_CLASS
GOO_IS_CANVAS_RECT_VIEW_CLASS
GOO_CANVAS_RECT_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvaspolyline</FILE>
GooCanvasPoints
GOO_TYPE_CANVAS_POINTS
goo_canvas_points_new
goo_canvas_points_ref
goo_canvas_points_unref
NUM_ARROW_POINTS
GooCanvasPolylineArrowData
<TITLE>GooCanvasPolyline</TITLE>
GooCanvasPolyline
goo_canvas_polyline_get_type
goo_canvas_polyline_new
goo_canvas_polyline_new_line
<SUBSECTION Standard>
GOO_CANVAS_POLYLINE
GOO_IS_CANVAS_POLYLINE
GOO_TYPE_CANVAS_POLYLINE
goo_canvas_points_get_type
GOO_CANVAS_POLYLINE_CLASS
GOO_IS_CANVAS_POLYLINE_CLASS
GOO_CANVAS_POLYLINE_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasmodelsimple</FILE>
<TITLE>GooCanvasModelSimple</TITLE>
GooCanvasModelSimple
goo_canvas_model_simple_new
<SUBSECTION Standard>
GOO_CANVAS_MODEL_SIMPLE
GOO_IS_CANVAS_MODEL_SIMPLE
GOO_TYPE_CANVAS_MODEL_SIMPLE
goo_canvas_model_simple_get_type
GOO_CANVAS_MODEL_SIMPLE_CLASS
GOO_IS_CANVAS_MODEL_SIMPLE_CLASS
GOO_CANVAS_MODEL_SIMPLE_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvaspolylineview</FILE>
<TITLE>GooCanvasPolylineView</TITLE>
GooCanvasPolylineView
goo_canvas_polyline_view_new
<SUBSECTION Standard>
GOO_CANVAS_POLYLINE_VIEW
GOO_IS_CANVAS_POLYLINE_VIEW
GOO_TYPE_CANVAS_POLYLINE_VIEW
goo_canvas_polyline_view_get_type
GOO_CANVAS_POLYLINE_VIEW_CLASS
GOO_IS_CANVAS_POLYLINE_VIEW_CLASS
GOO_CANVAS_POLYLINE_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvaspathview</FILE>
<TITLE>GooCanvasPathView</TITLE>
GooCanvasPathView
goo_canvas_path_view_new
<SUBSECTION Standard>
GOO_CANVAS_PATH_VIEW
GOO_IS_CANVAS_PATH_VIEW
GOO_TYPE_CANVAS_PATH_VIEW
goo_canvas_path_view_get_type
GOO_CANVAS_PATH_VIEW_CLASS
GOO_IS_CANVAS_PATH_VIEW_CLASS
GOO_CANVAS_PATH_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasitemsimple</FILE>
GooCanvasStyleValuesMask
GooCanvasStyle
goo_canvas_style_new
goo_canvas_style_ref
goo_canvas_style_unref
<TITLE>GooCanvasItemSimple</TITLE>
GooCanvasItemSimple
goo_canvas_item_simple_new
goo_canvas_item_simple_set_style
goo_canvas_item_simple_set_fill_options
goo_canvas_item_simple_set_stroke_options
goo_canvas_item_simple_get_path_bounds
goo_canvas_item_simple_user_bounds_to_device
goo_canvas_item_simple_check_in_path
goo_canvas_item_simple_paint_path
goo_canvas_item_simple_emit_changed
<SUBSECTION Standard>
GOO_CANVAS_ITEM_SIMPLE
GOO_IS_CANVAS_ITEM_SIMPLE
GOO_TYPE_CANVAS_ITEM_SIMPLE
goo_canvas_item_simple_get_type
GOO_CANVAS_ITEM_SIMPLE_CLASS
GOO_IS_CANVAS_ITEM_SIMPLE_CLASS
GOO_CANVAS_ITEM_SIMPLE_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasimage</FILE>
<TITLE>GooCanvasImage</TITLE>
GooCanvasImage
goo_canvas_image_new
<SUBSECTION Standard>
GOO_CANVAS_IMAGE
GOO_IS_CANVAS_IMAGE
GOO_TYPE_CANVAS_IMAGE
goo_canvas_image_get_type
GOO_CANVAS_IMAGE_CLASS
GOO_IS_CANVAS_IMAGE_CLASS
GOO_CANVAS_IMAGE_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasimageview</FILE>
<TITLE>GooCanvasImageView</TITLE>
GooCanvasImageView
goo_canvas_image_view_new
<SUBSECTION Standard>
GOO_CANVAS_IMAGE_VIEW
GOO_IS_CANVAS_IMAGE_VIEW
GOO_TYPE_CANVAS_IMAGE_VIEW
goo_canvas_image_view_get_type
GOO_CANVAS_IMAGE_VIEW_CLASS
GOO_IS_CANVAS_IMAGE_VIEW_CLASS
GOO_CANVAS_IMAGE_VIEW_GET_CLASS
</SECTION>

<SECTION>
<FILE>goocanvasutils</FILE>
<TITLE>Utility Functions</TITLE>
goo_canvas_util_ptr_array_insert
goo_canvas_util_ptr_array_move
goo_canvas_util_ptr_array_find_index
GOO_TYPE_CANVAS_POINTER_EVENTS
goo_canvas_pointer_events_get_type
GooCanvasPointerEvents
GOO_TYPE_CANVAS_ITEM_VISIBILITY
goo_canvas_item_visibility_get_type
GooCanvasItemVisibility
GooCairoLineDash
GOO_TYPE_CAIRO_PATTERN
GOO_TYPE_CAIRO_FILL_RULE
GOO_TYPE_CAIRO_OPERATOR
GOO_TYPE_CAIRO_ANTIALIAS
GOO_TYPE_CAIRO_LINE_CAP
GOO_TYPE_CAIRO_LINE_JOIN
GOO_TYPE_CAIRO_LINE_DASH
GOO_TYPE_CAIRO_MATRIX
goo_cairo_pattern_get_type
goo_cairo_fill_rule_get_type
goo_cairo_operator_get_type
goo_cairo_antialias_get_type
goo_cairo_line_cap_get_type
goo_cairo_line_join_get_type
goo_cairo_line_dash_get_type
goo_cairo_matrix_get_type
goo_cairo_line_dash_new
goo_cairo_line_dash_ref
goo_cairo_line_dash_unref
goo_cairo_matrix_copy
goo_canvas_cairo_pattern_from_pixbuf
goo_canvas_cairo_surface_from_pixbuf
</SECTION>

--- NEW FILE: goocanvas.types ---
#include "goocanvasview.h"
#include "goocanvasellipseview.h"
#include "goocanvasgroupview.h"
#include "goocanvasimageview.h"
#include "goocanvasitemview.h"
#include "goocanvaspathview.h"
#include "goocanvaspolylineview.h"
#include "goocanvasrectview.h"
#include "goocanvastextview.h"
#include "goocanvasview.h"

goo_canvas_model_get_type
goo_canvas_view_get_type
goo_canvas_item_get_type
goo_canvas_item_view_get_type
goo_canvas_ellipse_get_type
goo_canvas_ellipse_view_get_type
goo_canvas_group_get_type
goo_canvas_group_view_get_type
goo_canvas_image_get_type
goo_canvas_image_view_get_type
goo_canvas_path_get_type
goo_canvas_path_view_get_type
goo_canvas_polyline_get_type
goo_canvas_polyline_view_get_type
goo_canvas_rect_get_type
goo_canvas_rect_view_get_type
goo_canvas_text_get_type
goo_canvas_text_view_get_type



More information about the cairo-commit mailing list