Added docs for SPI_freeString, and used it to stop memory leak of strings

[platform/core/uifw/at-spi2-atk.git] / cspi / spi_hypertext.c

diff --git a/cspi/spi_hypertext.c b/cspi/spi_hypertext.c
index 64cc99d..2c8128c 100644 (file)
--- a/cspi/spi_hypertext.c
+++ b/cspi/spi_hypertext.c
@@ -1,47 +1,106 @@
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleHypertext_ref:
+ * @obj: a pointer to the #AccessibleHypertext object on which to operate.
+ *
+ * Increment the reference count for an #AccessibleHypertext object.
+ *       Since AccessibleHypertext is derived from AccessibleText,
+ *       this is the same as AccessibleText_unref().
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleHypertext_ref (AccessibleHypertext *obj)
 {
-  Accessibility_Hypertext_ref (*obj, &ev);
+  cspi_object_ref (obj);
   return 0;
 }
 
 
-
+/**
+ * AccessibleHypertext_unref:
+ * @obj: a pointer to the #AccessibleHypertext object on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleHypertext object.
+ *       Since AccessibleHypertext is derived from AccessibleText,
+ *       this is the same as AccessibleText_unref().
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleHypertext_unref (AccessibleHypertext *obj)
 {
-  Accessibility_Hypertext_unref (*obj, &ev);
+  cspi_object_unref (obj);
   return 0;
 }
 
 
 
+/**
+ * AccessibleHypertext_getNLinks:
+ * @obj: a pointer to the #AccessibleHypertext implementor on which to operate.
+ *
+ * Get the total number of #AccessibleHyperlinks which an
+ *        #AccessibleHypertext implementor has.
+ *
+ * Returns: a #long indicating the number of #AccessibleHyperlinks
+ *        of the #AccessibleHypertext implementor, or -1 if
+ *        the number cannot be determined (for example, if the
+ *        #AccessibleHypertext object is so large that it is not
+ *        all currently in the memory cache).
+ *
+ **/
 long
 AccessibleHypertext_getNLinks (AccessibleHypertext *obj)
 {
   return (long)
-    Accessibility_Hypertext_getNLinks (*obj, &ev);
+    Accessibility_Hypertext_getNLinks (CSPI_OBJREF (obj), cspi_ev ());
 }
 
 
+/**
+ * AccessibleHypertext_getLink:
+ * @obj: a pointer to the #AccessibleHypertext implementor on which to operate.
+ * @linkIndex: a (zero-index) long integer indicating which hyperlink to query.
+ *
+ * Get the #AccessibleHyperlink object at a specified index.
+ *
+ * Returns: the #AccessibleHyperlink object specified by #linkIndex.
+ *
+ **/
 AccessibleHyperlink *
 AccessibleHypertext_getLink (AccessibleHypertext *obj,
-                             long linkIndex)
+                             long int linkIndex)
 {
   return (AccessibleHyperlink *)
-    Accessibility_Hypertext_getLink (*obj,
-                                    (CORBA_long) linkIndex, &ev);
+    Accessibility_Hypertext_getLink (CSPI_OBJREF (obj),
+                                    (CORBA_long) linkIndex, cspi_ev ());
 }
 
 
-
+/**
+ * AccessibleHypertext_getLinkIndex:
+ * @obj: a pointer to the #AccessibleHypertext implementor on which to operate.
+ * @characterOffset: an integer specifying the character offset to query.
+ *
+ * Get the index of the #AccessibleHyperlink object at a specified
+ *        character offset.
+ *
+ * Returns: the linkIndex of the #AccessibleHyperlink active at
+ *        character offset @characterOffset, or -1 if there is
+ *        no hyperlink at the specified character offset.
+ *
+ **/
 long
 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
-                                  long characterIndex)
+                                  long int characterOffset)
 {
   return (long)
-    Accessibility_Hypertext_getLinkIndex (*obj,
-                                         (CORBA_long) characterIndex, &ev);
+    Accessibility_Hypertext_getLinkIndex (CSPI_OBJREF (obj),
+                                         (CORBA_long) characterOffset, cspi_ev ());
 }