Doc fix.

eek/eek-keyboard.c

@@ -738,7 +738,7 @@ eek_keyboard_create_section (EekKeyboard *keyboard)
  * eek_keyboard_find_key_by_keycode:
  * @keyboard: an #EekKeyboard
  * @keycode: a keycode
- * @returns: (transfer none): #EeekKey whose keycode is @keycode
+ * @returns: (transfer none): #EekKey whose keycode is @keycode
  *
  * Find an #EekKey whose keycode is @keycode.
  */

eek/eek-keyboard.h

@@ -37,6 +37,12 @@ G_BEGIN_DECLS
 typedef struct _EekKeyboardClass EekKeyboardClass;
 typedef struct _EekKeyboardPrivate EekKeyboardPrivate;
 
+/**
+ * EekKeyboard:
+ *
+ * The #EekKeyboard structure contains only private data and should
+ * only be accessed using the provided API.
+ */
 struct _EekKeyboard
 {
     /*< private >*/
@@ -47,16 +53,16 @@ struct _EekKeyboard
 
 /**
  * EekKeyboardClass:
- * @set_keysym_index: virtual function for setting group and level of
+ * @set_symbol_index: virtual function for setting group and level of
  * the entire keyboard
- * @get_keysym_index: virtual function for getting group and level of
+ * @get_symbol_index: virtual function for getting group and level of
  * the entire keyboard
  * @create_section: virtual function for creating a section
  * @find_key_by_keycode: virtual function for finding a key in the
  * keyboard by keycode
  * @key_pressed: class handler for #EekKeyboard::key-pressed signal
  * @key_released: class handler for #EekKeyboard::key-released signal
- * @keysym_index_changed: class handler for #EekKeyboard::keysym-index-changed signal
+ * @symbol_index_changed: class handler for #EekKeyboard::symbol-index-changed signal
  */
 struct _EekKeyboardClass
 {

eek/eek-serializable.c

@@ -17,6 +17,20 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/**
+ * SECTION:eek-serializable
+ * @short_description: Interface implemented by #EekElement to
+ * serialize it to #GVariant
+ *
+ * The #EekSerializableIface interface defines serialize/deserialize
+ * method of #EekElement.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif  /* HAVE_CONFIG_H */
+
 #include "eek-serializable.h"
 
 GType

eek/eek-serializable.h

@@ -31,6 +31,12 @@ G_BEGIN_DECLS
 typedef struct _EekSerializable EekSerializable;
 typedef struct _EekSerializableIface EekSerializableIface;
 
+/**
+ * EekSerializableIface:
+ *
+ * @serialize: virtual function for serializing object into #GVariant
+ * @deserialize: virtual function for deserializing object from #GVariant
+ */
 struct _EekSerializableIface
 {
     /*< private >*/
@@ -41,8 +47,6 @@ struct _EekSerializableIface
     gsize (* deserialize) (EekSerializable       *object,
                            GVariant              *variant,
                            gsize                  index);
-    void  (* copy)        (EekSerializable       *dest,
-                           const EekSerializable *src);
 
     /*< private >*/
     /* padding */
@@ -51,7 +55,6 @@ struct _EekSerializableIface
 
 GType            eek_serializable_get_type    (void);
 
-EekSerializable *eek_serializable_copy        (EekSerializable *object);
 GVariant        *eek_serializable_serialize   (EekSerializable *object);
 EekSerializable *eek_serializable_deserialize (GVariant        *variant);
 

eek/eek-symbol.c

@@ -18,6 +18,13 @@
  * 02110-1301 USA
  */
 
+/**
+ * SECTION:eek-symbol
+ * @short_description: Base class of a symbol
+ *
+ * The #EekSymbolClass class represents a symbol assigned to a key.
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif  /* HAVE_CONFIG_H */
@@ -256,6 +263,13 @@ eek_symbol_get_label (EekSymbol *symbol)
     return g_strdup (priv->label);
 }
 
+/**
+ * eek_symbol_set_category:
+ * @symbol: an #EekSymbol
+ * @category: an #EekSymbolCategory
+ *
+ * Set symbol category of @symbol to @category.
+ */
 void
 eek_symbol_set_category (EekSymbol        *symbol,
                          EekSymbolCategory category)
@@ -268,6 +282,12 @@ eek_symbol_set_category (EekSymbol        *symbol,
     priv->category = category;
 }
 
+/**
+ * eek_symbol_get_category:
+ * @symbol: an #EekSymbol
+ *
+ * Returns symbol category of @symbol.
+ */
 EekSymbolCategory
 eek_symbol_get_category (EekSymbol *symbol)
 {
@@ -279,6 +299,12 @@ eek_symbol_get_category (EekSymbol *symbol)
     return priv->category;
 }
 
+/**
+ * eek_symbol_set_modifier_mask:
+ * @symbol: an #EekSymbol
+ *
+ * Set modifier mask @symbol can trigger.
+ */
 void
 eek_symbol_set_modifier_mask (EekSymbol      *symbol,
                               EekModifierType mask)
@@ -291,6 +317,12 @@ eek_symbol_set_modifier_mask (EekSymbol      *symbol,
     priv->modifier_mask = mask;
 }
 
+/**
+ * eek_symbol_get_modifier_mask:
+ * @symbol: an #EekSymbol
+ *
+ * Returns modifier mask @symbol can trigger.
+ */
 EekModifierType
 eek_symbol_get_modifier_mask (EekSymbol *symbol)
 {

eek/eek-symbol.h

@@ -31,6 +31,11 @@ G_BEGIN_DECLS
  * @EEK_SYMBOL_CATEGORY_FUNCTION: the symbol represents a function
  * @EEK_SYMBOL_CATEGORY_KEYNAME: the symbol does not have meaning but
  * have a name
+ * @EEK_SYMBOL_CATEGORY_USER0: reserved for future use
+ * @EEK_SYMBOL_CATEGORY_USER1: reserved for future use
+ * @EEK_SYMBOL_CATEGORY_USER2: reserved for future use
+ * @EEK_SYMBOL_CATEGORY_USER3: reserved for future use
+ * @EEK_SYMBOL_CATEGORY_USER4: reserved for future use
  * @EEK_SYMBOL_CATEGORY_UNKNOWN: used for error reporting
  *
  * Category of the key symbols.
@@ -59,6 +64,12 @@ typedef enum {
 typedef struct _EekSymbolClass EekSymbolClass;
 typedef struct _EekSymbolPrivate EekSymbolPrivate;
 
+/**
+ * EekSymbol:
+ *
+ * The #EekSymbol structure contains only private data and should only
+ * be accessed using the provided API.
+ */
 struct _EekSymbol {
     /*< private >*/
     GObject parent;
@@ -66,6 +77,9 @@ struct _EekSymbol {
     EekSymbolPrivate *priv;
 };
 
+/**
+ * EekSymbolClass:
+ */
 struct _EekSymbolClass {
     /*< private >*/
     GObjectClass parent_class;

eek/eek-types.h

@@ -64,6 +64,35 @@ typedef enum {
     EEK_MODIFIER_BEHAVIOR_LATCH
 } EekModifierBehavior;
 
+/**
+ * EekModifierType:
+ * @EEK_SHIFT_MASK: the Shift key.
+ * @EEK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
+ *  X server this may either be CapsLock or ShiftLock).
+ * @EEK_CONTROL_MASK: the Control key.
+ * @EEK_MOD1_MASK: the fourth modifier key (it depends on the modifier
+ *  mapping of the X server which key is interpreted as this modifier, but
+ *  normally it is the Alt key).
+ * @EEK_MOD2_MASK: the fifth modifier key (it depends on the modifier
+ *  mapping of the X server which key is interpreted as this modifier).
+ * @EEK_MOD3_MASK: the sixth modifier key (it depends on the modifier
+ *  mapping of the X server which key is interpreted as this modifier).
+ * @EEK_MOD4_MASK: the seventh modifier key (it depends on the modifier
+ *  mapping of the X server which key is interpreted as this modifier).
+ * @EEK_MOD5_MASK: the eighth modifier key (it depends on the modifier
+ *  mapping of the X server which key is interpreted as this modifier).
+ * @EEK_BUTTON1_MASK: the first mouse button.
+ * @EEK_BUTTON2_MASK: the second mouse button.
+ * @EEK_BUTTON3_MASK: the third mouse button.
+ * @EEK_BUTTON4_MASK: the fourth mouse button.
+ * @EEK_BUTTON5_MASK: the fifth mouse button.
+ * @EEK_SUPER_MASK: the Super modifier. Since 2.10
+ * @EEK_HYPER_MASK: the Hyper modifier. Since 2.10
+ * @EEK_META_MASK: the Meta modifier. Since 2.10
+ * @EEK_RELEASE_MASK: not used in EEK itself. GTK+ uses it to differentiate
+ *  between (keyval, modifiers) pairs from key press and release events.
+ * @EEK_MODIFIER_MASK: a mask covering all modifier types.
+ */
 typedef enum
 {
   EEK_SHIFT_MASK    = 1 << 0,

eek/eek-xml-layout.c

@@ -21,13 +21,13 @@
  * @short_description: Layout engine which loads layout information from XML
  */
 
-#include <stdlib.h>
-#include <string.h>
-
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif  /* HAVE_CONFIG_H */
 
+#include <stdlib.h>
+#include <string.h>
+
 #include "eek-xml-layout.h"
 #include "eek-keyboard.h"
 #include "eek-section.h"

eek/eek-xml-layout.h

@@ -35,6 +35,12 @@ typedef struct _EekXmlLayout        EekXmlLayout;
 typedef struct _EekXmlLayoutClass   EekXmlLayoutClass;
 typedef struct _EekXmlLayoutPrivate EekXmlLayoutPrivate;
 
+/**
+ * EekXmlLayout:
+ *
+ * The #EekXmlLayout structure contains only private data and should
+ * only be accessed using the provided API.
+ */
 struct _EekXmlLayout
 {
     /*< private >*/
@@ -43,6 +49,9 @@ struct _EekXmlLayout
     EekXmlLayoutPrivate *priv;
 };
 
+/**
+ * EekXmlLayoutClass:
+ */
 struct _EekXmlLayoutClass
 {
     /*< private >*/

eek/eek-xml.c

@@ -16,6 +16,11 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION: eek-xml
+ * @short_description: #EekKeyboard to XML conversion utilities
+ */
+
 #include <stdio.h>
 #include <stdarg.h>
 #include <glib/gprintf.h>
@@ -216,6 +221,14 @@ output_section_callback (EekElement *element, gpointer user_data)
     g_string_markup_printf (data->output, "</section>\n");
 }
 
+/**
+ * eek_keyboard_output:
+ * @keyboard: an #EekKeyboard
+ * @output: a GString
+ * @indent: an integer
+ *
+ * Convert @keyboard into the XML format and store it into @output.
+ */
 void
 eek_keyboard_output (EekKeyboard *keyboard, GString *output, gint indent)
 {

eek/eek-xml.h

@@ -27,7 +27,9 @@ G_BEGIN_DECLS
 
 #define EEK_XML_SCHEMA_VERSION "0.90"
 
-void eek_keyboard_output (EekKeyboard *keyboard, GString *output, gint indent);
+void eek_keyboard_output (EekKeyboard *keyboard,
+                          GString     *output,
+                          gint         indent);
 
 G_END_DECLS
 #endif  /* EEK_XML_H */