From 4f6af53bad4ec54579484a07b0291b781bcbb8ad Mon Sep 17 00:00:00 2001
From: =?utf8?q?Alejandro=20Pi=C3=B1eiro?= <apinheiro@igalia.com>
Date: Tue, 12 Nov 2013 18:31:40 +0100
Subject: [PATCH] doc: improve documentation of AtkAttribute and
 AtkAttributeSet

---
 atk/atkobject.h       | 25 +++++++++++++++++--------
 docs/atk-sections.txt |  4 ++--
 2 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/atk/atkobject.h b/atk/atkobject.h
index f282c41..8b4ce7f 100755
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -311,20 +311,29 @@ typedef enum
  * AtkAttributeSet:
  *
  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
- * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
- * and atk_editable_text_set_run_attributes()
+ * used by atk_text_get_run_attributes(),
+ * atk_text_get_default_attributes(),
+ * atk_editable_text_set_run_attributes(),
+ * atk_document_get_attributes() and atk_object_get_attributes()
  **/
 typedef GSList AtkAttributeSet;
 
 /**
  * AtkAttribute:
- * @name: The attribute name. Call atk_text_attr_get_name()
- * @value: the value of the attribute, represented as a string. 
- * Call atk_text_attr_get_value() for those which are strings.
- * For values which are numbers, the string representation of the number 
- * is in value.
+ * @name: The attribute name.
+ * @value: the value of the attribute, represented as a string.
  *
- * A string name/value pair representing a text attribute. 
+ * AtkAttribute is a string name/value pair representing a generic
+ * attribute. This can be used to expose additional information from
+ * an accessible object as a whole (see atk_object_get_attributes())
+ * or an document (see atk_document_get_attributes()). In the case of
+ * text attributes (see atk_text_get_default_attributes()),
+ * #AtkTextAttribute enum defines all the possible text attribute
+ * names. You can use atk_text_attribute_get_name() to get the string
+ * name from the enum value. See also atk_text_attribute_for_name()
+ * and atk_text_attribute_get_value() for more information.
+ *
+ * A string name/value pair representing a generic attribute.
  **/
 typedef struct _AtkAttribute AtkAttribute;
 
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index 79e7c1f..881ad60 100644
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -162,6 +162,8 @@ AtkRole
 atk_role_register
 AtkLayer
 AtkImplementor
+AtkAttribute
+AtkAttributeSet
 AtkPropertyValues
 AtkFunction
 AtkPropertyChangeHandler
@@ -398,8 +400,6 @@ AtkTextGranularity
 AtkTextClipType
 AtkTextRange
 AtkTextRectangle
-AtkAttribute
-AtkAttributeSet
 AtkTextAttribute
 atk_text_get_text
 atk_text_get_character_at_offset
-- 
2.11.4.GIT