summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoanmarie Diggs <jdiggs@igalia.com>2017-11-30 07:11:26 -0500
committerJoanmarie Diggs <jdiggs@igalia.com>2017-11-30 08:53:32 -0500
commit4a2632dadfdb8450e80e1d41a1b521d62a241641 (patch)
tree3836dfec815f4f1f0fabdd23c4d6c8877259db63
parent35a473048fa9e257450ce618e86ff2e4e8973900 (diff)
downloadatk-4a2632dadfdb8450e80e1d41a1b521d62a241641.tar.gz
documentation: Remove list association from ATK_ROLE_DESCRIPTION_{TERM,VALUE}
There is a need for term-value pair roles outside of the context of an ATK_ROLE_DESCRIPTION_LIST. Rather than create yet more roles, we can just update the documentation so that the list association is not made within the definition of ATK_ROLE_DESCRIPTION_{TERM,VALUE}. https://bugzilla.gnome.org/show_bug.cgi?id=791020
-rw-r--r--atk/atkobject.h10
1 files changed, 3 insertions, 7 deletions
diff --git a/atk/atkobject.h b/atk/atkobject.h
index 8a8aafc..711dda7 100644
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -192,14 +192,10 @@ G_BEGIN_DECLS
* (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
* (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
* more than one group with the same term name. @Since: ATK-2.12
- *@ATK_ROLE_DESCRIPTION_TERM: An object that represents the term, or
- * name, part of a term-description group in a description
- * list. @Since: ATK-2.12
+ *@ATK_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
+ * with a corresponding definition. @Since: ATK-2.12
*@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
- * description, definition or value of a term-description group in a
- * description list. The values within a group are alternatives,
- * meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a
- * given ATK_ROLE_DESCRIPTION_TERM. @Since: ATK-2.12
+ * description, definition or value of a term. @Since: ATK-2.12
*@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a
* brief amount of information to the user and whose role is known by the
* implementor but lacks semantic value for the user. Examples in which