[at-spi2-core] documentation: Remove list association from ATSPI_ROLE_DESCRIPTION_{TERM, VALUE}



commit 319c6405062d8fe2fa2d016462395b992d8fb764
Author: Joanmarie Diggs <jdiggs igalia com>
Date:   Thu Nov 30 07:31:11 2017 -0500

    documentation: Remove list association from ATSPI_ROLE_DESCRIPTION_{TERM,VALUE}
    
    There is a need for term-value pair roles outside of the context of an
    ATSPI_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 ATSPI_ROLE_DESCRIPTION_{TERM,VALUE}.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=791021

 atspi/atspi-constants.h |    9 +++------
 1 files changed, 3 insertions(+), 6 deletions(-)
---
diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
index 1af391d..1604f59 100644
--- a/atspi/atspi-constants.h
+++ b/atspi/atspi-constants.h
@@ -1219,13 +1219,10 @@ typedef enum {
  * of one or more names (@ATSPI_ROLE_DESCRIPTION_TERM) followed by one or more
  * values (@ATSPI_ROLE_DESCRIPTION_VALUE). For each list, there should not be
  * more than one group with the same term name. @Since: 2.26.
- *@ATSPI_ROLE_DESCRIPTION_TERM: An object that represents the term, or name,
- * part of a term-description group in a description list. @Since: 2.26.
+ *@ATSPI_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
+ * with a corresponding definition. @Since: 2.26.
  *@ATSPI_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 @ATSPI_ROLE_DESCRIPTION_VALUE objects for a given
- * @ATSPI_ROLE_DESCRIPTION_TERM. @Since: 2.26.
+ * definition, or value of a term. @Since: 2.26.
  *@ATSPI_ROLE_FOOTNOTE: An object that contains the text of a footnote. @Since: 2.26.
  * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
  * enumeration.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]