Refer to return value in function documentation for atk_action_do_action

* atk/atkaction.c:
Refer to return value in function documentation for
atk_action_do_action
* atk/atkimage.c:
Fix typo in comments
* docs/tmpl/atkaction.sgml:
Update to include return value

diff --git a/ChangeLog b/ChangeLog
index d591b19..c402267 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,10 +1,20 @@
-<2001-08-22  Marc Mulcahy <marc.mulcahy@sun.com>
-       AtkAction.c AtkAction.h:
-               Made atk_action_do_action return a gboolean as the class member of AtkActionIface does.
+2001-08-23  Padraig O'Briain  <padraig.obriain@sun.com>
 
-       .cvsignore:
-               Added atk.spec
+       * atk/atkaction.c:
+       Refer to return value in function documentation for 
+       atk_action_do_action
+       * atk/atkimage.c:
+       Fix typo in comments
+       * docs/tmpl/atkaction.sgml:
+       Update to include return value
+
+2001-08-22  Marc Mulcahy <marc.mulcahy@sun.com>
 
+       * atk/atkaction.c atk/atkaction.h:
+       Made atk_action_do_action return a gboolean as the class member of 
+       AtkActionIface does.
+       * .cvsignore:
+       Added atk.spec
 
 2001-08-20  Padraig O'Briain  <padraig.obriain@sun.com>
 

diff --git a/atk/atkaction.c b/atk/atkaction.c
index 7962df4..fbf26f7 100755 (executable)
--- a/atk/atkaction.c
+++ b/atk/atkaction.c
@@ -45,6 +45,9 @@ atk_action_get_type ()
  * @i: the action index corresponding to the action to be performed 
  *
  * Perform the specified action on the object.
+ *
+ * Returns: %TRUE if success, %FALSE otherwise
+ *
  **/
 gboolean
 atk_action_do_action (AtkAction *obj,

diff --git a/atk/atkimage.c b/atk/atkimage.c
index c8a719d..54477f6 100755 (executable)
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -72,7 +72,7 @@ atk_image_get_image_description (AtkImage *image)
  * @width: filled with the image width
  * @height: filled with the image height
  *
- * Get the wdith and height in pixels for the specified image.
+ * Get the width and height in pixels for the specified image.
  * The values of @width and @height are returned as -1 if the
  * values cannot be obtained.
  **/

diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml
index 349c0e9..f744c7d 100644 (file)
--- a/docs/tmpl/atkaction.sgml
+++ b/docs/tmpl/atkaction.sgml
@@ -44,6 +44,7 @@ be manipulated should support this interface.
 
 @action: 
 @i: 
+@Returns: 
 
 
 <!-- ##### FUNCTION atk_action_get_n_actions ##### -->