GNOME.org
 

[PATCH] libgnomecanvas documentation cleanup

Hi!

Currently the libgnomecanvas documentation is a mess. Attached is a
patch that revamps the TOC and adds all unused doc strings to the
appropriate chapters. I've left out all changes to docs/reference/tmpl,
to minize the size of the attached patch. Since all files in there are
auto-generated anyways, I don't understand, why they are in CVS at all.

2002-04-28  Sebastian Rittau  <srittau jroger in-berlin de>

       * libgnomecanvas/gnome-canvas-path-def.c:
       (gnome_canvas_path_def_all_open): Document.
       (gnome_canvas_path_def_all_closed): Fixed typos in doc string.

       * libgnomecanvas/gnome-canvas-util.c:
       (gnome_canvas_update_bbox): Fixed doc string.
       (gnome_canvas_buf_ensure_buf): dito
       * libgnomecanvas/gnome-canvas.c:
       (gnome_canvas_new): dito
       (gnome_canvas_new_aa): dito

       * docs/reference/libgnomecanvas-docs.sgml:
       * docs/reference/libgnomecanvas-sections.txt:
       * docs/reference/tmpl/*.sgml
       Reorganized the chapter structure, gave document a name.

Okay to commit?

 - Sebastian

--- ChangeLog	26 Apr 2002 02:42:31 -0000	1.91
+++ ChangeLog	28 Apr 2002 14:13:31 -0000
@@ -1,3 +1,21 @@
+2002-04-28  Sebastian Rittau  <srittau jroger in-berlin de>
+
+	* libgnomecanvas/gnome-canvas-path-def.c:
+	(gnome_canvas_path_def_all_open): Document.
+	(gnome_canvas_path_def_all_closed): Fixed typos in doc string.
+
+	* libgnomecanvas/gnome-canvas-util.c:
+	(gnome_canvas_update_bbox): Fixed doc string.
+	(gnome_canvas_buf_ensure_buf): dito
+	* libgnomecanvas/gnome-canvas.c:
+	(gnome_canvas_new): dito
+	(gnome_canvas_new_aa): dito
+
+	* docs/reference/libgnomecanvas-docs.sgml:
+	* docs/reference/libgnomecanvas-sections.txt:
+	* docs/reference/tmpl/*.sgml
+	Reorganized the chapter structure, gave document a name.
+
 2002-04-25  Jody Goldberg <jody gnome org>
 
 	* libgnomecanvas/gnome-canvas-shape.c (gnome_canvas_shape_update_gdk)
--- docs/reference/libgnomecanvas-docs.sgml	2 Dec 2001 03:40:57 -0000	1.1
+++ docs/reference/libgnomecanvas-docs.sgml	28 Apr 2002 14:13:31 -0000
@@ -1,43 +1,45 @@
 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 <!ENTITY libgnomecanvas-GnomeCanvasBpath SYSTEM "sgml/gnome-canvas-bpath.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasClipgroup SYSTEM "sgml/gnome-canvas-clipgroup.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasEllipse SYSTEM "sgml/gnome-canvas-rect-ellipse.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasGroup SYSTEM "sgml/gnome-canvas-group.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasItem SYSTEM "sgml/gnome-canvas-item.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasLine SYSTEM "sgml/gnome-canvas-line.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasPixbuf SYSTEM "sgml/gnome-canvas-pixbuf.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasPolygon SYSTEM "sgml/gnome-canvas-polygon.sgml">
-<!ENTITY libgnomecanvas-GnomeCanvasEllipse SYSTEM "sgml/gnome-canvas-rect-ellipse.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasRE SYSTEM "sgml/gnome-canvas-re.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasRect SYSTEM "sgml/gnome-canvas-rect.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasRichText SYSTEM "sgml/gnome-canvas-rich-text.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasShape SYSTEM "sgml/gnome-canvas-shape.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasText SYSTEM "sgml/gnome-canvas-text.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvasWidget SYSTEM "sgml/gnome-canvas-widget.sgml">
 <!ENTITY libgnomecanvas-GnomeCanvas SYSTEM "sgml/gnome-canvas.sgml">
-<!ENTITY libgnomecanvas-gnome-canvas-i18n SYSTEM "sgml/gnome-canvas-i18n.sgml">
-<!ENTITY libgnomecanvas-gnome-canvas-marshal SYSTEM "sgml/gnome-canvas-marshal.sgml">
-<!ENTITY libgnomecanvas-gnome-canvas-path-def SYSTEM "sgml/gnome-canvas-path-def.sgml">
+<!ENTITY libgnomecanvas-GnomeCanvasPathDef SYSTEM "sgml/gnome-canvas-path-def.sgml">
 <!ENTITY libgnomecanvas-gnome-canvas-util SYSTEM "sgml/gnome-canvas-util.sgml">
-<!ENTITY libgnomecanvas-libgnomecanvas SYSTEM "sgml/libgnomecanvas.sgml">
 ]>
 <book id="index">
   <bookinfo>
-    <title>[Insert name here] Reference Manual</title>
+    <title>GNOME Canvas Library Reference Manual</title>
   </bookinfo>
 
   <chapter>
-    <title>[Insert title here]</title>
+    <title>GNOME Canvas Library (libgnomecanvas)</title>
+    &libgnomecanvas-GnomeCanvas;
     &libgnomecanvas-GnomeCanvasBpath;
     &libgnomecanvas-GnomeCanvasClipgroup;
+    &libgnomecanvas-GnomeCanvasEllipse;
+    &libgnomecanvas-GnomeCanvasGroup;
+    &libgnomecanvas-GnomeCanvasItem;
     &libgnomecanvas-GnomeCanvasLine;
     &libgnomecanvas-GnomeCanvasPixbuf;
     &libgnomecanvas-GnomeCanvasPolygon;
-    &libgnomecanvas-GnomeCanvasEllipse;
+    &libgnomecanvas-GnomeCanvasRE;
+    &libgnomecanvas-GnomeCanvasRect;
     &libgnomecanvas-GnomeCanvasRichText;
     &libgnomecanvas-GnomeCanvasShape;
     &libgnomecanvas-GnomeCanvasText;
     &libgnomecanvas-GnomeCanvasWidget;
-    &libgnomecanvas-GnomeCanvas;
-    &libgnomecanvas-gnome-canvas-i18n;
-    &libgnomecanvas-gnome-canvas-marshal;
-    &libgnomecanvas-gnome-canvas-path-def;
+    &libgnomecanvas-GnomeCanvasPathDef;
     &libgnomecanvas-gnome-canvas-util;
-    &libgnomecanvas-libgnomecanvas;
   </chapter>
 </book>
--- docs/reference/libgnomecanvas-sections.txt	2 Dec 2001 03:40:57 -0000	1.1
+++ docs/reference/libgnomecanvas-sections.txt	28 Apr 2002 14:13:32 -0000
@@ -1,7 +1,10 @@
+<INCLUDE>libgnomecanvas/libgnomecanvas.h</INCLUDE>
+
 <SECTION>
 <FILE>gnome-canvas-bpath</FILE>
-GnomeCanvasBpathPriv
 <TITLE>GnomeCanvasBpath</TITLE>
+GnomeCanvasBpath
+GnomeCanvasBpathPriv
 <SUBSECTION Standard>
 GNOME_CANVAS_BPATH
 GNOME_IS_CANVAS_BPATH
@@ -14,6 +17,7 @@
 <SECTION>
 <FILE>gnome-canvas-clipgroup</FILE>
 <TITLE>GnomeCanvasClipgroup</TITLE>
+GnomeCanvasClipgroup
 <SUBSECTION Standard>
 GNOME_CANVAS_CLIPGROUP
 GNOME_IS_CANVAS_CLIPGROUP
@@ -24,8 +28,75 @@
 </SECTION>
 
 <SECTION>
+<FILE>gnome-canvas-ellipse</FILE>
+<TITLE>GnomeCanvasEllipse</TITLE>
+GnomeCanvasEllipse
+<SUBSECTION Standard>
+GNOME_TYPE_CANVAS_ELLIPSE
+GNOME_CANVAS_ELLIPSE
+gnome_canvas_ellipse_get_type
+GNOME_CANVAS_ELLIPSE_CLASS
+GNOME_IS_CANVAS_ELLIPSE
+GNOME_IS_CANVAS_ELLIPSE_CLASS
+GNOME_CANVAS_ELLIPSE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gnome-canvas-group</FILE>
+<TITLE>GnomeCanvasGroup</TITLE>
+GnomeCanvasGroup
+<SUBSECTION Standard>
+GNOME_TYPE_CANVAS_GROUP
+GNOME_CANVAS_GROUP
+gnome_canvas_group_get_type
+GNOME_CANVAS_GROUP_CLASS
+GNOME_IS_CANVAS_GROUP
+GNOME_IS_CANVAS_GROUP_CLASS
+GNOME_CANVAS_GROUP_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gnome-canvas-item</FILE>
+<TITLE>GnomeCanvasItem</TITLE>
+GnomeCanvasItem
+<SUBSECTION>
+gnome_canvas_item_new
+gnome_canvas_item_construct
+gnome_canvas_item_set
+gnome_canvas_item_set_valist
+gnome_canvas_item_move
+gnome_canvas_item_affine_relative
+gnome_canvas_item_affine_absolute
+gnome_canvas_item_raise
+gnome_canvas_item_lower
+gnome_canvas_item_raise_to_top
+gnome_canvas_item_lower_to_bottom
+gnome_canvas_item_show
+gnome_canvas_item_hide
+gnome_canvas_item_grab
+gnome_canvas_item_ungrab
+gnome_canvas_item_w2i
+gnome_canvas_item_i2w
+gnome_canvas_item_i2w_affine
+gnome_canvas_item_i2c_affine
+gnome_canvas_item_reparent
+gnome_canvas_item_grab_focus
+gnome_canvas_item_get_bounds
+gnome_canvas_item_request_update
+<SUBSECTION Standard>
+GNOME_CANVAS_ITEM
+GNOME_IS_CANVAS_ITEM
+GNOME_TYPE_CANVAS_ITEM
+gnome_canvas_item_get_type
+GNOME_CANVAS_ITEM_CLASS
+GNOME_IS_CANVAS_ITEM_CLASS
+GNOME_CANVAS_ITEM_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>gnome-canvas-line</FILE>
 <TITLE>GnomeCanvasLine</TITLE>
+GnomeCanvasLine
 <SUBSECTION Standard>
 GNOME_CANVAS_LINE
 GNOME_IS_CANVAS_LINE
@@ -39,6 +110,7 @@
 <SECTION>
 <FILE>gnome-canvas-pixbuf</FILE>
 <TITLE>GnomeCanvasPixbuf</TITLE>
+GnomeCanvasPixbuf
 <SUBSECTION Standard>
 GNOME_CANVAS_PIXBUF
 GNOME_IS_CANVAS_PIXBUF
@@ -52,6 +124,7 @@
 <SECTION>
 <FILE>gnome-canvas-polygon</FILE>
 <TITLE>GnomeCanvasPolygon</TITLE>
+GnomeCanvasPolygon
 <SUBSECTION Standard>
 GNOME_CANVAS_POLYGON
 GNOME_IS_CANVAS_POLYGON
@@ -63,24 +136,9 @@
 </SECTION>
 
 <SECTION>
-<FILE>gnome-canvas-rect-ellipse</FILE>
+<FILE>gnome-canvas-re</FILE>
 <TITLE>GnomeCanvasRE</TITLE>
-GNOME_TYPE_CANVAS_RECT
-GNOME_CANVAS_RECT
-GNOME_CANVAS_RECT_CLASS
-GNOME_IS_CANVAS_RECT
-GNOME_IS_CANVAS_RECT_CLASS
-GNOME_CANVAS_RECT_GET_CLASS
-<TITLE>GnomeCanvasRect</TITLE>
-gnome_canvas_rect_get_type
-GNOME_TYPE_CANVAS_ELLIPSE
-GNOME_CANVAS_ELLIPSE
-GNOME_CANVAS_ELLIPSE_CLASS
-GNOME_IS_CANVAS_ELLIPSE
-GNOME_IS_CANVAS_ELLIPSE_CLASS
-GNOME_CANVAS_ELLIPSE_GET_CLASS
-<TITLE>GnomeCanvasEllipse</TITLE>
-gnome_canvas_ellipse_get_type
+GnomeCanvasRE
 <SUBSECTION Standard>
 GNOME_CANVAS_RE
 GNOME_IS_CANVAS_RE
@@ -92,14 +150,32 @@
 </SECTION>
 
 <SECTION>
+<FILE>gnome-canvas-rect</FILE>
+<TITLE>GnomeCanvasRect</TITLE>
+GnomeCanvasRect
+<SUBSECTION Standard>
+GNOME_TYPE_CANVAS_RECT
+GNOME_CANVAS_RECT
+gnome_canvas_rect_get_type
+GNOME_CANVAS_RECT_CLASS
+GNOME_IS_CANVAS_RECT
+GNOME_IS_CANVAS_RECT_CLASS
+GNOME_CANVAS_RECT_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>gnome-canvas-rich-text</FILE>
-GnomeCanvasRichTextPrivate
 <TITLE>GnomeCanvasRichText</TITLE>
+GnomeCanvasRichText
+GnomeCanvasRichTextPrivate
+<SUBSECTION>
 gnome_canvas_rich_text_cut_clipboard
 gnome_canvas_rich_text_copy_clipboard
 gnome_canvas_rich_text_paste_clipboard
 gnome_canvas_rich_text_set_buffer
 gnome_canvas_rich_text_get_buffer
+gnome_canvas_rich_text_get_iter_location
+gnome_canvas_rich_text_get_iter_at_location
 <SUBSECTION Standard>
 GNOME_CANVAS_RICH_TEXT
 GNOME_IS_CANVAS_RICH_TEXT
@@ -112,8 +188,10 @@
 
 <SECTION>
 <FILE>gnome-canvas-shape</FILE>
-GnomeCanvasShapePriv
 <TITLE>GnomeCanvasShape</TITLE>
+GnomeCanvasShape
+GnomeCanvasShapePriv
+<SUBSECTION>
 gnome_canvas_shape_set_path_def
 gnome_canvas_shape_get_path_def
 <SUBSECTION Standard>
@@ -127,8 +205,9 @@
 
 <SECTION>
 <FILE>gnome-canvas-text</FILE>
-GnomeCanvasTextPrivate
 <TITLE>GnomeCanvasText</TITLE>
+GnomeCanvasText
+GnomeCanvasTextPrivate
 <SUBSECTION Standard>
 GNOME_CANVAS_TEXT
 GNOME_IS_CANVAS_TEXT
@@ -142,6 +221,7 @@
 <SECTION>
 <FILE>gnome-canvas-widget</FILE>
 <TITLE>GnomeCanvasWidget</TITLE>
+GnomeCanvasWidget
 <SUBSECTION Standard>
 GNOME_CANVAS_WIDGET
 GNOME_IS_CANVAS_WIDGET
@@ -154,57 +234,17 @@
 
 <SECTION>
 <FILE>gnome-canvas</FILE>
-GNOME_CANVAS_EPSILON
-GNOME_CANVAS_COLOR
-GNOME_CANVAS_COLOR_A
-GnomeCanvasBuf
-<TITLE>GnomeCanvasItem</TITLE>
-gnome_canvas_item_new
-gnome_canvas_item_construct
-gnome_canvas_item_set
-gnome_canvas_item_set_valist
-gnome_canvas_item_move
-gnome_canvas_item_affine_relative
-gnome_canvas_item_affine_absolute
-gnome_canvas_item_scale
-gnome_canvas_item_rotate
-gnome_canvas_item_raise
-gnome_canvas_item_lower
-gnome_canvas_item_raise_to_top
-gnome_canvas_item_lower_to_bottom
-gnome_canvas_item_show
-gnome_canvas_item_hide
-gnome_canvas_item_grab
-gnome_canvas_item_ungrab
-gnome_canvas_item_w2i
-gnome_canvas_item_i2w
-gnome_canvas_item_i2w_affine
-gnome_canvas_item_i2c_affine
-gnome_canvas_item_reparent
-gnome_canvas_item_grab_focus
-gnome_canvas_item_get_bounds
-gnome_canvas_item_request_update
-GNOME_TYPE_CANVAS_GROUP
-GNOME_CANVAS_GROUP
-GNOME_CANVAS_GROUP_CLASS
-GNOME_IS_CANVAS_GROUP
-GNOME_IS_CANVAS_GROUP_CLASS
-GNOME_CANVAS_GROUP_GET_CLASS
-<TITLE>GnomeCanvasGroup</TITLE>
-gnome_canvas_group_get_type
-GNOME_TYPE_CANVAS
-GNOME_CANVAS
-GNOME_CANVAS_CLASS
-GNOME_IS_CANVAS
-GNOME_IS_CANVAS_CLASS
-GNOME_CANVAS_GET_CLASS
 <TITLE>GnomeCanvas</TITLE>
-gnome_canvas_get_type
+GnomeCanvas
+GnomeCanvasBuf
+<SUBSECTION>
 gnome_canvas_new
 gnome_canvas_new_aa
 gnome_canvas_root
 gnome_canvas_set_scroll_region
 gnome_canvas_get_scroll_region
+gnome_canvas_set_center_scroll_region
+gnome_canvas_get_center_scroll_region
 gnome_canvas_set_pixels_per_unit
 gnome_canvas_scroll_to
 gnome_canvas_get_scroll_offsets
@@ -224,35 +264,20 @@
 gnome_canvas_set_dither
 gnome_canvas_get_dither
 <SUBSECTION Standard>
-GNOME_CANVAS_ITEM
-GNOME_IS_CANVAS_ITEM
-GNOME_TYPE_CANVAS_ITEM
-gnome_canvas_item_get_type
-GNOME_CANVAS_ITEM_CLASS
-GNOME_IS_CANVAS_ITEM_CLASS
-GNOME_CANVAS_ITEM_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>gnome-canvas-i18n</FILE>
-_
-N_
-textdomain
-gettext
-dgettext
-dcgettext
-bindtextdomain
-</SECTION>
-
-<SECTION>
-<FILE>gnome-canvas-marshal</FILE>
-gnome_canvas_marshal_VOID__OBJECT_INT_INT_INT_INT
-gnome_canvas_marshal_BOOLEAN__BOXED
+GNOME_TYPE_CANVAS
+GNOME_CANVAS
+gnome_canvas_get_type
+GNOME_CANVAS_CLASS
+GNOME_IS_CANVAS
+GNOME_IS_CANVAS_CLASS
+GNOME_CANVAS_GET_CLASS
 </SECTION>
 
 <SECTION>
 <FILE>gnome-canvas-path-def</FILE>
+<TITLE>GnomeCanvasPathDef</TITLE>
 GnomeCanvasPathDef
+<SUBSECTION>
 gnome_canvas_path_def_new
 gnome_canvas_path_def_new_sized
 gnome_canvas_path_def_new_from_bpath
@@ -291,6 +316,10 @@
 
 <SECTION>
 <FILE>gnome-canvas-util</FILE>
+GNOME_CANVAS_EPSILON
+GNOME_CANVAS_COLOR
+GNOME_CANVAS_COLOR_A
+<SUBSECTION>
 GnomeCanvasPoints
 gnome_canvas_points_new
 gnome_canvas_points_ref
@@ -310,11 +339,19 @@
 gnome_canvas_buf_ensure_buf
 gnome_canvas_join_gdk_to_art
 gnome_canvas_cap_gdk_to_art
-</SECTION>
-
-<SECTION>
-<FILE>libgnomecanvas</FILE>
+<SUBSECTION Standard>
 gnome_canvas_points_get_type
 GNOME_TYPE_CANVAS_POINTS
 </SECTION>
 
+<SECTION>
+_
+N_
+gettext
+dgettext
+dcgettext
+textdomain
+bindtextdomain
+gnome_canvas_marshal_BOOLEAN__BOXED
+gnome_canvas_marshal_VOID__OBJECT_INT_INT_INT_INT
+</SECTION>
--- libgnomecanvas/gnome-canvas-path-def.c	28 Jun 2001 16:03:29 -0000	1.5
+++ libgnomecanvas/gnome-canvas-path-def.c	28 Apr 2002 14:13:34 -0000
@@ -1110,6 +1110,15 @@
 	return (!path->allclosed);
 }
 
+/**
+ * gnome_canvas_path_def_all_open:
+ * @path: a GnomeCanvasPathDef
+ *
+ * This function returns a boolean value indicating if the path only
+ * contains open segments.
+ *
+ * Returns: boolean, indicating if the path has all open segments.
+ */
 gboolean
 gnome_canvas_path_def_all_open (const GnomeCanvasPathDef * path)
 {
@@ -1139,10 +1148,10 @@
  * gnome_canvas_path_def_all_closed:
  * @path: a GnomeCanvasPathDef
  *
- * This function returns a boolean valid indicating if the path only
+ * This function returns a boolean value indicating if the path only
  * contains closed segments.
  *
- * Returns: boolean, idicating if the path has all closed segments.
+ * Returns: boolean, indicating if the path has all closed segments.
  */
 gboolean
 gnome_canvas_path_def_all_closed (const GnomeCanvasPathDef * path)
--- libgnomecanvas/gnome-canvas-util.c	16 Jan 2002 03:10:23 -0000	1.24
+++ libgnomecanvas/gnome-canvas-util.c	28 Apr 2002 14:13:36 -0000
@@ -599,7 +599,7 @@
 
 /**
  * gnome_canvas_update_bbox:
- * @canvas: the canvas needing update
+ * @item: the canvas item needing update
  * @x1: Left coordinate of the new bounding box
  * @y1: Top coordinate of the new bounding box
  * @x2: Right coordinate of the new bounding box
@@ -619,7 +619,7 @@
 }
 
 /**
- * gnome_canvas_ensure_buf
+ * gnome_canvas_buf_ensure_buf:
  * @buf: the buf that needs to be represened in RGB format
  *
  * Ensure that the buffer is in RGB format, suitable for compositing.
--- libgnomecanvas/gnome-canvas.c	22 Apr 2002 10:00:16 -0000	1.158
+++ libgnomecanvas/gnome-canvas.c	28 Apr 2002 14:13:44 -0000
@@ -2190,7 +2190,6 @@
 
 /**
  * gnome_canvas_new:
- * @void:
  *
  * Creates a new empty canvas in non-antialiased mode.  If you wish to use the
  * &GnomeCanvasImage item inside this canvas, then you must push the gdk_imlib
@@ -2207,7 +2206,6 @@
 
 /**
  * gnome_canvas_new_aa:
- * @void:
  *
  * Creates a new empty canvas in antialiased mode.  You should push the GdkRGB
  * visual and colormap before calling this functions, and they can be popped
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]