Added small docs patch from Bill Abt.;

supplements AtkUtil sgml page, and moves return code
exception/range info to "Returns" block.

diff --git a/ChangeLog b/ChangeLog
index 64c1b5f..5f36df3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2005-11-16  Bill Haneman <bill.haneman@sun.com>
+
+       * atk/atkimage.c:
+       * atk/atkhypertext.c:
+       * atk/atkobjectfactory.c:
+       * atk/atktable.c: Moved error return code
+       description to 'Returns' section.
+       * docs/tmpl/atkutil.sgml:
+       Committed a docs patch from Bill Abt.
+       
 2005-11-01  Simos Xenitellis  <simos@gnome.org>
 
        * configure.in: Added tt (Tatar) to ALL_LINGUAS.

diff --git a/atk/atkhypertext.c b/atk/atkhypertext.c
index f216d34..c9b123a 100755 (executable)
--- a/atk/atkhypertext.c
+++ b/atk/atkhypertext.c
@@ -129,10 +129,10 @@ atk_hypertext_get_n_links (AtkHypertext  *hypertext)
  * @char_index: a character index
  *
  * Gets the index into the array of hyperlinks that is associated with
- * the character specified by @char_index, or -1 if there is no hyperlink
- * associated with this character.
+ * the character specified by @char_index.
  *
- * Returns: an index into the array of hyperlinks in @hypertext
+ * Returns: an index into the array of hyperlinks in @hypertext,
+ * or -1 if there is no hyperlink associated with this character.
  **/
 gint 
 atk_hypertext_get_link_index (AtkHypertext  *hypertext,

diff --git a/atk/atkimage.c b/atk/atkimage.c
index 95b2686..f0ab0bd 100755 (executable)
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -141,14 +141,13 @@ atk_image_set_image_description (AtkImage        *image,
 /**
  * atk_image_get_image_position:
  * @image: a #GObject instance that implements AtkImageIface
- * @x: address of #gint to put x coordinate position
- * @y: address of #gint to put y coordinate position
+ * @x: address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
+ * @y: address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
  * @coord_type: specifies whether the coordinates are relative to the screen
  * or to the components top level window
  * 
  * Gets the position of the image in the form of a point specifying the
- * images top-left corner.  The values of @x and @y are returned as -1
- * if the values cannot be obtained.
+ * images top-left corner.
  **/
 void     
 atk_image_get_image_position (AtkImage *image,

diff --git a/atk/atkobjectfactory.c b/atk/atkobjectfactory.c
index c50dddf..81ab3b3 100755 (executable)
--- a/atk/atkobjectfactory.c
+++ b/atk/atkobjectfactory.c
@@ -114,8 +114,8 @@ atk_object_factory_invalidate (AtkObjectFactory *factory)
  * @factory: an #AtkObjectFactory 
  *
  * Gets the GType of the accessible which is created by the factory. 
- * The value G_TYPE_INVALID is returned if no type if found.
  * Returns: the type of the accessible which is created by the @factory.
+ * The value G_TYPE_INVALID is returned if no type if found.
  **/
 GType
 atk_object_factory_get_accessible_type (AtkObjectFactory *factory)

diff --git a/atk/atktable.c b/atk/atktable.c
index ed0ca78..5cecaf6 100755 (executable)
--- a/atk/atktable.c
+++ b/atk/atktable.c
@@ -166,10 +166,10 @@ atk_table_ref_at (AtkTable *table,
  * @column: a #gint representing a column in @table
  *
  * Gets a #gint representing the index at the specified @row and @column.
+ *
+ * Returns: a #gint representing the index at specified position.
  * The value -1 is returned if the object at row,column is not a child
  * of table or table does not implement this interface.
- *
- * Returns: a #gint representing the index at specified position 
  **/
 gint
 atk_table_get_index_at (AtkTable *table,
@@ -195,10 +195,10 @@ atk_table_get_index_at (AtkTable *table,
  * @table: a GObject instance that implements AtkTableInterface
  * @index_: a #gint representing an index in @table
  *
- * Gets a #gint representing the row at the specified @index_, or -1
- * if the table does not implement this interface
+ * Gets a #gint representing the row at the specified @index_.
  *
- * Returns: a gint representing the row at the specified index.
+ * Returns: a gint representing the row at the specified index,
+ * or -1 if the table does not implement this interface
  **/
 gint
 atk_table_get_row_at_index (AtkTable *table,
@@ -221,10 +221,10 @@ atk_table_get_row_at_index (AtkTable *table,
  * @table: a GObject instance that implements AtkTableInterface
  * @index_: a #gint representing an index in @table
  *
- * Gets a #gint representing the column at the specified @index_, or -1
- * if the table does not implement this interface
+ * Gets a #gint representing the column at the specified @index_. 
  *
- * Returns: a gint representing the column at the specified index.
+ * Returns: a gint representing the column at the specified index,
+ * or -1 if the table does not implement this interface
  **/
 gint
 atk_table_get_column_at_index (AtkTable *table,

diff --git a/atk/atkutil.c b/atk/atkutil.c
index 5e4cdab..11698bf 100755 (executable)
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -81,7 +81,7 @@ struct _FocusTracker {
 
 /**
  * atk_focus_tracker_init:
- * @add_function: Function to be called for focus tracker initialization
+ * @init: Function to be called for focus tracker initialization
  *
  * Specifies the function to be called for focus tracker initialization.
  * This function should be called by an implementation of the

diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml
index dddb115..c715f41 100644 (file)
--- a/docs/tmpl/atkutil.sgml
+++ b/docs/tmpl/atkutil.sgml
@@ -17,6 +17,9 @@ same thread. The file also contains a number of utility functions.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT AtkUtil ##### -->
 <para>
 The AtkObject structure should not be accessed directly.
@@ -72,7 +75,7 @@ such as receiving focus, occurs. The parameter of the AtkEventListener is the
 AtkObject on which the event occurred.
 </para>
 
-@Param1: 
+@Param1: an #AtkObject
 
 
 <!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
@@ -130,9 +133,9 @@ The AtkKeyEventStruct describes a keyboard event.
 An AtkKeySnoopFunc is a function which is called when a keyboard event occurs.
 </para>
 
-@event: 
-@func_data: 
-@Returns: 
+@event: keyboard event
+@func_data: a data gpointer for the function
+@Returns: return code
 
 
 <!-- ##### FUNCTION atk_add_key_event_listener ##### -->