Fix GTK-Doc comment.

This commit is contained in:
Daiki Ueno
2011-01-25 11:05:46 +09:00
parent 420b8014f8
commit af8274f305
8 changed files with 25 additions and 35 deletions

View File

@ -155,7 +155,8 @@ create_section (EekElement *element, gpointer user_data)
* eek_clutter_keyboard_new:
* @keyboard: an #EekKeyboard
*
* Create a new #EekClutterKeyboard.
* Create a new #ClutterActor displaying @keyboard.
* Returns: a #ClutterActor
*/
ClutterActor *
eek_clutter_keyboard_new (EekKeyboard *keyboard)

View File

@ -88,7 +88,7 @@ void eek_container_foreach_child (EekContainer *container,
gpointer user_data);
EekElement *eek_container_find (EekContainer *container,
EekCompareFunc func,
gpointer data);
gpointer user_data);
G_END_DECLS
#endif /* EEK_CONTAINER_H */

View File

@ -250,7 +250,8 @@ eek_gtk_keyboard_init (EekGtkKeyboard *self)
* eek_gtk_keyboard_new:
* @keyboard: an #EekKeyboard
*
* Create a new #EekGtkKeyboard.
* Create a new #GtkWidget displaying @keyboard.
* Returns: a #GtkWidget
*/
GtkWidget *
eek_gtk_keyboard_new (EekKeyboard *keyboard)

View File

@ -61,6 +61,7 @@ struct _EekKey
* @get_keysym_index: virtual function for getting group and level of the key
* @pressed: class handler for #EekKey::pressed signal
* @released: class handler for #EekKey::released signal
* @is_pressed: virtual function for getting whether the key is pressed
*/
struct _EekKeyClass
{

View File

@ -448,15 +448,15 @@ eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
/**
* eek_keyboard_new:
* @layout: an #EekLayout
* @preferred_width: default width of returned keyboard
* @preferred_height: default height of returned keyboard
* @initial_width: default width of returned keyboard
* @initial_height: default height of returned keyboard
*
* Create a new #EekKeyboard instance based on @layout.
*/
EekKeyboard *
eek_keyboard_new (EekLayout *layout,
gint preferred_width,
gint preferred_height)
gint initial_width,
gint initial_height)
{
EekKeyboard *keyboard = g_object_new (EEK_TYPE_KEYBOARD, NULL);
EekBounds bounds;
@ -464,8 +464,8 @@ eek_keyboard_new (EekLayout *layout,
g_return_val_if_fail (EEK_IS_LAYOUT (layout), NULL);
bounds.x = bounds.y = 0.0;
bounds.width = preferred_width;
bounds.height = preferred_height;
bounds.width = initial_width;
bounds.height = initial_height;
eek_element_set_bounds (EEK_ELEMENT(keyboard), &bounds);
eek_layout_apply (layout, keyboard);

View File

@ -52,10 +52,9 @@ struct _EekKeyboard
* @get_keysym_index: virtual function for getting group and level of
* the entire keyboard
* @create_section: virtual function for creating a section
* @set_layout: virtual function for setting layout engine
* @find_key_by_keycode: virtual function for finding a key in the
* keyboard by keycode
* @realize: virtual function for applying a layout to the keyboard
* @keysym_index_changed: class handler for #EekKeyboard::keysym-index-changed signal
*/
struct _EekKeyboardClass
{
@ -88,8 +87,8 @@ struct _EekKeyboardClass
GType eek_keyboard_get_type (void) G_GNUC_CONST;
EekKeyboard *eek_keyboard_new (EekLayout *layout,
gint preferred_width,
gint preferred_height);
gint initial_width,
gint initial_height);
void eek_keyboard_set_keysym_index (EekKeyboard *keyboard,
gint group,
gint level);