[at-spi2-core] Improving atspi-hypertext.c documentation



commit c2615773cc5f69ba742b1815edf5368b4d38ad5e
Author: Aline Bessa <alibezz gmail com>
Date:   Wed Jul 27 02:01:46 2011 -0300

    Improving atspi-hypertext.c documentation

 atspi/atspi-hypertext.c |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)
---
diff --git a/atspi/atspi-hypertext.c b/atspi/atspi-hypertext.c
index b7d4eb6..748d272 100644
--- a/atspi/atspi-hypertext.c
+++ b/atspi/atspi-hypertext.c
@@ -28,10 +28,10 @@
  * atspi_hypertext_get_n_links:
  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
  *
- * Get the total number of #AtspiHyperlinks which an
- *        #AtspiHypertext implementor has.
+ * Gets the total number of #AtspiHyperlink objects that an
+ * #AtspiHypertext implementor has.
  *
- * Returns: a #gint indicating the number of #AtspiHyperlinks
+ * Returns: a #gint indicating the number of #AtspiHyperlink objects
  *        of the #AtspiHypertext implementor, or -1 if
  *        the number cannot be determined (for example, if the
  *        #AtspiHypertext object is so large that it is not
@@ -52,12 +52,12 @@ atspi_hypertext_get_n_links (AtspiHypertext *obj, GError **error)
 /**
  * atspi_hypertext_get_link:
  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
- * @link_index: a (zero-index) integer indicating which hyperlink to query.
+ * @link_index: a (zero-index) #gint indicating which hyperlink to query.
  *
- * Get the #AtspiHyperlink object at a specified index.
+ * Gets the #AtspiHyperlink object at a specified index.
  *
  * Returns: (transfer full): the #AtspiHyperlink object specified by
- *          #link_index.
+ *          @link_index.
  **/
 AtspiHyperlink *
 atspi_hypertext_get_link (AtspiHypertext *obj, gint link_index, GError **error)
@@ -75,9 +75,9 @@ atspi_hypertext_get_link (AtspiHypertext *obj, gint link_index, GError **error)
 /**
  * atspi_hypertext_get_link_index:
  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
- * @character_offset: an integer specifying the character offset to query.
+ * @character_offset: a #gint specifying the character offset to query.
  *
- * Get the index of the #AtspiHyperlink object at a specified
+ * Gets the index of the #AtspiHyperlink object at a specified
  *        character offset.
  *
  * Returns: the linkIndex of the #AtspiHyperlink active at



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]