s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix GTK-DOC comments.

Browse Source
This commit is contained in:
Daiki Ueno
2011-04-21 16:55:19 +09:00
parent d71c79f268
commit de62d74ac5
13 changed files with 163 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
eek/eek-key.c
View File

@ -557,9 +557,9 @@ eek_key_get_symbol_matrix (EekKey *key)
/**
* eek_key_get_symbol:
* @key: an #EekKey
* @returns: (transfer none): the current #EekSymbol or %NULL on failure
*
* Get the current symbol of @key.
* Return value: (transfer none): the current #EekSymbol or %NULL on failure
*/
EekSymbol *
eek_key_get_symbol (EekKey *key)
@ -572,9 +572,9 @@ eek_key_get_symbol (EekKey *key)
* @key: an #EekKey
* @fallback_group: fallback group index
* @fallback_level: fallback level index
* @returns: (transfer none): the current #EekSymbol or %NULL on failure
*
* Get the current symbol of @key.
* Return value: (transfer none): the current #EekSymbol or %NULL on failure
*/
EekSymbol *
eek_key_get_symbol_with_fallback (EekKey *key,
@ -628,9 +628,9 @@ eek_key_get_symbol_with_fallback (EekKey *key,
* @level: level index of the symbol matrix
* @fallback_group: fallback group index
* @fallback_level: fallback level index
* @returns: (transfer none): an #EekSymbol at (@group, @level), or %NULL
*
* Get the symbol at (@group, @level) in the symbol matrix of @key.
* Return value: (transfer none): an #EekSymbol at (@group, @level), or %NULL
*/
EekSymbol *
eek_key_get_symbol_at_index (EekKey *key,

2
eek/eek-keyboard.c
View File

@ -660,9 +660,9 @@ eek_keyboard_create_section (EekKeyboard *keyboard)
* eek_keyboard_find_key_by_keycode:
* @keyboard: an #EekKeyboard
* @keycode: a keycode
* @returns: (transfer none): #EekKey whose keycode is @keycode
*
* Find an #EekKey whose keycode is @keycode.
* Return value: (transfer none): #EekKey whose keycode is @keycode
*/
EekKey *
eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,

3
eek/eek-keyboard.h
View File

@ -104,6 +104,7 @@ void eek_keyboard_set_size
(EekKeyboard *keyboard,
gdouble width,
gdouble height);
#ifndef EEK_DISABLE_DEPRECATED
void eek_keyboard_set_symbol_index
(EekKeyboard *keyboard,
gint group,
@ -112,7 +113,6 @@ void eek_keyboard_get_symbol_index
(EekKeyboard *keyboard,
gint *group,
gint *level);
void eek_keyboard_set_group
(EekKeyboard *keyboard,
gint group);
@ -123,6 +123,7 @@ gint eek_keyboard_get_group
(EekKeyboard *keyboard);
gint eek_keyboard_get_level
(EekKeyboard *keyboard);
#endif /* EEK_DISABLE_DEPRECATED */
void eek_keyboard_set_modifier_behavior
(EekKeyboard *keyboard,

3
eek/eek-keysym.c
View File

@ -223,7 +223,8 @@ eek_keysym_init (EekKeysym *self)
* modifier @modifier_mask.
*/
EekKeysym *
eek_keysym_new_with_modifier (guint xkeysym, EekModifierType modifier_mask)
eek_keysym_new_with_modifier (guint xkeysym,
EekModifierType modifier_mask)
{
EekKeysym *keysym;
EekKeysymPrivate *priv;

2
eek/eek-section.h
View File

@ -54,6 +54,8 @@ struct _EekSection
* @create_key: virtual function for creating key in the section
* @find_key_by_keycode: virtual function for accessing a key in the
* section by keycode
* @key_pressed: class handler for #EekSection::key-pressed signal
* @key_released: class handler for #EekSection::key-released signal
*/
struct _EekSectionClass
{

1
eek/eek-symbol-matrix.h
View File

@ -39,6 +39,7 @@ struct _EekSymbolMatrix
EekSymbol **data;
};
#define EEK_TYPE_SYMBOL_MATRIX (eek_symbol_matrix_get_type ())
GType eek_symbol_matrix_get_type (void) G_GNUC_CONST;
EekSymbolMatrix *eek_symbol_matrix_new (gint num_groups,
gint num_levels);

5
eek/eek-symbol.c
View File

@ -364,8 +364,9 @@ eek_symbol_get_category (EekSymbol *symbol)
/**
* eek_symbol_set_modifier_mask:
* @symbol: an #EekSymbol
* @mask: an #EekModifierType
*
* Set modifier mask @symbol can trigger.
* Set modifier mask that @symbol can trigger.
*/
void
eek_symbol_set_modifier_mask (EekSymbol *symbol,
@ -383,7 +384,7 @@ eek_symbol_set_modifier_mask (EekSymbol *symbol,
* eek_symbol_get_modifier_mask:
* @symbol: an #EekSymbol
*
* Get modifier mask @symbol can trigger.
* Get modifier mask that @symbol can trigger.
*/
EekModifierType
eek_symbol_get_modifier_mask (EekSymbol *symbol)

3
eek/eek-theme-context.c
View File

@ -121,7 +121,8 @@ eek_theme_context_changed (EekThemeContext *context)
/**
* eek_theme_context_set_theme:
* @context: a #EekThemeContext
* @context: an #EekThemeContext
* @theme: an #EekTheme
*
* Sets the default set of theme stylesheets for the context. This theme will
* be used for the root node and for nodes descending from it, unless some other

2
eek/eek-theme-context.h
View File

@ -28,7 +28,7 @@
G_BEGIN_DECLS
/**
* SECTION:EekThemeContext
* SECTION:eek-theme-context
* @short_description: holds global information about a tree of styled objects
*
* #EekThemeContext is responsible for managing information global to

6
eek/eek-theme-node.h
View File

@ -26,12 +26,12 @@
G_BEGIN_DECLS
/**
* SECTION:EekThemeNode
* SECTION:eek-theme-node
* @short_description: style information for one node in a tree of
* themed objects
*
* A #EekThemeNode represents the CSS style information (the set of
* CSS properties) for one node in a tree of themed objects. In
* The #EekThemeNode class represents the CSS style information (the
* set of CSS properties) for one node in a tree of themed objects. In
* typical usage, it represents the style information for a single
* #EekElement. A #EekThemeNode is immutable: attributes such as the
* CSS classes for the node are passed in at construction. If the

4
eek/eek-types.h
View File

@ -26,7 +26,6 @@ G_BEGIN_DECLS
#define I_(string) g_intern_static_string (string)
#define EEK_TYPE_SYMBOL_MATRIX (eek_symbol_matrix_get_type ())
#define EEK_TYPE_POINT (eek_point_get_type ())
#define EEK_TYPE_BOUNDS (eek_bounds_get_type ())
#define EEK_TYPE_OUTLINE (eek_outline_get_type ())
@ -141,7 +140,6 @@ typedef struct _EekThemeContext EekThemeContext;
typedef struct _EekThemeNode EekThemeNode;
typedef struct _EekSymbolMatrix EekSymbolMatrix;
typedef struct _EekPoint EekPoint;
typedef struct _EekBounds EekBounds;
typedef struct _EekOutline EekOutline;
typedef struct _EekColor EekColor;
@ -153,6 +151,7 @@ typedef struct _EekColor EekColor;
*
* 2D vertex
*/
typedef struct _EekPoint EekPoint;
struct _EekPoint
{
gdouble x;
@ -176,7 +175,6 @@ void eek_point_rotate (EekPoint *point,
*/
struct _EekBounds
{
/*< public >*/
gdouble x;
gdouble y;
gdouble width;