Some gtkdoc restructured, for new gtkdoc standard

6 files changed, 55 insertions, 55 deletions

diff --git a/libxklavier/xkl_config_item.h b/libxklavier/xkl_config_item.h
index 4bd2768..0aa90ed 100644
--- a/libxklavier/xkl_config_item.h
+++ b/libxklavier/xkl_config_item.h
@@ -56,67 +56,66 @@ extern "C" {
 #define XKL_CONFIG_ITEM_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), XKL_TYPE_CONFIG_ITEM, XklConfigItemClass))
 
 /**
+ * _XklConfigItem:
+ * @parent: The superclass object
+ * @name: The configuration item name. Corresponds to XML element "name".
+ * @short_description: The configuration item short description. Corresponds to XML element "shortDescription".
+ * @description: The configuration item description. Corresponds to XML element "description".
+ *
  * The configuration item. Corresponds to XML element "configItem".
  */
 	struct _XklConfigItem {
-/**
- * The superclass object
- */
 		GObject parent;
-/**
- * The configuration item name. Corresponds to XML element "name".
- */
+
 		gchar name[XKL_MAX_CI_NAME_LENGTH];
 
-/**
- * The configuration item short description. Corresponds to XML element "shortDescription".
- */
 		gchar short_description[XKL_MAX_CI_DESC_LENGTH];
 
-/**
- * The configuration item description. Corresponds to XML element "description".
- */
 		gchar description[XKL_MAX_CI_DESC_LENGTH];
 	};
 
 /**
+ * XCI_PROP_ALLOW_MULTIPLE_SELECTION:
  * Extra property for the XklConfigItem, defining whether the group allows multiple selection
  */
 #define XCI_PROP_ALLOW_MULTIPLE_SELECTION "allowMultipleSelection"
 
 /**
+ * XCI_PROP_VENDOR:
  * Extra property for the XklConfigItem, defining the vendor (used for models)
  */
 #define XCI_PROP_VENDOR "vendor"
 
 /**
+ * XCI_PROP_COUNTRY_LIST:
  * Extra property for the XklConfigItem, defining the list of countries (used for layouts/variants)
  */
 #define XCI_PROP_COUNTRY_LIST "countryList"
 
 /**
+ * XCI_PROP_LANGUAGE_LIST:
  * Extra property for the XklConfigItem, defining the list of languages (used for layouts/variants)
  */
 #define XCI_PROP_LANGUAGE_LIST "languageList"
 
 /**
+ * XCI_PROP_EXTRA_ITEM:
  * Extra property for the XklConfigItem, defining whether that item is exotic(extra)
  */
 #define XCI_PROP_EXTRA_ITEM "extraItem"
 
 /**
+ * _XklConfigItemClass:
+ * @parent_class: The superclass
  * The XklConfigItem class, derived from GObject
  */
 	struct _XklConfigItemClass {
-    /**
-     * The superclass
-     */
 		GObjectClass parent_class;
 	};
 
 /**
  * xkl_config_item_get_type:
- * 
+ *
  * Get type info for XklConfigItem
  *
  * Returns: GType for XklConfigItem
@@ -134,7 +133,6 @@ extern "C" {
 
 /**
  * xkl_config_item_set_name:
- *
  * @item: the XklConfigItem object to be changed
  * @name: (transfer none) (allow-none): Name (max. 32 characters); can be NULL.
  *
@@ -146,7 +144,6 @@ extern "C" {
 
 /**
  * xkl_config_item_set_short_description:
- *
  * @item: the XklConfigItem object to be changed
  * @short_description: (transfer none) (allow-none): Short Description (max. 10
  *        characters); can be NULL.
@@ -158,7 +155,6 @@ extern "C" {
 							  const gchar * short_description);
 /**
  * xkl_config_item_set_description:
- *
  * @item: the XklConfigItem object to be changed
  * @description: (transfer none) (allow-none): Description (max. 192
  *        characters); can be NULL.
diff --git a/libxklavier/xkl_config_registry.h b/libxklavier/xkl_config_registry.h
index bce8da3..d7259ad 100644
--- a/libxklavier/xkl_config_registry.h
+++ b/libxklavier/xkl_config_registry.h
@@ -40,25 +40,25 @@ extern "C" {
 #define XKL_CONFIG_REGISTRY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), XKL_TYPE_CONFIG_REGISTRY, XklConfigRegistryClass))
 
 /**
+ * _XklConfigRegistry:
+ * @parent: The superclass object
+ *
  * The configuration manager. Corresponds to XML element "configItem".
  */
 	struct _XklConfigRegistry {
-/**
- * The superclass object
- */
 		GObject parent;
-
+		/*< private >*/
 		XklConfigRegistryPrivate *priv;
 	};
 
 
 /**
+ * _XklConfigRegistryClass:
+ * @parent_class: The superclass
+ *
  * The XklConfigRegistry class, derived from GObject
  */
 	struct _XklConfigRegistryClass {
-    /**
-     * The superclass
-     */
 		GObjectClass parent_class;
 	};
 
diff --git a/libxklavier/xkl_engine.h b/libxklavier/xkl_engine.h
index 9ca35a4..df39da0 100644
--- a/libxklavier/xkl_engine.h
+++ b/libxklavier/xkl_engine.h
@@ -31,6 +31,7 @@ extern "C" {
 	typedef struct _XklEngine XklEngine;
 	typedef struct _XklEnginePrivate XklEnginePrivate;
 	typedef struct _XklEngineClass XklEngineClass;
+	typedef struct _XklState XklState;
 
 #define XKL_TYPE_ENGINE             (xkl_engine_get_type ())
 #define XKL_ENGINE(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), XKL_TYPE_ENGINE, XklEngine))
@@ -40,9 +41,11 @@ extern "C" {
 #define XKL_ENGINE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), XKL_TYPE_ENGINE, XklEngineClass))
 
 /**
- * The type of the keyboard state change
+ * XklEngineStateChange:
  *   @GROUP_CHANGED: Group was changed
  *   @INDICATORS_CHANGED: Indicators were changed
+ *
+ * The type of the keyboard state change
  */
 	typedef enum {
 		GROUP_CHANGED,
@@ -50,7 +53,7 @@ extern "C" {
 	} XklEngineStateChange;
 
 /**
- * A set of flags used to indicate the capabilities of the active backend
+ * XklEngineFeatures:
  *   @XKLF_CAN_TOGGLE_INDICATORS: Backend allows to toggls indicators on/off
  *   @XKLF_CAN_OUTPUT_CONFIG_AS_ASCII: Backend allows writing ASCII representation of the configuration
  *   @XKLF_CAN_OUTPUT_CONFIG_AS_BINARY: Backend allows writing binary representation of the configuration
@@ -58,6 +61,9 @@ extern "C" {
  *   @XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT: Backend requires manual configuration, some daemon should do 
  *                                   xkl_start_listen(engine,XKLL_MANAGE_LAYOUTS);
  *   @XKLF_DEVICE_DISCOVERY: Backend supports device discovery, can notify
+ *
+ * A set of flags used to indicate the capabilities of the active backend
+ *
  */
 	typedef enum { /*< flags >*/
 		XKLF_CAN_TOGGLE_INDICATORS = 1 << 0,
@@ -69,44 +75,40 @@ extern "C" {
 	} XklEngineFeatures;
 
 /**
+ * _XklState:
+ * @group: selected group 
+ * @indicators: set of active indicators
+ *
  * XKB state. Can be global or per-window
  */
-	typedef struct {
-/** 
- * selected group 
- */
+	struct _XklState {
 		gint32 group;
-/**
- * set of active indicators
- */
 		guint32 indicators;
-	} XklState;
+	};
 
 #define XKL_TYPE_STATE (xkl_state_get_type())
 
         GType xkl_state_get_type (void) G_GNUC_CONST;
 
 /**
- *	The main Xklavier engine class
+ * _XklEngine:
+ * @parent: The superclass object
+ *
+ * The main Xklavier engine class
  */
 	struct _XklEngine {
-/**
- * The superclass object
- */
 		GObject parent;
-/**
- * Private data
- */
+                /*< private >*/
 		XklEnginePrivate *priv;
 	};
 
 /**
+ * _XklEngineClass:
+ * @parent_class: The superclass
+ *
  * The XklEngine class, derived from GObject
  */
 	struct _XklEngineClass {
-/**
- * The superclass
- */
 		GObjectClass parent_class;
 
 /**
@@ -131,7 +133,7 @@ extern "C" {
 		 gint(*new_window_notify) (XklEngine * engine, Window win,
 					   Window parent);
 /**
- * XklEngine::state_notify
+ * XklEngine::state_notify:
  * @engine: the object on which the signal is emitted
  * @change_type: mask of changes
  * @group: new group
@@ -145,7 +147,7 @@ extern "C" {
 				      gint group, gboolean restore);
 
 /**
- * XklEngine::new_device_notify
+ * XklEngine::new_device_notify:
  * @engine: the object on which the signal is emitted
  *
  * Used for notifying application of the new keyboard attached
@@ -211,12 +213,14 @@ extern "C" {
 	extern guint xkl_engine_get_max_num_groups(XklEngine * engine);
 
 /**
- * The listener action modes:
+ * XklEngineListenModes:
  *   @XKLL_MANAGE_WINDOW_STATES: The listener process should handle the per-window states 
  *                       and all the related activity
  *   @XKLL_TRACK_KEYBOARD_STATE: Just track the state and pass it to the application above.
  *   @XKLL_MANAGE_LAYOUTS: The listener process should help backend to maintain the configuration
  *                  (manually switch layouts etc).
+ *
+ * The listener action modes:
  */
 	typedef enum {
 		XKLL_MANAGE_WINDOW_STATES = 0x01,
diff --git a/libxklavier/xklavier.c b/libxklavier/xklavier.c
index 8dde702..dd28aa0 100644
--- a/libxklavier/xklavier.c
+++ b/libxklavier/xklavier.c
@@ -348,7 +348,7 @@ xkl_engine_is_window_transparent(XklEngine * engine, Window win)
 							 toplevel_win);
 }
 
-/**
+/*
  * Loads the tree recursively.
  */
 gboolean
@@ -443,7 +443,7 @@ xkl_default_log_appender(const gchar file[], const gchar function[],
 	vfprintf(stdout, format, args);
 }
 
-/**
+/*
  * Just selects some events from the window.
  */
 void
@@ -551,7 +551,7 @@ xkl_engine_reset_all_info(XklEngine * engine, gboolean force,
 			  "NOT Resetting the cache: same configuration\n");
 }
 
-/**
+/*
  * Calling through vtable
  */
 const gchar **
diff --git a/libxklavier/xklavier.h b/libxklavier/xklavier.h
index 1c106ab..ee3bc1e 100644
--- a/libxklavier/xklavier.h
+++ b/libxklavier/xklavier.h
@@ -77,7 +77,7 @@ extern "C" {
 					va_list args);
 
 /**
- * xkl_default_log_appender: (skip):
+ * xkl_default_log_appender:
  * @file: name of the source file. 
  * Preprocessor symbol__FILE__ should be used here
  * @function: name of the function
@@ -95,7 +95,7 @@ extern "C" {
 					     va_list args);
 
 /**
- * xkl_set_log_appender: (skip):
+ * xkl_set_log_appender:
  * @fun: new log appender
  *
  * Installs the custom log appender.function
diff --git a/libxklavier/xklavier_util.c b/libxklavier/xklavier_util.c
index 0891726..1ed0196 100644
--- a/libxklavier/xklavier_util.c
+++ b/libxklavier/xklavier_util.c
@@ -261,7 +261,7 @@ xkl_engine_get_registered_parent(XklEngine * engine, Window win)
 	    Success ? parent : (Window) NULL;
 }
 
-/**
+/*
  * Make sure about the result. Origial XQueryTree is pretty stupid beast:)
  */
 Status