Documentation fixes for ref/unref methods that no longer return ints.

git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@160 e2bd861d-eb25-0410-b326-f6ed22b6b98c

diff --git a/ChangeLog b/ChangeLog
index caed7b9..caded9d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2001-12-10  Bill Haneman  <bill.haneman@sun.com>
+
+       * cspi/spi_action.c:
+       * cspi/spi_accessible.c:
+       * cspi/spi_application.c:
+       * cspi/spi_component.c:
+       * cspi/spi_selection.c:
+       * cspi/spi_text.c:
+       * cspi/spi_value.c:
+       Documentation fixes (removed return values from ref/unref methods).
+
 2001-12-10  Michael Meeks  <michael@ximian.com>
 
        * cspi/spi_action.c: audit for exception handling,

diff --git a/cspi/spi_accessible.c b/cspi/spi_accessible.c
index ca366c1..2f753da 100644 (file)
--- a/cspi/spi_accessible.c
+++ b/cspi/spi_accessible.c
@@ -108,8 +108,6 @@ AccessibleRole_getName (AccessibleRole role)
  *
  * Increment the reference count for an #Accessible object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 Accessible_ref (Accessible *obj)
@@ -740,7 +738,6 @@ Accessible_queryInterface (Accessible *obj,
  *
  * Increment the reference count for an #AccessibleRelation object.
  *
- * Returns: (no return code implemented yet).
  **/
 void
 AccessibleRelation_ref (AccessibleRelation *obj)
@@ -754,7 +751,6 @@ AccessibleRelation_ref (AccessibleRelation *obj)
  *
  * Decrement the reference count for an #AccessibleRelation object.
  *
- * Returns: (no return code implemented yet).
  **/
 void
 AccessibleRelation_unref (AccessibleRelation *obj)
@@ -823,8 +819,6 @@ AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
  *
  * Increment the reference count for an #AccessibleStateSet object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleStateSet_ref (AccessibleStateSet *obj)
@@ -838,8 +832,6 @@ AccessibleStateSet_ref (AccessibleStateSet *obj)
  *
  * Decrement the reference count for an #AccessibleStateSet object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleStateSet_unref (AccessibleStateSet *obj)

diff --git a/cspi/spi_action.c b/cspi/spi_action.c
index 507af16..ab50427 100644 (file)
--- a/cspi/spi_action.c
+++ b/cspi/spi_action.c
@@ -6,8 +6,6 @@
  *
  * Increment the reference count for an #AccessibleAction.
  *
- * Returns: 0 (no return code implemented yet).
- *
  **/
 void
 AccessibleAction_ref (AccessibleAction *obj)
@@ -21,8 +19,6 @@ AccessibleAction_ref (AccessibleAction *obj)
  *
  * Decrement the reference count for an #AccessibleAction.
  *
- * Returns: 0 (no return code implemented yet).
- *
  **/
 void
 AccessibleAction_unref (AccessibleAction *obj)

diff --git a/cspi/spi_application.c b/cspi/spi_application.c
index d6ec2aa..7ed57d7 100644 (file)
--- a/cspi/spi_application.c
+++ b/cspi/spi_application.c
@@ -12,7 +12,6 @@
  *
  * Increment the reference count for an #AccessibleApplication.
  *
- * Returns: (no return code implemented yet).
  **/
 void
 AccessibleApplication_ref (AccessibleApplication *obj)
@@ -26,7 +25,6 @@ AccessibleApplication_ref (AccessibleApplication *obj)
  *
  * Decrement the reference count for an #AccessibleApplication.
  *
- * Returns: (no return code implemented yet).
  **/
 void
 AccessibleApplication_unref (AccessibleApplication *obj)

diff --git a/cspi/spi_component.c b/cspi/spi_component.c
index 2d25593..52ef98e 100644 (file)
--- a/cspi/spi_component.c
+++ b/cspi/spi_component.c
@@ -12,8 +12,6 @@
  *
  * Increment the reference count for an #AccessibleComponent.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleComponent_ref (AccessibleComponent *obj)
@@ -27,8 +25,6 @@ AccessibleComponent_ref (AccessibleComponent *obj)
  *
  * Decrement the reference count for an #AccessibleComponent.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleComponent_unref (AccessibleComponent *obj)

diff --git a/cspi/spi_selection.c b/cspi/spi_selection.c
index e8c4e0c..25f45b2 100644 (file)
--- a/cspi/spi_selection.c
+++ b/cspi/spi_selection.c
@@ -6,8 +6,6 @@
  *
  * Increment the reference count for an #AccessibleSelection object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleSelection_ref (AccessibleSelection *obj)
@@ -21,8 +19,6 @@ AccessibleSelection_ref (AccessibleSelection *obj)
  *
  * Decrement the reference count for an #Accessible object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleSelection_unref (AccessibleSelection *obj)

diff --git a/cspi/spi_text.c b/cspi/spi_text.c
index eb69fd4..a49adbd 100644 (file)
--- a/cspi/spi_text.c
+++ b/cspi/spi_text.c
@@ -6,8 +6,6 @@
  *
  * Increment the reference count for an #AccessibleText object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleText_ref (AccessibleText *obj)
@@ -21,8 +19,6 @@ AccessibleText_ref (AccessibleText *obj)
  *
  * Decrement the reference count for an #AccessibleText object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleText_unref (AccessibleText *obj)

diff --git a/cspi/spi_value.c b/cspi/spi_value.c
index be4dd51..6e299b3 100644 (file)
--- a/cspi/spi_value.c
+++ b/cspi/spi_value.c
@@ -6,8 +6,6 @@
  *
  * Increment the reference count for an #AccessibleValue object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleValue_ref (AccessibleValue *obj)
@@ -21,8 +19,6 @@ AccessibleValue_ref (AccessibleValue *obj)
  *
  * Decrement the reference count for an #AccessibleValue object.
  *
- * Returns: (no return code implemented yet).
- *
  **/
 void
 AccessibleValue_unref (AccessibleValue *obj)

diff --git a/docs/reference/cspi/tmpl/spi_accessible.sgml b/docs/reference/cspi/tmpl/spi_accessible.sgml
index 6f6e954..ad381a3 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_accessible.sgml
+++ b/docs/reference/cspi/tmpl/spi_accessible.sgml
@@ -20,6 +20,7 @@ Accessible Objects
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ Accessible Objects
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_action.sgml b/docs/reference/cspi/tmpl/spi_action.sgml
index d07a721..4674885 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_action.sgml
+++ b/docs/reference/cspi/tmpl/spi_action.sgml
@@ -20,6 +20,7 @@ AccessibleAction Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleAction Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_application.sgml b/docs/reference/cspi/tmpl/spi_application.sgml
index fa6e50e..dafab29 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_application.sgml
+++ b/docs/reference/cspi/tmpl/spi_application.sgml
@@ -20,6 +20,7 @@ AccessibleApplication API
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleApplication API
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_component.sgml b/docs/reference/cspi/tmpl/spi_component.sgml
index a1d35dc..a8a87fb 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_component.sgml
+++ b/docs/reference/cspi/tmpl/spi_component.sgml
@@ -28,6 +28,7 @@ AccessibleComponent Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -37,6 +38,7 @@ AccessibleComponent Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_editabletext.sgml b/docs/reference/cspi/tmpl/spi_editabletext.sgml
index 3628b95..730d515 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_editabletext.sgml
+++ b/docs/reference/cspi/tmpl/spi_editabletext.sgml
@@ -20,6 +20,7 @@ AccessibleEditableText Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleEditableText Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_hypertext.sgml b/docs/reference/cspi/tmpl/spi_hypertext.sgml
index 29ca228..5a7f2c0 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_hypertext.sgml
+++ b/docs/reference/cspi/tmpl/spi_hypertext.sgml
@@ -20,6 +20,7 @@ AccessibleHypertext Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleHypertext Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_image.sgml b/docs/reference/cspi/tmpl/spi_image.sgml
index fd319ec..32f036e 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_image.sgml
+++ b/docs/reference/cspi/tmpl/spi_image.sgml
@@ -20,6 +20,7 @@ AccessibleImage Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleImage Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_relation.sgml b/docs/reference/cspi/tmpl/spi_relation.sgml
index 7cee90b..f7459e7 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_relation.sgml
+++ b/docs/reference/cspi/tmpl/spi_relation.sgml
@@ -31,6 +31,7 @@ AccessibleRelations and RelationSets
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -40,6 +41,7 @@ AccessibleRelations and RelationSets
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_selection.sgml b/docs/reference/cspi/tmpl/spi_selection.sgml
index ea00784..d46f4ae 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_selection.sgml
+++ b/docs/reference/cspi/tmpl/spi_selection.sgml
@@ -20,6 +20,7 @@ AccessibleSelection Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleSelection Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_stateset.sgml b/docs/reference/cspi/tmpl/spi_stateset.sgml
index 8d95b27..080d948 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_stateset.sgml
+++ b/docs/reference/cspi/tmpl/spi_stateset.sgml
@@ -54,6 +54,7 @@ State and StateSets
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -63,6 +64,7 @@ State and StateSets
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_table.sgml b/docs/reference/cspi/tmpl/spi_table.sgml
index 5b41e55..331c16a 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_table.sgml
+++ b/docs/reference/cspi/tmpl/spi_table.sgml
@@ -20,6 +20,7 @@ AccessibleTable Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleTable Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_text.sgml b/docs/reference/cspi/tmpl/spi_text.sgml
index 7f4bee0..c4e6c77 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_text.sgml
+++ b/docs/reference/cspi/tmpl/spi_text.sgml
@@ -35,6 +35,7 @@ AccessibleText Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -44,6 +45,7 @@ AccessibleText Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 

diff --git a/docs/reference/cspi/tmpl/spi_value.sgml b/docs/reference/cspi/tmpl/spi_value.sgml
index 4c786e5..ad6401d 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_value.sgml
+++ b/docs/reference/cspi/tmpl/spi_value.sgml
@@ -20,6 +20,7 @@ AccessibleValue Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -29,6 +30,7 @@ AccessibleValue Interface
 </para>
 
 @obj: 
+<!-- # Unused Parameters # -->
 @Returns: