From: P. F. Chimento Date: Thu, 14 Apr 2011 21:24:22 +0000 (+0200) Subject: Misc documentation fixes X-Git-Tag: v0.9~112 X-Git-Url: https://git.stderr.nl/gitweb?a=commitdiff_plain;h=3420fbfa4299d88d0057ae727c80e4c665c7515b;p=projects%2Fchimara%2Fchimara.git Misc documentation fixes --- diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c index 4d8b552..04d2687 100644 --- a/libchimara/chimara-glk.c +++ b/libchimara/chimara-glk.c @@ -1417,16 +1417,16 @@ chimara_glk_is_line_input_pending(ChimaraGlk *glk) /** * chimara_glk_get_tag: - * @glk: a #ChimarGlk widget + * @glk: a #ChimaraGlk widget * @window: The type of window to retrieve the tag for * @name: The name of the tag to retrieve * * Use this function to get a #GtkTextTag so style properties can be changed. - * See also #chimara_glk_set_css_from_string. + * See also chimara_glk_set_css_from_string(). * * The layout of the text in Chimara is controlled by two sets of tags: one set * describing the style in text buffers and one for text grids. See also the - * GLK specification for the difference between the two. The main narrative of + * Glk specification for the difference between the two. The main narrative of * a game is usually rendered in text buffers, whereas text grids are mostly * used for status bars and in game menus. * @@ -1445,9 +1445,9 @@ chimara_glk_is_line_input_pending(ChimaraGlk *glk) * user2 * hyperlink * pager - * + * */ -GtkTextTag* +GtkTextTag * chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *name) { CHIMARA_GLK_USE_PRIVATE(glk, priv); @@ -1466,12 +1466,12 @@ chimara_glk_get_tag(ChimaraGlk *glk, ChimaraGlkWindowType window, const gchar *n } /** - * chimara_glk_get_tag: - * @glk: a #ChimarGlk widget + * chimara_glk_get_tag_names: + * @glk: a #ChimaraGlk widget * - * Retrieves the possible tag names to use in #chimara_glk_get_tag. + * Retrieves the possible tag names to use in chimara_glk_get_tag(). */ -const gchar** +const gchar ** chimara_glk_get_tag_names(ChimaraGlk *glk) { return style_get_tag_names(); @@ -1481,7 +1481,7 @@ chimara_glk_get_tag_names(ChimaraGlk *glk) * chimara_glk_get_num_tag_names: * @glk: a #ChimaraGlk widget * - * Retrieves the number of style tags returned by #chimara_glk_get_tag_names. + * Retrieves the number of style tags returned by chimara_glk_get_tag_names(). */ gint chimara_glk_get_num_tag_names(ChimaraGlk *glk) @@ -1495,7 +1495,7 @@ chimara_glk_get_num_tag_names(ChimaraGlk *glk) * * Processes style updates and updates the widget to reflect the new style. * Call this every time you change a property of a #GtkTextTag retrieved by - * #chimara_glk_get_tag. + * chimara_glk_get_tag(). */ void chimara_glk_update_style(ChimaraGlk *glk) diff --git a/libchimara/chimara-glk.h b/libchimara/chimara-glk.h index 089bccb..df522da 100644 --- a/libchimara/chimara-glk.h +++ b/libchimara/chimara-glk.h @@ -39,6 +39,14 @@ typedef struct _ChimaraGlkClass { void(* iliad_screen_update) (ChimaraGlk *self, gboolean typing); } ChimaraGlkClass; +/** + * ChimaraGlkWindowType: + * @CHIMARA_GLK_TEXT_BUFFER: The styles for text buffer windows. + * @CHIMARA_GLK_TEXT_GRID: The styles for text grid windows. + * + * Specifies the type of windows for which to retrieve the style tag with + * chimara_glk_get_tag(). + */ typedef enum { CHIMARA_GLK_TEXT_BUFFER, CHIMARA_GLK_TEXT_GRID @@ -81,6 +89,9 @@ typedef enum _ChimaraResourceType { /** * ChimaraResourceLoadFunc: + * @usage: A #ChimaraResourceType constant. + * @resnum: The resource number to look for. + * @user_data: A pointer to provide to the callback. * * The type of function passed to chimara_glk_set_resource_load_callback(). It * takes a #ChimaraResourceType constant, @usage, to indicate what sort of