Mercurial > pidgin3 / file diff

--- a/finch/libgnt/gntbindable.h	Sun Feb 02 01:21:37 2014 +0530
+++ b/finch/libgnt/gntbindable.h	Sun Feb 02 02:27:03 2014 +0530
@@ -66,11 +66,6 @@
 
 G_BEGIN_DECLS
 
-/**
- *
- *
- * Returns:
- */
 GType gnt_bindable_get_gtype(void);
 
 /******************/
@@ -105,84 +100,93 @@
 /*GntBindableAction *gnt_bindable_action_parse(const char *name);*/
 
 /**
- * Free a bindable action.
+ * gnt_bindable_action_free:
+ * @action: The bindable action.
  *
- * @action: The bindable action.
+ * Free a bindable action.
  */
 void gnt_bindable_action_free(GntBindableAction *action);
 
 /**
- * Free a GntBindableActionParam.
+ * gnt_bindable_action_param_free:
+ * @param:  The GntBindableActionParam to free.
  *
- * @param:  The GntBindableActionParam to free.
+ * Free a GntBindableActionParam.
  */
 void gnt_bindable_action_param_free(GntBindableActionParam *param);
 
 /**
- * Register a bindable action for a class.
- *
+ * gnt_bindable_class_register_action:
  * @klass:      The class the binding is for.
  * @name:       The name of the binding.
  * @callback:   The callback  for the binding.
  * @trigger:    The default trigger for the binding, or %NULL, followed by a NULL-terminated
  *                   list of default parameters.
+ *
+ * Register a bindable action for a class.
  */
 void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
 
 /**
- * Register a key-binding to an existing action.
- *
+ * gnt_bindable_register_binding:
  * @klass:     The class the binding is for.
  * @name:      The name of the binding.
  * @trigger:   A new trigger for the binding, followed by a %NULL-terminated list of parameters for the callback.
+ *
+ * Register a key-binding to an existing action.
  */
 void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
 
 /**
- * Perform an action from a keybinding.
- *
+ * gnt_bindable_perform_action_key:
  * @bindable:  The bindable object.
  * @keys:      The key to trigger the action.
  *
+ * Perform an action from a keybinding.
+ *
  * Returns:  %TRUE if the action was performed successfully, %FALSE otherwise.
  */
 gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
 
 /**
- * Discover if a key is bound.
- *
+ * gnt_bindable_check_key:
  * @bindable:  The bindable object.
  * @keys:      The key to check for.
  *
+ * Discover if a key is bound.
+ *
  * Returns:  %TRUE if the the key has an action associated with it.
  */
 gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
 
 /**
- * Perform an action on a bindable object.
- *
+ * gnt_bindable_perform_action_named:
  * @bindable:  The bindable object.
  * @name:      The action to perform, followed by a %NULL-terminated list of parameters.
  *
+ * Perform an action on a bindable object.
+ *
  * Returns:  %TRUE if the action was performed successfully, %FALSE otherwise.
  */
 gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...) G_GNUC_NULL_TERMINATED;
 
 /**
- * Returns a GntTree populated with "key" -> "binding" for the widget.
+ * gnt_bindable_bindings_view:
+ * @bind:  The object to list the bindings for.
  *
- * @bind:  The object to list the bindings for.
+ * Returns a GntTree populated with "key" -> "binding" for the widget.
  *
  * Returns:   The GntTree.
  */
 GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
 
 /**
+ * gnt_bindable_build_help_window:
+ * @bindable:   The object to list the bindings for.
+ *
  * Builds a window that list the key bindings for a GntBindable object.
  * From this window a user can select a listing to rebind a new key for the given action.
  *
- * @bindable:   The object to list the bindings for.
- *
  * Returns:  %TRUE
  */