doc: improve documentation of AtkAttribute and AtkAttributeSet

[platform/upstream/atk.git] / atk / atkvalue.c

diff --git a/atk/atkvalue.c b/atk/atkvalue.c
index f8d3236..2a6b083 100755 (executable)
--- a/atk/atkvalue.c
+++ b/atk/atkvalue.c
@@ -20,6 +20,22 @@
 #include <string.h>
 #include "atkvalue.h"
 
+/**
+ * SECTION:atkvalue
+ * @Short_description: The ATK interface implemented by valuators and
+ *  components which display or select a value from a bounded range of
+ *  values.
+ * @Title:AtkValue
+ *
+ * #AtkValue should be implemented for components which either display
+ * a value from a bounded range, or which allow the user to specify a
+ * value from a bounded range, or both.  For instance, most sliders
+ * and range controls, as well as dials, should have #AtkObject
+ * representations which implement #AtkValue on the component's
+ * behalf.  #AtKValues may be read-only, in which case attempts to
+ * alter the value return FALSE to indicate failure.
+ */
+
 GType
 atk_value_get_type (void)
 {