From 81d40c829d23c350c2c2a97004d055e70fdf705f Mon Sep 17 00:00:00 2001
From: Daiki Ueno <ueno@unixuser.org>
Date: Sat, 22 Jan 2011 16:22:20 +0900
Subject: [PATCH] Add doc.

---
 eek/eek-key.c      |  6 ++++++
 eek/eek-keyboard.c | 14 +++++++++++---
 eek/eek-keyboard.h | 26 +++++++++++++-------------
 3 files changed, 30 insertions(+), 16 deletions(-)

diff --git a/eek/eek-key.c b/eek/eek-key.c
index 6a0ba887..74d2040e 100644
--- a/eek/eek-key.c
+++ b/eek/eek-key.c
@@ -711,6 +711,12 @@ eek_key_get_keysym_index (EekKey *key,
     EEK_KEY_GET_CLASS(key)->get_keysym_index (key, group, level);
 }
 
+/**
+ * eek_key_is_pressed:
+ * @key: an #EekKey
+ *
+ * Return %TRUE if key is marked as pressed.
+ */
 gboolean
 eek_key_is_pressed (EekKey *key)
 {
diff --git a/eek/eek-keyboard.c b/eek/eek-keyboard.c
index 191be519..2940df69 100644
--- a/eek/eek-keyboard.c
+++ b/eek/eek-keyboard.c
@@ -446,10 +446,18 @@ eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
                                                                   keycode);
 }
 
+/**
+ * eek_keyboard_new:
+ * @layout: an #EekLayout
+ * @preferred_width: default width of returned keyboard
+ * @preferred_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)
+eek_keyboard_new (EekLayout *layout,
+                  gint       preferred_width,
+                  gint       preferred_height)
 {
     EekKeyboard *keyboard = g_object_new (EEK_TYPE_KEYBOARD, NULL);
     EekBounds bounds;
diff --git a/eek/eek-keyboard.h b/eek/eek-keyboard.h
index 2787b1eb..b2e70194 100644
--- a/eek/eek-keyboard.h
+++ b/eek/eek-keyboard.h
@@ -85,22 +85,22 @@ struct _EekKeyboardClass
     gpointer pdummy[23];
 };
 
-GType        eek_keyboard_get_type             (void) G_GNUC_CONST;
+GType        eek_keyboard_get_type            (void) G_GNUC_CONST;
 
-EekKeyboard *eek_keyboard_new                  (EekLayout   *layout,
-                                                gint preferred_width,
-                                                gint preferred_height);
-void         eek_keyboard_set_keysym_index     (EekKeyboard *keyboard,
-                                                gint         group,
-                                                gint         level);
-void         eek_keyboard_get_keysym_index     (EekKeyboard *keyboard,
-                                                gint        *group,
-                                                gint        *level);
+EekKeyboard *eek_keyboard_new                 (EekLayout   *layout,
+                                               gint         preferred_width,
+                                               gint         preferred_height);
+void         eek_keyboard_set_keysym_index    (EekKeyboard *keyboard,
+                                               gint         group,
+                                               gint         level);
+void         eek_keyboard_get_keysym_index    (EekKeyboard *keyboard,
+                                               gint        *group,
+                                               gint        *level);
 
-EekSection  *eek_keyboard_create_section       (EekKeyboard *keyboard);
+EekSection  *eek_keyboard_create_section      (EekKeyboard *keyboard);
 
-EekKey      *eek_keyboard_find_key_by_keycode  (EekKeyboard *keyboard,
-                                                guint        keycode);
+EekKey      *eek_keyboard_find_key_by_keycode (EekKeyboard *keyboard,
+                                               guint        keycode);
 
 G_END_DECLS
 #endif  /* EEK_KEYBOARD_H */