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

Fix GTK-Doc comment.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/eek/eek-overview.xml
View File

@ -25,20 +25,21 @@
#ClutterActor:</para>
<informalexample>
<programlisting>
EekKeyboard *keyboard;
EekLayout *layout;
EekKeyboard *keyboard;
ClutterActor *actor;
/* Create a keyboard layout using libxklavier configuration. */
/* Create a layout engine based on libxklavier configuration. */
layout = eek_xkl_layout_new ();
/* Create a keyboard implemented as ClutterActor. */
keyboard = eek_clutter_keyboard_new ();
/* Create a keyboard from the given layout. */
keyboard = eek_keyboard_new (layout, initial_width, initial_height);
/* Apply the layout to the keyboard. */
eek_keyboard_set_layout (keyboard, layout);
/* Create a ClutterActor. */
actor = eek_clutter_keyboard_new (eekboard->keyboard);
clutter_group_add (CLUTTER_GROUP(stage),
eek_clutter_keyboard_get_actor (EEK_CLUTTER_KEYBOARD(keyboard)));
/* Add the actor to a stage. */
clutter_group_add (CLUTTER_GROUP(stage), actor);
</programlisting>
</informalexample>

15
docs/reference/eek/eek-sections.txt
View File

@ -2,13 +2,11 @@
<FILE>eek-keyboard</FILE>
<TITLE>EekKeyboard</TITLE>
EekKeyboardClass
EekKeyboardPrivate
EekKeyboard
eek_keyboard_new
eek_keyboard_set_keysym_index
eek_keyboard_get_keysym_index
eek_keyboard_create_section
eek_keyboard_set_layout
eek_keyboard_realize
eek_keyboard_find_key_by_keycode
<SUBSECTION Standard>
EEK_KEYBOARD
@ -40,9 +38,7 @@ EEK_LAYOUT_GET_IFACE
<TITLE>EekGtkKeyboard</TITLE>
EekGtkKeyboard
EekGtkKeyboardClass
EekGtkKeyboardPrivate
eek_gtk_keyboard_new
eek_gtk_keyboard_get_widget
<SUBSECTION Standard>
EEK_GTK_KEYBOARD
EEK_IS_GTK_KEYBOARD
@ -57,7 +53,6 @@ EEK_GTK_KEYBOARD_GET_CLASS
<FILE>eek-section</FILE>
<TITLE>EekSection</TITLE>
EekSectionClass
EekSectionPrivate
EekSection
eek_section_set_angle
eek_section_get_angle
@ -80,13 +75,11 @@ EEK_SECTION_GET_CLASS
<FILE>eek-container</FILE>
<TITLE>EekContainer</TITLE>
EekContainerClass
EekContainerPrivate
EekCallback
EekCompareFunc
EekContainer
eek_container_foreach_child
eek_container_find
eek_container_find_by_position
<SUBSECTION Standard>
EEK_CONTAINER
EEK_IS_CONTAINER
@ -102,9 +95,7 @@ EEK_CONTAINER_GET_CLASS
<TITLE>EekClutterKeyboard</TITLE>
EekClutterKeyboard
EekClutterKeyboardClass
EekClutterKeyboardPrivate
eek_clutter_keyboard_new
eek_clutter_keyboard_get_actor
<SUBSECTION Standard>
EEK_CLUTTER_KEYBOARD
EEK_IS_CLUTTER_KEYBOARD
@ -120,7 +111,6 @@ EEK_CLUTTER_KEYBOARD_GET_CLASS
<TITLE>EekXklLayout</TITLE>
EekXklLayout
EekXklLayoutClass
EekXklLayoutPrivate
eek_xkl_layout_new
eek_xkl_layout_set_config
eek_xkl_layout_set_config_full
@ -150,7 +140,6 @@ EEK_XKL_LAYOUT_GET_CLASS
<TITLE>EekXkbLayout</TITLE>
EekXkbLayout
EekXkbLayoutClass
EekXkbLayoutPrivate
eek_xkb_layout_new
eek_xkb_layout_set_names
eek_xkb_layout_set_names_full
@ -174,7 +163,6 @@ EEK_XKB_LAYOUT_GET_CLASS
<FILE>eek-key</FILE>
<TITLE>EekKey</TITLE>
EekKeyClass
EekKeyPrivate
EekKey
eek_key_set_keycode
eek_key_get_keycode
@ -201,7 +189,6 @@ EEK_KEY_GET_CLASS
<FILE>eek-element</FILE>
<TITLE>EekElement</TITLE>
EekElementClass
EekElementPrivate
EekElement
eek_element_set_parent
eek_element_get_parent

3
eek/eek-clutter-keyboard.c
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)

2
eek/eek-container.h
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 */

3
eek/eek-gtk-keyboard.c
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)

1
eek/eek-key.h
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
{

12
eek/eek-keyboard.c
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);

7
eek/eek-keyboard.h
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);