Add introspection annotations

[projects/chimara/chimara.git] / libchimara / chimara-glk.c

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index 7b4a63d0ac2a9ea7a4aca9dd74776d93c7f8eae1..a200b6ba46ad8f8189a71efb8f8ac1032b5ccb28 100644 (file)
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -861,7 +861,10 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
        /**
         * ChimaraGlk:spacing:
         *
-        * The amount of space between the Glk windows.
+        * The amount of space between the Glk windows. This space forms a visible
+        * border between windows; however, if you open a window using the
+        * %winmethod_NoBorder flag, there will be no spacing between it and its
+        * sibling window, no matter what the value of this property is.
         */
        g_object_class_install_property(object_class, PROP_SPACING,
                g_param_spec_uint("spacing", _("Spacing"),
@@ -1447,6 +1450,9 @@ chimara_glk_is_line_input_pending(ChimaraGlk *glk)
  *     <listitem><para>hyperlink</para></listitem>
  *     <listitem><para>pager</para></listitem>
  * </itemizedlist>
+ *
+ * Returns: (transfer none): The #GtkTextTag corresponding to @name in the
+ * styles of @window.
  */
 GtkTextTag *
 chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name)
@@ -1469,25 +1475,21 @@ chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *n
 /**
  * chimara_glk_get_tag_names:
  * @glk: a #ChimaraGlk widget
+ * @num_tags: Return location for the number of tag names retrieved.
  *
  * Retrieves the possible tag names to use in chimara_glk_get_tag().
+ *
+ * Returns: (transfer none) (array length=num_tags) (element-type utf8):
+ * Array of strings containing the tag names. This array is owned by Chimara,
+ * do not free it.
  */
 const gchar **
-chimara_glk_get_tag_names(ChimaraGlk *glk)
+chimara_glk_get_tag_names(ChimaraGlk *glk, unsigned int *num_tags)
 {
-       return style_get_tag_names();
-}
+       g_return_val_if_fail(num_tags != NULL, NULL);
 
-/**
- * chimara_glk_get_num_tag_names:
- * @glk: a #ChimaraGlk widget
- *
- * Retrieves the number of style tags returned by chimara_glk_get_tag_names().
- */
-gint
-chimara_glk_get_num_tag_names(ChimaraGlk *glk)
-{
-       return CHIMARA_NUM_STYLES;
+       *num_tags = CHIMARA_NUM_STYLES;
+       return style_get_tag_names();
 }
 
 /**