documentation: Remove list association from ATK_ROLE_DESCRIPTION_{TERM,VALUE}
authorJoanmarie Diggs <jdiggs@igalia.com>
Thu, 30 Nov 2017 12:11:26 +0000 (07:11 -0500)
committerJoanmarie Diggs <jdiggs@igalia.com>
Thu, 30 Nov 2017 13:53:32 +0000 (08:53 -0500)
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

atk/atkobject.h

index 8a8aafc..711dda7 100644 (file)
@@ -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