[at-spi2-core] Fix some annotations compilation warnings

From: Javier HernÃndez AntÃnez <jhernandez src gnome org>
To: commits-list gnome org
Cc:
Subject: [at-spi2-core] Fix some annotations compilation warnings
Date: Tue, 4 Sep 2012 16:51:52 +0000 (UTC)
commit bbb28bfb926d095e336bb532a9543ad07d2c6649
Author: Javier HernÃndez <jhernandez emergya com>
Date:   Tue Sep 4 03:58:34 2012 +0200

    Fix some annotations compilation warnings

 atspi/atspi-accessible.c |    1 -
 atspi/atspi-collection.c |   29 +++++------------------------
 atspi/atspi-matchrule.c  |   35 +++++++++++++----------------------
 atspi/atspi-stateset.c   |   30 +++++++-----------------------
 4 files changed, 25 insertions(+), 70 deletions(-)
---
diff --git a/atspi/atspi-accessible.c b/atspi/atspi-accessible.c
index 3159f05..ca98d8b 100644
--- a/atspi/atspi-accessible.c
+++ b/atspi/atspi-accessible.c
@@ -1448,7 +1448,6 @@ _atspi_accessible_new (AtspiApplication *app, const gchar *path)
 
 /**
  * atspi_accessible_set_cache_mask:
- *
  * @accessible: The #AtspiAccessible to operate on.  Must be the desktop or
  *             the root of an application.
  * @mask: (type int): An #AtspiCache specifying a bit mask of the types of data to cache.
diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c
index 138d658..9e1a7b5 100644
--- a/atspi/atspi-collection.c
+++ b/atspi/atspi-collection.c
@@ -101,16 +101,11 @@ return_accessibles (DBusMessage *message)
 
 /**
  * atspi_collection_get_matches:
- *
  * @collection: A pointer to the #AtspiCollection to query.
- *
  * @rule: An #AtspiMatchRule describing the match criteria.
- *
  * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
  *          be sorted.
- *
  * @count: The maximum number of results to return, or 0 for no limit.
- *
  * @traverse: Not supported.
  *
  * Gets all #AtspiAccessible objects from the @collection matching a given
@@ -150,25 +145,18 @@ atspi_collection_get_matches (AtspiCollection *collection,
 
 /**
  * atspi_collection_get_matches_to:
- *
  * @collection: A pointer to the #AtspiCollection to query.
- *
  * @current_object: The object at which to start searching.
- *
  * @rule: An #AtspiMatchRule describing the match criteria.
- *
  * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
  *          be sorted.
- *
  * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
- *        the objects to be traversed.
- *
+ *          the objects to be traversed.
  * @limit_scope: If #TRUE, only descendants of @current_object's parent
- * will be returned. Otherwise (if #FALSE), any accessible may be returned
- * if it would preceed @current_object in a flattened hierarchy.
- *
+ *          will be returned. Otherwise (if #FALSE), any accessible may be
+ *          returned if it would preceed @current_object in a flattened
+ *          hierarchy.
  * @count: The maximum number of results to return, or 0 for no limit.
- *
  * @traverse: Not supported.
  *
  * Gets all #AtspiAccessible objects from the @collection, after 
@@ -218,21 +206,14 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
 
 /**
  * atspi_collection_get_matches_from:
- *
  * @collection: A pointer to the #AtspiCollection to query.
- *
  * @current_object: Upon reaching this object, searching should stop.
- *
  * @rule: An #AtspiMatchRule describing the match criteria.
- *
  * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
  *          be sorted.
- *
  * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
- *        the objects to be traversed.
- *
+ *          the objects to be traversed.
  * @count: The maximum number of results to return, or 0 for no limit.
- *
  * @traverse: Not supported.
  *
  * Gets all #AtspiAccessible objects from the @collection, before  
diff --git a/atspi/atspi-matchrule.c b/atspi/atspi-matchrule.c
index d68cdb9..60060bb 100644
--- a/atspi/atspi-matchrule.c
+++ b/atspi/atspi-matchrule.c
@@ -77,37 +77,28 @@ atspi_match_rule_class_init (AtspiMatchRuleClass *klass)
 
 /**
  * atspi_match_rule_new:
- *
  * @states: An #AtspiStateSet specifying the states to match or NULL if none.
- *
  * @statematchtype: An #AtspiCollectionMatchType specifying how to interpret
- *                  @states.
- *
+ *          @states.
  * @attributes: (element-type gchar* gchar*): A #GHashTable specifying
- *              attributes to match.
- *
+ *          attributes to match.
  * @attributematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @attributes.
- *
+ *          interpret @attributes.
  * @interfaces: (element-type gchar*): An array of interfaces to match, or
- *              NULL if not applicable.  Interface names should be specified
- *              by their DBus names (org.a11y.Atspi.Accessible,
- *              org.a11y.Atspi.Component, etc).
- *
+ *          NULL if not applicable.  Interface names should be specified
+ *          by their DBus names (org.a11y.Atspi.Accessible,
+ *          org.a11y.Atspi.Component, etc).
  * @interfacematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @interfaces.
- *
+ *          interpret @interfaces.
  * @roles: (element-type AtspiRole): A #GArray of roles to match, or NULL if
- *         not applicable.
- *
+ *          not applicable.
  * @rolematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @roles.
- *
+ *          interpret @roles.
  * @invert: if #TRUE, the match rule should be denied (inverted); if #FALSE,
- * it should not. For example, if the match rule defines that a match is
- * an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, 
- * inverting it would match all objects that are not of ROLE_HEADING, 
- * focusable and clickable at the same time.  
+ *          it should not. For example, if the match rule defines that a match is
+ *          an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action,
+ *          inverting it would match all objects that are not of ROLE_HEADING,
+ *          focusable and clickable at the same time.
  *
  * Creates a new #AtspiMatchRule with specified @states, @attributes, 
  * @interfaces, and @roles.
diff --git a/atspi/atspi-stateset.c b/atspi/atspi-stateset.c
index b5619e8..fd6fc0c 100644
--- a/atspi/atspi-stateset.c
+++ b/atspi/atspi-stateset.c
@@ -87,9 +87,8 @@ atspi_state_set_class_init (AtspiStateSetClass* klass)
 
 /**
  * atspi_state_set_new:
- *
  * @states: (element-type AtspiStateType): An array of states with which the
- * method initializes the state set.
+ *          method initializes the state set.
  *
  * Generates an #AtspiStateSet with the given @states.
  *
@@ -124,13 +123,10 @@ _atspi_state_set_new_internal (AtspiAccessible *accessible, gint64 states)
 
 /**
  * atspi_state_set_set_by_name:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
- *
  * @name: a string corresponding to a state name.
- * 
- * @enabled: if #TRUE, @name should be enabled in the @set in question; otherwise, it
- * should be disabled. 
+ * @enabled: if #TRUE, @name should be enabled in the @set in question;
+ *          otherwise, it should be disabled.
  *
  * Enables/disables a state in an #AtspiStateSet according to its @name.
  **/
@@ -180,9 +176,7 @@ refresh_states (AtspiStateSet *set)
 
 /**
  * atspi_state_set_add:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
- *
  * @state: an #AtspiStateType to be added to the specified #AtspiStateSet.
  *
  * Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the
@@ -198,9 +192,7 @@ atspi_state_set_add (AtspiStateSet *set, AtspiStateType state)
 
 /**
  * atspi_state_set_compare:
- *
  * @set: a pointer to the first #AtspiStateSet object on which to operate.
- *
  * @set2: a pointer to the second #AtspiStateSet object on which to operate.
  *
  * Determines the differences between two instances of #AtspiStateSet.
@@ -223,14 +215,12 @@ atspi_state_set_compare (AtspiStateSet *set,
 
 /**
  * atspi_state_set_contains:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
- *
  * @state: an #AtspiStateType for which the specified #AtspiStateSet
- *       will be queried.
+ *          will be queried.
  *
  * Determines whether a given #AtspiStateSet includes a given state; that is,
- *       whether @state is true for the @set in question.
+ *          whether @state is true for the @set in question.
  *
  * Returns: #TRUE if @state is true/included in the given #AtspiStateSet,
  *          otherwise #FALSE.
@@ -248,14 +238,12 @@ atspi_state_set_contains (AtspiStateSet *set,
 
 /**
  * atspi_state_set_equals:
- *
  * @set: a pointer to the first #AtspiStateSet object on which to operate.
- *
  * @set2: a pointer to the second #AtspiStateSet object on which to operate.
  *
  * Determines whether two instances of #AtspiStateSet are equivalent (i.e.
- *         consist of the same #AtspiStates).  Useful for checking multiple
- *         state variables at once.
+ *          consist of the same #AtspiStates).  Useful for checking multiple
+ *          state variables at once.
  *
  * @see #atspi_state_set_compare.
  *
@@ -276,7 +264,6 @@ atspi_state_set_equals (AtspiStateSet *set,
 
 /**
  * atspi_state_set_get_states:
- *
  * @set: The #AtspiStateSet to be queried.
  *
  * Returns the states in an #AtspiStateSet as an array.
@@ -307,7 +294,6 @@ atspi_state_set_get_states (AtspiStateSet *set)
 
 /**
  * atspi_state_set_is_empty:
- *
  * @set: The #AtspiStateSet to query.
  *
  * Returns: #TRUE if the state set contains no states; #FALSE otherwise.
@@ -320,9 +306,7 @@ atspi_state_set_is_empty (AtspiStateSet *set)
 
 /**
  * atspi_state_set_remove:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
- *
  * @state: an #AtspiStateType to remove from the specified @set.
  *
  * Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]