[epiphany] ephy-action-helper: document flags API

[Diego Escalante Urrelo <diegoe src gnome org>]

commit 0257e7153ecbe593a0b13cca3ec90f9db03705e7
Author: Diego Escalante Urrelo <diegoe igalia com>
Date:   Mon Jan 23 10:04:48 2012 -0500

    ephy-action-helper: document flags API
    
    https://bugzilla.gnome.org/show_bug.cgi?id=668510

 src/ephy-action-helper.c |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/src/ephy-action-helper.c b/src/ephy-action-helper.c
index ba48eb9..4dbcdce 100644
--- a/src/ephy-action-helper.c
+++ b/src/ephy-action-helper.c
@@ -23,6 +23,20 @@
 
 #define SENSITIVITY_KEY	"EphyAction::Sensitivity"
 
+/**
+ * ephy_action_change_sensitivity_flags:
+ * @action: a #GtkAction object
+ * @flags: arbitrary combination of bit flags, defined by the user
+ * @set: %TRUE if @flags should be added to @action
+ *
+ * This helper function provides an extra layer on top of #GtkAction to
+ * manage its sensitivity. It uses bit @flags defined by the user, like
+ * in ephy-window.c, SENS_FLAG_*.
+ *
+ * Effectively, the @action won't be sensitive until it has no flags
+ * set. This means you can stack @flags for different events or
+ * conditions at the same time.
+ */
 void 
 ephy_action_change_sensitivity_flags (GtkAction *action,
 				      guint flags,