Created attachment 192671 [details] [review]
Some documentation improvements for AtspiAccessible

Some documentation improvements for AtspiAccessible.

Created attachment 192672 [details] [review]
Some documentation improvements for atspi-text

Some documentation improvements for atspi-text.

Created attachment 192679 [details] [review]
Some documentation improvements for atspi-image

Some documentation improvements for atspi-image.

Comment on attachment 192671 [details] [review]
Some documentation improvements for AtspiAccessible

Looks good over-all.  Thanks for the patch.  You've caught quite a few functions that were either missing a trailing : or had wrong type names; the code was derived from cspi, which had different names for all of the functions and most types and parameters, so those types of glitches might be there.

>- * Get the UI role of an #AtspiAccessible object.
>+ * Gets the UI role played by an #AtspiAccessible object.

I wouldn't have made this wording change, but I guess either wording is okay.


>@@ -719,12 +723,12 @@ add_to_attribute_array (gpointer key, gpointer >- * Returns: (element-type gchar*) (transfer full): The name-value-pair
>+ * Returns: (element-type GArray*) (transfer full): The name-value-pair
>  *          attributes assigned to this object.

Actually, (element-type gchar *) is appropriate here.  The function returns a GArray of strings, and element-type is a gobject-introspection annotation (used for GI bindings for Python and potentially other languages) specifying the element-type of items _inside_ the GArray container, not the type of the container itself.  See http://live.gnome.org/GObjectIntrospection/Annotations

>+/**
>+ * atspi_accessible_new:
>+ * @app: an #AtspiApplication reference to the new objects's parent application.
>+ * @path: a UTF-8 string indicating the new object's parent path.
>+ *
>+ * Creates a new #AtspiAccessible object.
>+ * Returns: a new #AtspiAccessible object. 
>+ **/

This is an internal function not meant to be public, so it should not be documented by gtk-doc.  I should really have named it _atspi_accessible_new(), so I think that renaming it would make sense.  Also, "parent" in this context refers to AtspiObject (used internally as a base for AtspiAccessible and AtspiHyperlink).  I'm not sure that it necessarily needs a comment, and I'm fine with it having one or not, but, if it has one, then the parameters should look something like this:
* @app: the #AtspiApplication associated with this object.
 * @path: the object's D-Bus object path.
 AtspiAccessible *

Thanks, Mike! I'll work on these changes and send new patches asap.

Also, mclasen mentioned that the new way of handling descriptions is to edit the .c files directly, so, since this is new documentation, I think that adding them this way would be good if possible.  You could grep the gtk 3 sources for @short_description (after the SECTION comment) for an example.

Anyway, thanks again for your work!

Created attachment 192716 [details] [review]
Some documentation improvements for AtspiAccessible

Mike,

I added your suggestions in this patch. Since atspi_accessible_new isn't public, it won't be gtk-documented. I intend to add some simple comments on it (as well as on every other private method) after finishing the gtk-doc documentation. It's in my TODOLIST since yesterday. :) When I start doing it, your comments about this method's attributes will be very useful.

About the "Get/Gets" renaming, I did it simply because it sounds more natural to me. ATK uses "Gets", too.

Thanks for taking a look! More patches are on the way.

Created attachment 192717 [details] [review]
Some documentation improvements for atspi-document

Some documentation improvements for atspi-document.

Created attachment 192718 [details] [review]
Some documentation improvements for atspi-value

Some documentation improvements for atspi-value.

Created attachment 192719 [details] [review]
Some documentation improvements for atspi-hypertext

Some documentation improvements for atspi-hypertext.

Comment on attachment 192672 [details] [review]
Some documentation improvements for atspi-text

Looks okay to me.  Do you have commit access?

Comment on attachment 192716 [details] [review]
Some documentation improvements for AtspiAccessible

Looks okay; thanks for the fixes.

Comment on attachment 192718 [details] [review]
Some documentation improvements for atspi-value

Looks good; just one small nit:

> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface supporting a one-dimensional scalar 
>+to be modified, or which reflects its value. If
>+STATE_EDITABLE is not present, the valuator is
>+treated as "read only".

I don't think "valuator" is the word you want here (yeah; I know that it is used in the AtkValue docs).  I'd just put "value" instead.

Created attachment 192775 [details] [review]
Some documentation improvements for atspi-value

Adding Mike's suggestions to atspi-value documentation.

Created attachment 192778 [details] [review]
Some documentation improvements for atspi-editabletext

Some documentation improvements for atspi-editabletext.

Created attachment 192779 [details] [review]
Some documentation improvements for atspi-table

Some documentation improvements for atspi-table.

Created attachment 192780 [details] [review]
Some documentation improvements for atspi-selection

Some documentation improvements for atspi-selection.

Created attachment 193019 [details] [review]
Some documentation improvements for atspi-component

Some documentation improvements for atspi-component.

Mike, could you please tell me if I'm supposed to gtk-document atspi_rect_copy and/or atspi_point_copy? Thanks!

Created attachment 193022 [details] [review]
Some documentation improvements for atspi-collection

Some documentation improvements for atspi-collection.

There are still some arguments (recurse and traverse) i couldn't figure out. Help is very welcome. =)

Created attachment 193025 [details] [review]
Some documentation improvements for atspi-stateset

Some documentation improvements for atspi-stateset.

Created attachment 193095 [details] [review]
Some documentation improvements for atspi-application

Some documentation improvements for atspi-application.

Created attachment 193098 [details] [review]
Some documentation improvements for atspi-relation

Some documentation improvements for atspi-relation.

Created attachment 193104 [details] [review]
Some documentation improvements for atspi-matcherule

Some documentation improvements for atspi-matcherule.

Created attachment 193107 [details] [review]
Some documentation improvements for atspi-devicelistener

Some documentation improvements for atspi-devicelistener.

Created attachment 193222 [details] [review]
Some documentation improvements for atspi-registry

Some documentation improvements for atspi-registry. I wish I could reuse more of these descriptions

http://people.gnome.org/~billh/at-spi-idl/html/classAccessibility_1_1Registry.html

but I'm not sure if this is how things work nowadays... Help is welcome.

Created attachment 193277 [details] [review]
Some documentation improvements for atspi-types

Some documentation improvements for atspi-types.

Created attachment 193287 [details] [review]
Some documentation improvements for atspi-constants.

Some documentation improvements for atspi-constants.

I couldn't figure out how some constants work, this is why they miss documentation.

Help is very welcome.

Created attachment 193325 [details] [review]
Some documentation improvements for atspi-hyperlink

Some documentation improvements for atspi-hyperlink.

Created attachment 193327 [details] [review]
Some documentation improvements for atspi-event-listener

Some documentation improvements for atspi-event-listener.

Created attachment 193329 [details] [review]
Some documentation improvements for atspi-misc

Some documentation improvements for atspi-misc.

Created attachment 193457 [details] [review]
Some documentation improvements for atspi-constants

This is a better version of my improvements on atspi-constants.

Instead of only describing the enumerations, I tried to detail the constants, too. AtspiCollectionSortOrder and AtspiCollectionTreeTraversalType constants were not documented, since I am waiting for some feedback on them.

(In reply to comment #15)
> Created an attachment (id=192778) [details] [review]
> Some documentation improvements for atspi-editabletext
> 
> Some documentation improvements for atspi-editabletext.

While we're looking at this, I'd like the "length" parameter in atspi_editable_text_insert_text to be documented to accept -1, meaning that the whole string should be inserted.  I think it would be good to similarly document this in atk; it seems to be a gtk convention, and this is the gtk/gail behavior, since the atk classes pass the value to gtk functions which have that behavior, but it is not currently documented.  However, this is effectively an addition to the spec and so goes beyond a documentation fix.  Alex, do you have an opinion as to whether this makes sense?

API, looks like you weren't CCed on this bug.  See my last comment.

Comment on attachment 192779 [details] [review]
Some documentation improvements for atspi-table

Looks good; I noticed a couple of additional things (both present in the original) that you could fix if you'd like.

>@@ -29,10 +29,11 @@
>- * Returns: (transfer full): an #Accessible object that serves as the table's


Should be #AtspiAccessible (another left-over CSPI-ism).


>@@ -331,10 +337,10 @@ atspi_table_get_column_extent_at (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @row: the specified table row, zero-indexed.
>  *
>- * Get the header associated with a table row, if available.  This differs from
>- * atspi_table_get_row_description, which returns a string.
>+ * Returns: (transfer full): an #AtspiAccessible representatin of the specified

representatin -> representation (typo in the original).

Thanks!

Comment on attachment 192780 [details] [review]
Some documentation improvements for atspi-selection

Looks good.

>@@ -114,11 +116,11 @@ atspi_selection_select_child (AtspiSelection >+ * Removes a child to the selected children list of an #AtspiSelection.

Grammar: Should be "Removes a child from the selected children list ..." But this was there in the original, so fix if you'd like.

Thanks for all comments, Mike! I'll update the related patches asap. :-)

Created attachment 193607 [details] [review]
Some documentation improvements for atspi-table (typo fixed)

Some documentation improvements for atspi-table (typo fixed).

Created attachment 193608 [details] [review]
Some documentation improvements for atspi-selection (grammar issue fixed)

Some documentation improvements for atspi-selection (grammar issue fixed)

Created attachment 193609 [details] [review]
Some documentation improvements for atspi-editabletext (adding more documentation for length parameter at atspi_editable_text_insert_text)

Some documentation improvements for atspi-editabletext (adding more documentation for length parameter at atspi_editable_text_insert_text).

I didn't mark the previous editabletext patch as obsolete because we're waiting for Alex' feedback about it.

Review of attachment 193457 [details] [review]:

To echo what Mike has said in reviewing some of your other patches, almost all of the following are a) nits present in the original documentation and b) NOT something you did. But as long as we're cleaning all of this stuff up.... :-) And some of them are questions to which I do not have definitive answers, but would ask you (and others) to consider them.

1. Do these sorts of things belong in the documentation? Perhaps so. It's a genuine question. Their presence simply struck me as odd when looking at the resulting HTML:

   #define ATSPI_SORTORDER_COUNT (7+1)
   One higher than the highest valid value of AtspiCollectionSortOrder.

2. Spelling nit from the old docs:

   Indicates the orientation of *thsi* object is horizontal

3. General inconsistency with the definitions in the old docs. Let's decide and be consistent throughout: Start with capital letter or not? End with a period or not? In addition, unless there's a good reason why the AtspiEventType definitions start with a '<' and nothing else does....

4. Capitalization nit from the old docs ('note' should be 'Note'):

   ... without specifying a hardware key. note

5. Property reference consistency from the old docs: 

   * an instance of 'accessible-description property'
   * an instance of 'accessibleName property'

My personal vote would be 'accessible description property' and 'accessible name property' unless there is some overriding rule which dictates otherwise. But whatever is chosen, the format should be consistent.

6. Regarding ATSPI_Collection_MATCH_INVALID: The other 'invalid' items are accompanied by a statement that it probably is an error condition. Can we verify that is the case here and, if so, state that in the docs rather than say nothing for that one lone item? (Contrary to some of the other questionable Collection related things, I expect MatchRule to stay.)

7. In this text: "Similarly, ATSPI_RELATION_CONTROLLER_FOR can be used to further specify the context in which a valuator is useful, and/or the other UI components which are directly effected by user interactions with the valuator. Common examples include association of scrollbars with the viewport or panel which they control."

Mike had suggested as a general rule to prefer 'value' instead of (the old docs') 'valuator'. I agree. However, I'm not convinced *in the above example* 'valuator' or 'value' is the right term. So we can try to come up with a more accurate term. However, with the nice definitions which follow, I'm tempted to say the above examples are redundant/unnecessary. In other words:

"AtspiRelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship. It allows better semantic identification of how objects are associated with one another. <strike>For instance the ATSPI_RELATION_LABELLED_BY relationship may be used to identify labelling information that should accompany the accessibleName property when presenting an object's content or identity to the end user. Similarly, ATSPI_RELATION_CONTROLLER_FOR can be used to further specify the context in which a valuator is useful, and/or the other UI components which are directly effected by user interactions with the valuator. Common examples include association of scrollbars with the viewport or panel which they control.</strike>"

8. There are a number of instances where you have added: "Enumeration used by interface Foo to specify or do something with respect to Bar." And by saying what the enum in question is actually for, you make life much better for all involved. :-) Thanks!! But your useful statements are followed by the old docs' "Bitfield/set of flags generated from the AT-SPI specification." So I'm wondering: Is there a better way to encapsulate both into a single statement.?

Again, you'll note that 99% of the above fall under the category of "things not in your work." They are just things I noticed when reading the resulting HTML.

Thanks again VERY, VERY much for all the time and energy you have invested here!!

(In reply to comment #32)
> (In reply to comment #15)
> > Created an attachment (id=192778) [details] [review] [details] [review]
> > Some documentation improvements for atspi-editabletext
> > 
> > Some documentation improvements for atspi-editabletext.
> 
> While we're looking at this, I'd like the "length" parameter in
> atspi_editable_text_insert_text to be documented to accept -1, meaning that the
> whole string should be inserted.  I think it would be good to similarly
> document this in atk; it seems to be a gtk convention, and this is the gtk/gail
> behavior, since the atk classes pass the value to gtk functions which have that
> behavior, but it is not currently documented.  However, this is effectively an
> addition to the spec and so goes beyond a documentation fix.  Alex, do you have
> an opinion as to whether this makes sense?

Well, it makes sense to me, as far as it is true that this function have this behaviour. Is this the current case right now?

Created attachment 193734 [details] [review]
Some documentation improvements for atspi-constants.

This patch adds corrections/changes for Joanie's review points 2, 3, 4, 5, 6. 

About point 1:

  I didn't change it because it's a removing action, so I guess it's important to hear your opinions first, Mike and Piñeiro. IMHO, nuking these documentations would be better; they look strange to me, too.

About point 7:

  IMO, this example is unnecessary. I just didn't remove it in the first moment because perhaps someone thinks they're important. In other words, I agree with Joanie about it - actually, I think examples like this should be nuked in other points of atspi-accessible.h. They look messy to me...

About point 8: 

  IMO, "Bitfield/set of flags generated from the AT-SPI specification." statements add nothing to the documentation. I think they should be removed, too.

Comments? ;)

(In reply to comment #41)
the
> > whole string should be inserted.  I think it would be good to similarly
> > document this in atk; it seems to be a gtk convention, and this is the gtk/gail
> > behavior, since the atk classes pass the value to gtk functions which have that
> > behavior, but it is not currently documented.  However, this is effectively an
> > addition to the spec and so goes beyond a documentation fix.  Alex, do you have
> > an opinion as to whether this makes sense?
> 
> Well, it makes sense to me, as far as it is true that this function have this
> behaviour. Is this the current case right now?

It behaves this way for gtk, but I'm not sure other than that.  At least for now, I think it would make sense to have libatspi replace -1 with the length of the string.  However, I guess this would be a new "feature," so it would need to wait for 3.4.  So we might as well just leave things be for now, and I can add that in to the documentation if I make a code change.  Whether atk should document this behavior as expected on the part of implementors (or convert the parameter before calling the vfunc) could be considered separately from this.

(In reply to comment #42)
> 
> About point 1:
> 
>   I didn't change it because it's a removing action, so I guess it's important
> to hear your opinions first, Mike and Piñeiro. IMHO, nuking these
> documentations would be better; they look strange to me, too.
> 
> About point 7:
> 
>   IMO, this example is unnecessary. I just didn't remove it in the first moment
> because perhaps someone thinks they're important. In other words, I agree with
> Joanie about it - actually, I think examples like this should be nuked in other
> points of atspi-accessible.h. They look messy to me...
> 
> About point 8: 
> 
>   IMO, "Bitfield/set of flags generated from the AT-SPI specification."
> statements add nothing to the documentation. I think they should be removed,
> too.
> 
> Comments? ;)

All of these changes are okay with me.  I think the "generated from AT-SPI specification" comments are left over from before Mark removed the Telepathy markup and we were auto-generating a header from the xml specification.  The header is not currently auto-generated from everything, so you can remove those comments.

(In reply to comment #19)
> There are still some arguments (recurse and traverse) i couldn't figure out.
> Help is very welcome. =)

I don't know what "traverse" was supposed to be, but it is unsupported in the only application-side implementation (in at-spi2-atk), and Joanie thinks that it should go away, since, as with some other things in the collections API, no one uses it.  So I think that writing "not supported" for it would make sense for now.

"Recurse" should be renamed to "restrict"; this was discussed on the wiki but evidently not done completely.  If it is true for atspi_collection_get_matches_to, then only descendants of the parent of @current_object will be returned.  Otherwise any accessible in the document may be returned if it would preceed @current_object in a flattened hierarchy.

(In reply to comment #43)

Ok, patch https://bugzilla.gnome.org/attachment.cgi?id=193609 should not be used until the -1 feature is implemented. =)

Created attachment 194174 [details] [review]
Removes -1 length documentation (according to comment #41) from atspi-editabletext

Removes -1 length documentation (according to comment #41) from atspi-editabletext

Created attachment 194176 [details] [review]
Removes "bitset" references in atspi-constants (comment #42)

Removes "bitset" references in atspi-constants (comment #42).

Created attachment 194179 [details] [review]
Fixing traverse and recurse/restrict documentation (comment #45)

Fixing traverse and recurse/restrict documentation (comment #45).

Comment on attachment 194174 [details] [review]
Removes -1 length documentation (according to comment #41) from atspi-editabletext






>From ad28daaf8fffa1c7e8d0891ca2357720d9b740cb Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 21:39:32 -0300
>Subject: [PATCH 1/4] Improving atspi-editabletext.c documentation
>
>---
> atspi/atspi-editabletext.c |   54 ++++++++++++++++++++++---------------------
> 1 files changed, 28 insertions(+), 26 deletions(-)
>
>diff --git a/atspi/atspi-editabletext.c b/atspi/atspi-editabletext.c
>index 153230c..58ac715 100644
>--- a/atspi/atspi-editabletext.c
>+++ b/atspi/atspi-editabletext.c
>@@ -28,12 +28,12 @@
> /**
>  * atspi_editable_text_set_attributes:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @attributes: a character string indicating the attributes to apply to the range,
>+ * @attributes: a string indicating the attributes to apply to the range,
>  *        delimited by ':'.
>- * @startOffset: a #long indicating the start of the desired text range.
>- * @endOffset: a #long indicating the first character past the desired range.
>+ * @startOffset: a #gint indicating the start of the desired text range.
>+ * @endOffset: a #gint indicating the first character past the desired range.
>  *
>- * Set the attributes applied to a range of text from an #AtspiEditableText
>+ * Sets the attributes applied to a range of text from an #AtspiEditableText
>  *          object, and the bounds of the range.
>  *
>  * Returns: #TRUE if the operation was successful, otherwise #FALSE.
>@@ -83,15 +83,17 @@ atspi_editable_text_set_text_contents (AtspiEditableText *obj,
> /**
>  * atspi_editable_text_insert_text:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @position: an integer indicating the character offset at which to insert
>+ * @position: a #gint indicating the character offset at which to insert
>  *       the new text.  
>- * @text: a gchar* pointer to the text to insert, in UTF-8 encoding.
>- * @length: (frankly I'm not sure this parameter should be here)
>+ * @text: a string representing the text to insert, in UTF-8 encoding.
>+ * @length:  the number of characters of text to insert. If the character
>+ * count of text is less than or equal to length, the entire contents
>+ * of text will be inserted.
>  *
>- * Insert text into an #AtspiEditableText object.
>+ * Inserts text into an #AtspiEditableText object.
>  * As with all character offsets, the specified @position may not be the
>- *       same as the resulting byte offset, since the text is in a
>- *       variable-width encoding.
>+ * same as the resulting byte offset, since the text is in a
>+ * variable-width encoding.
>  *
>  * Returns: #TRUE if the operation was successful, otherwise #FALSE.
>  **/
>@@ -115,14 +117,14 @@ atspi_editable_text_insert_text (AtspiEditableText *obj,
> /**
>  * atspi_editable_text_copy_text:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @start_pos: an integer indicating the starting character offset
>+ * @start_pos: a #gint indicating the starting character offset
>  *       of the text to copy.
>- * @end_pos: an integer indicating the offset of the first character
>+ * @end_pos: a #gint indicating the offset of the first character
>  *       past the end of the text section to be copied.
>  *
>- * Copy text from an #AtspiEditableText object into the clipboard.
>+ * Copies text from an #AtspiEditableText object into the system clipboard.
>  *
>- * see: atspi_editable_text_paste_text 
>+ * see: #atspi_editable_text_paste_text 
>  *
>  * Returns: #TRUE if the operation was successful, otherwise #FALSE.
>  **/
>@@ -144,15 +146,15 @@ atspi_editable_text_copy_text (AtspiEditableText *obj,
> /**
>  * atspi_editable_text_cut_text:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @start_pos: an integer indicating the starting character offset
>+ * @start_pos: a #gint indicating the starting character offset
>  *       of the text to cut.
>- * @end_pos: an integer indicating the offset of the first character
>+ * @end_pos: a #gint indicating the offset of the first character
>  *       past the end of the text section to be cut.
>  *
>- * Delete text from an #AtspiEditableText object, copying the
>- *       excised portion into the clipboard.
>+ * Deletes text from an #AtspiEditableText object, copying the
>+ *       excised portion into the system clipboard.
>  *
>- * see: atspi_editable_text_paste_text
>+ * see: #atspi_editable_text_paste_text
>  *
>  * Returns: #TRUE if operation was successful, #FALSE otherwise.
>  **/
>@@ -175,15 +177,15 @@ atspi_editable_text_cut_text (AtspiEditableText *obj,
> /**
>  * atspi_editable_text_delete_text:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @start_pos: an integer indicating the starting character offset
>+ * @start_pos: a #gint indicating the starting character offset
>  *       of the text to delete.
>- * @end_pos: an integer indicating the offset of the first character
>+ * @end_pos: a #gint indicating the offset of the first character
>  *       past the end of the text section to be deleted.
>  *
>- * Delete text from an #AtspiEditableText object, without copying the
>- *       excised portion into the clipboard.
>+ * Deletes text from an #AtspiEditableText object, without copying the
>+ *       excised portion into the system clipboard.
>  *
>- * see: atspi_editable_text_cut_text
>+ * see: #atspi_editable_text_cut_text
>  *
>  * Returns: #TRUE if the operation was successful, otherwise #FALSE.
>  **/
>@@ -206,10 +208,10 @@ atspi_editable_text_delete_text (AtspiEditableText *obj,
> /**
>  * atspi_editable_text_paste_text:
>  * @obj: a pointer to the #AtspiEditableText object to modify.
>- * @position: an integer indicating the character offset at which to insert
>+ * @position: a #gint indicating the character offset at which to insert
>  *       the new text.  
>  *
>- * Insert text from the clipboard into an #AtspiEditableText object.
>+ * Inserts text from the system clipboard into an #AtspiEditableText object.
>  * As with all character offsets, the specified @position may not be the
>  *       same as the resulting byte offset, since the text is in a
>  *       variable-width encoding.
>-- 
>1.7.6
>
>
>From bb3ad3750f264e2a19c5cb38610b3f5fbbe30143 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 21:57:52 -0300
>Subject: [PATCH 2/4] Adding descriptions for atspi-editabletext
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml    |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-editabletext.sgml |    8 ++++++--
> 2 files changed, 19 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-editabletext.sgml b/doc/libatspi/tmpl/atspi-editabletext.sgml
>index 051bdfb..3fa05bd 100644
>--- a/doc/libatspi/tmpl/atspi-editabletext.sgml
>+++ b/doc/libatspi/tmpl/atspi-editabletext.sgml
>@@ -2,11 +2,15 @@
> atspi-editabletext
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface that provides methods for modifying textual content
>+of components which support editing.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+Derived from atspi-text, the atspi-editabletext interface 
>+provides methods for modifying textual content of components
>+which support editing. EditableText also interacts with the
>+system clipboard via copy, cut, and paste methods.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.6
>
>
>From 08984d644ed635deb677edace175ae9106c06799 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 11 Aug 2011 01:22:12 -0300
>Subject: [PATCH 3/4] Adding more documentation to length parameter at
> atspi_editable_text_insert_text
>
>---
> atspi/atspi-editabletext.c |    3 ++-
> 1 files changed, 2 insertions(+), 1 deletions(-)
>
>diff --git a/atspi/atspi-editabletext.c b/atspi/atspi-editabletext.c
>index 58ac715..6bbff91 100644
>--- a/atspi/atspi-editabletext.c
>+++ b/atspi/atspi-editabletext.c
>@@ -88,7 +88,8 @@ atspi_editable_text_set_text_contents (AtspiEditableText *obj,
>  * @text: a string representing the text to insert, in UTF-8 encoding.
>  * @length:  the number of characters of text to insert. If the character
>  * count of text is less than or equal to length, the entire contents
>- * of text will be inserted.
>+ * of text will be inserted. Passing -1 indicates that the whole string
>+ * should be inserted.
>  *
>  * Inserts text into an #AtspiEditableText object.
>  * As with all character offsets, the specified @position may not be the
>-- 
>1.7.6
>
>
>From 48fff9d42503f4bd99dbf564aa3fedcc17810660 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 18 Aug 2011 21:55:43 -0300
>Subject: [PATCH 4/4] Removing -1 length documentation
>
>---
> atspi/atspi-editabletext.c |    3 +--
> 1 files changed, 1 insertions(+), 2 deletions(-)
>
>diff --git a/atspi/atspi-editabletext.c b/atspi/atspi-editabletext.c
>index 6bbff91..58ac715 100644
>--- a/atspi/atspi-editabletext.c
>+++ b/atspi/atspi-editabletext.c
>@@ -88,8 +88,7 @@ atspi_editable_text_set_text_contents (AtspiEditableText *obj,
>  * @text: a string representing the text to insert, in UTF-8 encoding.
>  * @length:  the number of characters of text to insert. If the character
>  * count of text is less than or equal to length, the entire contents
>- * of text will be inserted. Passing -1 indicates that the whole string
>- * should be inserted.
>+ * of text will be inserted.
>  *
>  * Inserts text into an #AtspiEditableText object.
>  * As with all character offsets, the specified @position may not be the
>-- 
>1.7.6
>

Comment on attachment 194176 [details] [review]
Removes "bitset" references in atspi-constants (comment #42)






>From d860e3d450702835829a2f9a6b87805296dc481a Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 01:22:26 -0300
>Subject: [PATCH 1/9] Improving atspi-constants documentation
>
>---
> atspi/atspi-constants.h |  360 ++++++++++++++++++++++++----------------------
> 1 files changed, 188 insertions(+), 172 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 2747ae8..2c9bee5 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -66,8 +66,7 @@ extern "C" {
> #endif
> 
> /**
>- *
>-ATSPI_LOCALE_TYPE:
>+ * AtspiLocaleType:
>  * @ATSPI_LOCALE_TYPE_MESSAGES:
>  * @ATSPI_LOCALE_TYPE_COLLATE:
>  * @ATSPI_LOCALE_TYPE_CTYPE:
>@@ -75,11 +74,11 @@ ATSPI_LOCALE_TYPE:
>  * @ATSPI_LOCALE_TYPE_NUMERIC:
>  * @ATSPI_LOCALE_TYPE_TIME:
>  *
>- * Used by Text and Document interfaces these correspond to the POSIX
>- * 'setlocale' enum values.
>+ * Used by interfaces #AtspiText and #AtspiDocument, this
>+ * enumeration corresponds to the POSIX 'setlocale' enum values.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_LOCALE_TYPE_MESSAGES,
>     ATSPI_LOCALE_TYPE_COLLATE,
>@@ -92,21 +91,21 @@ typedef enum {
> /**
>  * ATSPI_LOCALE_TYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiLocaleType.
>- */
>+ * One higher than the highest valid value of #AtspiLocaleType.
>+ **/
> #define ATSPI_LOCALE_TYPE _COUNT(5+1)
> 
> /**
>- *
>-ATSPI_COORD_TYPE:
>+ * AtspiCoordType:
>  * @ATSPI_COORD_TYPE_SCREEN:
>  * @ATSPI_COORD_TYPE_WINDOW:
>  *
>- * Used by Component, Image, and Text interfaces to specify whether coordinates
>+ * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
>+ * to specify whether coordinates
>  * are relative to the window or the screen.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_COORD_TYPE_SCREEN,
>     ATSPI_COORD_TYPE_WINDOW,
>@@ -115,13 +114,12 @@ typedef enum {
> /**
>  * ATSPI_COORD_TYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiCoordType.
>- */
>+ * One higher than the highest valid value of #AtspiCoordType.
>+ **/
> #define ATSPI_COORD_TYPE_COUNT (1+1)
> 
> /**
>- *
>-ATSPI_Collection_SortOrder:
>+ * AtspiCollectionSortOrder:
>  * @ATSPI_Collection_SORT_ORDER_INVALID:
>  * @ATSPI_Collection_SORT_ORDER_CANONICAL:
>  * @ATSPI_Collection_SORT_ORDER_FLOW:
>@@ -131,8 +129,11 @@ ATSPI_Collection_SortOrder:
>  * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
>  * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
>  *
>+ * Enumeration used by interface #AtspiCollection to specify
>+ * the way #AtspiAccesible objects should be sorted.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_Collection_SORT_ORDER_INVALID,
>     ATSPI_Collection_SORT_ORDER_CANONICAL,
>@@ -147,13 +148,12 @@ typedef enum {
> /**
>  * ATSPI_SORTORDER_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiCollectionSortOrder.
>+ * One higher than the highest valid value of #AtspiCollectionSortOrder.
>  */
> #define ATSPI_SORTORDER_COUNT (7+1)
> 
> /**
>- *
>-ATSPI_Collection_MatchType:
>+ * AtspiCollectionMatchType:
>  * @ATSPI_Collection_MATCH_INVALID:
>  * @ATSPI_Collection_MATCH_ALL:
>  * @ATSPI_Collection_MATCH_ANY:
>@@ -161,8 +161,11 @@ ATSPI_Collection_MatchType:
>  * @ATSPI_Collection_MATCH_EMPTY:
>  * @ATSPI_Collection_MATCH_LAST_DEFINED:
>  *
>+ * Enumeration used by #AtspiMatchRule to specify
>+ * how to interpret #AtspiAccesible objects.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_Collection_MATCH_INVALID,
>     ATSPI_Collection_MATCH_ALL,
>@@ -175,20 +178,22 @@ typedef enum {
> /**
>  * ATSPI_MATCHTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiCollectionMatchType.
>- */
>+ * One higher than the highest valid value of #AtspiCollectionMatchType.
>+ **/
> #define ATSPI_MATCHTYPES_COUNT (5+1)
> 
> /**
>- *
>-ATSPI_Collection_TreeTraversalType:
>+ * AtspiCollectionTreeTraversalType:
>  * @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
>  * @ATSPI_Collection_TREE_RESTRICT_SIBLING:
>  * @ATSPI_Collection_TREE_INORDER:
>  * @ATSPI_Collection_TREE_LAST_DEFINED:
>  *
>+ * Enumeration used by interface #AtspiCollection to specify
>+ * restrictions on #AtspiAccesible objects to be traversed.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
>     ATSPI_Collection_TREE_RESTRICT_SIBLING,
>@@ -199,14 +204,13 @@ typedef enum {
> /**
>  * ATSPI_TREETRAVERSALTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of
>+ * One higher than the highest valid value of
>  * #AtspiCollection_TreeTraversalType.
>  */
> #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
> 
> /**
>- *
>-ATSPI_ComponentLayer:
>+ * AtspiComponentLayer:
>  * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
>  * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
>  * is painted.        The 'desktop background' is generally in this layer.
>@@ -224,22 +228,24 @@ ATSPI_ComponentLayer:
>  * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
>  * enumeration.
>  *
>- * The ComponentLayer of a Component instance indicates its relative stacking
>- * order       with respect to the onscreen visual representation of the UI.      
>- * ComponentLayer, in combination with Component bounds information, can be used  
>- *     to compute the visibility of all or part of a component.  This is important
>- * in       programmatic determination of region-of-interest for magnification,
>- * and in       &#168;flat screen review&#168; models of the screen, as well as
>- * for other uses.       Objects residing in two of the ComponentLayer categories
>- * support       further z-ordering information, with respect to their peers in
>- * the same layer:       namely, LAYER_WINDOW and LAYER_MDI.  Relative stacking
>- * order for other objects within       the same layer is not available; the
>- * recommended heuristic is &#168;first child paints first&#168;,        in other
>- * words, assume that the first siblings in the child list are subject to being   
>- *    overpainted by later siblings if their bounds intersect.        The order of
>- * layers, from bottom to top, is: 	     	    	LAYER_BACKGROUND 	    	LAYER_WINDOW
>- * 	    	LAYER_MDI 	    	LAYER_CANVAS 	    	LAYER_WIDGET 	    	LAYER_POPUP 	   
>- * 	LAYER_OVERLAY 	
>+ * The #AtspiComponentLayer of a Component instance indicates its relative
>+ * stacking order with respect to the onscreen visual representation of the
>+ * UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds 
>+ * information, can be used to compute the visibility of all or part of a 
>+ * component.  This is important in programmatic determination of 
>+ * region-of-interest for magnification, and in 
>+ * flat screen review models of the screen, as well as
>+ * for other uses. Objects residing in two of the #AtspiComponentLayer 
>+ * categories support further z-ordering information, with respect to their 
>+ * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and 
>+ * @ATSPI_LAYER_MDI.  Relative stacking order for other objects within the 
>+ * same layer is not available; the recommended heuristic is 
>+ * first child paints first. In other words, assume that the 
>+ * first siblings in the child list are subject to being overpainted by later 
>+ * siblings if their bounds intersect. The order of layers, from bottom to top,
>+ *  is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
>+ * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and 	   
>+ * @ATSPI_LAYER_OVERLAY.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>  */
>@@ -256,50 +262,50 @@ typedef enum {
> } AtspiComponentLayer;
> 
> /**
>- * ATSPI_COMPONENTLAYER:_COUNT
>+ * ATSPI_COMPONENTLAYER_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiComponentLayer.
>- */
>+ * One higher than the highest valid value of #AtspiComponentLayer.
>+ **/
> #define ATSPI_COMPONENTLAYER_COUNT (8+1)
> 
> /**
>- *
>-ATSPI_TEXT_BOUNDARY_TYPE:
>+ * AtspiTextBoundaryType:
>  * @ATSPI_TEXT_BOUNDARY_CHAR: Text is bounded by this character only.       
>  * Start and end offsets differ by one, by definition, for this value.
>  * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
>- * range is from start of       one word to the start of another word.
>+ * range is from start of one word to the start of another word.
>  * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
>- * range is from  	    the end of one word to the end of another.     Some locales
>- * may not distinguish between words and       characters or glyphs, in particular
>- * those locales which use       wholly or partially ideographic character sets. 
>- * In these cases,       characters may be returned in lieu of multi-character
>+ * range is from the end of one word to the end of another. Some locales
>+ * may not distinguish between words and characters or glyphs. In particular,
>+ * those locales which use wholly or partially ideographic character sets. 
>+ * In these cases, characters may be returned in lieu of multi-character
>  * substrings.
>  * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
>- * sentence, as determined  	    by the application.       Some locales or
>- * character sets may not include explicit sentence       delimiters, so this
>- * boundary type can not always be honored.       Some locales will return lines
>+ * sentence, as determined by the application. Some locales or
>+ * character sets may not include explicit sentence delimiters, so this
>+ * boundary type can not always be honored. Some locales will return lines
>  * of text instead of grammatical sentences.
>  * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
>- * as determined by the application,  	    including the sentence-delimiting
>- * character, for instance '.'       Some locales or character sets may not
>- * include explicit sentence       delimiters, so this boundary type can not
>- * always be honored.       Some locales will return lines of text instead of
>+ * as determined by the application, including the sentence-delimiting
>+ * character, for instance '.' Some locales or character sets may not
>+ * include explicit sentence delimiters, so this boundary type can not
>+ * always be honored. Some locales will return lines of text instead of
>  * grammatical sentences.
>  * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
>- * i.e. range is        from start of one line to the start of another.  This
>- * generally        means that an end-of-line character will appear at the end of
>+ * i.e. range is from start of one line to the start of another.  This
>+ * generally means that an end-of-line character will appear at the end of
>  * the range.
>  * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
>- * range is       from start of one line to the start of another.  This generally 
>- *       means that an end-of-line character will be the first character of the
>+ * range is from start of one line to the start of another.  This generally 
>+ * means that an end-of-line character will be the first character of the
>  * range.
>  *
>  * Specifies the boundary conditions determining a run of text as returned from
>- *       GetTextAtOffset, GetTextAfterOffset, and GetTextBeforeOffset.
>+ * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
>+ * #atspi_text_get_text_before_offset.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_TEXT_BOUNDARY_CHAR,
>     ATSPI_TEXT_BOUNDARY_WORD_START,
>@@ -313,13 +319,12 @@ typedef enum {
> /**
>  * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiTextBOundaryType.
>+ * One higher than the highest valid value of #AtspiTextBOundaryType.
>  */
> #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
> 
> /**
>- *
>-ATSPI_TEXT_CLIP_TYPE:
>+ * AtspiTextClipType:
>  * @ATSPI_TEXT_CLIP_NONE:
>  * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
>  * are omitted
>@@ -328,12 +333,11 @@ ATSPI_TEXT_CLIP_TYPE:
>  * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
>  * bounded by min and max are retained.
>  *
>- * TEXT_CLIP_TYPE:       CLIP_MIN means text clipped by min coordinate is
>- * omitted,       CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH 
>- *      will retain only text falling fully within the min/max bounds.
>+ * Enumeration used by interface #AtspiText to indicate
>+ * how to treat characters intersecting bounding boxes.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_TEXT_CLIP_NONE,
>     ATSPI_TEXT_CLIP_MIN,
>@@ -344,13 +348,12 @@ typedef enum {
> /**
>  * ATSPI_TEXT_CLIP_TYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiTextClipType.
>+ * One higher than the highest valid value of #AtspiTextClipType.
>  */
> #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
> 
> /**
>- *
>-ATSPI_StateType:
>+ * AtspiStateType:
>  * @ATSPI_STATE_INVALID:
>  * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
>  * is an active subelement within a container or table
>@@ -473,14 +476,14 @@ ATSPI_StateType:
>  * to failure of input       validation.  For instance, a form control may
>  * acquire this state in response       to invalid or malformed user input.
>  * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
>- * in question implements some form of &#168;typeahead&#168; or       
>+ * in question implements some form of typeahead or       
>  * pre-selection behavior whereby entering the first character of one or more
>  * sub-elements       causes those elements to scroll into view or become
>  * selected.  Subsequent character input       may narrow the selection further as
>  * long as one or more sub-elements match the string.       This state is normally
>  * only useful and encountered on objects that implement Selection.       In some
>  * cases the typeahead behavior may result in full or partial
>- * &#168;completion&#168; of        the data in the input field, in which case
>+ * completion of        the data in the input field, in which case
>  * these input events may trigger text-changed       events from the source.
>  * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
>  * question supports text selection.        It should only be exposed on objects
>@@ -499,8 +502,12 @@ ATSPI_StateType:
>  * as a parameter, it indicates the number of       items in the StateType
>  * enumeration.
>  *
>+ * 
>+ * Enumeration used by various interfaces indicating every possible state 
>+ * an #AtspiAccesible object can assume.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_STATE_INVALID,
>     ATSPI_STATE_ACTIVE,
>@@ -549,20 +556,19 @@ typedef enum {
> /**
>  * ATSPI_STATETYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiStateType.
>- */
>+ * One higher than the highest valid value of #AtspiStateType.
>+ **/
> #define ATSPI_STATETYPE_COUNT (41+1)
> 
> /**
>- *
>-ATSPI_KeyEventType:
>+ * AtspiKeyEventType:
>  * @ATSPI_KEY_PRESSED:
>  * @ATSPI_KEY_RELEASED:
>  *
>- * Deprecated, DO NOT USE!
>+ * Deprecated. Should not be used.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_KEY_PRESSED,
>     ATSPI_KEY_RELEASED,
>@@ -571,13 +577,12 @@ typedef enum {
> /**
>  * ATSPI_KEYEVENTTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiKeyEventType.
>- */
>+ * One higher than the highest valid value of #AtspiKeyEventType.
>+ **/
> #define ATSPI_KEYEVENTTYPE_COUNT (1+1)
> 
> /**
>- *
>-ATSPI_EventType:
>+ * AtspiEventType:
>  * @ATSPI_KEY_PRESSED_EVENT: < key on a keyboard device was pressed.
>  * @ATSPI_KEY_RELEASED_EVENT: < key on a keyboard device was released.
>  * @ATSPI_BUTTON_PRESSED_EVENT: < button on a non-keyboard human interface
>@@ -585,12 +590,12 @@ ATSPI_EventType:
>  * @ATSPI_BUTTON_RELEASED_EVENT: < button on a non-keyboard human interface
>  * device        (HID) was pressed
>  *
>- * Used to specify the event types of interest to an EventListener, or       to
>- * identify the type of an event for which notification has been sent.        @see
>- * EventTypeSeq, DeviceEvent::type
>+ * Enumeration used to specify the event types of interest to an 
>+ * #AtspiEventListener, or 
>+ * to identify the type of an event for which notification has been sent.  
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_KEY_PRESSED_EVENT,
>     ATSPI_KEY_RELEASED_EVENT,
>@@ -601,13 +606,12 @@ typedef enum {
> /**
>  * ATSPI_EVENTTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiEventType.
>+ * One higher than the highest valid value of #AtspiEventType.
>  */
> #define ATSPI_EVENTTYPE_COUNT (3+1)
> 
> /**
>- *
>-AtspiKeySynthType:
>+ * AtspiKeySynthType:
>  * @ATSPI_KEY_PRESS: emulate the pressing of a hardware keyboard key.
>  * @ATSPI_KEY_RELEASE: emulate the release of a hardware keyboard key.
>  * @ATSPI_KEY_PRESSRELEASE: a hardware keyboard key is pressed and immediately
>@@ -629,11 +633,11 @@ AtspiKeySynthType:
>  * KeySynthType::KEY_SYM.       In practice this limitation primarily effects
>  * Chinese and Japanese locales.
>  *
>- * Used when synthesizing keyboard input via
>- * DeviceEventController:GenerateKeyboardEvent.
>+ * Enumeration used when synthesizing keyboard input via
>+ * #atspi_generate_keyboard_event.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_KEY_PRESS,
>     ATSPI_KEY_RELEASE,
>@@ -645,13 +649,12 @@ typedef enum {
> /**
>  * ATSPI_KEYSYNTHTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiKeySynthType.
>- */
>+ * One higher than the highest valid value of #AtspiKeySynthType.
>+ **/
> #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
> 
> /**
>- *
>-ATSPI_ModifierType:
>+ * AtspiModifierType:
>  * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key
>  * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key
>  * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'
>@@ -667,8 +670,10 @@ ATSPI_ModifierType:
>  * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
>  * to the        appropriate META value, for the convenience of the client.
>  *
>+ *
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_MODIFIER_SHIFT,
>     ATSPI_MODIFIER_SHIFTLOCK,
>@@ -683,13 +688,12 @@ typedef enum {
> /**
>  * ATSPI_MODIFIERTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiModifierType.
>- */
>+ * One higher than the highest valid value of #AtspiModifierType.
>+ **/
> #define ATSPI_MODIFIERTYPE_COUNT (7+1)
> 
> /**
>- *
>-ATSPI_RelationType:
>+ * AtspiRelationType:
>  * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
>  * normally encounter this RelationType value.
>  * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
>@@ -742,20 +746,27 @@ ATSPI_RelationType:
>  * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
>  * determine the size of the enumeration.
>  *
>- * RelationType specifies a relationship between objects (possibly one-to-many
>- * or many-to-one)       outside of the normal parent/child hierarchical
>- * relationship.  It allows better semantic       identification of how objects
>- * are associated with one another.       For instance the RELATION_LABELLED_BY
>+ * #AtspiRelationType specifies a relationship between objects 
>+ * (possibly one-to-many
>+ * or many-to-one) outside of the normal parent/child hierarchical
>+ * relationship. It allows better semantic       identification of how objects
>+ * are associated with one another.       For instance the 
>+ * @ATSPI_RELATION_LABELLED_BY
>  * relationship may be used to identify labelling information       that should
>  * accompany the accessibleName property when presenting an object's content or
>- * identity       to the end user.  Similarly, RELATION_CONTROLLER_FOR can be used
>- * to further specify the context       in which a valuator is useful, and/or the
>- * other UI components which are directly effected by       user interactions with
>- * the valuator. Common examples include association of scrollbars with       the
>+ * identity       to the end user.  Similarly, 
>+ * @ATSPI_RELATION_CONTROLLER_FOR can be used
>+ * to further specify the context in which a valuator is useful, and/or the
>+ * other UI components which are directly effected by user interactions with
>+ * the valuator. Common examples include association of scrollbars with the
>  * viewport or panel which they control.
>  *
>+ * 
>+ * Enumeration used to specify
>+ * the type of relation encapsulated in an #AtspiRelation object.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>- */
>+ **/
> typedef enum {
>     ATSPI_RELATION_NULL,
>     ATSPI_RELATION_LABEL_FOR,
>@@ -782,13 +793,12 @@ typedef enum {
> /**
>  * ATSPI_RELATIONTYPE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiRelationType.
>- */
>+ * One higher than the highest valid value of #AtspiRelationType.
>+ **/
> #define ATSPI_RELATIONTYPE_COUNT (19+1)
> 
> /**
>- *
>-ATSPI_Role:
>+ * AtspiRole:
>  * @ATSPI_ROLE_INVALID: A Role indicating an error condition, such as
>  * uninitialized Role data.
>  * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
>@@ -871,7 +881,7 @@ ATSPI_Role:
>  * radio buttons in the       same group to become uncghecked when this one is
>  * checked.
>  * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
>- * (see ROLE_RADIO_BUTTON)
>+ * (see @ATSPI_ROLE_RADIO_BUTTON)
>  * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
>  * layered pane as its       children.
>  * @ATSPI_ROLE_ROW_HEADER: The header for a row of data
>@@ -879,40 +889,41 @@ ATSPI_Role:
>  * incrementally view a large       amount of data by moving the bounds of a
>  * viewport along a one-dimensional axis.
>  * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
>- * a large amount       of information.  ROLE_SCROLL_PANE objects are usually
>- * accompanied by       ROLE_SCROLL_BAR controllers, on which the
>- * RELATION_CONTROLLER_FOR and       RELATION_CONTROLLED_BY reciprocal relations
>- * are set; \see        Accessibility::RelationSet.
>+ * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
>+ * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
>+ * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY 
>+ * reciprocal relations
>+ * are set; see  #atspi_get_relation_set.
>  * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
>  * visible and       logical separation of the contents in a menu.
>  * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
>  * range
>  * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
>  * be selected,        and which displays the current choice.  Unlike
>- * ROLE_SCROLL_BAR,       ROLE_SLIDER objects need not control 'viewport'-like
>- * objects.
>+ * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control 
>+ * 'viewport'-like objects.
>  * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
>  * at the same time.
>  * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
>- * (c.f. ROLE_PROGRESS_BAR)
>+ * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
>  * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
>  * and columns.
>- * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. \note
>- * Table cells need not have ROLE_TABLE_CELL,        other RoleType values are
>- * valid as well.
>+ * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. NOTE:
>+ * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other 
>+ * #AtspiRoleType values are valid as well.
>  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
>  * in a Table.
>  * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
>  * Table. Table rows and columns may also be        labelled via the
>- * RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships;        see
>- * Accessibility.RelationSet.
>+ * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships;
>+ * see #atspi_get_relation_set.
>  * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
>  * and shown in its own window.
>- * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal
>+ * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
>  * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecific
>  * type.
>  * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
>- * unchecked, but does       not procide a separate indicator for the current
>+ * unchecked, but does not procide a separate indicator for the current
>  * state.
>  * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
>  * toggle buttons
>@@ -927,20 +938,20 @@ ATSPI_Role:
>  * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
>  * otherwise clip a larger object or        content renderer to a specific
>  * onscreen viewport.
>- * @ATSPI_ROLE_WINDOW: A &#168;top level window&#168; with no title or border.
>+ * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
>  * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
>  * included in the        core enumeration
>  * @ATSPI_ROLE_HEADER: An object that serves as a document header.
>  * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
>  * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
>- * text content. See also ROLE_TEXT.
>+ * text content. See also @ATSPI_ROLE_TEXT.
>  * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.    
>  *    for text objects which it controls        (should have CONTROLLER_FOR
>  * relation to such).
>  * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
>  * of an        application, which may contain ROLE_FRAME objects or other      
>- * accessible objects.  Children of AccessibleDesktop objects        are generally
>- * ROLE_APPLICATION objects.
>+ * accessible objects.  Children of #AccessibleDesktop objects  are generally
>+ * @ATSPI_ROLE_APPLICATION objects.
>  * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
>  * for insertion        into an entry widget, for instance a list of words for
>  * completion        of a text entry.
>@@ -951,50 +962,52 @@ ATSPI_Role:
>  * embedded.       In particular, it is used for some kinds of document embedding,
>  * and       for embedding of out-of-process component, "panel applets", etc.
>  * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
>- * entered or modified by the user, 	    provided STATE_EDITABLE is present.      
>- * A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies
>- * a       read-only 'text field' in a form, as opposed to a title, label, or
>+ * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
>+ * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is 
>+ * not present) implies
>+ * a read-only 'text field' in a form, as opposed to a title, label, or
>  * caption.
>  * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
>- *  It may contain multiple       subelements whose attributes and/or description
>- * may be queried to obtain both the       quantitative data and information about
>- * how the data is being presented.       The LABELLED_BY relation is particularly
>- * important in interpreting objects of this type,       as is the
>- * accessible-description property.         See ROLE_CAPTION
>+ *  It may contain multiple subelements whose attributes and/or description
>+ * may be queried to obtain both the  quantitative data and information about
>+ * how the data is being presented. The @ATSPI_LABELLED_BY relation is 
>+ * particularly
>+ * important in interpreting objects of this type, as is the
>+ * accessible-description property. See @ATSPI_ROLE_CAPTION.
>  * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
>- * textual, about another user interface       element such as a table, chart, or
>+ * textual, about another user interface element such as a table, chart, or
>  * image.
>  * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
>- * contains a view of document content.         Document frames may occur within
>- * another Document instance, in which case the second        document may be said
>- * to be embedded in the containing instance.  HTML frames are       often
>- * ROLE_DOCUMENT_FRAME.  Either this object, or a singleton descendant, should
>- * implement       the Document interface.
>+ * contains a view of document content. Document frames may occur within
>+ * another Document instance, in which case the second  document may be said
>+ * to be embedded in the containing instance.  HTML frames are often
>+ * @ATSPI_ROLE_DOCUMENT_FRAME.  Either this object, or a singleton descendant, 
>+ * should implement the #AtspiDocument interface.
>  * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
>  * follows it in a document.       The 'heading level' of the heading, if
>  * availabe,  may be obtained by       querying the object's attributes.
>  * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
>- * page of        information.  ROLE_PAGE is used in documents and content which
>- * support       a paginated navigation model.
>+ * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
>+ * support a paginated navigation model.
>  * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
>- * which constitutes       a particular 'logical' section of the document.  The
>- * type of content within       a section, and the nature of the section division
>- * itself, may be obtained       by querying the object's attributes.  Sections
>+ * which constitutes a particular 'logical' section of the document.  The
>+ * type of content within a section, and the nature of the section division
>+ * itself, may be obtained by querying the object's attributes.  Sections
>  * may be nested.
>  * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
>- * the hierarchy,        and is exposed for purely technical reasons.  Objects of
>- * this role        should be ignored by clients, if they are encountered at all.
>+ * the hierarchy, and is exposed for purely technical reasons.  Objects of
>+ * this role should be ignored by clients, if they are encountered at all.
>  * @ATSPI_ROLE_FORM: The object is a containing instance of document content
>- * which       has within it components with which the user can interact in order
>- * to       input information; i.e. the object is a container for pushbuttons,    
>- *   comboboxes, text input fields, and other 'GUI' components.       ROLE_FORM
>- * should not, in general, be used for toplevel GUI containers       or dialogs,
>- * but should be reserved for 'GUI' containers which occur within       document
>- * content, for instance within Web documents, presentations, or        text
>+ * which has within it components with which the user can interact in order
>+ * to input information; i.e. the object is a container for pushbuttons,    
>+ * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
>+ * should not, in general, be used for toplevel GUI containers or dialogs,
>+ * but should be reserved for 'GUI' containers which occur within document
>+ * content, for instance within Web documents, presentations, or text
>  * documents.  Unlike other GUI containers and dialogs which occur inside      
>- * application instances, ROLE_FORM containers' components are associated with    
>- *   the current document, rather than the current foreground application or      
>- * viewer instance.
>+ * application instances, @ATSPI_ROLE_FORM containers' components are
>+ * associated with the current document, rather than the current foreground 
>+ * application or viewer instance.
>  * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a      
>  * hypertext document.  Such objects are distinct from 'inline'       content
>  * which may also use the Hypertext/Hyperlink interfaces       to indicate the
>@@ -1035,6 +1048,9 @@ ATSPI_Role:
>  * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
>  * enumeration.
>  *
>+ * Enumeration used by interface #AtspiAccessible to specify the role
>+ * of an #AtspiAccessible object.
>+ *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>  */
> typedef enum {
>@@ -1147,7 +1163,7 @@ typedef enum {
> /**
>  * ATSPI_ROLE_COUNT:
>  *
>- * 1 higher than the highest valid value of #AtspiRole.
>+ * One higher than the highest valid value of #AtspiRole.
>  */
> #define ATSPI_ROLE_COUNT (90+1)
> 
>-- 
>1.7.6
>
>
>From 6a12412811e99e3f1ac95c76079dd1c96673e8c8 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 01:28:33 -0300
>Subject: [PATCH 2/9] Adding descriptions to atspi-constants documentation
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   17 +++++++++++++++--
> doc/libatspi/tmpl/atspi-hyperlink.sgml |   10 ----------
> doc/libatspi/tmpl/libatspi-unused.sgml |    9 +++++++++
> 3 files changed, 24 insertions(+), 12 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..4d597e5 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -2,11 +2,11 @@
> atspi-constants
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+Constant definitions needed by multiple interfaces.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+Constant definitions needed by multiple interfaces.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>index 0cae0d5..dc6eab3 100644
>--- a/doc/libatspi/tmpl/atspi-hyperlink.sgml
>+++ b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>@@ -33,16 +33,6 @@ AtspiHyperlink
> 
> @parent_class: 
> 
>-<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>-<para>
>-
>-</para>
>-
>-@app: 
>-@path: 
>-@Returns: 
>-
>-
> <!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### -->
> <para>
> 
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2f0d56d 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,12 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>+<para>
>+
>+</para>
>+
>+@app: 
>+@path: 
>+@Returns: 
>+
>-- 
>1.7.6
>
>
>From 53430373d3a0567bd376c89aa3da522e00901649 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 9 Aug 2011 02:16:47 -0300
>Subject: [PATCH 3/9] Adding descriptions for constants - not only
> enumerations. AtspiCollectionSortOrder and
> AtspiCollectionTreeTraversalType were not documented,
> since I am waiting for some feedback on them.
>
>---
> atspi/atspi-constants.h |  431 ++++++++++++++++++++++++-----------------------
> 1 files changed, 219 insertions(+), 212 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 2c9bee5..4ed8783 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -67,12 +67,16 @@ extern "C" {
> 
> /**
>  * AtspiLocaleType:
>- * @ATSPI_LOCALE_TYPE_MESSAGES:
>- * @ATSPI_LOCALE_TYPE_COLLATE:
>- * @ATSPI_LOCALE_TYPE_CTYPE:
>- * @ATSPI_LOCALE_TYPE_MONETARY:
>- * @ATSPI_LOCALE_TYPE_NUMERIC:
>- * @ATSPI_LOCALE_TYPE_TIME:
>+ * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages
>+ * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string 
>+ * collation 
>+ * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character 
>+ * classification, conversion, case-sensitive comparison, and wide character 
>+ * functions 
>+ * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting
>+ * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal 
>+ * point and the thousands separator)
>+ * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting
>  *
>  * Used by interfaces #AtspiText and #AtspiDocument, this
>  * enumeration corresponds to the POSIX 'setlocale' enum values.
>@@ -97,12 +101,12 @@ typedef enum {
> 
> /**
>  * AtspiCoordType:
>- * @ATSPI_COORD_TYPE_SCREEN:
>- * @ATSPI_COORD_TYPE_WINDOW:
>+ * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen
>+ * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's 
>+ * top-level window
>  *
>  * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
>- * to specify whether coordinates
>- * are relative to the window or the screen.
>+ * to specify whether coordinates are relative to the window or the screen.
>  *
>  * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
>@@ -154,12 +158,15 @@ typedef enum {
> 
> /**
>  * AtspiCollectionMatchType:
>- * @ATSPI_Collection_MATCH_INVALID:
>- * @ATSPI_Collection_MATCH_ALL:
>- * @ATSPI_Collection_MATCH_ANY:
>- * @ATSPI_Collection_MATCH_NONE:
>- * @ATSPI_Collection_MATCH_EMPTY:
>- * @ATSPI_Collection_MATCH_LAST_DEFINED:
>+ * @ATSPI_Collection_MATCH_INVALID: 
>+ * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met
>+ * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met
>+ * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met
>+ * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
>+ * the criteria is non-empty; for empty criteria this rule requires returned 
>+ * value to also have empty set. 
>+ * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
>+ * enumeration.
>  *
>  * Enumeration used by #AtspiMatchRule to specify
>  * how to interpret #AtspiAccesible objects.
>@@ -215,22 +222,23 @@ typedef enum {
>  * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
>  * is painted.        The 'desktop background' is generally in this layer.
>  * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
>- * UI Component        containers.
>+ * UI #AtspiComponent containers.
>  * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
>  * 'foreground' widgets reside.
>- * @ATSPI_LAYER_MDI: A special layer between LAYER_CANVAS and LAYER_WIDGET, in
>- * which the       'pseudo windows' (e.g. the MDI frames) reside.        (See
>- * Component.GetMDIZOrder)
>- * @ATSPI_LAYER_POPUP: A layer for popup window content, above LAYER_WIDGET.
>+ * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and 
>+ * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) 
>+ * reside. See #atspi_component_get_mdi_z_order. 
>+ * @ATSPI_LAYER_POPUP: A layer for popup window content, above
>+ * @ATSPI_LAYER_WIDGET.
>  * @ATSPI_LAYER_OVERLAY: The topmost layer.
>  * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
>  * resides.
>  * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
>  * enumeration.
>  *
>- * The #AtspiComponentLayer of a Component instance indicates its relative
>- * stacking order with respect to the onscreen visual representation of the
>- * UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds 
>+ * The #AtspiComponentLayer of an #AtspiComponent instance indicates its 
>+ * relative stacking order with respect to the onscreen visual representation 
>+ * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds 
>  * information, can be used to compute the visibility of all or part of a 
>  * component.  This is important in programmatic determination of 
>  * region-of-interest for magnification, and in 
>@@ -270,8 +278,9 @@ typedef enum {
> 
> /**
>  * AtspiTextBoundaryType:
>- * @ATSPI_TEXT_BOUNDARY_CHAR: Text is bounded by this character only.       
>- * Start and end offsets differ by one, by definition, for this value.
>+ * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this 
>+ * character only. Start and end offsets differ by one, by definition, 
>+ * for this value.
>  * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
>  * range is from start of one word to the start of another word.
>  * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
>@@ -325,7 +334,7 @@ typedef enum {
> 
> /**
>  * AtspiTextClipType:
>- * @ATSPI_TEXT_CLIP_NONE:
>+ * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted
>  * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
>  * are omitted
>  * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
>@@ -354,7 +363,8 @@ typedef enum {
> 
> /**
>  * AtspiStateType:
>- * @ATSPI_STATE_INVALID:
>+ * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error 
>+ * condition.
>  * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
>  * is an active subelement within a container or table
>  * @ATSPI_STATE_ARMED: Indicates that the object is armed
>@@ -368,10 +378,10 @@ typedef enum {
>  * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
>  * object
>  * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
>- * currently reflects some application state.        Objects that are "greyed out"
>- * may lack this state, and may lack the STATE_SENSITIVE if direct user      
>- * interaction cannot cause
>- * them to acquire STATE_ENABLED.  @see STATE_SENSITIVE.
>+ * currently reflects some application state. Objects that are "greyed out"
>+ * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
>+ * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. 
>+ * See @ATSPI_STATE_SENSITIVE
>  * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
>  * disclosure of its children
>  * @ATSPI_STATE_EXPANDED: Indicates this object is expanded
>@@ -387,119 +397,118 @@ typedef enum {
>  * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
>  * represented only by an icon
>  * @ATSPI_STATE_MODAL: Indicates something must be done with this object
>- * before the user can       interact with an object in a different window.
>+ * before the user can interact with an object in a different window.
>  * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
>  * lines of text
>  * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
>- * its children to be       selected at the same time, or in the case of text
>- * objects,        that the object supports non-contiguous text selections.
>+ * its children to be selected at the same time, or in the case of text
>+ * objects, that the object supports non-contiguous text selections.
>  * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
>- * rectangular region.       It also indicates an alpha value of unity, if it
>+ * rectangular region. It also indicates an alpha value of unity, if it
>  * supports alpha blending.
>  * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed
>  * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
>  * fixed
>  * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
>- * that allows its       children to be selected and that this child is one of
>+ * that allows its children to be selected and that this child is one of
>  * those children       that can be selected.
>  * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
>- * allows its       children to be selected and that this child is one of those
>- * children       that has been selected.
>+ * allows its children to be selected and that this child is one of those
>+ * children that has been selected.
>  * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
>- * interaction.        STATE_SENSITIVE usually accompanies STATE_ENABLED for
>- * user-actionable controls,       but may be found in the absence of
>- * STATE_ENABLED if the current visible state of the        control is
>- * "disconnected" from the application state.  In such cases, direct user
>- * interaction       can often result in the object gaining STATE_SENSITIVE, for
>- * instance if a user makes        an explicit selection using an object whose
>- * current state is ambiguous or undefined.       @see STATE_ENABLED,
>- * STATE_INDETERMINATE.
>+ * interaction. @ATSPI_STATE_SENSITIVE usually accompanies 
>+ * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the 
>+ * absence of @ATSPI_STATE_ENABLED if the current visible state of the control 
>+ * is "disconnected" from the application state.  In such cases, direct user
>+ * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE, 
>+ * for instance if a user makes an explicit selection using an object whose
>+ * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
>+ * @ATSPI_STATE_INDETERMINATE.
>  * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
>- * object's parent's       parent, and so on, are all 'shown' to the end-user,
>- * i.e.       subject to "exposure" if blocking or obscuring objects do not
>- * interpose       between this object
>- * and the top of the window stack.
>+ * object's parent's parent, and so on, are all 'shown' to the end-user,
>+ * i.e. subject to "exposure" if blocking or obscuring objects do not
>+ * interpose between this object and the top of the window stack.
>  * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
>  * single line of text
>  * @ATSPI_STATE_STALE: Indicates that the information returned for this object
>- * may no longer be       synchronized with the application state.  This can occur
>- * if the object has STATE_TRANSIENT,       and can also occur towards the end of
>- * the object peer's
>- * lifecycle.
>+ * may no longer be synchronized with the application state.  This can occur
>+ * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the 
>+ * end of the object peer's lifecycle
>  * @ATSPI_STATE_TRANSIENT: Indicates this object is transient
>  * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
>- * for example this state may appear on        such objects as scrollbars, text
>+ * for example this state may appear on such objects as scrollbars, text
>  * objects (with vertical text flow), separators, etc.
>- * @ATSPI_STATE_VISIBLE: 	  Indicates this object is visible, e.g. has been
>- * explicitly marked for exposure to the user. 	  STATE_VISIBLE is no guarantee
>- * that the object is actually unobscured on the screen, only       that it is
>- * 'potentially' visible, barring obstruction, being scrolled or clipped out of
>- * the        field of view, or having an ancestor container that has not yet made
>- * visible.       A widget is potentially onscreen if it has both STATE_VISIBLE
>- * and STATE_SHOWING.       The absence of STATE_VISIBLE and STATE_SHOWING is
>- * semantically equivalent to saying        that an object is 'hidden'.
>+ * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
>+ * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no 
>+ * guarantee that the object is actually unobscured on the screen, only that 
>+ * it is 'potentially' visible, barring obstruction, being scrolled or clipped 
>+ * out of the field of view, or having an ancestor container that has not yet 
>+ * made visible. A widget is potentially onscreen if it has both 
>+ * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of 
>+ * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
>+ * semantically equivalent to saying that an object is 'hidden'.
>  * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
>- * event is sent when children       become 'active' (i.e. are selected or
>- * navigated to onscreen).  Used to       prevent need to enumerate all children
>- * in very large containers, like       tables.  The presence of
>- * STATE_MANAGES_DESCENDANTS is an indication to the client.       that the
>- * children should not, and need not, be enumerated by the client.       Objects
>- * implementing this state are expected to provide relevant state      
>- * notifications to listening clients, for instance notifications of visibility   
>- *    changes and activation of their contained child objects, without the client 
>- *       having previously requested references to those children.
>+ * event is sent when children become 'active' (i.e. are selected or
>+ * navigated to onscreen).  Used to prevent need to enumerate all children
>+ * in very large containers, like tables. The presence of
>+ * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
>+ * children should not, and need not, be enumerated by the client.
>+ * Objects implementing this state are expected to provide relevant state      
>+ * notifications to listening clients, for instance notifications of 
>+ * visibility changes and activation of their contained child objects, without 
>+ * the client having previously requested references to those children.
>  * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
>- * indicator is in a state other than        checked or not checked.  This
>- * usually means that the boolean value reflected or        controlled by the
>+ * indicator is in a state other than checked or not checked.  This
>+ * usually means that the boolean value reflected or controlled by the
>  * object does not apply consistently to the entire current context.      
>  * For example, a checkbox for the "Bold" attribute of text may have
>- * STATE_INDETERMINATE       if the currently selected text contains a mixture
>- * of weight attributes.         In many cases interacting with a
>- * STATE_INDETERMINATE object will cause        the context's corresponding
>- * boolean attribute to be homogenized, whereupon the object       will lose
>- * STATE_INDETERMINATE and a corresponding state-changed event will be fired.
>+ * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
>+ * of weight attributes. In many cases interacting with a
>+ * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
>+ * boolean attribute to be homogenized, whereupon the object will lose
>+ * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
>+ * fired.
>  * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
>- * 'required' from the user,        for instance before completing the
>+ * 'required' from the user, for instance before completing the
>  * processing of a form.
>  * @ATSPI_STATE_TRUNCATED: 	  Indicates that an object's onscreen content
>  * is truncated, e.g. a text value in a spreadsheet cell.
>  * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
>- * dynamic, not static.       This state may be applied to an object during an
>- * animated 'effect' and        be removed from the object once its visual
>- * representation becomes static.     some applications, notably content viewers,
>- * may not be able to detect       all kinds of animated content.  Therefore the
>- * absence of this state should not       be taken as
>+ * dynamic, not static. This state may be applied to an object during an
>+ * animated 'effect' and be removed from the object once its visual
>+ * representation becomes static. Some applications, notably content viewers,
>+ * may not be able to detect all kinds of animated content.  Therefore the
>+ * absence of this state should not be taken as
>  * definitive evidence that the object's visual representation is      
>  * static; this state is advisory.
>  * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
>- * due
>- * to failure of input       validation.  For instance, a form control may
>- * acquire this state in response       to invalid or malformed user input.
>+ * due to failure of input validation.  For instance, a form control may
>+ * acquire this state in response to invalid or malformed user input.
>  * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
>  * in question implements some form of typeahead or       
>  * pre-selection behavior whereby entering the first character of one or more
>- * sub-elements       causes those elements to scroll into view or become
>- * selected.  Subsequent character input       may narrow the selection further as
>- * long as one or more sub-elements match the string.       This state is normally
>- * only useful and encountered on objects that implement Selection.       In some
>- * cases the typeahead behavior may result in full or partial
>- * completion of        the data in the input field, in which case
>- * these input events may trigger text-changed       events from the source.
>+ * sub-elements causes those elements to scroll into view or become
>+ * selected. Subsequent character input may narrow the selection further as
>+ * long as one or more sub-elements match the string. This state is normally
>+ * only useful and encountered on objects that implement #AtspiSelection.
>+ * In some cases the typeahead behavior may result in full or partial
>+ * completion of the data in the input field, in which case
>+ * these input events may trigger text-changed events from the source.
>  * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
>- * question supports text selection.        It should only be exposed on objects
>- * which implement the Text interface,        in order to distinguish this state
>- * from STATE_SELECTABLE, which infers that       the object in question is a
>- * selectable child of an object which implements       Selection.  While similar,
>- * text selection and subelement selection are       distinct operations.
>+ * question supports text selection. It should only be exposed on objects
>+ * which implement the #AtspiText interface, in order to distinguish this state
>+ * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
>+ * selectable child of an object which implements #AtspiSelection. While 
>+ * similar, text selection and subelement selection are distinct operations.
>  * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
>- * the 'default' interaction object        in a dialog, i.e. the one that gets
>- * activated if the user presses "Enter" when the       dialog is initially
>+ * the 'default' interaction object in a dialog, i.e. the one that gets
>+ * activated if the user presses "Enter" when the dialog is initially
>  * posted.
>  * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
>- * hyperlink)       has already been activated or invoked, with the result that
>- * some backing data       has been downloaded or rendered.
>+ * hyperlink) has already been activated or invoked, with the result that
>+ * some backing data has been downloaded or rendered.
>  * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
>- * as a parameter, it indicates the number of       items in the StateType
>+ * as a parameter, it indicates the number of items in the #AtspiStateType
>  * enumeration.
>  *
>  * 
>@@ -617,20 +626,20 @@ typedef enum {
>  * @ATSPI_KEY_PRESSRELEASE: a hardware keyboard key is pressed and immediately
>  * released.
>  * @ATSPI_KEY_SYM: a symbolic key event is generated, without specifying a
>- * hardware key.        @note if the keysym is not present in the current keyboard
>- * map,       the DeviceEventController instance has a limited ability to generate
>- *       such keysyms on-the-fly.  Reliability of GenerateKeyboardEvent calls     
>- *  using out-of-keymap keysyms will vary from system to system, and on the      
>- * number of different out-of-keymap being generated in quick succession.       In
>- * practice this is rarely significant, since the keysyms of interest to       AT
>- * clients and keyboard emulators are usually part of the current keymap, i.e.    
>- *   present on the system keyboard for the current locale (even if a physical    
>- *   hardware keyboard is not connected.
>+ * hardware key. @note if the keysym is not present in the current keyboard
>+ * map, the #AtspiDeviceEventController instance has a limited ability to 
>+ * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent 
>+ * calls using out-of-keymap keysyms will vary from system to system, and on 
>+ * the number of different out-of-keymap being generated in quick succession. 
>+ * In practice this is rarely significant, since the keysyms of interest to 
>+ * AT clients and keyboard emulators are usually part of the current keymap, 
>+ * i.e. present on the system keyboard for the current locale (even if a 
>+ * physical hardware keyboard is not connected.
>  * @ATSPI_KEY_STRING: a string is converted to its equivalent keyboard events
>- * and emitted.        If the string consists of complex character or composed
>- * characters       which are not in the current keymap, string emission is
>- * subject to the       out-of-keymap limitations described for
>- * KeySynthType::KEY_SYM.       In practice this limitation primarily effects
>+ * and emitted. If the string consists of complex character or composed
>+ * characters which are not in the current keymap, string emission is
>+ * subject to the out-of-keymap limitations described for
>+ * @ATSPI_KEY_SYM. In practice this limitation primarily effects
>  * Chinese and Japanese locales.
>  *
>  * Enumeration used when synthesizing keyboard input via
>@@ -660,15 +669,15 @@ typedef enum {
>  * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'
>  * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr)
>  * @ATSPI_MODIFIER_META: depending on the platform this may map to 'Window',
>- * 'Function', 'Meta',       'Menu', or 'NumLock'.         Such 'Meta keys' will
>- * map to one of META, META2, META3.       On X Windows platforms these META
>- * values map to        the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
>- * event having       ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit
>- * is       set in the corresponding XEvent.
>- * @ATSPI_MODIFIER_META2:
>- * @ATSPI_MODIFIER_META3:
>+ * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
>+ * map to one of META, META2, META3. On X Windows platforms these META
>+ * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
>+ * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
>+ * is set in the corresponding XEvent.
>+ * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META
>+ * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META
>  * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
>- * to the        appropriate META value, for the convenience of the client.
>+ * to the appropriate META value, for the convenience of the client.
>  *
>  *
>  *
>@@ -695,16 +704,17 @@ typedef enum {
> /**
>  * AtspiRelationType:
>  * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
>- * normally encounter this RelationType value.
>+ * normally encounter this #AtspiRelationType value.
>  * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
>  * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
>  * objects.
>  * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
>- * modifies the state, onscreen location, or other attributes       of one or more
>+ * modifies the state, onscreen location, or other attributes of one or more
>  * target objects.
>  * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
>- * modified/controlled by user interaction with one or        more other objects. 
>- *  For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars.
>+ * modified/controlled by user interaction with one or more other objects. 
>+ * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
>+ * scrollbars.
>  * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
>  * group as') to one or more other objects.
>  * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
>@@ -712,37 +722,37 @@ typedef enum {
>  * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
>  * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
>  * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
>- * its type is not specified in the enumeration       and must be obtained via a
>- * call to getRelationTypeName.
>+ * its type is not specified in the enumeration.
>  * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
>- * another object.         For instance, text in a paragraph may flow to another
>- * object which is not the        'next sibling' in the accessibility hierarchy.
>- * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of RELATION_FLOWS_TO.
>+ * another object. For instance, text in a paragraph may flow to another
>+ * object which is not the 'next sibling' in the accessibility hierarchy.
>+ * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
>  * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
>- * a subwindow of another object, even though       it is not the object's child. 
>- * Useful when dealing with embedded applications and other cases       where the
>+ * a subwindow of another object, even though it is not the object's child. 
>+ * Useful when dealing with embedded applications and other cases where the
>  * widget hierarchy does not map cleanly to the onscreen presentation.
>- * @ATSPI_RELATION_EMBEDS: Similar to SUBWINDOW_OF, but specifically used for
>- * cross-process embedding.
>- * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of RELATION_EMBEDS; Used to denote
>- * content rendered by embedded renderers that       live in a separate process
>+ * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but 
>+ * specifically used for cross-process embedding.
>+ * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
>+ * denote content rendered by embedded renderers that live in a separate process
>  * space from the embedding context.
>  * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
>- * frame associated with another onscreen object.       Similar to TOOLTIP_FOR,
>- * but more general.  Useful for windows which are technically        toplevels
>- * but which, for one or more reasons, do not explicitly cause their associated   
>- *    window to lose 'window focus'. Creation of a ROLE_WINDOW object with the
>- * POPUP_FOR relation       usually requires some presentation action on the part
>- * of assistive technology clients, even though       the previous toplevel
>- * ROLE_FRAME object may still be the active window.
>+ * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
>+ * but more general. Useful for windows which are technically toplevels
>+ * but which, for one or more reasons, do not explicitly cause their 
>+ * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
>+ * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires 
>+ * some presentation action on the part
>+ * of assistive technology clients, even though the previous toplevel
>+ * @ATSPI_ROLE_FRAME object may still be the active window.
>  * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
>- * RELATION_POPUP_FOR.
>+ * @ATSPI_RELATION_POPUP_FOR.
>  * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides
>- * descriptive information        about another object; more verbose than
>- * RELATION_LABEL_FOR.
>+ * descriptive information about another object; more verbose than
>+ * @ATSPI_RELATION_LABEL_FOR.
>  * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides
>- * descriptive information        about this object; more verbose than
>- * RELATION_LABELLED_BY.
>+ * descriptive information about this object; more verbose than
>+ * @ATSPI_RELATION_LABELLED_BY.
>  * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
>  * determine the size of the enumeration.
>  *
>@@ -799,7 +809,7 @@ typedef enum {
> 
> /**
>  * AtspiRole:
>- * @ATSPI_ROLE_INVALID: A Role indicating an error condition, such as
>+ * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
>  * uninitialized Role data.
>  * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
>  * accelerators for the parent
>@@ -814,7 +824,7 @@ typedef enum {
>  * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
>  * provides a separate       indicator for the current state.
>  * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box (see
>- * ROLE_CHECK_BOX)
>+ * @ATSPI_ROLE_CHECK_BOX)
>  * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
>  * color.
>  * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data
>@@ -822,15 +832,15 @@ typedef enum {
>  * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date
>  * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
>  * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
>- * iconified versions of those       internal frames.
>+ * iconified versions of those internal frames.
>  * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
>- * visual element,       or which displays a value via such a rotating element.
>+ * visual element, or which displays a value via such a rotating element.
>  * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border
>  * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
>- * and select the contents       of a directory
>+ * and select the contents of a directory
>  * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
>- * the directory and lets       the user select a file, browse a different
>- * directory, or specify a       filename.
>+ * the directory and lets the user select a file, browse a different
>+ * directory, or specify a filename.
>  * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
>  * elements.
>  * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface
>@@ -841,7 +851,7 @@ typedef enum {
>  * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
>  * all panes beneath it
>  * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children   
>- *    represent the document content.
>+ * represent the document content.
>  * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
>  * components
>  * @ATSPI_ROLE_IMAGE: An image, typically static.
>@@ -850,56 +860,55 @@ typedef enum {
>  * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
>  * interface
>  * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
>- * drawn in layers,       providing a form of stacking order.
>+ * drawn in layers, providing a form of stacking order.
>  * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
>- * allows the       user to select one or more of them.
>+ * allows the user to select one or more of them.
>  * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
>  * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
>- * list of       actions the user can choose from.
>+ * list of actions the user can choose from.
>  * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
>- * dialog box of an       application that contains a list of menus the user can
>+ * dialog box of an application that contains a list of menus the user can
>  * choose from.
>  * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
>- * an action the       user can choose.
>+ * an action the user can choose.
>  * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
>- * DIALOG
>+ * dialog
>  * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list
>  * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
>- * page tabs), one at a time,       through some mechanism provided by the
>+ * page tabs), one at a time,through some mechanism provided by the
>  * object.
>  * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
>  * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
>- * where the text       content is not shown visibly to the user.
>+ * where the text content is not shown visibly to the user.
>  * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
>- * user a list of       choices, and then hides when the user selects one of those
>+ * user a list of choices, and then hides when the user selects one of those
>  * choices.
>  * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
>  * been completed.
>  * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
>- * application to do       something.
>+ * application to do something.
>  * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
>- * radio buttons in the       same group to become uncghecked when this one is
>+ * radio buttons in the same group to become unchecked when this one is
>  * checked.
>  * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
>  * (see @ATSPI_ROLE_RADIO_BUTTON)
>  * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
>- * layered pane as its       children.
>+ * layered pane as its children.
>  * @ATSPI_ROLE_ROW_HEADER: The header for a row of data
>  * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
>- * incrementally view a large       amount of data by moving the bounds of a
>+ * incrementally view a large amount of data by moving the bounds of a
>  * viewport along a one-dimensional axis.
>  * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
>  * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
>  * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
>  * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY 
>- * reciprocal relations
>- * are set; see  #atspi_get_relation_set.
>+ * reciprocal relations are set. See  #atspi_get_relation_set.
>  * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
>- * visible and       logical separation of the contents in a menu.
>+ * visible and logical separation of the contents in a menu.
>  * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
>  * range
>  * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
>- * be selected,        and which displays the current choice.  Unlike
>+ * be selected, and which displays the current choice.  Unlike
>  * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control 
>  * 'viewport'-like objects.
>  * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
>@@ -912,11 +921,11 @@ typedef enum {
>  * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other 
>  * #AtspiRoleType values are valid as well.
>  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
>- * in a Table.
>+ * in an #AtspiTable.
>  * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
>- * Table. Table rows and columns may also be        labelled via the
>- * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships;
>- * see #atspi_get_relation_set.
>+ * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
>+ * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
>+ * See #atspi_get_relation_set.
>  * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
>  * and shown in its own window.
>  * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
>@@ -933,58 +942,56 @@ typedef enum {
>  * user.
>  * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
>  * hierarchical info to the user
>- * @ATSPI_ROLE_UNKNOWN: The object contains some Accessible information, but
>- * its role is       not known.
>+ * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information, 
>+ * but its role is not known.
>  * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
>- * otherwise clip a larger object or        content renderer to a specific
>+ * otherwise clip a larger object or content renderer to a specific
>  * onscreen viewport.
>  * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
>  * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
>- * included in the        core enumeration
>+ * included in the core enumeration
>  * @ATSPI_ROLE_HEADER: An object that serves as a document header.
>  * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
>  * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
>  * text content. See also @ATSPI_ROLE_TEXT.
>  * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.    
>- *    for text objects which it controls        (should have CONTROLLER_FOR
>- * relation to such).
>+ *    for text objects which it controls (should have 
>+ * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
>  * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
>- * of an        application, which may contain ROLE_FRAME objects or other      
>- * accessible objects.  Children of #AccessibleDesktop objects  are generally
>+ * of an application, which may contain @ATSPI_ROLE_FRAME objects or other      
>+ * accessible objects. Children of #AccessibleDesktop objects  are generally
>  * @ATSPI_ROLE_APPLICATION objects.
>  * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
>- * for insertion        into an entry widget, for instance a list of words for
>- * completion        of a text entry.
>+ * for insertion into an entry widget, for instance a list of words for
>+ * completion of a text entry.
>  * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
>  * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container.  This
>- * role is a        "grouping" hint that the contained objects share a context
>- * which is        different from the container in which this accessible is
>- * embedded.       In particular, it is used for some kinds of document embedding,
>- * and       for embedding of out-of-process component, "panel applets", etc.
>+ * role is a "grouping" hint that the contained objects share a context
>+ * which is different from the container in which this accessible is
>+ * embedded. In particular, it is used for some kinds of document embedding,
>+ * and for embedding of out-of-process component, "panel applets", etc.
>  * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
>  * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
>  * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is 
>- * not present) implies
>- * a read-only 'text field' in a form, as opposed to a title, label, or
>- * caption.
>+ * not present) implies a read-only 'text field' in a form, as opposed to a 
>+ * title, label, or caption.
>  * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
>- *  It may contain multiple subelements whose attributes and/or description
>+ * It may contain multiple subelements whose attributes and/or description
>  * may be queried to obtain both the  quantitative data and information about
>  * how the data is being presented. The @ATSPI_LABELLED_BY relation is 
>- * particularly
>- * important in interpreting objects of this type, as is the
>+ * particularly important in interpreting objects of this type, as is the
>  * accessible-description property. See @ATSPI_ROLE_CAPTION.
>  * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
>  * textual, about another user interface element such as a table, chart, or
>  * image.
>  * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
>- * contains a view of document content. Document frames may occur within
>- * another Document instance, in which case the second  document may be said
>- * to be embedded in the containing instance.  HTML frames are often
>- * @ATSPI_ROLE_DOCUMENT_FRAME.  Either this object, or a singleton descendant, 
>+ * contains a view of document content. #AtspiDocument frames may occur within
>+ * another #AtspiDocument instance, in which case the second  document may be
>+ * said to be embedded in the containing instance.  HTML frames are often
>+ * @ATSPI_ROLE_DOCUMENT_FRAME:  Either this object, or a singleton descendant, 
>  * should implement the #AtspiDocument interface.
>  * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
>- * follows it in a document.       The 'heading level' of the heading, if
>+ * follows it in a document. The 'heading level' of the heading, if
>  * availabe,  may be obtained by       querying the object's attributes.
>  * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
>  * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
>@@ -1010,12 +1017,12 @@ typedef enum {
>  * application or viewer instance.
>  * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a      
>  * hypertext document.  Such objects are distinct from 'inline'       content
>- * which may also use the Hypertext/Hyperlink interfaces       to indicate the
>- * range/location within a text object where       an inline or embedded object
>+ * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
>+ * the range/location within a text object where an inline or embedded object
>  * lies.
>  * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
>- * which is used       to allow composition or input of a 'complex character',    
>- *   in other words it is an "input method window."
>+ * which is used to allow composition or input of a 'complex character',    
>+ * in other words it is an "input method window."
>  * @ATSPI_ROLE_TABLE_ROW: A row in a table.
>  * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
>  * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
>-- 
>1.7.6
>
>
>From 3dae9f6a4e85ecf53a09bb917edcdfcb12e2b5e7 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 12 Aug 2011 18:54:07 -0300
>Subject: [PATCH 4/9] Fixing a spelling error
>
>---
> atspi/atspi-constants.h |    2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 4ed8783..3c6efb4 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -392,7 +392,7 @@ typedef enum {
>  * focus
>  * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
>  * tooltip
>- * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of thsi object is
>+ * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
>  * horizontal
>  * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
>  * represented only by an icon
>-- 
>1.7.6
>
>
>From ae0f10e853aabe07c2e5e1fd2721a3826e67d7db Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 12 Aug 2011 21:06:39 -0300
>Subject: [PATCH 5/9] Fixing general inconsistency with capital letters, dots
> etc
>
>---
> atspi/atspi-constants.h |  172 ++++++++++++++++++++++++-----------------------
> 1 files changed, 87 insertions(+), 85 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 3c6efb4..6aeca63 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -67,16 +67,16 @@ extern "C" {
> 
> /**
>  * AtspiLocaleType:
>- * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages
>+ * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages.
>  * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string 
>- * collation 
>+ * collation. 
>  * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character 
>  * classification, conversion, case-sensitive comparison, and wide character 
>- * functions 
>- * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting
>+ * functions. 
>+ * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting.
>  * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal 
>- * point and the thousands separator)
>- * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting
>+ * point and the thousands separator).
>+ * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting.
>  *
>  * Used by interfaces #AtspiText and #AtspiDocument, this
>  * enumeration corresponds to the POSIX 'setlocale' enum values.
>@@ -101,9 +101,9 @@ typedef enum {
> 
> /**
>  * AtspiCoordType:
>- * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen
>+ * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen.
>  * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's 
>- * top-level window
>+ * top-level window.
>  *
>  * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
>  * to specify whether coordinates are relative to the window or the screen.
>@@ -159,9 +159,9 @@ typedef enum {
> /**
>  * AtspiCollectionMatchType:
>  * @ATSPI_Collection_MATCH_INVALID: 
>- * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met
>- * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met
>- * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met
>+ * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
>+ * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
>+ * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
>  * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
>  * the criteria is non-empty; for empty criteria this rule requires returned 
>  * value to also have empty set. 
>@@ -328,17 +328,17 @@ typedef enum {
> /**
>  * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
>  *
>- * One higher than the highest valid value of #AtspiTextBOundaryType.
>+ * One higher than the highest valid value of #AtspiTextBoundaryType.
>  */
> #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
> 
> /**
>  * AtspiTextClipType:
>- * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted
>+ * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
>  * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
>- * are omitted
>+ * are omitted.
>  * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
>- * coordinate are omitted
>+ * coordinate are omitted.
>  * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
>  * bounded by min and max are retained.
>  *
>@@ -366,49 +366,49 @@ typedef enum {
>  * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error 
>  * condition.
>  * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
>- * is an active subelement within a container or table
>- * @ATSPI_STATE_ARMED: Indicates that the object is armed
>+ * is an active subelement within a container or table.
>+ * @ATSPI_STATE_ARMED: Indicates that the object is armed.
>  * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
>  * representation is in the process of changing, or       the object is
>  * temporarily unavailable for interaction due to activity already in progress.
>- * @ATSPI_STATE_CHECKED: Indicates this object is currently checked
>- * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed
>+ * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
>+ * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
>  * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
>- * backing widget        (for instance, if its peer object has been destroyed)
>+ * backing widget        (for instance, if its peer object has been destroyed).
>  * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
>- * object
>+ * object.
>  * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
>  * currently reflects some application state. Objects that are "greyed out"
>  * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
>  * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. 
>- * See @ATSPI_STATE_SENSITIVE
>+ * See @ATSPI_STATE_SENSITIVE.
>  * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
>- * disclosure of its children
>- * @ATSPI_STATE_EXPANDED: Indicates this object is expanded
>+ * disclosure of its children.
>+ * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
>  * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
>  * which means all       events resulting from typing on the keyboard will
>- * normally be passed       to it when it has focus
>+ * normally be passed       to it when it has focus.
>  * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
>- * focus
>+ * focus.
>  * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
>- * tooltip
>+ * tooltip.
>  * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
>- * horizontal
>+ * horizontal.
>  * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
>- * represented only by an icon
>+ * represented only by an icon.
>  * @ATSPI_STATE_MODAL: Indicates something must be done with this object
>  * before the user can interact with an object in a different window.
>  * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
>- * lines of text
>+ * lines of text.
>  * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
>  * its children to be selected at the same time, or in the case of text
>  * objects, that the object supports non-contiguous text selections.
>  * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
>  * rectangular region. It also indicates an alpha value of unity, if it
>  * supports alpha blending.
>- * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed
>+ * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
>  * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
>- * fixed
>+ * fixed.
>  * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
>  * that allows its children to be selected and that this child is one of
>  * those children       that can be selected.
>@@ -416,7 +416,7 @@ typedef enum {
>  * allows its children to be selected and that this child is one of those
>  * children that has been selected.
>  * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
>- * interaction. @ATSPI_STATE_SENSITIVE usually accompanies 
>+ * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
>  * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the 
>  * absence of @ATSPI_STATE_ENABLED if the current visible state of the control 
>  * is "disconnected" from the application state.  In such cases, direct user
>@@ -429,12 +429,12 @@ typedef enum {
>  * i.e. subject to "exposure" if blocking or obscuring objects do not
>  * interpose between this object and the top of the window stack.
>  * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
>- * single line of text
>+ * single line of text.
>  * @ATSPI_STATE_STALE: Indicates that the information returned for this object
>  * may no longer be synchronized with the application state.  This can occur
>  * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the 
>- * end of the object peer's lifecycle
>- * @ATSPI_STATE_TRANSIENT: Indicates this object is transient
>+ * end of the object peer's lifecycle.
>+ * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
>  * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
>  * for example this state may appear on such objects as scrollbars, text
>  * objects (with vertical text flow), separators, etc.
>@@ -592,12 +592,14 @@ typedef enum {
> 
> /**
>  * AtspiEventType:
>- * @ATSPI_KEY_PRESSED_EVENT: < key on a keyboard device was pressed.
>- * @ATSPI_KEY_RELEASED_EVENT: < key on a keyboard device was released.
>- * @ATSPI_BUTTON_PRESSED_EVENT: < button on a non-keyboard human interface
>- * device        (HID) was pressed
>- * @ATSPI_BUTTON_RELEASED_EVENT: < button on a non-keyboard human interface
>- * device        (HID) was pressed
>+ * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was 
>+ * pressed.
>+ * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was 
>+ * released.
>+ * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard 
>+ * human interface device (HID) was pressed.
>+ * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
>+ * human interface device (HID) was released.
>  *
>  * Enumeration used to specify the event types of interest to an 
>  * #AtspiEventListener, or 
>@@ -621,11 +623,11 @@ typedef enum {
> 
> /**
>  * AtspiKeySynthType:
>- * @ATSPI_KEY_PRESS: emulate the pressing of a hardware keyboard key.
>- * @ATSPI_KEY_RELEASE: emulate the release of a hardware keyboard key.
>- * @ATSPI_KEY_PRESSRELEASE: a hardware keyboard key is pressed and immediately
>- * released.
>- * @ATSPI_KEY_SYM: a symbolic key event is generated, without specifying a
>+ * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
>+ * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
>+ * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
>+ * ofa hardware keyboard key.
>+ * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
>  * hardware key. @note if the keysym is not present in the current keyboard
>  * map, the #AtspiDeviceEventController instance has a limited ability to 
>  * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent 
>@@ -635,7 +637,7 @@ typedef enum {
>  * AT clients and keyboard emulators are usually part of the current keymap, 
>  * i.e. present on the system keyboard for the current locale (even if a 
>  * physical hardware keyboard is not connected.
>- * @ATSPI_KEY_STRING: a string is converted to its equivalent keyboard events
>+ * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
>  * and emitted. If the string consists of complex character or composed
>  * characters which are not in the current keymap, string emission is
>  * subject to the out-of-keymap limitations described for
>@@ -664,18 +666,18 @@ typedef enum {
> 
> /**
>  * AtspiModifierType:
>- * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key
>- * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key
>- * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'
>- * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr)
>- * @ATSPI_MODIFIER_META: depending on the platform this may map to 'Window',
>+ * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
>+ * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
>+ * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
>+ * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
>+ * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
>  * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
>  * map to one of META, META2, META3. On X Windows platforms these META
>  * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
>  * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
>  * is set in the corresponding XEvent.
>- * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META
>- * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META
>+ * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
>+ * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
>  * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
>  * to the appropriate META value, for the convenience of the client.
>  *
>@@ -754,7 +756,7 @@ typedef enum {
>  * descriptive information about this object; more verbose than
>  * @ATSPI_RELATION_LABELLED_BY.
>  * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
>- * determine the size of the enumeration.
>+ * determine the size of the enumeration. 
>  *
>  * #AtspiRelationType specifies a relationship between objects 
>  * (possibly one-to-many
>@@ -812,53 +814,53 @@ typedef enum {
>  * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
>  * uninitialized Role data.
>  * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
>- * accelerators for the parent
>- * @ATSPI_ROLE_ALERT: Object is used to alert the user about something
>+ * accelerators for the parent.
>+ * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
>  * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
>- * kind
>- * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator
>+ * kind.
>+ * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
>  * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
>- * into a 2d list
>+ * into a 2d list.
>  * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
>- * events
>+ * events.
>  * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
>  * provides a separate       indicator for the current state.
>- * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box (see
>- * @ATSPI_ROLE_CHECK_BOX)
>+ * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
>+ * @ATSPI_ROLE_CHECK_BOX.
>  * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
>  * color.
>- * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data
>- * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from
>- * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date
>- * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
>+ * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
>+ * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
>+ * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
>+ * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE.
>  * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
>  * iconified versions of those internal frames.
>  * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
>  * visual element, or which displays a value via such a rotating element.
>- * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border
>+ * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
>  * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
>- * and select the contents of a directory
>+ * and select the contents of a directory.
>  * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
>  * the directory and lets the user select a file, browse a different
>  * directory, or specify a filename.
>  * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
>  * elements.
>- * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface
>+ * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
>  * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
>- * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font
>+ * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
>  * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
>  * etc.
>  * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
>- * all panes beneath it
>+ * all panes beneath it.
>  * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children   
>  * represent the document content.
>  * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
>- * components
>+ * components.
>  * @ATSPI_ROLE_IMAGE: An image, typically static.
>  * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
>  * pane.
>  * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
>- * interface
>+ * interface.
>  * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
>  * drawn in layers, providing a form of stacking order.
>  * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
>@@ -872,8 +874,8 @@ typedef enum {
>  * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
>  * an action the user can choose.
>  * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
>- * dialog
>- * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list
>+ * dialog.
>+ * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
>  * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
>  * page tabs), one at a time,through some mechanism provided by the
>  * object.
>@@ -891,10 +893,10 @@ typedef enum {
>  * radio buttons in the same group to become unchecked when this one is
>  * checked.
>  * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
>- * (see @ATSPI_ROLE_RADIO_BUTTON)
>+ * . See @ATSPI_ROLE_RADIO_BUTTON.
>  * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
>  * layered pane as its children.
>- * @ATSPI_ROLE_ROW_HEADER: The header for a row of data
>+ * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
>  * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
>  * incrementally view a large amount of data by moving the bounds of a
>  * viewport along a one-dimensional axis.
>@@ -906,7 +908,7 @@ typedef enum {
>  * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
>  * visible and logical separation of the contents in a menu.
>  * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
>- * range
>+ * range.
>  * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
>  * be selected, and which displays the current choice.  Unlike
>  * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control 
>@@ -935,13 +937,13 @@ typedef enum {
>  * unchecked, but does not procide a separate indicator for the current
>  * state.
>  * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
>- * toggle buttons
>+ * toggle buttons.
>  * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
>- * object
>+ * object.
>  * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
>  * user.
>  * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
>- * hierarchical info to the user
>+ * hierarchical info to the user.
>  * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information, 
>  * but its role is not known.
>  * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
>@@ -949,7 +951,7 @@ typedef enum {
>  * onscreen viewport.
>  * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
>  * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
>- * included in the core enumeration
>+ * included in the core enumeration.
>  * @ATSPI_ROLE_HEADER: An object that serves as a document header.
>  * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
>  * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
>@@ -1022,7 +1024,7 @@ typedef enum {
>  * lies.
>  * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
>  * which is used to allow composition or input of a 'complex character',    
>- * in other words it is an "input method window."
>+ * in other words it is an "input method window".
>  * @ATSPI_ROLE_TABLE_ROW: A row in a table.
>  * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
>  * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
>-- 
>1.7.6
>
>
>From a710f9e1e35dea203834a2a3b3cdd21f742e516a Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 12 Aug 2011 21:07:53 -0300
>Subject: [PATCH 6/9] s/note/Note/g
>
>---
> atspi/atspi-constants.h |    4 ++--
> 1 files changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 6aeca63..2062e84 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -628,7 +628,7 @@ typedef enum {
>  * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
>  * ofa hardware keyboard key.
>  * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
>- * hardware key. @note if the keysym is not present in the current keyboard
>+ * hardware key. Note: if the keysym is not present in the current keyboard
>  * map, the #AtspiDeviceEventController instance has a limited ability to 
>  * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent 
>  * calls using out-of-keymap keysyms will vary from system to system, and on 
>@@ -919,7 +919,7 @@ typedef enum {
>  * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
>  * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
>  * and columns.
>- * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. NOTE:
>+ * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
>  * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other 
>  * #AtspiRoleType values are valid as well.
>  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
>-- 
>1.7.6
>
>
>From f69ffceb7c61118ceb8762ed064eb66124cd21a0 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 12 Aug 2011 21:22:18 -0300
>Subject: [PATCH 7/9] Padronizing accessible references
>
>---
> atspi/atspi-constants.h |    4 ++--
> 1 files changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 2062e84..b217325 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -765,7 +765,7 @@ typedef enum {
>  * are associated with one another.       For instance the 
>  * @ATSPI_RELATION_LABELLED_BY
>  * relationship may be used to identify labelling information       that should
>- * accompany the accessibleName property when presenting an object's content or
>+ * accompany the accessible name property when presenting an object's content or
>  * identity       to the end user.  Similarly, 
>  * @ATSPI_RELATION_CONTROLLER_FOR can be used
>  * to further specify the context in which a valuator is useful, and/or the
>@@ -982,7 +982,7 @@ typedef enum {
>  * may be queried to obtain both the  quantitative data and information about
>  * how the data is being presented. The @ATSPI_LABELLED_BY relation is 
>  * particularly important in interpreting objects of this type, as is the
>- * accessible-description property. See @ATSPI_ROLE_CAPTION.
>+ * accessible description property. See @ATSPI_ROLE_CAPTION.
>  * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
>  * textual, about another user interface element such as a table, chart, or
>  * image.
>-- 
>1.7.6
>
>
>From 1095f1c9000a4b7f4ddab27eb7e9aa2396e80ecf Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 12 Aug 2011 22:14:19 -0300
>Subject: [PATCH 8/9] Adding documentation to atspi_collection_match_invalid
>
>---
> atspi/atspi-constants.h |    3 ++-
> 1 files changed, 2 insertions(+), 1 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index b217325..21c7e42 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -158,7 +158,8 @@ typedef enum {
> 
> /**
>  * AtspiCollectionMatchType:
>- * @ATSPI_Collection_MATCH_INVALID: 
>+ * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or 
>+ * uninitialized value.
>  * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
>  * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
>  * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
>-- 
>1.7.6
>
>
>From fd15def1f210cd682deb11f03fee27b46a1173d8 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 18 Aug 2011 22:39:38 -0300
>Subject: [PATCH 9/9] Removing bitset sentences
>
>---
> atspi/atspi-constants.h |   15 ---------------
> 1 files changed, 0 insertions(+), 15 deletions(-)
>
>diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
>index 21c7e42..7bc5a2e 100644
>--- a/atspi/atspi-constants.h
>+++ b/atspi/atspi-constants.h
>@@ -81,7 +81,6 @@ extern "C" {
>  * Used by interfaces #AtspiText and #AtspiDocument, this
>  * enumeration corresponds to the POSIX 'setlocale' enum values.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_LOCALE_TYPE_MESSAGES,
>@@ -108,7 +107,6 @@ typedef enum {
>  * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
>  * to specify whether coordinates are relative to the window or the screen.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_COORD_TYPE_SCREEN,
>@@ -136,7 +134,6 @@ typedef enum {
>  * Enumeration used by interface #AtspiCollection to specify
>  * the way #AtspiAccesible objects should be sorted.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_Collection_SORT_ORDER_INVALID,
>@@ -172,7 +169,6 @@ typedef enum {
>  * Enumeration used by #AtspiMatchRule to specify
>  * how to interpret #AtspiAccesible objects.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_Collection_MATCH_INVALID,
>@@ -200,7 +196,6 @@ typedef enum {
>  * Enumeration used by interface #AtspiCollection to specify
>  * restrictions on #AtspiAccesible objects to be traversed.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
>@@ -256,7 +251,6 @@ typedef enum {
>  * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and 	   
>  * @ATSPI_LAYER_OVERLAY.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  */
> typedef enum {
>     ATSPI_LAYER_INVALID,
>@@ -314,7 +308,6 @@ typedef enum {
>  * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
>  * #atspi_text_get_text_before_offset.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_TEXT_BOUNDARY_CHAR,
>@@ -346,7 +339,6 @@ typedef enum {
>  * Enumeration used by interface #AtspiText to indicate
>  * how to treat characters intersecting bounding boxes.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_TEXT_CLIP_NONE,
>@@ -516,7 +508,6 @@ typedef enum {
>  * Enumeration used by various interfaces indicating every possible state 
>  * an #AtspiAccesible object can assume.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_STATE_INVALID,
>@@ -577,7 +568,6 @@ typedef enum {
>  *
>  * Deprecated. Should not be used.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_KEY_PRESSED,
>@@ -606,7 +596,6 @@ typedef enum {
>  * #AtspiEventListener, or 
>  * to identify the type of an event for which notification has been sent.  
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_KEY_PRESSED_EVENT,
>@@ -648,7 +637,6 @@ typedef enum {
>  * Enumeration used when synthesizing keyboard input via
>  * #atspi_generate_keyboard_event.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_KEY_PRESS,
>@@ -684,7 +672,6 @@ typedef enum {
>  *
>  *
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_MODIFIER_SHIFT,
>@@ -778,7 +765,6 @@ typedef enum {
>  * Enumeration used to specify
>  * the type of relation encapsulated in an #AtspiRelation object.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  **/
> typedef enum {
>     ATSPI_RELATION_NULL,
>@@ -1061,7 +1047,6 @@ typedef enum {
>  * Enumeration used by interface #AtspiAccessible to specify the role
>  * of an #AtspiAccessible object.
>  *
>- * Bitfield/set of flags generated from the AT-SPI specification.
>  */
> typedef enum {
>     ATSPI_ROLE_INVALID,
>-- 
>1.7.6
>

Comment on attachment 194179 [details] [review]
Fixing traverse and recurse/restrict documentation (comment #45)






>From 9eeaad869172e61baff45211b36b37a1544f3ee9 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 13:17:57 -0300
>Subject: [PATCH 1/4] Starting to improve atspi-collection
>
>---
> atspi/atspi-collection.c               |   23 ++++++++++++-----------
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> 2 files changed, 25 insertions(+), 11 deletions(-)
>
>diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c
>index 43dfa2f..5dd9bf8 100644
>--- a/atspi/atspi-collection.c
>+++ b/atspi/atspi-collection.c
>@@ -26,21 +26,22 @@
> /* TODO: Improve documentation and implement some missing functions */
> 
> /**
>- * atspi_collection_is_ancester_of:
>+ * atspi_collection_is_ancestor_of:
>  *
>- * @collection: The #AtspiCollection to test against.
>+ * @collection: A pointer to the #AtspiCollection to test against.
>  * @test: The #AtspiAccessible to test.
>  *
>+ * Not yet implemented. 
>+ *
>  * Returns: TRUE if @collection is an ancestor of @test; FALSE otherwise.
>  *
>- * Not yet implemented.
>  **/
> gboolean
> atspi_collection_is_ancestor_of (AtspiCollection *collection,
>                                  AtspiAccessible *test,
>                                  GError **error)
> {
>-  g_warning ("Atspi: TODO: Implement is_ancester_of");
>+  g_warning ("Atspi: TODO: Implement is_ancestor_of");
>   return FALSE;
> }
> 
>@@ -107,8 +108,8 @@ return_accessibles (DBusMessage *message)
> /**
>  * atspi_collection_get_matches:
>  *
>- * @collection: The #AtspiCollection.
>- * @rule: A #AtspiMatchRule describing the match criteria.
>+ * @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.
>@@ -149,9 +150,9 @@ atspi_collection_get_matches (AtspiCollection *collection,
> /**
>  * atspi_collection_get_matches_to:
>  *
>- * @collection: The #AtspiCollection.
>+ * @collection: A pointer to the #AtspiCollection to query.
>  * @current_object: The object at which to start searching.
>- * @rule: A #AtspiMatchRule describing the match criteria.
>+ * @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
>@@ -205,9 +206,9 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
> /**
>  * atspi_collection_get_matches_from:
>  *
>- * @collection: The #AtspiCollection.
>+ * @collection: A pointer to the #AtspiCollection to query.
>  * @current_object: Upon reaching this object, searching should stop.
>- * @rule: A #AtspiMatchRule describing the match criteria.
>+ * @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
>@@ -257,7 +258,7 @@ atspi_collection_get_matches_from (AtspiCollection *collection,
> /**
>  * atspi_collection_get_active_descendant:
>  * 
>- * @collection: The #AtspiCollection to query.
>+  @collection: A pointer to the #AtspiCollection to query.
>  *
>  * Returns: (transfer full): The active descendant of #collection.
>  *
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>-- 
>1.7.6
>
>
>From ee75b9a18bf3938e3ed434fc0eff0ba8bb463d37 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Mon, 1 Aug 2011 21:30:45 -0300
>Subject: [PATCH 2/4] Improving atspi-collection documentation.
>
>---
> atspi/atspi-collection.c |   49 +++++++++++++++++++++++++++++++---------------
> 1 files changed, 33 insertions(+), 16 deletions(-)
>
>diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c
>index 5dd9bf8..a40a453 100644
>--- a/atspi/atspi-collection.c
>+++ b/atspi/atspi-collection.c
>@@ -28,12 +28,7 @@
> /**
>  * atspi_collection_is_ancestor_of:
>  *
>- * @collection: A pointer to the #AtspiCollection to test against.
>- * @test: The #AtspiAccessible to test.
>- *
>- * Not yet implemented. 
>- *
>- * Returns: TRUE if @collection is an ancestor of @test; FALSE otherwise.
>+ * Not yet implemented.
>  *
>  **/
> gboolean
>@@ -109,14 +104,21 @@ 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: TODO
>  *
>- * Returns: (element-type AtspiAccessible*) (transfer full): A #GArray of
>- *          #AtspiAccessibles matching the given match rule.
>+ * Gets all #AtspiAccessible objects from the @collection matching a given
>+ * @rule.  
>+ *
>+ * Returns: (element-type AtspiAccessible*) (transfer full): All 
>+ *          #AtspiAccessible objects matching the given match rule.
>  **/
> GArray *
> atspi_collection_get_matches (AtspiCollection *collection,
>@@ -151,18 +153,28 @@ 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.
>+ *
>  * @recurse: TODO
>+ *
>  * @count: The maximum number of results to return, or 0 for no limit.
>+ *
>  * @traverse: TODO
>  *
>- * Returns: (element-type AtspiAccessible*) (transfer full): A #GArray of
>- *          #AtspiAccessibles matching the given match rule after
>+ * Gets all #AtspiAccessible objects from the @collection, after 
>+ * @current_object, matching a given @rule.  
>+ *
>+ * Returns: (element-type AtspiAccessible*) (transfer full): All
>+ *          #AtspiAccessible objects matching the given match rule after
>  *          @current_object.
>  **/
> GArray *
>@@ -207,17 +219,26 @@ 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.
>+ *
>  * @count: The maximum number of results to return, or 0 for no limit.
>+ *
>  * @traverse: TODO
>  *
>- * Returns: (element-type AtspiAccessible*) (transfer full): A #GArray of
>- *          #AtspiAccessibles matching the given match rule that preceed
>+ * Gets all #AtspiAccessible objects from the @collection, before  
>+ * @current_object, matching a given @rule.  
>+ *
>+ * Returns: (element-type AtspiAccessible*) (transfer full): All 
>+ *          #AtspiAccessible objects matching the given match rule that preceed
>  *          @current_object.
>  **/
> GArray *
>@@ -257,10 +278,6 @@ atspi_collection_get_matches_from (AtspiCollection *collection,
> 
> /**
>  * atspi_collection_get_active_descendant:
>- * 
>-  @collection: A pointer to the #AtspiCollection to query.
>- *
>- * Returns: (transfer full): The active descendant of #collection.
>  *
>  * Not yet implemented.
>  **/
>-- 
>1.7.6
>
>
>From 1781a84fbda77071f4343eb08e01245a2cc0ee5b Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Mon, 1 Aug 2011 21:56:24 -0300
>Subject: [PATCH 3/4] Adding descriptions for atspi-collection.
>
>---
> doc/libatspi/tmpl/atspi-collection.sgml |    7 +++++--
> 1 files changed, 5 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-collection.sgml b/doc/libatspi/tmpl/atspi-collection.sgml
>index 81bfd37..5502900 100644
>--- a/doc/libatspi/tmpl/atspi-collection.sgml
>+++ b/doc/libatspi/tmpl/atspi-collection.sgml
>@@ -2,11 +2,14 @@
> atspi-collection
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface designed to allow accessibles which satisfy a set of 
>+criteria to be returned.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface designed to allow accessibles which satisfy a set of 
>+criteria to be returned. This interface can be used to avoid iteration
>+or client-side search of the object tree.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.6
>
>
>From 504f87dd41a5385cfa9336b88880ea6fd954a27f Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 18 Aug 2011 23:14:02 -0300
>Subject: [PATCH 4/4] Fixing traverse recurse/restrict documentations
>
>---
> atspi/atspi-collection.c |   16 +++++++++-------
> 1 files changed, 9 insertions(+), 7 deletions(-)
>
>diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c
>index a40a453..210a0cd 100644
>--- a/atspi/atspi-collection.c
>+++ b/atspi/atspi-collection.c
>@@ -112,7 +112,7 @@ return_accessibles (DBusMessage *message)
>  *
>  * @count: The maximum number of results to return, or 0 for no limit.
>  *
>- * @traverse: TODO
>+ * @traverse: Not supported.
>  *
>  * Gets all #AtspiAccessible objects from the @collection matching a given
>  * @rule.  
>@@ -164,11 +164,13 @@ atspi_collection_get_matches (AtspiCollection *collection,
>  * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
>  *        the objects to be traversed.
>  *
>- * @recurse: TODO
>+ * @restrict: 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.
>  *
>  * @count: The maximum number of results to return, or 0 for no limit.
>  *
>- * @traverse: TODO
>+ * @traverse: Not supported.
>  *
>  * Gets all #AtspiAccessible objects from the @collection, after 
>  * @current_object, matching a given @rule.  
>@@ -183,7 +185,7 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
>                               AtspiMatchRule *rule,
>                               AtspiCollectionSortOrder sortby,
>                               AtspiCollectionTreeTraversalType tree,
>-                              gboolean recurse,
>+                              gboolean restrict,
>                               gint count,
>                               gboolean traverse,
>                               GError **error)
>@@ -192,7 +194,7 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
>   DBusMessage *reply;
>   dbus_int32_t d_sortby = sortby;
>   dbus_int32_t d_tree = tree;
>-  dbus_bool_t d_recurse = recurse;
>+  dbus_bool_t d_restrict = restrict;
>   dbus_int32_t d_count = count;
>   dbus_bool_t d_traverse = traverse;
> 
>@@ -205,7 +207,7 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
>     return NULL;
>   dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
>                                      DBUS_TYPE_UINT32, &d_tree,
>-                            DBUS_TYPE_BOOLEAN, &d_recurse,
>+                            DBUS_TYPE_BOOLEAN, &d_restrict,
>                             DBUS_TYPE_INT32, &d_count,
>                             DBUS_TYPE_BOOLEAN, &d_traverse,
>                             DBUS_TYPE_INVALID);
>@@ -232,7 +234,7 @@ atspi_collection_get_matches_to (AtspiCollection *collection,
>  *
>  * @count: The maximum number of results to return, or 0 for no limit.
>  *
>- * @traverse: TODO
>+ * @traverse: Not supported.
>  *
>  * Gets all #AtspiAccessible objects from the @collection, before  
>  * @current_object, matching a given @rule.  
>-- 
>1.7.6
>

Comment on attachment 193608 [details] [review]
Some documentation improvements for atspi-selection (grammar issue fixed)






>From f2a68284d8d6da7829ff216e1253a1cae370543d Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 23:49:04 -0300
>Subject: [PATCH 1/3] Improving atspi-selection.c documentation
>
>---
> atspi/atspi-selection.c |   32 +++++++++++++++++---------------
> 1 files changed, 17 insertions(+), 15 deletions(-)
>
>diff --git a/atspi/atspi-selection.c b/atspi/atspi-selection.c
>index 687f033..44a4a49 100644
>--- a/atspi/atspi-selection.c
>+++ b/atspi/atspi-selection.c
>@@ -28,7 +28,7 @@
>  * atspi_selection_get_n_selected_children:
>  * @obj: a pointer to the #AtspiSelection implementor on which to operate.
>  *
>- * Get the number of children of an #AtspiSelection implementor which are
>+ * Gets the number of children of an #AtspiSelection implementor which are
>  *        currently selected.
>  *
>  * Returns: a #gint indicating the number of #Accessible children
>@@ -53,15 +53,17 @@ atspi_selection_get_n_selected_children (AtspiSelection *obj, GError **error)
>  * @selected_child_index: a #gint indicating which of the selected
>  *      children is specified.
>  *
>- * Get the i-th selected #AtspiAccessible child of an #AtspiSelection.
>- *      Note that @child_index refers to the index in the list of 'selected'
>+ * Gets the i-th selected #AtspiAccessible child of an #AtspiSelection.
>+ *      Note that @selected_child_index refers to the index in the list 
>+ *      of 'selected'
>  *      children and generally differs from that used in
>- *      #atspi_accessible_get_child_at_index() or returned by
>- *      #atspi_accessible_get_index_in_parent(). @selected_child_index must lie between 0
>- *      and #Atspi_selection_get_n_selected_children()-1, inclusive.
>+ *      #atspi_accessible_get_child_at_index or returned by
>+ *      #atspi_accessible_get_index_in_parent.
>+ *      @selected_child_index must lie between 0
>+ *      and #atspi_selection_get_n_selected_children - 1, inclusive.
>  *
>  * Returns: (transfer full): a pointer to a selected #AtspiAccessible child
>- *          object, specified by @child_index.
>+ *          object, specified by @selected_child_index.
>  *
>  **/
> AtspiAccessible *
>@@ -86,7 +88,7 @@ atspi_selection_get_selected_child (AtspiSelection *obj,
>  * @child_index: a #gint indicating which child of the #Accessible
>  *              is to be selected.
>  *
>- * Add a child to the selected children list of an #AtspiSelection.
>+ * Adds a child to the selected children list of an #AtspiSelection.
>  *         For #AtspiSelection implementors that only allow
>  *         single selections, this may replace the (single) current
>  *         selection.
>@@ -114,11 +116,11 @@ atspi_selection_select_child (AtspiSelection *obj,
>  * @selected_child_index: a #gint indicating which of the selected children
>  *              of the #Accessible is to be selected.
>  *
>- * Remove a child to the selected children list of an #AtspiSelection.
>+ * Removes a child to the selected children list of an #AtspiSelection.
>  *          Note that @child_index is the index in the selected-children list,
>  *          not the index in the parent container.  @selectedChildIndex in this
>  *          method, and @child_index in #atspi_selection_select_child
>- *          are asymmettric.
>+ *          are asymmetric.
>  *
>  * Returns: #TRUE if the child was successfully deselected, #FALSE otherwise.
>  **/
>@@ -143,7 +145,7 @@ atspi_selection_deselect_selected_child (AtspiSelection *obj,
>  * @child_index: a #gint indicating which of the children
>  *              of the #AtspiAccessible is to be de-selected.
>  *
>- * Deselect a specific child of an #AtspiSelection.
>+ * Deselects a specific child of an #AtspiSelection.
>  *          Note that @child_index is the index of the child
>  *          in the parent container.
>  * 
>@@ -171,9 +173,9 @@ atspi_selection_deselect_child (AtspiSelection *obj,
>  * @obj: a pointer to the #AtspiSelection implementor on which to operate.
>  * @child_index: an index into the #AtspiSelection's list of children.
>  *
>- * Determine whether a particular child of an #AtspiSelection implementor
>+ * Determines whether a particular child of an #AtspiSelection implementor
>  *        is currently selected.  Note that @child_index is the index into the
>- *        standard #Accessible container's list of children.
>+ *        standard #AtspiAccessible container's list of children.
>  *
>  * Returns: #TRUE if the specified child is currently selected,
>  *          #FALSE otherwise.
>@@ -197,7 +199,7 @@ atspi_selection_is_child_selected (AtspiSelection *obj,
>  * atspi_selection_select_all:
>  * @obj: a pointer to the #AtspiSelection implementor on which to operate.
>  *
>- * Attempt to select all of the children of an #AtspiSelection implementor.
>+ * Attempts to select all of the children of an #AtspiSelection implementor.
>  * Not all #AtspiSelection implementors support this operation.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>@@ -219,7 +221,7 @@ atspi_selection_select_all (AtspiSelection *obj, GError **error)
>  * atspi_selection_clear_selection:
>  * @obj: a pointer to the #AtspiSelection implementor on which to operate.
>  *
>- * Clear the current selection, removing all selected children from the
>+ * Clears the current selection, removing all selected children from the
>  *       specified #AtspiSelection implementor's selection list.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>-- 
>1.7.5.1
>
>
>From 7bc2e86d5a8780e26aba8533ac0ffeac18fab76f Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 23:55:21 -0300
>Subject: [PATCH 2/3] Adding descriptions to atspi-selection.c
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-selection.sgml |    9 +++++++--
> 2 files changed, 20 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-selection.sgml b/doc/libatspi/tmpl/atspi-selection.sgml
>index 92c8a53..6c7a102 100644
>--- a/doc/libatspi/tmpl/atspi-selection.sgml
>+++ b/doc/libatspi/tmpl/atspi-selection.sgml
>@@ -2,11 +2,16 @@
> atspi-selection
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface which indicates that an object exposes a 'selection' model,
>+allowing the selection of one or more of its children.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface which indicates that an object exposes a 'selection'
>+model, allowing the selection of one or more of its children.
>+Read-only Selection instances are possible, in which case the
>+interface is used to programmatically determine the selected-ness
>+of its children.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>
>
>From b7869ecc011797a5ff1ff8cdb6b7f614b4dfc8a9 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 11 Aug 2011 01:07:30 -0300
>Subject: [PATCH 3/3] Fixing grammar issue
>
>---
> atspi/atspi-selection.c |    2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
>diff --git a/atspi/atspi-selection.c b/atspi/atspi-selection.c
>index 44a4a49..bc5e19e 100644
>--- a/atspi/atspi-selection.c
>+++ b/atspi/atspi-selection.c
>@@ -116,7 +116,7 @@ atspi_selection_select_child (AtspiSelection *obj,
>  * @selected_child_index: a #gint indicating which of the selected children
>  *              of the #Accessible is to be selected.
>  *
>- * Removes a child to the selected children list of an #AtspiSelection.
>+ * Removes a child from the selected children list of an #AtspiSelection.
>  *          Note that @child_index is the index in the selected-children list,
>  *          not the index in the parent container.  @selectedChildIndex in this
>  *          method, and @child_index in #atspi_selection_select_child
>-- 
>1.7.5.1
>

Comment on attachment 193607 [details] [review]
Some documentation improvements for atspi-table (typo fixed)






>From 1da26d875e764120704b0ac8b0b1846864375c19 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 23:09:11 -0300
>Subject: [PATCH 1/3] Improving atspi-table.c documentation
>
>---
> atspi/atspi-table.c |  171 +++++++++++++++++++++++++++-----------------------
> 1 files changed, 92 insertions(+), 79 deletions(-)
>
>diff --git a/atspi/atspi-table.c b/atspi/atspi-table.c
>index aa5667b..84f17fe 100644
>--- a/atspi/atspi-table.c
>+++ b/atspi/atspi-table.c
>@@ -29,10 +29,11 @@
>  * atspi_table_get_caption:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Get an accessible representation of the caption for an #AtspiTable.
>+ * Gets an accessible representation of the caption for an #AtspiTable.
>+ *
>+ * Returns: (transfer full): an #AtspiAccessible object that serves as
>+ * the table's caption.
>  *
>- * Returns: (transfer full): an #Accessible object that serves as the table's
>- *          caption.
>  **/
> AtspiAccessible *
> atspi_table_get_caption (AtspiTable *obj, GError **error)
>@@ -49,7 +50,7 @@ atspi_table_get_caption (AtspiTable *obj, GError **error)
>  * atspi_table_get_summary:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Get an accessible object which summarizes the contents of an #AtspiTable.
>+ * Gets an accessible object which summarizes the contents of an #AtspiTable.
>  *
>  * Returns: (transfer full): an #AtspiAccessible object that serves as the
>  *          table's summary (often a reduced #AtspiTable).
>@@ -70,11 +71,11 @@ atspi_table_get_summary (AtspiTable *obj, GError **error)
>  * atspi_table_get_n_rows:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Get the number of rows in an #AtspiTable,
>+ * Gets the number of rows in an #AtspiTable,
>  *        exclusive of any rows that are programmatically hidden, but inclusive
>  *        of rows that may be outside of the current scrolling window or viewport.
>  *
>- * Returns: an integer indicating the number of rows in the table.
>+ * Returns: a #gint indicating the number of rows in the table.
>  **/
> gint
> atspi_table_get_n_rows (AtspiTable *obj, GError **error)
>@@ -92,11 +93,11 @@ atspi_table_get_n_rows (AtspiTable *obj, GError **error)
>  * atspi_table_get_n_columns:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Get the number of columns in an #AtspiTable,
>+ * Gets the number of columns in an #AtspiTable,
>  *        exclusive of any columns that are programmatically hidden, but inclusive
>  *        of columns that may be outside of the current scrolling window or viewport.
>  *
>- * Returns: an integer indicating the number of columns in the table.
>+ * Returns: a #gint indicating the number of columns in the table.
>  **/
> gint
> atspi_table_get_n_columns (AtspiTable *obj, GError **error)
>@@ -116,9 +117,9 @@ atspi_table_get_n_columns (AtspiTable *obj, GError **error)
>  * @row: the specified table row, zero-indexed.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get the table cell at the specified row and column indices.
>- *          To get the accessible object at a particular (x, y) screen coordinate,
>- *          use #atspi_component_get_accessible_at_point ().
>+ * Gets the table cell at the specified row and column indices.
>+ * To get the accessible object at a particular (x, y) screen 
>+ * coordinate, use #atspi_component_get_accessible_at_point.
>  *
>  * Returns: (transfer full): an #AtspiAccessible object representing the
>  *          specified table cell.
>@@ -145,13 +146,14 @@ atspi_table_get_accessible_at (AtspiTable *obj,
>  * @row: the specified table row, zero-indexed.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get the 1-D child index corresponding to the specified 2-D row and column indices.
>- *          To get the accessible object at a particular (x, y) screen coordinate,
>- *          use #Accessible_getAccessibleAtPoint ().
>- * @see #atspi_table_getRowAtIndex(), #atspi_table_getColumnAtIndex()
>+ * Gets the 1-D child index corresponding to the specified 2-D row and
>+ * column indices. To get the accessible object at a particular (x, y) screen 
>+ * coordinate, use #atspi_component_get_accessible_at_point.
>+ *
>+ * @see #atspi_table_get_row_at_index, #atspi_table_get_column_at_index
>  *
>- * Returns: a long integer which serves as the index of a specified cell in the
>- *          table, in a form usable by #Accessible_getChildAtIndex().
>+ * Returns: a #gint which serves as the index of a specified cell in the
>+ *          table, in a form usable by #atspi_get_child_at_index.
>  **/
> gint
> atspi_table_get_index_at (AtspiTable *obj,
>@@ -174,11 +176,12 @@ atspi_table_get_index_at (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @index: the specified child index, zero-indexed.
>  *
>- * Get the table row index occupied by the child at a particular 1-D child index.
>+ * Gets the table row index occupied by the child at a particular 1-D 
>+ * child index.
>  *
>- * @see #atspi_table_get_indexAt(), #atspi_table_get_columnAtIndex()
>+ * @see #atspi_table_get_index_at, #atspi_table_get_column_at_index
>  *
>- * Returns: a long integer indicating the first row spanned by the child of a
>+ * Returns: a #gint indicating the first row spanned by the child of a
>  *          table, at the specified 1-D (zero-offset) @index.
>  **/
> gint
>@@ -201,11 +204,12 @@ atspi_table_get_row_at_index (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @index: the specified child index, zero-indexed.
>  *
>- * Get the table column index occupied by the child at a particular 1-D child index.
>+ * Gets the table column index occupied by the child at a particular 1-D
>+ * child index.
>  *
>- * @see #atspi_table_getIndexAt(), #atspi_table_getRowAtIndex()
>+ * @see #atspi_table_get_index_at, #atspi_table_get_row_at_index
>  *
>- * Returns: a long integer indicating the first column spanned by the child of a
>+ * Returns: a #gint indicating the first column spanned by the child of a
>  *          table, at the specified 1-D (zero-offset) @index.
>  **/
> gint
>@@ -228,8 +232,8 @@ atspi_table_get_column_at_index (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @row: the specified table row, zero-indexed.
>  *
>- * Get a text description of a particular table row.  This differs from
>- * atspi_table_get_row_header, which returns an #AtspiAccessible.
>+ * Gets a text description of a particular table row.  This differs from
>+ * #atspi_table_get_row_header, which returns an #AtspiAccessible.
>  *
>  * Returns: a UTF-8 string describing the specified table row, if available.
>  **/
>@@ -253,8 +257,8 @@ atspi_table_get_row_description (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get a text description of a particular table column.  This differs from
>- * atspi_table_get_column_header, which returns an #Accessible.
>+ * Gets a text description of a particular table column.  This differs from
>+ * #atspi_table_get_column_header, which returns an #Accessible.
>  *
>  * Returns: a UTF-8 string describing the specified table column, if available.
>  **/
>@@ -278,10 +282,11 @@ atspi_table_get_column_description (AtspiTable *obj,
>  * @row: the specified table row, zero-indexed.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get the number of rows spanned by the table cell at the specific row and column.
>- * (some tables can have cells which span multiple rows and/or columns).
>+ * Gets the number of rows spanned by the table cell at the specific row
>+ * and column. (some tables can have cells which span multiple rows
>+ * and/or columns).
>  *
>- * Returns: a long integer indicating the number of rows spanned by the specified cell.
>+ * Returns: a #gint indicating the number of rows spanned by the specified cell.
>  **/
> gint
> atspi_table_get_row_extent_at (AtspiTable *obj,
>@@ -305,10 +310,11 @@ atspi_table_get_row_extent_at (AtspiTable *obj,
>  * @row: the specified table row, zero-indexed.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get the number of columns spanned by the table cell at the specific row and column.
>- * (some tables can have cells which span multiple rows and/or columns).
>+ * Gets the number of columns spanned by the table cell at the specific
>+ * row and column (some tables can have cells which span multiple
>+ * rows and/or columns).
>  *
>- * Returns: a long integer indicating the number of columns spanned by the specified cell.
>+ * Returns: a #gint indicating the number of columns spanned by the specified cell.
>  **/
> gint
> atspi_table_get_column_extent_at (AtspiTable *obj,
>@@ -331,10 +337,10 @@ atspi_table_get_column_extent_at (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @row: the specified table row, zero-indexed.
>  *
>- * Get the header associated with a table row, if available.  This differs from
>- * atspi_table_get_row_description, which returns a string.
>+ * Gets the header associated with a table row, if available. This differs from
>+ * #atspi_table_get_row_description, which returns a string.
>  *
>- * Returns: (transfer full): a #Accessible representatin of the specified
>+ * Returns: (transfer full): an #AtspiAccessible representatin of the specified
>  *          table row, if available.
>  **/
> AtspiAccessible *
>@@ -357,10 +363,11 @@ atspi_table_get_row_header (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @column: the specified table column, zero-indexed.
>  *
>- * Get the header associated with a table column, if available.  This differs from
>- * atspi_table_get_column_description, which returns a string.
>+ * Gets the header associated with a table column, if available.
>+ * This differs from #atspi_table_get_column_description, which
>+ * returns a string.
>  *
>- * Returns: (transfer full): a #AtspiAccessible representation of the
>+ * Returns: (transfer full): an #AtspiAccessible representation of the
>  *          specified table column, if available.
>  **/
> AtspiAccessible *
>@@ -382,10 +389,10 @@ atspi_table_get_column_header (AtspiTable *obj,
>  * atspi_table_get_n_selected_rows:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Query a table to find out how many rows are currently selected.  Not all tables
>- *  support row selection.
>+ * Query a table to find out how many rows are currently selected. 
>+ * Not all tables support row selection.
>  *
>- * Returns: a long integer indicating the number of rows currently selected.
>+ * Returns: a #gint indicating the number of rows currently selected.
>  **/
> gint
> atspi_table_get_n_selected_rows (AtspiTable *obj, GError **error)
>@@ -403,9 +410,9 @@ atspi_table_get_n_selected_rows (AtspiTable *obj, GError **error)
>  * atspi_table_get_selected_rows:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Query a table for a list of indices of rows which are currently selected.
>+ * Queries a table for a list of indices of rows which are currently selected.
>  *
>- * Returns: (element-type gint) (transfer full): an array of integers,
>+ * Returns: (element-type gint) (transfer full): an array of #gint values,
>  *          specifying which rows are currently selected.
>  **/
> GArray *
>@@ -425,9 +432,10 @@ atspi_table_get_selected_rows (AtspiTable *obj,
>  * atspi_table_get_selected_columns:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Query a table for a list of indices of columns which are currently selected.
>+ * Queries a table for a list of indices of columns which are currently
>+ * selected.
>  *
>- * Returns: (element-type gint) (transfer full): an array of integers,
>+ * Returns: (element-type gint) (transfer full): an array of #gint values,
>  *          specifying which columns are currently selected.
>  **/
> GArray *
>@@ -447,10 +455,10 @@ atspi_table_get_selected_columns (AtspiTable *obj,
>  * atspi_table_get_n_selected_columns:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  *
>- * Query a table to find out how many columns are currently selected.  Not all tables
>- *  support column selection.
>+ * Queries a table to find out how many columns are currently selected. 
>+ * Not all tables support column selection.
>  *
>- * Returns: a long integer indicating the number of columns currently selected.
>+ * Returns: a #gint indicating the number of columns currently selected.
>  **/
> gint
> atspi_table_get_n_selected_columns (AtspiTable *obj, GError **error)
>@@ -469,7 +477,8 @@ atspi_table_get_n_selected_columns (AtspiTable *obj, GError **error)
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @row: the zero-indexed row number of the row being queried.
>  *
>- * Determine whether a table row is selected.  Not all tables support row selection.
>+ * Determines whether a table row is selected.  Not all tables support 
>+ * row selection.
>  *
>  * Returns: #TRUE if the specified row is currently selected, #FALSE if not.
>  **/
>@@ -493,7 +502,7 @@ atspi_table_is_row_selected (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @column: the zero-indexed column number of the column being queried.
>  *
>- * Determine whether specified table column is selected.
>+ * Determines whether specified table column is selected.
>  * Not all tables support column selection.
>  *
>  * Returns: #TRUE if the specified column is currently selected, #FALSE if not.
>@@ -518,7 +527,7 @@ atspi_table_is_column_selected (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @row: the zero-indexed row number of the row being selected.
>  *
>- * Select the specified row, adding it to the current row selection.
>+ * Selects the specified row, adding it to the current row selection.
>  * Not all tables support row selection.
>  *
>  * Returns: #TRUE if the specified row was successfully selected, #FALSE if not.
>@@ -543,7 +552,7 @@ atspi_table_add_row_selection (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @column: the zero-indexed column number of the column being selected.
>  *
>- * Select the specified column, adding it to the current column selection.
>+ * Selects the specified column, adding it to the current column selection.
>  * Not all tables support column selection.
>  *
>  * Returns: #TRUE if the specified column was successfully selected, #FALSE if not.
>@@ -566,12 +575,13 @@ atspi_table_add_column_selection (AtspiTable *obj,
> /**
>  * atspi_table_remove_row_selection:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>- * @row: the zero-indexed number of the row being deselected.
>+ * @row: the zero-indexed number of the row being de-selected.
>  *
>- * De-select the specified row, removing it to the current row selection.
>+ * De-selects the specified row, removing it from the current row selection.
>  * Not all tables support row selection.
>  *
>- * Returns: #TRUE if the specified row was successfully de-selected, #FALSE if not.
>+ * Returns: #TRUE if the specified row was successfully de-selected,
>+ * #FALSE if not.
>  **/
> gboolean
> atspi_table_remove_row_selection (AtspiTable *obj,
>@@ -593,10 +603,12 @@ atspi_table_remove_row_selection (AtspiTable *obj,
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>  * @column: the zero-indexed column number of the column being de-selected.
>  *
>- * De-select the specified column, removing it to the current column selection.
>+ * De-selects the specified column, removing it from the current column
>+ * selection.
>  * Not all tables support column selection.
>  *
>- * Returns: #TRUE if the specified column was successfully de-selected, #FALSE if not.
>+ * Returns: #TRUE if the specified column was successfully de-selected,
>+ * #FALSE if not.
>  **/
> gboolean
> atspi_table_remove_column_selection (AtspiTable *obj,
>@@ -616,42 +628,43 @@ atspi_table_remove_column_selection (AtspiTable *obj,
> /**
>  * atspi_table_get_row_column_extents_at_index:
>  * @obj: a pointer to the #AtspiTable implementor on which to operate.
>- * @index: the index of the Table child whose row/column 
>+ * @index: the index of the #AtspiTable child whose row/column 
>  * extents are requested.
>  * @row: (out): back-filled with the first table row associated with
>- * the cell with child index \c index.
>+ * the cell with child index.
>  * @col: (out): back-filled with the first table column associated 
>- * with the cell with child index \c index.
>+ * with the cell with child index.
>  * @row_extents: (out): back-filled with the number of table rows 
>- * across which child \c i extends.
>+ * across which child i extends.
>  * @col_extents: (out): back-filled with the number of table columns
>- * across which child \c i extends.
>- * @is_selected: (out): a boolean which is back-filled with \c True
>- * if the child at index \c i corresponds to a selected table cell,
>- * \c False otherwise.
>+ * across which child i extends.
>+ * @is_selected: (out): a boolean which is back-filled with #TRUE
>+ * if the child at index i corresponds to a selected table cell,
>+ * #FALSE otherwise.
>  *
>- * Given a child index, determine the row and column indices and 
>+ * Given a child index, determines the row and column indices and 
>  * extents, and whether the cell is currently selected.  If
>- * the child at \c index is not a cell (for instance, if it is 
>- * a summary, caption, etc.), \c False is returned.
>+ * the child at index is not a cell (for instance, if it is 
>+ * a summary, caption, etc.), #FALSE is returned.
>  *
>  * Example:
>- * If the Table child at index '6' extends across columns 5 and 6 of
>- * row 2 of a Table instance, and is currently selected, then
>+ * If the #AtspiTable child at index '6' extends across columns 5 and 6 of
>+ * row 2 of an #AtspiTable instance, and is currently selected, then
>  * 
>- * retval = table::getRowColumnExtentsAtIndex (6, row, col, 
>+ * retval = atspi_table_get_row_column_extents_at_index (table, 6,
>+ *                                             row, col, 
>  *                                             row_extents,
>  *                                             col_extents,
>  *                                             is_selected);
>  * 
>- * will return True, and after the call
>+ * will return #TRUE, and after the call
>  * row, col, row_extents, col_extents,
>- * and \c is_selected will contain 2, 5, 1, 2, and 
>- * True, respectively.
>+ * and is_selected will contain 2, 5, 1, 2, and 
>+ * #TRUE, respectively.
>  *
>- * Returns: \c True if the index is associated with a valid table
>- * cell, \c False if the index does not correspond to a cell.  If 
>- * \c False is returned, the values of the out parameters are 
>+ * Returns: #TRUE if the index is associated with a valid table
>+ * cell, #FALSE if the index does not correspond to a cell.  If 
>+ * #FALSE is returned, the values of the out parameters are 
>  * undefined.
>  **/
> gboolean
>@@ -684,7 +697,7 @@ atspi_table_get_row_column_extents_at_index (AtspiTable *obj,
>  * @row: the zero-indexed row of the cell being queried.
>  * @column: the zero-indexed column of the cell being queried.
>  *
>- * Determine whether the cell at a specific row and column is selected.
>+ * Determines whether the cell at a specific row and column is selected.
>  *
>  * Returns: #TRUE if the specified cell is currently selected, #FALSE if not.
>  **/
>-- 
>1.7.5.1
>
>
>From 98a2e7acfa9447d3cfffc2157dbfb2ce11e1872c Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 23:14:33 -0300
>Subject: [PATCH 2/3] Adding descriptions to atspi-table.c
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-table.sgml     |   12 ++++++++++--
> 2 files changed, 23 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-table.sgml b/doc/libatspi/tmpl/atspi-table.sgml
>index fc0000e..a90cea4 100644
>--- a/doc/libatspi/tmpl/atspi-table.sgml
>+++ b/doc/libatspi/tmpl/atspi-table.sgml
>@@ -2,11 +2,19 @@
> atspi-table
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface used by containers whose data is arranged in a tabular form.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface used by containers whose contained data is arranged
>+in a tabular (i.e. row-column) form. Tables may resemble
>+a two-dimensional grid, as in a spreadsheet, or may feature objects
>+which span multiple rows and/or columns, but whose bounds are
>+aligned on a row/column matrix. Objects within tables are children
>+of the table object, and they may be referenced either via a child
>+index or via a row/column pair. Table 'cells' may implement other
>+interfaces, such as Text, Action, Image, and Component, and should do
>+so as appropriate to their onscreen rresentation and/or behavior.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>
>
>From b4d84a425f886ebe1ceac8e3144f0bb8d711a49e Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 11 Aug 2011 00:54:04 -0300
>Subject: [PATCH 3/3] Fixing a typo
>
>---
> atspi/atspi-table.c |    2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
>diff --git a/atspi/atspi-table.c b/atspi/atspi-table.c
>index 84f17fe..66a490a 100644
>--- a/atspi/atspi-table.c
>+++ b/atspi/atspi-table.c
>@@ -340,7 +340,7 @@ atspi_table_get_column_extent_at (AtspiTable *obj,
>  * Gets the header associated with a table row, if available. This differs from
>  * #atspi_table_get_row_description, which returns a string.
>  *
>- * Returns: (transfer full): an #AtspiAccessible representatin of the specified
>+ * Returns: (transfer full): an #AtspiAccessible representation of the specified
>  *          table row, if available.
>  **/
> AtspiAccessible *
>-- 
>1.7.5.1
>

Comment on attachment 193329 [details] [review]
Some documentation improvements for atspi-misc






>From 5835b66bbccf80d9842b3b3162c9e005b72a1329 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 20:56:18 -0300
>Subject: [PATCH 1/2] Improving atspi-misc documentation
>
>---
> atspi/atspi-misc.c |   10 +++++-----
> 1 files changed, 5 insertions(+), 5 deletions(-)
>
>diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c
>index 46616c3..e17a524 100644
>--- a/atspi/atspi-misc.c
>+++ b/atspi/atspi-misc.c
>@@ -869,8 +869,8 @@ atspi_init (void)
>  *
>  * Starts/enters the main event loop for the AT-SPI services.
>  *
>- * (NOTE: This method does not return control, it is exited via a call to
>- *  atspi_event_quit () from within an event handler).
>+ * NOTE: This method does not return control; it is exited via a call to
>+ * #atspi_event_quit from within an event handler.
>  *
>  **/
> void
>@@ -885,7 +885,7 @@ atspi_event_main (void)
>  * atspi_event_quit:
>  *
>  * Quits the last main event loop for the SPI services,
>- * see atspi_event_main
>+ * See: #atspi_event_main
>  **/
> void
> atspi_event_quit (void)
>@@ -896,10 +896,10 @@ atspi_event_quit (void)
> /**
>  * atspi_exit:
>  *
>- * Disconnects from the Accessibility Registry and releases 
>+ * Disconnects from #AtspiRegistry instances and releases 
>  * any floating resources. Call only once at exit.
>  *
>- * Returns: 0 if there were no leaks, otherwise non zero.
>+ * Returns: 0 if there were no leaks, otherwise other integer values.
>  **/
> int
> atspi_exit (void)
>-- 
>1.7.5.1
>
>
>From 2c772f2548861a6e1556c9ca5a25b44a9a364566 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 21:09:12 -0300
>Subject: [PATCH 2/2] Adding descriptions to atspi-misc documentation
>
>---
> atspi/atspi-misc.c                     |    2 +-
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-hyperlink.sgml |   10 ----------
> doc/libatspi/tmpl/atspi-misc.sgml      |    4 ++--
> doc/libatspi/tmpl/libatspi-unused.sgml |    9 +++++++++
> 5 files changed, 25 insertions(+), 13 deletions(-)
>
>diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c
>index e17a524..2e92518 100644
>--- a/atspi/atspi-misc.c
>+++ b/atspi/atspi-misc.c
>@@ -884,7 +884,7 @@ atspi_event_main (void)
> /**
>  * atspi_event_quit:
>  *
>- * Quits the last main event loop for the SPI services,
>+ * Quits the last main event loop for the AT-SPI services,
>  * See: #atspi_event_main
>  **/
> void
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>index 0cae0d5..dc6eab3 100644
>--- a/doc/libatspi/tmpl/atspi-hyperlink.sgml
>+++ b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>@@ -33,16 +33,6 @@ AtspiHyperlink
> 
> @parent_class: 
> 
>-<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>-<para>
>-
>-</para>
>-
>-@app: 
>-@path: 
>-@Returns: 
>-
>-
> <!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### -->
> <para>
> 
>diff --git a/doc/libatspi/tmpl/atspi-misc.sgml b/doc/libatspi/tmpl/atspi-misc.sgml
>index 4b4a289..06656a4 100644
>--- a/doc/libatspi/tmpl/atspi-misc.sgml
>+++ b/doc/libatspi/tmpl/atspi-misc.sgml
>@@ -2,11 +2,11 @@
> atspi-misc
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+Miscellaneous methods for using AT-SPI services.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+Miscellaneous methods for using AT-SPI services.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2f0d56d 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,12 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>+<para>
>+
>+</para>
>+
>+@app: 
>+@path: 
>+@Returns: 
>+
>-- 
>1.7.5.1
>

Comment on attachment 193277 [details] [review]
Some documentation improvements for atspi-types






>From 39980fddb5e3678a04b8cf4f6371e3ad8575ea4d Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 4 Aug 2011 19:41:28 -0300
>Subject: [PATCH 1/2] Improving atspi-types documentation.
>
>---
> atspi/atspi-types.h |   12 ++++++------
> 1 files changed, 6 insertions(+), 6 deletions(-)
>
>diff --git a/atspi/atspi-types.h b/atspi/atspi-types.h
>index e56f93f..99bb8f5 100644
>--- a/atspi/atspi-types.h
>+++ b/atspi/atspi-types.h
>@@ -118,14 +118,14 @@ typedef struct _AtspiKeySet
> 
> /**
>  *AtspiKeyListenerSyncType:
>- *@SPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously, 
>+  * @ATSPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously, 
>  * which means in some cases they may already have been delivered to the 
>  * application before the AT client receives the notification.  
>- *@SPI_KEYLISTENER_SYNCHRONOUS: Events are delivered synchronously, before the 
>+ * @ATSPI_KEYLISTENER_SYNCHRONOUS: Events are delivered synchronously, before the 
>  * currently focussed application sees them.  
>- *@ATSPI_KEYLISTENER_CANCONSUME: Events may be consumed by the AT client.  Presumes and
>+ * @ATSPI_KEYLISTENER_CANCONSUME: Events may be consumed by the AT client.  Presumes and
>  * requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC.
>- *@SPI_KEYLISTENER_ALL_WINDOWS: Events are received not from the application toolkit layer, but
>+ * @ATSPI_KEYLISTENER_ALL_WINDOWS: Events are received not from the application toolkit layer, but
>  * from the device driver or windowing system subsystem; such notifications are 'global' in the 
>  * sense that they are not broken or defeated by applications that participate poorly
>  * in the accessibility APIs, or not at all; however because of the intrusive nature of
>@@ -133,8 +133,8 @@ typedef struct _AtspiKeySet
>  * event notifications, even when inaccessible or "broken" applications have focus, are not
>  * required, it may be best to avoid this enum value/flag.
>  *
>- *Specified the tyupe of a key listener event.
>- * Certain of the values above can and should be bitwise-'OR'ed
>+ * Specifies the type of a key listener event.
>+ * The values above can and should be bitwise-'OR'-ed
>  * together, observing the compatibility limitations specified in the description of
>  * each value.  For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is
>  * a commonly used combination which gives the AT complete control over the delivery of matching
>-- 
>1.7.5.1
>
>
>From a2fb5bb99507cd773e1bc1c4785c3a3f770f64b0 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 4 Aug 2011 19:47:06 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-types.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-hyperlink.sgml |   10 ----------
> doc/libatspi/tmpl/atspi-types.sgml     |    4 ++--
> doc/libatspi/tmpl/libatspi-unused.sgml |    9 +++++++++
> 4 files changed, 24 insertions(+), 12 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>index 0cae0d5..dc6eab3 100644
>--- a/doc/libatspi/tmpl/atspi-hyperlink.sgml
>+++ b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>@@ -33,16 +33,6 @@ AtspiHyperlink
> 
> @parent_class: 
> 
>-<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>-<para>
>-
>-</para>
>-
>-@app: 
>-@path: 
>-@Returns: 
>-
>-
> <!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### -->
> <para>
> 
>diff --git a/doc/libatspi/tmpl/atspi-types.sgml b/doc/libatspi/tmpl/atspi-types.sgml
>index 4eca01a..01782ed 100644
>--- a/doc/libatspi/tmpl/atspi-types.sgml
>+++ b/doc/libatspi/tmpl/atspi-types.sgml
>@@ -2,11 +2,11 @@
> atspi-types
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+Type definitions needed by multiple interfaces.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+Type definitions needed by multiple interfaces.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2f0d56d 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,12 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>+<para>
>+
>+</para>
>+
>+@app: 
>+@path: 
>+@Returns: 
>+
>-- 
>1.7.5.1
>

Comment on attachment 193222 [details] [review]
Some documentation improvements for atspi-registry






>From 280d87d16fcf6d798b79a53c5c71be8143639f3e Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 4 Aug 2011 02:48:19 -0300
>Subject: [PATCH 1/2] Improving atspi-registry documentation.
>
>---
> atspi/atspi-registry.c |   61 +++++++++++++++++++++++++----------------------
> 1 files changed, 32 insertions(+), 29 deletions(-)
>
>diff --git a/atspi/atspi-registry.c b/atspi/atspi-registry.c
>index 9856be3..a4fbb7d 100644
>--- a/atspi/atspi-registry.c
>+++ b/atspi/atspi-registry.c
>@@ -1,3 +1,4 @@
>+
> /*
>  * AT-SPI - Assistive Technology Service Provider Interface
>  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
>@@ -28,11 +29,11 @@
> /**
>  * atspi_get_desktop_count:
>  *
>- * Get the number of virtual desktops.
>- * NOTE: currently multiple virtual desktops are not implemented, this
>- *       function always returns '1'.
>+ * Gets the number of virtual desktops.
>+ * NOTE: multiple virtual desktops are not implemented yet; as a 
>+ * consequence, this function always returns 1.
>  *
>- * Returns: an integer indicating the number of active virtual desktops.
>+ * Returns: a #gint indicating the number of active virtual desktops.
>  **/
> gint
> atspi_get_desktop_count ()
>@@ -42,12 +43,14 @@ atspi_get_desktop_count ()
> 
> /**
>  * atspi_get_desktop:
>- * @i: an integer indicating which of the accessible desktops is to be returned.
>+ * @i: a #gint indicating which of the accessible desktops is to be returned.
>  *
>- * Get the virtual desktop indicated by index @i.
>- * NOTE: currently multiple virtual desktops are not implemented.
>+ * Gets the virtual desktop indicated by index @i.
>+ * NOTE: currently multiple virtual desktops are not implemented;
>+ * as a consequence, any @i value different from 0 will not return a
>+ * virtual desktop - instead it will return NULL.
>  *
>- * Returns: (transfer full): a pointer to the 'i-th' virtual desktop's
>+ * Returns: (transfer full): a pointer to the @i-th virtual desktop's
>  * #AtspiAccessible representation.
>  **/
> AtspiAccessible*
>@@ -60,14 +63,14 @@ atspi_get_desktop (gint i)
> /**
>  * atspi_get_desktop_list:
>  *
>- * Get the list of virtual desktops.  On return, @list will point
>+ * Gets the list of virtual desktops.  On return, @list will point
>  *     to a newly-created, NULL terminated array of virtual desktop
>  *     pointers.
>  *     It is the responsibility of the caller to free this array when
>  *     it is no longer needed.
>- *
>- * Not Yet Implemented : this implementation always returns a single
>- * #Accessible desktop.
>+ * NOTE: currently multiple virtual desktops are not implemented;
>+ * this implementation always returns a #Garray with a single
>+ * #AtspiAccessible desktop.
>  *
>  * Returns: (transfer full): a #GArray of desktops.
>  **/
>@@ -89,28 +92,28 @@ atspi_get_desktop_list ()
>  *             keystroke events are requested.
>  * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
>  *        #AtspiKeyDefinition array indicating which keystroke events are
>- *        requested, or %NULL
>+ *        requested, or NULL
>  *        to indicate that all keycodes and keyvals for the specified
>  *        modifier set are to be included.
>  * @modmask:   an #AtspiKeyMaskType mask indicating which
>  *             key event modifiers must be set in combination with @keys,
>  *             events will only be reported for key events for which all
>  *             modifiers in @modmask are set.  If you wish to listen for
>- *             events with multiple modifier combinations you must call
>- *             register_keystroke_listener() once for each
>+ *             events with multiple modifier combinations, you must call
>+ *             #atspi_register_keystroke_listener once for each
>  *             combination.
>  * @event_types: an #AtspiKeyMaskType mask indicating which
>- *             types of key events are requested (#ATSPI_KEY_PRESSED, etc.).
>- * @sync_type: a #AtspiKeyListenerSyncType parameter indicating
>+ *             types of key events are requested (ATSPI_KEY_PRESSED etc.).
>+ * @sync_type: an #AtspiKeyListenerSyncType parameter indicating
>  *             the behavior of the notification/listener transaction.
>  *             
>- * Register a listener for keystroke events, either pre-emptively for
>+ * Registers a listener for keystroke events, either pre-emptively for
>  *             all windows (ATSPI_KEYLISTENER_ALL_WINDOWS),
>  *             non-preemptively (ATSPI_KEYLISTENER_NOSYNC), or
>  *             pre-emptively at the toolkit level (ATSPI_KEYLISTENER_CANCONSUME).
>  *             If ALL_WINDOWS or CANCONSUME are used, the event is consumed
>- *             upon receipt if one of @listener's callbacks returns #TRUE.
>- *             ( Other sync_type values may be available in the future )
>+ *             upon receipt if one of @listener's callbacks returns #TRUE 
>+ *             (other sync_type values may be available in the future).
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>  **/
>@@ -183,7 +186,7 @@ atspi_register_keystroke_listener (AtspiDeviceListener  *listener,
>  *            keystroke events are requested.
>  * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
>  *        #AtspiKeyDefinition array indicating which keystroke events are
>- *        requested, or %NULL
>+ *        requested, or NULL
>  *        to indicate that all keycodes and keyvals for the specified
>  *        modifier set are to be included.
>  * @modmask:  the key modifier mask for which this listener is to be
>@@ -231,7 +234,7 @@ atspi_deregister_keystroke_listener (AtspiDeviceListener *listener,
>  *             types of key events are requested (#ATSPI_KEY_PRESSED, etc.).
>  * @filter: Unused parameter.
>  *             
>- * Register a listener for device events, for instance button events.
>+ * Registers a listener for device events, for instance button events.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>  **/
>@@ -292,19 +295,19 @@ atspi_deregister_device_event_listener (AtspiDeviceListener *listener,
> 
> /**
>  * atspi_generate_keyboard_event:
>- * @keyval: a long integer indicating the keycode or keysym of the key event
>+ * @keyval: a #gint indicating the keycode or keysym of the key event
>  *           being synthesized.
>  * @keystring: an (optional) UTF-8 string which, if @keyval is NULL,
>- *           indicates a 'composed' keyboard input string which is 
>+ *           indicates a 'composed' keyboard input string  
>  *           being synthesized; this type of keyboard event synthesis does
>  *           not emulate hardware keypresses but injects the string 
>  *           as though a composing input method (such as XIM) were used.
>- * @synth_type: a #AtspiKeySynthType flag indicating whether @keyval
>+ * @synth_type: an #AtspiKeySynthType flag indicating whether @keyval
>  *           is to be interpreted as a keysym rather than a keycode
>  *           (ATSPI_KEYSYM), or whether to synthesize
>  *           ATSPI_KEY_PRESS, ATSPI_KEY_RELEASE, or both (ATSPI_KEY_PRESSRELEASE).
>  *
>- * Synthesize a keyboard event (as if a hardware keyboard event occurred in the
>+ * Synthesizes a keyboard event (as if a hardware keyboard event occurred in the
>  * current UI context).
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>@@ -327,12 +330,12 @@ atspi_generate_keyboard_event (glong keyval,
> 
> /**
>  * atspi_generate_mouse_event:
>- * @x: a #long indicating the screen x coordinate of the mouse event.
>- * @y: a #long indicating the screen y coordinate of the mouse event.
>+ * @x: a #glong indicating the screen x coordinate of the mouse event.
>+ * @y: a #glong indicating the screen y coordinate of the mouse event.
>  * @name: a string indicating which mouse event to be synthesized
>  *        (e.g. "b1p", "b1c", "b2r", "rel", "abs").
>  *
>- * Synthesize a mouse event at a specific screen coordinate.
>+ * Synthesizes a mouse event at a specific screen coordinate.
>  * Most AT clients should use the #AccessibleAction interface when
>  * tempted to generate mouse events, rather than this method.
>  * Event names: b1p = button 1 press; b2r = button 2 release;
>-- 
>1.7.5.1
>
>
>From 702d6651da2d96b2e8cefba098d60be7a43e199c Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Thu, 4 Aug 2011 02:58:45 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-registry.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-registry.sgml  |    8 ++++++--
> 2 files changed, 19 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-registry.sgml b/doc/libatspi/tmpl/atspi-registry.sgml
>index e7f43e8..a8e9569 100644
>--- a/doc/libatspi/tmpl/atspi-registry.sgml
>+++ b/doc/libatspi/tmpl/atspi-registry.sgml
>@@ -2,11 +2,15 @@
> atspi-registry
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+A service through which applications providing accessibility services 
>+can rendezvous with consumers of those services.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+A service through which applications providing accessibility services (servers)
>+can rendezvous with consumers of those services (Assistive Technologies). The 
>+atspi-registry is the first "port of call" for accessible applications and for
>+assistive technologies wishing to query and interact with those applications.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193104 [details] [review]
Some documentation improvements for atspi-matcherule






>From 62b52c72ec8614c967706d677cec9abc93c0d29e Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 20:32:21 -0300
>Subject: [PATCH 1/2] Improving atspi-matchrule documentation.
>
>---
> atspi/atspi-matchrule.c |   22 ++++++++++++++++++----
> 1 files changed, 18 insertions(+), 4 deletions(-)
>
>diff --git a/atspi/atspi-matchrule.c b/atspi/atspi-matchrule.c
>index 76415c2..d68cdb9 100644
>--- a/atspi/atspi-matchrule.c
>+++ b/atspi/atspi-matchrule.c
>@@ -79,27 +79,41 @@ 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.
>+ *
>  * @attributes: (element-type gchar* gchar*): A #GHashTable specifying
>  *              attributes to match.
>+ *
>  * @attributematchtype: An #AtspiCollectionMatchType specifying how to
>  *                      interpret @attributes.
>+ *
>  * @interfaces: (element-type gchar*): An array of interfaces to match, or
>- *              NUL if not applicable.  Interface names should be specified
>+ *              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.
>+ *
>  * @roles: (element-type AtspiRole): A #GArray of roles to match, or NULL if
>  *         not applicable.
>+ *
>  * @rolematchtype: An #AtspiCollectionMatchType specifying how to
>  *                      interpret @roles.
>- * @invert: Specifies whether results should be inverted.
>- * TODO: Document this parameter better.
>+ *
>+ * @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.  
>+ *
>+ * Creates a new #AtspiMatchRule with specified @states, @attributes, 
>+ * @interfaces, and @roles.
>  *
>  * Returns: (transfer full): A new #AtspiMatchRule.
>- */
>+ **/
> AtspiMatchRule *
> atspi_match_rule_new (AtspiStateSet *states,
>                       AtspiCollectionMatchType statematchtype,
>-- 
>1.7.5.1
>
>
>From 8f4d6fdf354bcae1db213381c05bf60404c131a4 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 20:36:55 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-matchrule.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-matchrule.sgml |    8 +++++---
> 2 files changed, 18 insertions(+), 3 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-matchrule.sgml b/doc/libatspi/tmpl/atspi-matchrule.sgml
>index 5213265..b52922b 100644
>--- a/doc/libatspi/tmpl/atspi-matchrule.sgml
>+++ b/doc/libatspi/tmpl/atspi-matchrule.sgml
>@@ -1,12 +1,14 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiMatchRule
>+atspi-matchrule
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface that allows the definition of match rules
>+for accessible objects.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface that allows the definition of match rules
>+for accessible objects.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193098 [details] [review]
Some documentation improvements for atspi-relation






>From ecfe71f9a0ff499a39121893c716e48be43a05c6 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 18:36:18 -0300
>Subject: [PATCH 1/2] Improving atspi-relation documentation.
>
>---
> atspi/atspi-relation.c |   14 +++++++-------
> 1 files changed, 7 insertions(+), 7 deletions(-)
>
>diff --git a/atspi/atspi-relation.c b/atspi/atspi-relation.c
>index 60e8947..7493ecf 100644
>--- a/atspi/atspi-relation.c
>+++ b/atspi/atspi-relation.c
>@@ -28,7 +28,7 @@
>  * atspi_relation_get_relation_type:
>  * @obj: a pointer to the #AtspiRelation object to query.
>  *
>- * Get the type of relationship represented by an #AtspiRelation.
>+ * Gets the type of relationship represented by an #AtspiRelation.
>  *
>  * Returns: an #AtspiRelationType indicating the type of relation
>  *         encapsulated in this #AtspiRelation object.
>@@ -44,12 +44,12 @@ atspi_relation_get_relation_type (AtspiRelation *obj)
>  * atspi_relation_get_n_targets:
>  * @obj: a pointer to the #AtspiRelation object to query.
>  *
>- * Get the number of objects which this relationship has as its
>- *       target objects (the subject is the #Accessible from which this
>+ * Gets the number of objects which this relationship has as its
>+ *       target objects (the subject is the #AtspiAccessible from which this
>  *       #AtspiRelation originated).
>  *
>- * Returns: a short integer indicating how many target objects which the
>- *       originating #Accessible object has the #AtspiRelation
>+ * Returns: a #gint indicating how many target objects which the
>+ *       originating #AtspiAccessible object has the #AtspiRelation
>  *       relationship with.
>  **/
> gint
>@@ -61,9 +61,9 @@ atspi_relation_get_n_targets (AtspiRelation *obj)
> /**
>  * atspi_relation_get_target:
>  * @obj: a pointer to the #AtspiRelation object to query.
>- * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
>+ * @i: a (zero-index) #gint indicating which (of possibly several) target is requested.
>  *
>- * Get the @i-th target of a specified #AtspiRelation relationship.
>+ * Gets the @i-th target of a specified #AtspiRelation relationship.
>  *
>  * Returns: (transfer full): an #AtspiAccessible which is the @i-th object
>  *          with which the originating #AtspiAccessible has relationship
>-- 
>1.7.5.1
>
>
>From 99900284ae55dc8a2d4a76c77dcdf77ca4083f07 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 18:36:31 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-relation.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-relation.sgml  |    9 ++++++---
> 2 files changed, 19 insertions(+), 3 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-relation.sgml b/doc/libatspi/tmpl/atspi-relation.sgml
>index 80254d8..dc548e6 100644
>--- a/doc/libatspi/tmpl/atspi-relation.sgml
>+++ b/doc/libatspi/tmpl/atspi-relation.sgml
>@@ -1,12 +1,15 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiRelation
>+atspi-relation
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+ An interface via which non-hierarchical relationships
>+ are indicated.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+ An interface via which non-hierarchical relationships
>+ are indicated. An instance of this interface represents
>+ a "one-to-many" correspondance.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193095 [details] [review]
Some documentation improvements for atspi-application






>From 3973f32e270ec95527e0b84afd54dd325afe74d2 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 18:08:59 -0300
>Subject: [PATCH] Adding descriptions for atspi-application.
>
>---
> doc/libatspi/tmpl/atspi-application.sgml |    8 +++++---
> doc/libatspi/tmpl/atspi-constants.sgml   |   13 +++++++++++++
> 2 files changed, 18 insertions(+), 3 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-application.sgml b/doc/libatspi/tmpl/atspi-application.sgml
>index e53186e..09f953b 100644
>--- a/doc/libatspi/tmpl/atspi-application.sgml
>+++ b/doc/libatspi/tmpl/atspi-application.sgml
>@@ -1,12 +1,14 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiApplication
>+atspi-application
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+ An interface identifying the root object associated
>+ with a running application.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+ An interface identifying an object which is the root of the
>+  hierarchy associated with a running application.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193025 [details] [review]
Some documentation improvements for atspi-stateset






>From c95371bec8dd0e99aa0b7f481d1e722a91c9a086 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 00:06:07 -0300
>Subject: [PATCH 1/2] Improving atspi-stateset documentation.
>
>---
> atspi/atspi-stateset.c |   60 ++++++++++++++++++++++++++++++++---------------
> 1 files changed, 41 insertions(+), 19 deletions(-)
>
>diff --git a/atspi/atspi-stateset.c b/atspi/atspi-stateset.c
>index a5bcc51..54622ec 100644
>--- a/atspi/atspi-stateset.c
>+++ b/atspi/atspi-stateset.c
>@@ -85,11 +85,13 @@ atspi_state_set_class_init (AtspiStateSetClass* klass)
> {
> }
> 
>-/*
>+/**
>  * atspi_state_set_new:
>  *
>- * @states: (element-type AtspiStateType): An array of states with which to initialize
>- * the state set.
>+ * @states: (element-type AtspiStateType): An array of states with which the
>+ * method initializes the state set.
>+ *
>+ * Generates an #AtspiStateSet with the given @states.
>  *
>  * Returns: A new #AtspiStateSet with the given states.
>  **/
>@@ -120,6 +122,18 @@ _atspi_state_set_new_internal (AtspiAccessible *accessible, gint64 states)
>   return set;
> }
> 
>+/**
>+ * 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. 
>+ *
>+ * Enables/disables a state in an #AtspiStateSet according to its @name.
>+ **/
> void
> atspi_state_set_set_by_name (AtspiStateSet *set, const gchar *name, gboolean enabled)
> {
>@@ -168,10 +182,11 @@ 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.
>  *
>- * Add a particular #AtspiState to an #AtspiStateSet (i.e. set the
>- *       given state to #TRUE in the stateset.
>+ * Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the
>+ *       given state to #TRUE in the stateset).
>  *
>  **/
> void
>@@ -183,15 +198,17 @@ atspi_state_set_add (AtspiStateSet *set, AtspiStateType state)
> 
> /**
>  * atspi_state_set_compare:
>+ *
>  * @set: a pointer to the first #AtspiStateSet object on which to operate.
>- * @set: a pointer to the second #AtspiStateSet setect on which to operate.
>  *
>- * Determine the differences between two instances of #AtspiStateSet.
>- *.
>- * @see AtspiStateSet_equals().
>+ * @set2: a pointer to the second #AtspiStateSet object on which to operate.
>+ *
>+ * Determines the differences between two instances of #AtspiStateSet.
>+ *
>+ * @see #atspi_state_set_equals.
>  *
>  * Returns: (transfer full): an #AtspiStateSet object containing all states
>- *          contained on one of the two sets but not the other.
>+ * contained on one of the two sets but not the other.
>  *
>  **/
> AtspiStateSet *
>@@ -206,12 +223,14 @@ 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.
>  *
>- * Determine whether a given #AtspiStateSet includes a given state; that is,
>- *       whether @state is true for the stateset in question.
>+ * Determines whether a given #AtspiStateSet includes a given state; that is,
>+ *       whether @state is true for the @set in question.
>  *
>  * Returns: #TRUE if @state is true/included in the given #AtspiStateSet,
>  *          otherwise #FALSE.
>@@ -229,17 +248,19 @@ 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.
>  *
>- * Determine whether two instances of #AtspiStateSet are equivalent (i.e.
>+ * Determines whether two instances of #AtspiStateSet are equivalent (i.e.
>  *         consist of the same #AtspiStates).  Useful for checking multiple
>- *         state variables at once; construct the target state then compare against it.
>+ *         state variables at once.
>  *
>- * @see AtspiStateSet_compare().
>+ * @see #atspi_state_set_compare.
>  *
>  * Returns: #TRUE if the two #AtspiStateSets are equivalent,
>- *          otherwise #FALSE.
>+ * otherwise #FALSE.
>  *
>  **/
> gboolean
>@@ -258,7 +279,7 @@ atspi_state_set_equals (AtspiStateSet *set,
>  *
>  * @set: The #AtspiStateSet to be queried.
>  *
>- * Return the states in an #AtspiStateSet as an array.
>+ * Returns the states in an #AtspiStateSet as an array.
>  *
>  * Returns: (element-type AtspiStateType) (transfer full): A #GArray of state
>  *          types representing the current state.
>@@ -305,9 +326,10 @@ 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 specifiedn state set.
>  *
>- * Remove a particular #AtspiState to an #AtspiStateSet (i.e. set the
>+ * @state: an #AtspiStateType to remove from the specified @set.
>+ *
>+ * Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the
>  *       given state to #FALSE in the stateset.)
>  *
>  **/
>-- 
>1.7.5.1
>
>
>From fa3e83f7c05b48764d5d9c4cf5b62968ceb9c8b9 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 00:25:34 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-stateset.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-stateset.sgml  |    8 +++++---
> 2 files changed, 18 insertions(+), 3 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-stateset.sgml b/doc/libatspi/tmpl/atspi-stateset.sgml
>index 129c772..dc65b8d 100644
>--- a/doc/libatspi/tmpl/atspi-stateset.sgml
>+++ b/doc/libatspi/tmpl/atspi-stateset.sgml
>@@ -1,12 +1,14 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiStateSet
>+atspi-stateset
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+The atspi-stateset objects implement wrappers around a
>+bitmap of accessible states.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+The atspi-stateset objects implement wrappers around a
>+bitmap of accessible states.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193019 [details] [review]
Some documentation improvements for atspi-component






>From aaeaeeb0f7359df04d670e062ca6872cb1f49b0d Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Mon, 1 Aug 2011 19:40:04 -0300
>Subject: [PATCH 1/2] Improving atspi-component documentation.
>
>---
> atspi/atspi-component.c |   46 ++++++++++++++++++++++------------------------
> 1 files changed, 22 insertions(+), 24 deletions(-)
>
>diff --git a/atspi/atspi-component.c b/atspi/atspi-component.c
>index bd9ef2b..3c84fb9 100644
>--- a/atspi/atspi-component.c
>+++ b/atspi/atspi-component.c
>@@ -62,15 +62,15 @@ G_DEFINE_BOXED_TYPE (AtspiPoint, atspi_point, atspi_point_copy, g_free)
> /**
>  * atspi_component_contains:
>  * @obj: a pointer to the #AtspiComponent to query.
>- * @x: a #long specifying the x coordinate in question.
>- * @y: a #long specifying the y coordinate in question.
>+ * @x: a #gint specifying the x coordinate in question.
>+ * @y: a #gint specifying the y coordinate in question.
>  * @ctype: the desired coordinate system of the point (@x, @y)
>  *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
>  *
>- * Query whether a given #AtspiComponent contains a particular point.
>+ * Queries whether a given #AtspiComponent contains a particular point.
>  *
>- * Returns: a #TRUE if the specified component contains the point (@x, @y),
>- *          otherwise #FALSE.
>+ * Returns: #TRUE if the specified component contains the point (@x, @y),
>+ *          #FALSE otherwise.
>  **/
> gboolean
> atspi_component_contains (AtspiComponent *obj,
>@@ -97,10 +97,10 @@ atspi_component_contains (AtspiComponent *obj,
>  * @ctype: the coordinate system of the point (@x, @y)
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * Get the accessible child at a given coordinate within an #AtspiComponent.
>+ * Gets the accessible child at a given coordinate within an #AtspiComponent.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiAccessible child of the
>- *          specified component which contains the point (@x, @y), or NULL of
>+ *          specified component which contains the point (@x, @y), or NULL if
>  *         no child contains the point.
>  **/
> AtspiAccessible *
>@@ -126,10 +126,9 @@ atspi_component_get_accessible_at_point (AtspiComponent *obj,
>  * @ctype: the desired coordinate system into which to return the results,
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * Returns: A #AtspiRect giving the accessible's extents.
>- *
>- * Get the bounding box of the specified #AtspiComponent.
>+ * Gets the bounding box of the specified #AtspiComponent.
>  *
>+ * Returns: An #AtspiRect giving the accessible's extents.
>  **/
> AtspiRect *
> atspi_component_get_extents (AtspiComponent *obj,
>@@ -151,9 +150,9 @@ atspi_component_get_extents (AtspiComponent *obj,
>  * @ctype: the desired coordinate system into which to return the results,
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * returns: A #AtspiPoint giving the position.
>- * Get the minimum x and y coordinates of the specified #AtspiComponent.
>+ * Gets the minimum x and y coordinates of the specified #AtspiComponent.
>  *
>+ * returns: An #AtspiPoint giving the @obj's position.
>  **/
> AtspiPoint *
> atspi_component_get_position (AtspiComponent *obj,
>@@ -178,10 +177,10 @@ atspi_component_get_position (AtspiComponent *obj,
> /**
>  * atspi_component_get_size:
>  * @obj: a pointer to the #AtspiComponent to query.
>- * returns: A #AtspiPoint giving the size.
>  *
>- * Get the size of the specified #AtspiComponent.
>+ * Gets the size of the specified #AtspiComponent.
>  *
>+ * returns: An #AtspiPoint giving the @obj's size.
>  **/
> AtspiPoint *
> atspi_component_get_size (AtspiComponent *obj, GError **error)
>@@ -203,7 +202,7 @@ atspi_component_get_size (AtspiComponent *obj, GError **error)
>  * atspi_component_get_layer:
>  * @obj: a pointer to the #AtspiComponent to query.
>  *
>- * Query which layer the component is painted into, to help determine its 
>+ * Queries which layer the component is painted into, to help determine its 
>  *      visibility in terms of stacking order.
>  *
>  * Returns: the #AtspiComponentLayer into which this component is painted.
>@@ -222,10 +221,10 @@ atspi_component_get_layer (AtspiComponent *obj, GError **error)
>  * atspi_component_get_mdi_z_order:
>  * @obj: a pointer to the #AtspiComponent to query.
>  *
>- * Query the z stacking order of a component which is in the MDI or window
>+ * Queries the z stacking order of a component which is in the MDI or window
>  *       layer. (Bigger z-order numbers mean nearer the top)
>  *
>- * Returns: a short integer indicating the stacking order of the component 
>+ * Returns: a #gshort indicating the stacking order of the component 
>  *       in the MDI layer, or -1 if the component is not in the MDI layer.
>  **/
> gshort
>@@ -242,7 +241,7 @@ atspi_component_get_mdi_z_order (AtspiComponent *obj, GError **error)
>  * atspi_component_grab_focus:
>  * @obj: a pointer to the #AtspiComponent on which to operate.
>  *
>- * Attempt to set the keyboard input focus to the specified
>+ * Attempts to set the keyboard input focus to the specified
>  *         #AtspiComponent.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>@@ -262,9 +261,9 @@ atspi_component_grab_focus (AtspiComponent *obj, GError **error)
>  * atspi_component_get_alpha:
>  * @obj: The #AtspiComponent to be queried.
>  *
>- * Get the opacity/alpha value of a component, if alpha blending is in use.
>+ * Gets the opacity/alpha value of a component, if alpha blending is in use.
>  *
>- * Returns: the opacity value of a component, as a double between 0.0 and 1.0. 
>+ * Returns: the opacity value of a component, as a #gdouble between 0.0 and 1.0. 
>  **/
> gdouble      
> atspi_component_get_alpha    (AtspiComponent *obj, GError **error)
>@@ -286,10 +285,9 @@ atspi_component_get_alpha    (AtspiComponent *obj, GError **error)
>  * @ctype: the coordinate system in which the position is specified.
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * Returns: #TRUE if successful; #FALSE otherwise.
>- *
>- * Move and resize the specified component.
>+ * Moves and resizes the specified component.
>  *
>+ * Returns: #TRUE if successful; #FALSE otherwise.
>  **/
> gboolean
> atspi_component_set_extents (AtspiComponent *obj,
>@@ -373,7 +371,7 @@ atspi_component_set_position (AtspiComponent *obj,
>  *
>  * Returns: #TRUE if successful; #FALSE otherwise.
>  *
>- * Resize the specified component to the given coordinates.
>+ * Resizes the specified component to the given coordinates.
>  **/
> gboolean
> atspi_component_set_size (AtspiComponent *obj,
>-- 
>1.7.5.1
>
>
>From ffbf17509de6a4f6167514ab8b65b1e1a98e5b8e Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Mon, 1 Aug 2011 19:49:44 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-component.
>
>---
> doc/libatspi/tmpl/atspi-component.sgml |   12 ++++++++++--
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> 2 files changed, 23 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-component.sgml b/doc/libatspi/tmpl/atspi-component.sgml
>index 39e0915..546137e 100644
>--- a/doc/libatspi/tmpl/atspi-component.sgml
>+++ b/doc/libatspi/tmpl/atspi-component.sgml
>@@ -2,11 +2,19 @@
> atspi-component
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+ An interface implemented by objects which have onscreen visual 
>+ representations.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+  The Component interface is implemented by objects which occupy on-screen
>+  space, e.g. objects which have onscreen visual representations. The methods
>+  in Component allow clients to identify where the objects lie in the onscreen
>+  coordinate system, their relative size, stacking order, and position. It
>+  also provides a mechanism whereby keyboard focus may be transferred to 
>+  specific user interface elements programmatically.  This is a 2D API. 
>+  Coordinates of 3D objects are projected into the 2-dimensional screen view
>+  for purposes of this interface.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 192775 [details] [review]
Some documentation improvements for atspi-value






>From 9bbff67676e5c49b9bac52151d11515c58fba86c Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 01:43:29 -0300
>Subject: [PATCH 1/3] Improving atspi-value.c documentation
>
>---
> atspi/atspi-value.c |   12 ++++++------
> 1 files changed, 6 insertions(+), 6 deletions(-)
>
>diff --git a/atspi/atspi-value.c b/atspi/atspi-value.c
>index 32966d2..fbd9573 100644
>--- a/atspi/atspi-value.c
>+++ b/atspi/atspi-value.c
>@@ -28,7 +28,7 @@
>  * atspi_value_get_minimum_value:
>  * @obj: a pointer to the #AtspiValue implementor on which to operate. 
>  *
>- * Get the minimum allowed value for an #AtspiValue.
>+ * Gets the minimum allowed value for an #AtspiValue.
>  *
>  * Returns: the minimum allowed value for this object.
>  *
>@@ -48,7 +48,7 @@ atspi_value_get_minimum_value (AtspiValue *obj, GError **error)
>  * atspi_value_get_current_value:
>  * @obj: a pointer to the #AtspiValue implementor on which to operate. 
>  *
>- * Get the current value for an #AtspiValue.
>+ * Gets the current value for an #AtspiValue.
>  *
>  * Returns: the current value for this object.
>  **/
>@@ -68,7 +68,7 @@ atspi_value_get_current_value (AtspiValue *obj, GError **error)
>  * atspi_value_get_maximum_value:
>  * @obj: a pointer to the #AtspiValue implementor on which to operate. 
>  *
>- * Get the maximum allowed value for an #AtspiValue.
>+ * Gets the maximum allowed value for an #AtspiValue.
>  *
>  * Returns: the maximum allowed value for this object.
>  **/
>@@ -87,9 +87,9 @@ atspi_value_get_maximum_value (AtspiValue *obj, GError **error)
> /**
>  * atspi_value_set_current_value:
>  * @obj: a pointer to the #AtspiValue implementor on which to operate.
>- * @new_value: a #float value which is the desired new value of the object.
>+ * @new_value: a #gdouble value which is the desired new value of the object.
>  *
>- * Set the current value of an #AtspiValue.
>+ * Sets the current value of an #AtspiValue.
>  *
>  * Returns: #TRUE if the value could be assigned the specified value,
>  *          #FALSE otherwise.
>@@ -126,7 +126,7 @@ atspi_value_set_current_value (AtspiValue *obj, gdouble new_value, GError **erro
>  * atspi_value_get_minimum_increment:
>  * @obj: a pointer to the #AtspiValue implementor on which to operate. 
>  *
>- * Get the minimum increment by which an #AtspiValue can be adjusted.
>+ * Gets the minimum increment by which an #AtspiValue can be adjusted.
>  *
>  * Returns: the minimum increment by which the value may be changed, or
>  * zero if the minimum increment cannot be determined.
>-- 
>1.7.5.1
>
>
>From 32136d397655fb3a6ba631b3af09ea5ac74d3162 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 01:47:26 -0300
>Subject: [PATCH 2/3] Adding descriptions for atspi-value.c
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-value.sgml     |    8 ++++++--
> 2 files changed, 19 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-value.sgml b/doc/libatspi/tmpl/atspi-value.sgml
>index 656bc18..b5e50e2 100644
>--- a/doc/libatspi/tmpl/atspi-value.sgml
>+++ b/doc/libatspi/tmpl/atspi-value.sgml
>@@ -2,11 +2,15 @@
> atspi-value
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface supporting a one-dimensional scalar 
>+to be modified, or which reflects its value.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface supporting a one-dimensional scalar 
>+to be modified, or which reflects its value. If
>+STATE_EDITABLE is not present, the valuator is
>+treated as "read only".
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>
>
>From 714fdb7c67c2765f73e8962952e1145d334f3b94 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 21:00:58 -0300
>Subject: [PATCH 3/3] Adding Mike Gorse's suggestions
>
>---
> doc/libatspi/tmpl/atspi-value.sgml |    2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-value.sgml b/doc/libatspi/tmpl/atspi-value.sgml
>index b5e50e2..59f3cfc 100644
>--- a/doc/libatspi/tmpl/atspi-value.sgml
>+++ b/doc/libatspi/tmpl/atspi-value.sgml
>@@ -9,7 +9,7 @@ to be modified, or which reflects its value.
> <para>
> An interface supporting a one-dimensional scalar 
> to be modified, or which reflects its value. If
>-STATE_EDITABLE is not present, the valuator is
>+STATE_EDITABLE is not present, the value is
> treated as "read only".
> </para>
> 
>-- 
>1.7.5.1
>

Comment on attachment 192719 [details] [review]
Some documentation improvements for atspi-hypertext






>From e064d8554fcc69312e892ec686b6919f428b9f52 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 02:01:46 -0300
>Subject: [PATCH 1/2] Improving atspi-hypertext.c documentation
>
>---
> atspi/atspi-hypertext.c |   16 ++++++++--------
> 1 files changed, 8 insertions(+), 8 deletions(-)
>
>diff --git a/atspi/atspi-hypertext.c b/atspi/atspi-hypertext.c
>index b7d4eb6..748d272 100644
>--- a/atspi/atspi-hypertext.c
>+++ b/atspi/atspi-hypertext.c
>@@ -28,10 +28,10 @@
>  * atspi_hypertext_get_n_links:
>  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
>  *
>- * Get the total number of #AtspiHyperlinks which an
>- *        #AtspiHypertext implementor has.
>+ * Gets the total number of #AtspiHyperlink objects that an
>+ * #AtspiHypertext implementor has.
>  *
>- * Returns: a #gint indicating the number of #AtspiHyperlinks
>+ * Returns: a #gint indicating the number of #AtspiHyperlink objects
>  *        of the #AtspiHypertext implementor, or -1 if
>  *        the number cannot be determined (for example, if the
>  *        #AtspiHypertext object is so large that it is not
>@@ -52,12 +52,12 @@ atspi_hypertext_get_n_links (AtspiHypertext *obj, GError **error)
> /**
>  * atspi_hypertext_get_link:
>  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
>- * @link_index: a (zero-index) integer indicating which hyperlink to query.
>+ * @link_index: a (zero-index) #gint indicating which hyperlink to query.
>  *
>- * Get the #AtspiHyperlink object at a specified index.
>+ * Gets the #AtspiHyperlink object at a specified index.
>  *
>  * Returns: (transfer full): the #AtspiHyperlink object specified by
>- *          #link_index.
>+ *          @link_index.
>  **/
> AtspiHyperlink *
> atspi_hypertext_get_link (AtspiHypertext *obj, gint link_index, GError **error)
>@@ -75,9 +75,9 @@ atspi_hypertext_get_link (AtspiHypertext *obj, gint link_index, GError **error)
> /**
>  * atspi_hypertext_get_link_index:
>  * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
>- * @character_offset: an integer specifying the character offset to query.
>+ * @character_offset: a #gint specifying the character offset to query.
>  *
>- * Get the index of the #AtspiHyperlink object at a specified
>+ * Gets the index of the #AtspiHyperlink object at a specified
>  *        character offset.
>  *
>  * Returns: the linkIndex of the #AtspiHyperlink active at
>-- 
>1.7.5.1
>
>
>From 5c0920b620d390166a280159ead83e46870b895b Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 02:07:07 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-hypertext.c
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-hypertext.sgml |    9 +++++++--
> 2 files changed, 20 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hypertext.sgml b/doc/libatspi/tmpl/atspi-hypertext.sgml
>index 6032645..5448f61 100644
>--- a/doc/libatspi/tmpl/atspi-hypertext.sgml
>+++ b/doc/libatspi/tmpl/atspi-hypertext.sgml
>@@ -2,11 +2,16 @@
> atspi-hypertext
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface used for objects which implement linking between
>+multiple resource locations.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface used for objects which implement linking between
>+multiple resource or content locations, or multiple 'markers'
>+within a single document. A hypertext instance is associated
>+with one or more hyperlinks which are associated with	particular
>+offests within the hypertext's content.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 192717 [details] [review]
Some documentation improvements for atspi-document






>From 220774cf748f151a9f3eaa79f85fb1262949bfb4 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 01:26:45 -0300
>Subject: [PATCH 1/2] Improving atspi-document.c documentation
>
>---
> atspi/atspi-document.c |   24 ++++++++++--------------
> 1 files changed, 10 insertions(+), 14 deletions(-)
>
>diff --git a/atspi/atspi-document.c b/atspi/atspi-document.c
>index 87feb04..8353689 100644
>--- a/atspi/atspi-document.c
>+++ b/atspi/atspi-document.c
>@@ -25,9 +25,9 @@
> 
> /**
>  * atspi_document_get_locale:
>- * @obj: a pointer to the #Accessible object on which to operate.
>+ * @obj: a pointer to the #AtspiDocument object on which to operate.
>  *
>- * Gets the locale associated with the document's content.
>+ * Gets the locale associated with the document's content, 
>  * e.g. the locale for LOCALE_TYPE_MESSAGES.
>  *
>  * Returns: a string compliant with the POSIX standard for locale description.
>@@ -46,14 +46,12 @@ atspi_document_get_locale (AtspiDocument *obj, GError **error)
> 
> /**
>  * atspi_document_get_attribute_value:
>- * @obj: a pointer to the #Accessible object on which to operate.
>- * @attribute: a string indicating the name of a specific attribute 
>+ * @obj: a pointer to the #AtspiDocument object on which to operate.
>+ * @attribute: a string indicating the name of a specific attribute.
>  *
>  * Gets the value of a single attribute, if specified for the document as a whole.
>  *
>- * (name-value pair) being queried.
>- * 
>- * Returns a string corresponding to the value of the specified attribute, or
>+ * Returns: a string corresponding to the value of the specified attribute, or
>  * an empty string if the attribute is unspecified for the object.
>  **/
> gchar *
>@@ -76,15 +74,13 @@ atspi_document_get_attribute_value (AtspiDocument *obj,
> 
> /**
>  * atspi_document_get_attributes:
>- * @obj: a pointer to the #Accessible object on which to operate.
>+ * @obj: a pointer to the #AtspiDocument object on which to operate.
>  * 
>- * Gets all attributes specified for a document as a whole.  
>- *
>- * For attributes which change within 
>- * the document content, see atspi_text_get_attribute_run instead.
>+ * Gets all constant attributes for the document as a whole. For attributes
>+ * that change within the document content, see @atspi_text_get_attribute_run instead.
>  * 
>- * Returns: (element-type gchar* gchar*) (transfer full): an ::AttributeSet
>- *          containing the attributes of the document, as name-value pairs.
>+ * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
>+ *          containing the constant attributes of the document, as name-value pairs.
>  **/
> GHashTable *
> atspi_document_get_attributes (AtspiDocument *obj, GError **error)
>-- 
>1.7.5.1
>
>
>From b3b316ad6d29c857b9af31e3fc5181afbdbc256a Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 01:36:54 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-document.c
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-document.sgml  |    8 ++++++--
> doc/libatspi/tmpl/libatspi-unused.sgml |    6 ++++++
> 3 files changed, 25 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-document.sgml b/doc/libatspi/tmpl/atspi-document.sgml
>index 5162ed2..05d4c68 100644
>--- a/doc/libatspi/tmpl/atspi-document.sgml
>+++ b/doc/libatspi/tmpl/atspi-document.sgml
>@@ -2,11 +2,15 @@
> atspi-document
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface which indicates the start of
>+a document content.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+A 'tagging' interface which indicates the start of
>+a document content. Children are normally assumed to
>+be part of the document content. Document attributes
>+are those associated with the document as a whole.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..99f8542 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,9 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_document_get_type ##### -->
>+<para>
>+
>+</para>
>+
>+
>-- 
>1.7.5.1
>

Comment on attachment 192716 [details] [review]
Some documentation improvements for AtspiAccessible






>From 7d338f6c5c0a00f202cdc4a119d63430bd0f3eca Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 13:44:06 -0300
>Subject: [PATCH 1/3] Changing atspi-accessible C file
>
>---
> atspi/atspi-accessible.c |  192 +++++++++++++++++++++++++--------------------
> 1 files changed, 107 insertions(+), 85 deletions(-)
>
>diff --git a/atspi/atspi-accessible.c b/atspi/atspi-accessible.c
>index dba7fe0..4b35b12 100644
>--- a/atspi/atspi-accessible.c
>+++ b/atspi/atspi-accessible.c
>@@ -289,13 +289,13 @@ static const char *role_names [] =
> #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
> 
> /**
>- * atspi_role_get_name
>- * @role: an #AtspiAccessibleRole object to query.
>+ * atspi_role_get_name:
>+ * @role: an #AtspiRole object to query.
>  *
>- * Get a localizeable string that indicates the name of an #AtspiAccessibleRole.
>+ * Gets a localizable string that indicates the name of an #AtspiRole.
>  * <em>DEPRECATED.</em>
>  *
>- * Returns: a localizable string name for an #AtspiAccessibleRole enumerated type.
>+ * Returns: a localizable string name for an #AtspiRole enumerated type.
>  **/
> gchar *
> atspi_role_get_name (AtspiRole role)
>@@ -314,10 +314,10 @@ atspi_role_get_name (AtspiRole role)
>  * atspi_accessible_get_name:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the name of an #AtspiAccessible object.
>+ * Gets the name of an #AtspiAccessible object.
>  *
>- * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object.
>- * or NULL on exception
>+ * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object 
>+ * or NULL on exception.
>  **/
> gchar *
> atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
>@@ -337,10 +337,10 @@ atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_description:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the description of an #AtspiAccessible object.
>+ * Gets the description of an #AtspiAccessible object.
>  *
>- * Returns: a UTF-8 string describing the #AtspiAccessible object.
>- * or NULL on exception
>+ * Returns: a UTF-8 string describing the #AtspiAccessible object 
>+ * or NULL on exception.
>  **/
> gchar *
> atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
>@@ -364,7 +364,7 @@ const char *str_parent = "Parent";
>  * atspi_accessible_get_parent:
>  * @obj: a pointer to the #AtspiAccessible object to query.
>  *
>- * Get an #AtspiAccessible object's parent container.
>+ * Gets an #AtspiAccessible object's parent container.
>  *
>  * Returns: (transfer full): a pointer to the #AtspiAccessible object which
>  *          contains the given #AtspiAccessible instance, or NULL if the @obj
>@@ -412,10 +412,10 @@ atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_child_count:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the number of children contained by an #AtspiAccessible object.
>+ * Gets the number of children contained by an #AtspiAccessible object.
>  *
>  * Returns: a #long indicating the number of #AtspiAccessible children
>- *          contained by an #AtspiAccessible object. or -1 on exception
>+ *          contained by an #AtspiAccessible object or -1 on exception.
>  *
>  **/
> gint
>@@ -440,10 +440,10 @@ atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  * @child_index: a #long indicating which child is specified.
>  *
>- * Get the #AtspiAccessible child of an #AtspiAccessible object at a given index.
>+ * Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index.
>  *
>  * Returns: (transfer full): a pointer to the #AtspiAccessible child object at
>- * index @child_index. or NULL on exception
>+ * index @child_index or NULL on exception.
>  **/
> AtspiAccessible *
> atspi_accessible_get_child_at_index (AtspiAccessible *obj,
>@@ -470,13 +470,14 @@ atspi_accessible_get_child_at_index (AtspiAccessible *obj,
> }
> 
> /**
>- * atspi_accessible_get_index_in_parent
>+ * atspi_accessible_get_index_in_parent:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the index of an #AtspiAccessible object in its containing #AtspiAccessible.
>+ * Gets the index of an #AtspiAccessible object within its parent's 
>+ * #AtspiAccessible children list.
>  *
>  * Returns: a #glong indicating the index of the #AtspiAccessible object
>- *          in its parent (i.e. containing) #AtspiAccessible instance,
>+ *          in its parent,
>  *          or -1 if @obj has no containing parent or on exception.
>  **/
> gint
>@@ -516,11 +517,11 @@ typedef struct
>  * atspi_accessible_get_relation_set:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the set of #AtspiRelation objects which describe this #AtspiAccessible object's
>- *       relationships with other #AtspiAccessible objects.
>+ * Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's
>+ * relationships with other #AtspiAccessible objects.
>  *
>- * Returns: (element-type AtspiAccessible*) (transfer full): an array of
>- *          #AtspiAccessibleRelation pointers. or NULL on exception
>+ * Returns: (element-type AtspiAccessible*) (transfer full): a #GArray of
>+ *          #AtspiRelation pointers or NULL on exception.
>  **/
> GArray *
> atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
>@@ -554,10 +555,10 @@ atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_role:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the UI role of an #AtspiAccessible object.
>- * A UTF-8 string describing this role can be obtained via atspi_accessible_getRoleName ().
>+ * Gets the UI role played by an #AtspiAccessible object.
>+ * This role's name can be obtained via atspi_accessible_get_role_name ().
>  *
>- * Returns: the #AtspiRole of the object.
>+ * Returns: the #AtspiRole of an #AtspiAccessible object.
>  *
>  **/
> AtspiRole
>@@ -582,11 +583,12 @@ atspi_accessible_get_role (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_role_name:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get a UTF-8 string describing the role this object plays in the UI.
>+ * Gets a UTF-8 string corresponding to the name of the role played by an object.
>  * This method will return useful values for roles that fall outside the
>- * enumeration used in atspi_accessible_getRole ().
>+ * enumeration used in atspi_accessible_get_role ().
>  *
>- * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
>+ * Returns: a UTF-8 string specifying the type of UI role played by an
>+ * #AtspiAccessible object.
>  *
>  **/
> gchar *
>@@ -613,11 +615,13 @@ atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_localized_role_name:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get a UTF-8 string describing the (localized) role this object plays in the UI.
>+ * Gets a UTF-8 string corresponding to the name of the role played by an 
>+ * object, translated to the current locale.
>  * This method will return useful values for roles that fall outside the
>  * enumeration used in atspi_accessible_getRole ().
>  *
>- * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
>+ * Returns: a localized, UTF-8 string specifying the type of UI role played 
>+ * by an #AtspiAccessible object.
>  *
>  **/
> gchar *
>@@ -647,10 +651,10 @@ defunct_set ()
>  * atspi_accessible_get_state_set:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Gets the current state of an object.
>+ * Gets the states currently held by an object.
>  *
>- * Returns: (transfer full): a pointer to an #AtspiStateSet representing the
>- *          object's current state.
>+ * Returns: (transfer full): a pointer to an #AtspiStateSet representing an
>+ * object's current state set.
>  **/
> AtspiStateSet *
> atspi_accessible_get_state_set (AtspiAccessible *obj)
>@@ -679,13 +683,13 @@ atspi_accessible_get_state_set (AtspiAccessible *obj)
>  * atspi_accessible_get_attributes:
>  * @obj: The #AtspiAccessible being queried.
>  *
>- * Get the #AttributeSet representing any assigned 
>+ * Gets the #AttributeSet representing any assigned 
>  * name-value pair attributes or annotations for this object.
>  * For typographic, textual, or textually-semantic attributes, see
>  * atspi_text_get_attributes instead.
>  *
>  * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair
>- *          attributes assigned to this object.
>+ * attributes assigned to this object.
>  */
> GHashTable *
> atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)
>@@ -719,12 +723,12 @@ add_to_attribute_array (gpointer key, gpointer value, gpointer data)
>  * atspi_accessible_get_attributes_as_array:
>  * @obj: The #AtspiAccessible being queried.
>  *
>- * Get the #AttributeSet representing any assigned 
>+ * Gets a #GArray representing any assigned 
>  * name-value pair attributes or annotations for this object.
>  * For typographic, textual, or textually-semantic attributes, see
>  * atspi_text_get_attributes_as_array instead.
>  *
>- * Returns: (element-type gchar*) (transfer full): The name-value-pair
>+ * Returns: (element-type GArray*) (transfer full): The name-value-pair
>  *          attributes assigned to this object.
>  */
> GArray *
>@@ -753,9 +757,9 @@ atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_application:
>  * @obj: The #AtspiAccessible being queried.
>  *
>- * Get the containing #AtspiApplication for an object.
>+ * Gets the containing #AtspiApplication for an object.
>  *
>- * Returns: (transfer full): the containing AtspiApplication instance for
>+ * Returns: (transfer full): the containing #AtspiApplication instance for
>  *          this object.
>  */
> AtspiAccessible *
>@@ -796,11 +800,10 @@ atspi_accessible_get_application (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_toolkit_name:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the toolkit for a #AtspiAccessible object.
>+ * Gets the toolkit name for an #AtspiAccessible object.
>  * Only works on application root objects.
>  *
>- * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object.
>- * or NULL on exception
>+ * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception.
>  **/
> gchar *
> atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
>@@ -821,11 +824,10 @@ atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_toolkit_version:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the toolkit version for a #AtspiAccessible object.
>+ * Gets the toolkit version for an #AtspiAccessible object.
>  * Only works on application root objects.
>  *
>- * Returns: a UTF-8 string indicating the toolkit ersion for the #AtspiAccessible object.
>- * or NULL on exception
>+ * Returns: a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception.
>  **/
> gchar *
> atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
>@@ -846,12 +848,11 @@ atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_atspi_version:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the AT-SPI IPC specification version supported by the application
>+ * Gets the AT-SPI IPC specification version supported by the application
>  * pointed to by the #AtspiAccessible object.
>  * Only works on application root objects.
>  *
>- * Returns: a UTF-8 string indicating the AT-SPI ersion for the #AtspiAccessible object.
>- * or NULL on exception
>+ * Returns: a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception.
>  **/
> gchar *
> atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error)
>@@ -872,11 +873,11 @@ atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error)
>  * atspi_accessible_get_toolkit_version:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the application id for a #AtspiAccessible object.
>+ * Gets the application id for a #AtspiAccessible object.
>  * Only works on application root objects.
>  *
>- * Returns: a gint indicating the id for the #AtspiAccessible object.
>- * or -1 on exception
>+ * Returns: a positive #gint indicating the id for the #AtspiAccessible object 
>+ * or -1 on exception.
>  **/
> gint
> atspi_accessible_get_id (AtspiAccessible *obj, GError **error)
>@@ -926,7 +927,8 @@ _atspi_accessible_is_a (AtspiAccessible *accessible,
>  * atspi_accessible_is_action:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiAction.
>+ * Query whether the specified #AtspiAccessible implements the 
>+ * #AtspiAction interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiAction interface,
>  *          #FALSE otherwise.
>@@ -942,7 +944,8 @@ atspi_accessible_is_action (AtspiAccessible *obj)
>  * atspi_accessible_is_application:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiApplication.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiApplication interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiApplication interface,
>  *          #FALSE otherwise.
>@@ -955,10 +958,13 @@ atspi_accessible_is_application (AtspiAccessible *obj)
> }
> 
> /**                      
>- * atspi_accessible_is_collection:                                                                                                                                                                          * @obj: a pointer to the #AtspiAccessible instance to query.                                                                                                                                          
>- *                          
>- * Query whether the specified #AtspiAccessible implements #AtspiCollection.    
>- * Returns: #TRUE if @obj implements the #AtspiCollection interface,                                                                                                               
>+ * atspi_accessible_is_collection:
>+ * @obj: a pointer to the #AtspiAccessible instance to query.
>+ *
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiCollection interface.
>+ *
>+ * Returns: #TRUE if @obj implements the #AtspiCollection interface,
>  *          #FALSE otherwise.
>  **/
> gboolean
>@@ -988,7 +994,8 @@ atspi_accessible_is_component (AtspiAccessible *obj)
>  * atspi_accessible_is_document:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiDocument.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiDocument interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiDocument interface,
>  *          #FALSE otherwise.
>@@ -1004,7 +1011,8 @@ atspi_accessible_is_document (AtspiAccessible *obj)
>  * atspi_accessible_is_editable_text:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiEditableText.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiEditableText interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiEditableText interface,
>  *          #FALSE otherwise.
>@@ -1020,7 +1028,8 @@ atspi_accessible_is_editable_text (AtspiAccessible *obj)
>  * atspi_accessible_is_hypertext:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiHypertext.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiHypertext interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
>  *          #FALSE otherwise.
>@@ -1036,7 +1045,8 @@ atspi_accessible_is_hypertext (AtspiAccessible *obj)
>  * atspi_accessible_is_hyperlink:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiHyperlink.
>+ * Query whether the specified #AtspiAccessible implements the 
>+ * #AtspiHyperlink interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
>  *          #FALSE otherwise.
>@@ -1052,7 +1062,8 @@ atspi_accessible_is_hyperlink (AtspiAccessible *obj)
>  * atspi_accessible_is_image:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiImage.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiImage interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiImage interface,
>  *          #FALSE otherwise.
>@@ -1068,7 +1079,8 @@ atspi_accessible_is_image (AtspiAccessible *obj)
>  * atspi_accessible_is_selection:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiSelection.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiSelection interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiSelection interface,
>  *          #FALSE otherwise.
>@@ -1084,7 +1096,8 @@ atspi_accessible_is_selection (AtspiAccessible *obj)
>  * atspi_accessible_is_table:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiTable.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiTable interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiTable interface,
>  *          #FALSE otherwise.
>@@ -1100,8 +1113,8 @@ atspi_accessible_is_table (AtspiAccessible *obj)
>  * atspi_accessible_is_streamable_content:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements
>- *          #AtspiStreamableContent.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiStreamableContent interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,
>  *          #FALSE otherwise.
>@@ -1122,7 +1135,8 @@ atspi_accessible_is_streamable_content (AtspiAccessible *obj)
>  * atspi_accessible_is_text:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiText.
>+ * Query whether the specified #AtspiAccessible implements the 
>+ * #AtspiText interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiText interface,
>  *          #FALSE otherwise.
>@@ -1138,7 +1152,8 @@ atspi_accessible_is_text (AtspiAccessible *obj)
>  * atspi_accessible_is_value:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Query whether the specified #AtspiAccessible implements #AtspiValue.
>+ * Query whether the specified #AtspiAccessible implements the
>+ * #AtspiValue interface.
>  *
>  * Returns: #TRUE if @obj implements the #AtspiValue interface,
>  *          #FALSE otherwise.
>@@ -1154,7 +1169,7 @@ atspi_accessible_is_value (AtspiAccessible *obj)
>  * atspi_accessible_get_action:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiAction interface for an #AtspiAccessible.
>+ * Gets the #AtspiAction interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiAction interface
>  *          instance, or NULL if @obj does not implement #AtspiAction.
>@@ -1170,7 +1185,7 @@ atspi_accessible_get_action (AtspiAccessible *accessible)
>  * atspi_accessible_get_collection:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiCollection interface for an #AtspiAccessible.
>+ * Gets the #AtspiCollection interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiCollection interface
>  *          instance, or NULL if @obj does not implement #AtspiCollection.
>@@ -1186,7 +1201,7 @@ atspi_accessible_get_collection (AtspiAccessible *accessible)
>  * atspi_accessible_get_component:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiComponent interface for an #AtspiAccessible.
>+ * Gets the #AtspiComponent interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiComponent interface
>  *          instance, or NULL if @obj does not implement #AtspiComponent.
>@@ -1202,7 +1217,7 @@ atspi_accessible_get_component (AtspiAccessible *obj)
>  * atspi_accessible_get_document:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiDocument interface for an #AtspiAccessible.
>+ * Gets the #AtspiDocument interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiDocument interface
>  *          instance, or NULL if @obj does not implement #AtspiDocument.
>@@ -1218,7 +1233,7 @@ atspi_accessible_get_document (AtspiAccessible *accessible)
>  * atspi_accessible_get_editable_text:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiEditableText interface for an #AtspiAccessible.
>+ * Gets the #AtspiEditableText interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiEditableText interface
>  *          instance, or NULL if @obj does not implement #AtspiEditableText.
>@@ -1234,8 +1249,7 @@ atspi_accessible_get_editable_text (AtspiAccessible *accessible)
>  * atspi_accessible_get_hyperlink:
>  * @obj: a pointer to the #AtspiAccessible object on which to operate.
>  *
>- * Get the #AtspiHyperlink associated with the given #AtspiAccessible, if
>- * supported.
>+ * Gets the #AtspiHyperlink interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): the #AtspiHyperlink object associated with
>  *          the given #AtspiAccessible, or NULL if not supported.
>@@ -1251,7 +1265,7 @@ atspi_accessible_get_hyperlink (AtspiAccessible *accessible)
>  * atspi_accessible_get_hypertext:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiHypertext interface for an #AtspiAccessible.
>+ * Gets the #AtspiHypertext interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiHypertext interface
>  *          instance, or NULL if @obj does not implement #AtspiHypertext.
>@@ -1267,7 +1281,7 @@ atspi_accessible_get_hypertext (AtspiAccessible *accessible)
>  * atspi_accessible_get_image:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiImage interface for an #AtspiAccessible.
>+ * Gets the #AtspiImage interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
>  *          NULL if @obj does not implement #AtspiImage.
>@@ -1283,7 +1297,7 @@ atspi_accessible_get_image (AtspiAccessible *accessible)
>  * atspi_accessible_get_selection:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiSelection interface for an #AtspiAccessible.
>+ * Gets the #AtspiSelection interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiSelection interface
>  *          instance, or NULL if @obj does not implement #AtspiSelection.
>@@ -1300,7 +1314,7 @@ atspi_accessible_get_selection (AtspiAccessible *accessible)
>  * atspi_accessible_get_streamable_content:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiStreamableContent interface for an #AtspiAccessible.
>+ * Gets the #AtspiStreamableContent interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface
>  *          instance, or NULL if @obj does not implement #AtspiStreamableContent.
>@@ -1317,7 +1331,7 @@ atspi_accessible_get_streamable_content (AtspiAccessible *accessible)
>  * atspi_accessible_get_table:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiTable interface for an #AtspiAccessible.
>+ * Gets the #AtspiTable interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
>  *          NULL if @obj does not implement #AtspiTable.
>@@ -1333,7 +1347,7 @@ atspi_accessible_get_table (AtspiAccessible *obj)
>  * atspi_accessible_get_text:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiTable interface for an #AtspiAccessible.
>+ * Gets the #AtspiTable interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
>  *          NULL if @obj does not implement #AtspiText.
>@@ -1349,7 +1363,7 @@ atspi_accessible_get_text (AtspiAccessible *obj)
>  * atspi_accessible_get_value:
>  * @obj: a pointer to the #AtspiAccessible instance to query.
>  *
>- * Get the #AtspiTable interface for an #AtspiAccessible.
>+ * Gets the #AtspiTable interface for an #AtspiAccessible.
>  *
>  * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
>  *          NULL if @obj does not implement #AtspiValue.
>@@ -1372,12 +1386,13 @@ append_const_val (GArray *array, const gchar *val)
> 
> /**
>  * atspi_accessible_get_interfaces:
>+ * @obj: The #AtspiAccessible to query.
>  *
>- * #obj: The #AtspiAccessible to query.
>+ * A set of pointers to all interfaces supported by an #AtspiAccessible.
>  *
>  * Returns: (element-type gchar*) (transfer full): A #GArray of strings
>  *          describing the interfaces supported by the object.  Interfaces are
>- *          denoted in short-hand (ie, "Component", "Text", etc.)
>+ *          denoted in short-hand (i.e. "Component", "Text" etc.).
>  **/
> GArray *
> atspi_accessible_get_interfaces (AtspiAccessible *obj)
>@@ -1414,7 +1429,14 @@ atspi_accessible_get_interfaces (AtspiAccessible *obj)
> 
>   return ret;
> }
>-
>+/**
>+ * atspi_accessible_new:
>+ * @app: an #AtspiApplication reference to the new objects's parent application.
>+ * @path: a UTF-8 string indicating the new object's parent path.
>+ *
>+ * Creates a new #AtspiAccessible object.
>+ * Returns: a new #AtspiAccessible object. 
>+ **/
> AtspiAccessible *
> atspi_accessible_new (AtspiApplication *app, const gchar *path)
> {
>-- 
>1.7.5.1
>
>
>From f3d44461697743f5403092a439cc5fdf8bf96133 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 14:18:00 -0300
>Subject: [PATCH 2/3] Adding descriptions to atspiaccessible
>
>---
> doc/libatspi/tmpl/atspi-accessible.sgml |    7 +++++--
> doc/libatspi/tmpl/atspi-constants.sgml  |   13 +++++++++++++
> 2 files changed, 18 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-accessible.sgml b/doc/libatspi/tmpl/atspi-accessible.sgml
>index 1b3f3c9..a2e999a 100644
>--- a/doc/libatspi/tmpl/atspi-accessible.sgml
>+++ b/doc/libatspi/tmpl/atspi-accessible.sgml
>@@ -2,11 +2,14 @@
> AtspiAccessible
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+The base interface which is implemented by all accessible objects.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+The base interface which is implemented by all accessible objects. 
>+All objects support interfaces for querying their contained 'children'
>+and position in the accessible-object hierarchy, whether or not they
>+actually have children.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>-- 
>1.7.5.1
>
>
>From 1d0d8d7da9d0985e85eeebaa318aed2d7b2b460e Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Wed, 27 Jul 2011 01:02:53 -0300
>Subject: [PATCH 3/3] Adding Mike Gorse's suggestions
>
>---
> atspi/atspi-accessible.c |   13 +++----------
> 1 files changed, 3 insertions(+), 10 deletions(-)
>
>diff --git a/atspi/atspi-accessible.c b/atspi/atspi-accessible.c
>index 4b35b12..2316c27 100644
>--- a/atspi/atspi-accessible.c
>+++ b/atspi/atspi-accessible.c
>@@ -728,7 +728,7 @@ add_to_attribute_array (gpointer key, gpointer value, gpointer data)
>  * For typographic, textual, or textually-semantic attributes, see
>  * atspi_text_get_attributes_as_array instead.
>  *
>- * Returns: (element-type GArray*) (transfer full): The name-value-pair
>+ * Returns: (element-type gchar*) (transfer full): The name-value-pair
>  *          attributes assigned to this object.
>  */
> GArray *
>@@ -1429,15 +1429,8 @@ atspi_accessible_get_interfaces (AtspiAccessible *obj)
> 
>   return ret;
> }
>-/**
>- * atspi_accessible_new:
>- * @app: an #AtspiApplication reference to the new objects's parent application.
>- * @path: a UTF-8 string indicating the new object's parent path.
>- *
>- * Creates a new #AtspiAccessible object.
>- * Returns: a new #AtspiAccessible object. 
>- **/
>-AtspiAccessible *
>+
>+AtspiAccessible * 
> atspi_accessible_new (AtspiApplication *app, const gchar *path)
> {
>   AtspiAccessible *accessible;
>-- 
>1.7.5.1
>

Comment on attachment 192679 [details] [review]
Some documentation improvements for atspi-image






>From debf16bc8702e09ef1e095459e1512947e1efb59 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 15:19:17 -0300
>Subject: [PATCH 1/2] Improving atspi-image.c documentation
>
>---
> atspi/atspi-image.c |   25 ++++++++++++++++++-------
> 1 files changed, 18 insertions(+), 7 deletions(-)
>
>diff --git a/atspi/atspi-image.c b/atspi/atspi-image.c
>index b6536b6..4f17326 100644
>--- a/atspi/atspi-image.c
>+++ b/atspi/atspi-image.c
>@@ -28,7 +28,7 @@
>  * atspi_image_get_image_description:
>  * @obj: a pointer to the #AtspiImage implementor on which to operate.
>  *
>- * Get the description of the image displayed in an #AtspiImage object.
>+ * Gets the description of the image displayed in an #AtspiImage object.
>  *
>  * Returns: a UTF-8 string describing the image.
>  **/
>@@ -48,7 +48,11 @@ atspi_image_get_image_description (AtspiImage *obj, GError **error)
>  * atspi_image_get_image_size:
>  * @obj: a pointer to the #AtspiImage to query.
>  *
>- * Get the size of the image displayed in a specified #AtspiImage object.
>+ * Gets the size of the image displayed in a specified #AtspiImage object.
>+ *
>+ * Returns: a pointer to an #AtspiPoint where x corresponds to
>+ * the image's width and y corresponds to the image's height.
>+ *
>  **/
> AtspiPoint *
> atspi_image_get_image_size (AtspiImage *obj, GError **error)
>@@ -72,8 +76,12 @@ atspi_image_get_image_size (AtspiImage *obj, GError **error)
>  * @ctype: the desired coordinate system into which to return the results,
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * Get the minimum x and y coordinates of the image displayed in a
>+ * Gets the minimum x and y coordinates of the image displayed in a
>  *         specified #AtspiImage implementor.
>+ *
>+ * Returns: a pointer to an #AtspiPoint where x and y correspond to the
>+ * minimum coordinates of the displayed image. 
>+ * 
>  **/
> AtspiPoint *
> atspi_image_get_image_position (AtspiImage *obj,
>@@ -102,8 +110,11 @@ atspi_image_get_image_position (AtspiImage *obj,
>  * @ctype: the desired coordinate system into which to return the results,
>  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
>  *
>- * Get the bounding box of the image displayed in a
>+ * Gets the bounding box of the image displayed in a
>  *         specified #AtspiImage implementor.
>+ *
>+ * Returns: a pointer to an #AtspiRect corresponding to the image's bounding box. The minimum x and y coordinates, 
>+ * width, and height are specified.
>  **/
> AtspiRect *
> atspi_image_get_image_extents (AtspiImage *obj,
>@@ -123,11 +134,11 @@ atspi_image_get_image_extents (AtspiImage *obj,
> 
> /**
>  * atspi_image_get_image_locale:
>- * @obj: The #AtspiImage being queried.
>+ * @obj: a pointer to the #AtspiImage to query.
>  *
>- * Get the locale associated with an image and its textual representation.
>+ * Gets the locale associated with an image and its textual representation.
>  *
>- * Returns: A POSIX LC_MESSAGES-style Locale value for image description and text.
>+ * Returns: A POSIX LC_MESSAGES-style locale value for image description and text.
>  **/
> gchar *
> atspi_image_get_image_locale  (AtspiImage *obj, GError **error)
>-- 
>1.7.5.1
>
>
>From f122bc2678634fbb9ecee89e056d04f67c964221 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 15:31:45 -0300
>Subject: [PATCH 2/2] Adding descriptions to atspi-image
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-image.sgml     |    7 +++++--
> doc/libatspi/tmpl/libatspi-unused.sgml |    6 ++++++
> 3 files changed, 24 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-image.sgml b/doc/libatspi/tmpl/atspi-image.sgml
>index 2b7a36e..44a431c 100644
>--- a/doc/libatspi/tmpl/atspi-image.sgml
>+++ b/doc/libatspi/tmpl/atspi-image.sgml
>@@ -2,11 +2,14 @@
> atspi-image
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface implemented by objects which render image data or pictoral information on to the screen.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+The image interface should be implemented by objects which render
>+graphical information that is not purely intended to enhance 
>+the visual layout, but which conveys some semantic or informational
>+content.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2d0bbde 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,9 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_image_get_type ##### -->
>+<para>
>+
>+</para>
>+
>+
>-- 
>1.7.5.1
>

Comment on attachment 192672 [details] [review]
Some documentation improvements for atspi-text






>From 0f4e13c993250b5504bcdf752ebed735465c25e2 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 14:20:25 -0300
>Subject: [PATCH 1/2] Improving atspi-text.c documentation
>
>---
> atspi/atspi-text.c |  150 +++++++++++++++++++++++++++-------------------------
> 1 files changed, 78 insertions(+), 72 deletions(-)
>
>diff --git a/atspi/atspi-text.c b/atspi/atspi-text.c
>index 59f0730..ee364f1 100644
>--- a/atspi/atspi-text.c
>+++ b/atspi/atspi-text.c
>@@ -23,7 +23,14 @@
>  */
> 
> #include "atspi-private.h"
>-
>+/**
>+ * atspi_range_copy:
>+ * @src: a pointer to the source #AtspiRange object that will be copied.
>+ *
>+ * Gets a copy of an #AtspiRange object.
>+ *
>+ * Returns: the #AtspiRange copy of an #AtspiRange object.
>+ **/
> AtspiRange *
> atspi_range_copy (AtspiRange *src)
> {
>@@ -61,9 +68,9 @@ G_DEFINE_BOXED_TYPE (AtspiTextRange, atspi_text_range, atspi_text_range_copy,
>  * atspi_text_get_character_count:
>  * @obj: a pointer to the #AtspiText object to query.
>  *
>- * Get the character count of an #AccessibleText object.
>+ * Gets the character count of an #AccessibleText object.
>  *
>- * Returns: a long integer indicating the total number of
>+ * Returns: a #gint indicating the total number of
>  *              characters in the #AccessibleText object.
>  **/
> gint
>@@ -81,11 +88,11 @@ atspi_text_get_character_count (AtspiText *obj, GError **error)
> /**
>  * atspi_text_get_text:
>  * @obj: a pointer to the #AtspiText object to query.
>- * @start_offset: a #long indicating the start of the desired text range.
>- * @end_offset: a #long indicating the first character past the desired range.
>+ * @start_offset: a #gint indicating the start of the desired text range.
>+ * @end_offset: a #gint indicating the first character past the desired range.
>  *
>- * Get a range of text from an #AtspiText object.  The number of bytes
>- *          in the returned string may exceed end_offset-start_offset, since
>+ * Gets a range of text from an #AtspiText object.  The number of bytes
>+ *          in the returned string may exceed either end_offset or start_offset, since
>  *          UTF-8 is a variable-width encoding.
>  *
>  * Returns: a text string containing characters from @start_offset
>@@ -114,9 +121,9 @@ atspi_text_get_text (AtspiText *obj,
>  * atspi_text_get_caret_offset:
>  * @obj: a pointer to the #AtspiText object to query.
>  *
>- * Get the current offset of the text caret in an #AtspiText object.
>+ * Gets the current offset of the text caret in an #AtspiText object.
>  *
>- * Returns: a long integer indicating the current position of the text caret.
>+ * Returns: a #gint indicating the current position of the text caret.
>  **/
> gint
> atspi_text_get_caret_offset (AtspiText *obj, GError **error)
>@@ -133,19 +140,20 @@ atspi_text_get_caret_offset (AtspiText *obj, GError **error)
> /**
>  * atspi_text_get_attributes:
>  * @obj: a pointer to the #AtspiText object to query.
>- * @offset: a long integer indicating the offset from which the attribute
>+ * @offset: a #gint indicating the offset from which the attribute
>  *        search is based.
>- * @start_offset: (out): a #gint indicating the start of the desired text
>+ * @start_offset: (out): a #gint pointer indicating the start of the desired text
>  *                range.
>- * @end_offset: (out): a #gint indicating the first character past the desired
>+ * @end_offset: (out): a #gint pointer indicating the first character past the desired
>  *              range.
>  *
>- * Get the attributes applied to a range of text from an #AtspiText
>- *          object, and the bounds of the range.
>- *          The text attributes correspond to CSS attributes where possible,
>+ * Gets the attributes applied to a range of text from an #AtspiText
>+ * object. The text attributes correspond to CSS attributes
>+ * where possible.
>+ * <em>DEPRECATED</em>
>  *
>  * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
>- *          describing the attributes at the given character offset
>+ * describing the attributes at the given character offset.
>  **/
> GHashTable *
> atspi_text_get_attributes (AtspiText *obj,
>@@ -185,19 +193,22 @@ atspi_text_get_attributes (AtspiText *obj,
> /**
>  * atspi_text_get_attribute_run:
>  * @obj: a pointer to the #AtspiText object to query.
>- * @offset: an integer indicating the offset from which the attribute
>+ * @offset: a #gint indicating the offset from which the attribute
>  *        search is based.
>- * @include_defaults: a #bool if False, the call should only return those 
>- *                 attributes which are explicitly set on the current attribute 
>- *                 run, omitting any attributes which are inherited from the 
>- *                 default values.
>- * @start_offset: (out): a #gint indicating the start of the desired text
>+ * @include_defaults: a #bool that, when set as #FALSE, indicates the call
>+ * should only return those attributes which are explicitly set on the current
>+ * attribute run, omitting any attributes which are inherited from the 
>+ * default values.
>+ * @start_offset: (out): a #gint pointer indicating the start of the desired text
>  *                range.
>- * @end_offset: (out): a #gint indicating the first character past the desired
>+ * @end_offset: (out): a #gint pointer indicating the first character past the desired
>  *              range.
>  *
>- * Returns: (element-type gchar* gchar*) (transfer full): the AttributeSet
>- *          defined at offset, optionally including the 'default' attributes.
>+ * Gets a set of attributes applied to a range of text from an #AtspiText object, optionally
>+ * including its 'default' attributes.
>+ *
>+ * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable with attributes
>+ *          defined at the indicated offset, optionally including the 'default' ones.
>  **/
> GHashTable *
> atspi_text_get_attribute_run (AtspiText *obj,
>@@ -243,8 +254,10 @@ atspi_text_get_attribute_run (AtspiText *obj,
>  * @offset: The character offset at which to query the attribute.
>  * @attribute_name: The attribute to query.
>  *
>+ * Gets the value of a named attribute at a given offset.
>+ *
>  * Returns: the value of a given attribute at the given offset, or NULL if
>- *          not present.
>+ * not present.
>  **/
> gchar *
> atspi_text_get_attribute_value (AtspiText *obj,
>@@ -265,15 +278,11 @@ atspi_text_get_attribute_value (AtspiText *obj,
>  * atspi_text_get_default_attributes:
>  * @obj: a pointer to the #AtspiText object to query.
>  *
>- * Get the default attributes applied to an #AtspiText
>- *          object.
>- *          The text attributes correspond to CSS attributes where possible,
>- *          keys and values are delimited from one another via ":", and
>- *          the delimiter between key/value pairs is ";". Thus
>- *          "font-size:10;foreground-color:0,0,0" would be a valid
>- *          return string.  The combination of this attribute set and
>- *          the attributes reported by #atspi_text_getAttributes
>- *          describes the entire set of text attributes over a range.
>+ * Gets the default attributes applied to an #AtspiText
>+ * object. The text attributes correspond to CSS attributes 
>+ * where possible. The combination of this attribute set and
>+ * the attributes reported by #atspi_text_get_attributes
>+ * describes the entire set of text attributes over a range.
>  *
>  * Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
>  *          containing the default attributes applied to a text object,
>@@ -296,7 +305,7 @@ atspi_text_get_default_attributes (AtspiText *obj, GError **error)
>  * @obj: a pointer to the #AtspiText object on which to operate.
>  * @new_offset: the offset to which the text caret is to be moved.
>  *
>- * Set the text caret position for an #AtspiText object.
>+ * Moves the text caret to a given position.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>  **/
>@@ -318,12 +327,12 @@ atspi_text_set_caret_offset (AtspiText *obj,
> /**
>  * atspi_text_get_text_before_offset:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @offset: an integer indicating the offset from which the delimiter
>+ * @offset: a #gint indicating the offset from which the delimiter
>  *        search is based.
>  * @type: an #AtspiTextBoundaryType indicating whether the desired
>  *       text string is a word, sentence, line, or attribute run.
>  *
>- * Get delimited text from an #AtspiText object which precedes a given
>+ * Gets delimited text from an #AtspiText object which precedes a given
>  *          text offset.
>  *
>  * Returns: an #AtspiTextRange containing a UTF-8 string representing the
>@@ -360,12 +369,12 @@ atspi_text_get_text_before_offset (AtspiText *obj,
> /**
>  * atspi_text_get_text_at_offset:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @offset: a long integer indicating the offset from which the delimiter
>+ * @offset: a #gint indicating the offset from which the delimiter
>  *        search is based.
>  * @type: an #AtspiTextBoundaryType indicating whether the desired
>  *       text string is a word, sentence, line, or attribute run.
>  *
>- * Get delimited text from an #AtspiText object which includes a given
>+ * Gets delimited text from an #AtspiText object which includes a given
>  *          text offset.
>  *
>  * Returns: an #AtspiTextRange containing a UTF-8 string representing the
>@@ -402,12 +411,12 @@ atspi_text_get_text_at_offset (AtspiText *obj,
> /**
>  * atspi_text_get_text_after_offset:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @offset: an integer indicating the offset from which the delimiter
>+ * @offset: a #gint indicating the offset from which the delimiter
>  *        search is based.
>  * @type: an #AtspiTextBoundaryType indicating whether the desired
>  *       text string is a word, sentence, line, or attribute run.
>  *
>- * Get delimited text from an #AtspiText object which follows a given
>+ * Gets delimited text from an #AtspiText object which follows a given
>  *          text offset.
>  *
>  * Returns: an #AtspiTextRange containing a UTF-8 string representing the
>@@ -445,12 +454,12 @@ atspi_text_get_text_after_offset (AtspiText *obj,
> /**
>  * atspi_text_get_character_at_offset:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @offset: a long integer indicating the text offset where the desired
>+ * @offset: a #gint indicating the text offset where the desired
>  *          character is located.
>  *
>- * Get the character at a given offset for an #AtspiText object.
>+ * Gets the character at a given offset for an #AtspiText object.
>  *
>- * Returns: an #unsigned long integer which represents the
>+ * Returns: a #guint  representing the
>  *        UCS-4 unicode code point of the given character, or
>  *        0xFFFFFFFF if the character in question cannot be represented
>  *        in the UCS-4 encoding.
>@@ -473,15 +482,16 @@ atspi_text_get_character_at_offset (AtspiText *obj,
> /**
>  * atspi_text_get_character_extents:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @offset: an integer indicating the offset of the text character for
>+ * @offset: a #gint indicating the offset of the text character for
>  *        whom boundary information is requested.
>  * @type: an #AccessibleCoordType indicating the coordinate system to use
>  *        for the returned values.
>  *
>- * Returns: A #AtspiRect specifying the position and size of the character.
>- *
>- * Get the bounding box containing the glyph representing
>+ * Gets a bounding box containing the glyph representing
>  *        the character at a particular text offset.
>+ *
>+ * Returns: An #AtspiRect specifying the position and size of the character.
>+ *
>  **/
> AtspiRect *
> atspi_text_get_character_extents (AtspiText *obj,
>@@ -516,9 +526,9 @@ atspi_text_get_character_extents (AtspiText *obj,
>  * @type: an #AtspiCoordType indicating the coordinate system in which
>  *       the values should be returned.
>  *
>- * Get the character offset into the text at a given point.
>+ * Gets the character offset into the text at a given point.
>  *
>- * Returns: the offset (as an integer) at the point (@x, @y)
>+ * Returns: the offset (as a #gint) at the point (@x, @y)
>  *       in the specified coordinate system.
>  *
>  **/
>@@ -543,17 +553,18 @@ atspi_text_get_offset_at_point (AtspiText *obj,
> /**
>  * atspi_text_get_range_extents:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @start_offset: an integer indicating the offset of the first text character for
>+ * @start_offset: a #gint indicating the offset of the first text character for
>  *        whom boundary information is requested.
>- * @end_offset: an integer indicating the offset of the text character
>+ * @end_offset: a #gint indicating the offset of the text character
>  *        after the last character for whom boundary information is requested.
>  * @type: an #AtspiCoordType indicating the coordinate system to use
>  *        for the returned values.
>  *
>- * Returns: A #AtspiRect giving the position and size of the specified range
>+ * Gets the bounding box for text within a range in an  #AtspiText object.
>+ *
>+ * Returns: An #AtspiRect giving the position and size of the specified range
>  *          of text.
>  *
>- * Get the bounding box for text within a range in an  #AtspiText object.
>  **/
> AtspiRect *
> atspi_text_get_range_extents (AtspiText *obj,
>@@ -595,7 +606,7 @@ atspi_text_get_range_extents (AtspiText *obj,
>  * @clipTypeY: an #AtspiTextClipType indicating how to treat characters that
>  *        intersect the bounding box's y extents.
>  *
>- * Get the ranges of text from an #AtspiText object which lie within the
>+ * Gets the ranges of text from an #AtspiText object which lie within the
>  *          bounds defined by (@x, @y) and (@x+@width, @y+@height).
>  *
>  * Returns: (transfer full) (element-type AtspiTextRange*): a null-terminated list of
>@@ -628,10 +639,10 @@ atspi_text_get_bounded_ranges (AtspiText *obj,
>  * atspi_text_get_n_selections:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>  *
>- * Get the number of active non-contiguous selections for an
>+ * Gets the number of active non-contiguous selections for an
>  *          #AtspiText object.
>  *
>- * Returns: a long integer indicating the current
>+ * Returns: a #gint indicating the current
>  *          number of non-contiguous text selections active
>  *          within an #AtspiText object.
>  **/
>@@ -648,15 +659,11 @@ atspi_text_get_n_selections (AtspiText *obj, GError **error)
> }
> 
> /**
>- * atspi_text_get_sSelection:
>+ * atspi_text_get_selection:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @selection_num: an integer indicating which selection to query.
>- * @start_offset: a pointer to a long integer into which the start offset
>- *           of the selection will be returned.
>- * @end_offset: a pointer to a long integer into which the start offset
>- *           of the selection will be returned.
>+ * @selection_num: a #gint indicating which selection to query.
>  *
>- * Get the bounds of the @selection_num-th active text selection for an
>+ * Gets the bounds of the @selection_num-th active text selection for an
>  *         #AtspiText object.
>  **/
> AtspiRange *
>@@ -686,7 +693,7 @@ atspi_text_get_selection (AtspiText *obj,
>  * @start_offset: the starting offset of the desired new selection.
>  * @end_offset: the offset of the first character after the new selection.
>  *
>- * Select some text (add a text selection) in an #AtspiText object.
>+ * Selects some text (adds a text selection) in an #AtspiText object.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>  **/
>@@ -706,10 +713,9 @@ atspi_text_add_selection (AtspiText *obj,
> /**
>  * atspi_text_remove_selection:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>- * @selection_num: an integer indicating which (possibly of several)
>- *         text selection to remove.
>+ * @selection_num: a #gint indicating which text selection to remove.
>  *
>- * De-select a text selection.
>+ * De-selects a text selection.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>  **/
>@@ -732,11 +738,11 @@ atspi_text_remove_selection (AtspiText *obj,
>  * atspi_text_set_selection:
>  * @obj: a pointer to the #AtspiText object on which to operate.
>  * @selection_num: a zero-offset index indicating which text selection to modify.
>- * @start_offset: a long int, the new starting offset for the selection.
>- * @end_offset: a long int, the desired new offset of the first character
>+ * @start_offset: a #gint indicating the new starting offset for the selection.
>+ * @end_offset: a #gint indicating the desired new offset of the first character
>  *             after the selection.
>  *
>- * Change the bounds of an existing #AtspiText text selection.
>+ * Changes the bounds of an existing #AtspiText text selection.
>  *
>  * Returns: #TRUE if successful, #FALSE otherwise.
>  **/
>-- 
>1.7.5.1
>
>
>From 009ad3a016ba1ab4d6d8c97e59a346d685175245 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 26 Jul 2011 14:29:57 -0300
>Subject: [PATCH 2/2] Adding descriptions to atspi-text
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-text.sgml      |   10 ++++++++--
> 2 files changed, 21 insertions(+), 2 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-text.sgml b/doc/libatspi/tmpl/atspi-text.sgml
>index 0a4bdaa..961edcb 100644
>--- a/doc/libatspi/tmpl/atspi-text.sgml
>+++ b/doc/libatspi/tmpl/atspi-text.sgml
>@@ -2,11 +2,17 @@
> atspi-text
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface implemented by objects which place textual
>+information onscreen.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+The text interface should be implemented by objects which place textual
>+information onscreen as character strings or glyphs. The text interface
>+allows access to textual content including display attributes and 
>+semantic hints associated with runs of text, and to bounding boc
>+information for glyphs and substrings. It also alows portions of text to
>+be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

It seems there are several patches here that have not yet been reviewed or committed. Could either Aline or Mike please see what the story is and either comment regarding their state and/or update their status? Thanks!

I think most of these patches -- or all of them -- have already been reviewed/commented by Mike, but they were not commited yet. I can't commit them, unfortunately.

Comment on attachment 193325 [details] [review]
Some documentation improvements for atspi-hyperlink






>From ca66ed2b8abbfe2ed647d4cdad05043763713c39 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 19:02:16 -0300
>Subject: [PATCH 1/2] Improving atspi-hyperlink documentation
>
>---
> atspi/atspi-hyperlink.c |   34 ++++++++++++++++++----------------
> 1 files changed, 18 insertions(+), 16 deletions(-)
>
>diff --git a/atspi/atspi-hyperlink.c b/atspi/atspi-hyperlink.c
>index 2397bba..71e1651 100644
>--- a/atspi/atspi-hyperlink.c
>+++ b/atspi/atspi-hyperlink.c
>@@ -52,11 +52,12 @@ _atspi_hyperlink_new (AtspiApplication *app, const gchar *path)
>  * atspi_hyperlink_get_n_anchors:
>  * @obj: a pointer to the #AtspiHyperlink object on which to operate.
>  *
>- * Get the total number of anchors which an #AtspiHyperlink implementor has.
>- *       Though typical hyperlinks have only one anchor, client-side image maps and
>- *       other hypertext objects may potentially activate or refer to multiple
>- *       URIs.  For each anchor there is a corresponding URI and object.
>- * see atspi_hyperlink_get_uri() and atspi_hyperlink_get_object().
>+ * Gets the total number of anchors which an #AtspiHyperlink implementor has.
>+ * Though typical hyperlinks have only one anchor, client-side image maps and
>+ * other hypertext objects may potentially activate or refer to multiple
>+ * URIs.  For each anchor there is a corresponding URI and object.
>+ * 
>+ * see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object.
>  *
>  * Returns: a #gint indicating the number of anchors in this hyperlink.
>  **/
>@@ -77,7 +78,7 @@ atspi_hyperlink_get_n_anchors (AtspiHyperlink *obj, GError **error)
>  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
>  * @i: a (zero-index) integer indicating which hyperlink anchor to query.
>  *
>- * Get the URI associated with a particular hyperlink anchor.  
>+ * Gets the URI associated with a particular hyperlink anchor.  
>  *
>  * Returns: a UTF-8 string giving the URI of the @ith hyperlink anchor.
>  **/
>@@ -100,9 +101,10 @@ atspi_hyperlink_get_uri (AtspiHyperlink *obj, int i, GError **error)
> /**
>  * atspi_hyperlink_get_object:
>  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
>- * @i: a (zero-index) long integer indicating which hyperlink anchor to query.
>+ * @i: a (zero-index) #gint indicating which hyperlink anchor to query.
>  *
>- * Get the object associated with a particular hyperlink anchor, as an #Accessible. 
>+ * Gets the object associated with a particular hyperlink anchor, as an
>+ * #AtspiAccessible. 
>  *
>  * Returns: (transfer full): an #AtspiAccessible that represents the object
>  *        associated with the @ith anchor of the specified #AtspiHyperlink.
>@@ -125,8 +127,8 @@ atspi_hyperlink_get_object (AtspiHyperlink *obj, gint i, GError **error)
>  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
>  *
>  *
>- * Get the starting and ending character offsets of the text range associated with
>- *       a #AtspiHyperlink, in its originating #AtspiHypertext.
>+ * Gets the starting and ending character offsets of the text range 
>+ * associated with an #AtspiHyperlink, in its originating #AtspiHypertext.
>  **/
> AtspiRange *
> atspi_hyperlink_get_index_range (AtspiHyperlink *obj, GError **error)
>@@ -151,8 +153,8 @@ atspi_hyperlink_get_index_range (AtspiHyperlink *obj, GError **error)
>  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
>  *
>  *
>- * Get the starting character offset of the text range associated with
>- *       a #AtspiHyperlink, in its originating #AtspiHypertext.
>+ * Gets the starting character offset of the text range associated with
>+ *       an #AtspiHyperlink, in its originating #AtspiHypertext.
>  **/
> gint
> atspi_hyperlink_get_start_index (AtspiHyperlink *obj, GError **error)
>@@ -172,8 +174,8 @@ atspi_hyperlink_get_start_index (AtspiHyperlink *obj, GError **error)
>  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
>  *
>  *
>- * Get the ending character offset of the text range associated with
>- *       a #AtspiHyperlink, in its originating #AtspiHypertext.
>+ * Gets the ending character offset of the text range associated with
>+ *       an #AtspiHyperlink, in its originating #AtspiHypertext.
>  **/
> gint
> atspi_hyperlink_get_end_index (AtspiHyperlink *obj, GError **error)
>@@ -194,10 +196,10 @@ atspi_hyperlink_get_end_index (AtspiHyperlink *obj, GError **error)
>  * atspi_hyperlink_is_valid:
>  * @obj: a pointer to the #AtspiHyperlink on which to operate.
>  *
>- * Tell whether an #AtspiHyperlink object is still valid with respect to its
>+ * Tells whether an #AtspiHyperlink object is still valid with respect to its
>  *          originating hypertext object.
>  *
>- * Returns: #TRUE of the specified #AtspiHyperlink is still valid with respect
>+ * Returns: #TRUE if the specified #AtspiHyperlink is still valid with respect
>  *          to its originating #AtspiHypertext object, #FALSE otherwise.
>  **/
> gboolean
>-- 
>1.7.5.1
>
>
>From e32e3081aeb13c4c5ea43cf265494f637202531d Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 19:12:14 -0300
>Subject: [PATCH 2/2] Adding descriptions to atspi-hyperlink documentation
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-hyperlink.sgml |   23 ++++++++++-------------
> doc/libatspi/tmpl/libatspi-unused.sgml |    9 +++++++++
> 3 files changed, 32 insertions(+), 13 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>index 0cae0d5..a9886d7 100644
>--- a/doc/libatspi/tmpl/atspi-hyperlink.sgml
>+++ b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>@@ -1,12 +1,19 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiHyperlink
>+atspi-hyperlink
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+Instances of atspi-hyperlink are the means by which end users
>+and clients interact with linked content.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+ Instances of atspi-hyperlink are returned by 
>+ atspi-hypertext objects, and are the means by 
>+ which end users and clients interact with linked,
>+ and in some cases embedded, content. These instances
>+ may have multiple "anchors", where an anchor corresponds to a
>+ reference to a particular resource with a corresponding resource 
>+ identified (URI). 
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>@@ -33,16 +40,6 @@ AtspiHyperlink
> 
> @parent_class: 
>
>-<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>-<para>
>-
>-</para>
>-
>-@app: 
>-@path: 
>-@Returns: 
>-
>-
> <!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### -->
> <para>
> 
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2f0d56d 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,12 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>+<para>
>+
>+</para>
>+
>+@app: 
>+@path: 
>+@Returns: 
>+
>-- 
>1.7.5.1
>

Comment on attachment 193107 [details] [review]
Some documentation improvements for atspi-devicelistener

This was committed a while ago, but status was not updated.




>From f25f6de13f3104f956cf327c13948dbc2851a862 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 21:44:54 -0300
>Subject: [PATCH 1/2] Improving atspi-devicelistener documentation.
>
>---
> atspi/atspi-device-listener.c |   27 ++++++++++++++-------------
> atspi/atspi-device-listener.h |   10 +++++-----
> 2 files changed, 19 insertions(+), 18 deletions(-)
>
>diff --git a/atspi/atspi-device-listener.c b/atspi/atspi-device-listener.c
>index 6f7d9cf..9770ed3 100644
>--- a/atspi/atspi-device-listener.c
>+++ b/atspi/atspi-device-listener.c
>@@ -211,9 +211,9 @@ G_DEFINE_TYPE (AtspiDeviceListener, atspi_device_listener,
>  * @user_data: (closure): a pointer to data which will be passed to the
>  * callback when invoked.
>  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
>- * and data associated with the callback should be freed.  Can be NULL.
>+ * and data associated with the callback should be freed. It can be NULL.
>  *
>- * Create a new #AtspiDeviceListener with a specified callback function.
>+ * Creates a new #AtspiDeviceListener with a specified callback function.
>  *
>  * Returns: (transfer full): a pointer to a newly-created #AtspiDeviceListener.
>  *
>@@ -232,14 +232,15 @@ atspi_device_listener_new (AtspiDeviceListenerCB callback,
> }
> 
> /**
>- * atspi_device_listener_new_simple: (skip):
>+ * atspi_device_listener_new_simple:
>  * @callback: (scope notified): an #AtspiDeviceListenerCB callback function,
>  *            or NULL.
>  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
>- * and data associated with the callback should be freed.  Can be NULL.
>+ * and data associated with the callback should be freed.  It an be NULL.
>  *
>- * Create a new #AtspiDeviceListener with a specified callback function.
>- * Like atspi_device_listener_new, but callback takes no user data.
>+ * Creates a new #AtspiDeviceListener with a specified callback function.
>+ * This method is similar to #atspi_device_listener_new, but callback
>+ * takes no user data.
>  *
>  * Returns: a pointer to a newly-created #AtspiDeviceListener.
>  *
>@@ -255,12 +256,12 @@ atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback,
>  * atspi_device_listener_add_callback:
>  * @listener: the #AtspiDeviceListener instance to modify.
>  * @callback: (scope notified): an #AtspiDeviceListenerCB function pointer.
>- * @user_data: (closure): a pointer to data which will be passed to the
>- *             callback when invoked.
>  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
>- * and data associated with the callback should be freed.  Can be NULL.
>+ * and data associated with the callback should be freed. It can be NULL.
>+ * @user_data: (closure): a pointer to data which will be passed to the
>+ *             callback when invoked. 
>  *
>- * Add an in-process callback function to an existing #AtspiDeviceListener.
>+ * Adds an in-process callback function to an existing #AtspiDeviceListener.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>  *
>@@ -291,7 +292,8 @@ atspi_device_listener_add_callback (AtspiDeviceListener  *listener,
>  * @listener: the #AtspiDeviceListener instance to modify.
>  * @callback: (scope call): an #AtspiDeviceListenerCB function pointer.
>  *
>- * Remove an in-process callback function from an existing #AtspiDeviceListener.
>+ * Removes an in-process callback function from an existing 
>+ * #AtspiDeviceListener.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>  *
>@@ -404,8 +406,7 @@ done:
> 
> gchar *
> _atspi_device_listener_get_path (AtspiDeviceListener *listener)
>-{
>-  return g_strdup_printf ("/org/a11y/atspi/listeners/%d", listener->id);
>+{  return g_strdup_printf ("/org/a11y/atspi/listeners/%d", listener->id);
> }
> 
> G_DEFINE_BOXED_TYPE (AtspiDeviceEvent,
>diff --git a/atspi/atspi-device-listener.h b/atspi/atspi-device-listener.h
>index 169738c..2e785d1 100644
>--- a/atspi/atspi-device-listener.h
>+++ b/atspi/atspi-device-listener.h
>@@ -38,8 +38,8 @@
>  *
>  * A callback function prototype via which clients receive device event notifications.
>  *
>- * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
>- * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
>+ * Returns: #TRUE if the client wishes to consume/preempt the event, preventing it from being
>+ * relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal.
>  **/
> typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
> 						     void                      *user_data);
>@@ -49,10 +49,10 @@ typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
>  * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
>  *          being received.
>  *
>- * Like #AtspiDeviceListenerCB but with no user data.
>+ * Similar to #AtspiDeviceListenerCB, but with no user data.
>  *
>- * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
>- * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
>+ * Returns: #TRUE if the client wishes to consume/preempt the event, preventing it from being
>+ * relayed to the currently focussed application, #FALSE if the event delivery should proceed as normal.
>  **/
> typedef gboolean (*AtspiDeviceListenerSimpleCB)    (const AtspiDeviceEvent *stroke);
> 
>-- 
>1.7.5.1
>
>
>From efd67c6098a0c3a829a001a224c973802d06b2f2 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Tue, 2 Aug 2011 21:50:25 -0300
>Subject: [PATCH 2/2] Adding descriptions for atspi-devicelistener.
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml       |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-device-listener.sgml |    8 +++++---
> 2 files changed, 18 insertions(+), 3 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-device-listener.sgml b/doc/libatspi/tmpl/atspi-device-listener.sgml
>index 6e007c8..f1f3de1 100644
>--- a/doc/libatspi/tmpl/atspi-device-listener.sgml
>+++ b/doc/libatspi/tmpl/atspi-device-listener.sgml
>@@ -1,12 +1,14 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiDeviceListener
>+atspi-devicelistener
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+An interface for creating and manipulating
>+device listeners.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+An interface for creating and manipulating
>+device listeners with callback functions.
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>-- 
>1.7.5.1
>

Comment on attachment 193327 [details] [review]
Some documentation improvements for atspi-event-listener

This was committed a while ago, but status was never updated.




>From 3401cd900a446cca716b8a6251a956d2241216ba Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 20:17:38 -0300
>Subject: [PATCH 1/2] Improving atspi-event-listener documentation
>
>---
> atspi/atspi-event-listener.c |   35 ++++++++++++++++++++++++-----------
> 1 files changed, 24 insertions(+), 11 deletions(-)
>
>diff --git a/atspi/atspi-event-listener.c b/atspi/atspi-event-listener.c
>index 18cad17..309ac31 100644
>--- a/atspi/atspi-event-listener.c
>+++ b/atspi/atspi-event-listener.c
>@@ -122,6 +122,8 @@ callback_unref (gpointer callback)
>  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
>  * and data associated with the callback should be freed.  Can be NULL.
>  *
>+ * Creates a new #AtspiEventListener associated with a specified @callback.
>+ *
>  * Returns: (transfer full): A new #AtspiEventListener.
>  */
> AtspiEventListener *
>@@ -138,14 +140,15 @@ atspi_event_listener_new (AtspiEventListenerCB callback,
> }
> 
> /**
>- * atspi_event_listener_new_simple: (skip)
>+ * atspi_event_listener_new_simple:
>  * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
>  * when an event is fired.
>  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
>  * and data associated with the callback should be freed.  Can be NULL.
>  *
>+ * Creates a new #AtspiEventListener associated with a specified @callback.
>  * Returns: (transfer full): A new #AtspiEventListener.
>- */
>+ **/
> AtspiEventListener *
> atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
>                                  GDestroyNotify callback_destroyed)
>@@ -401,6 +404,8 @@ listener_entry_free (EventListenerEntry *e)
>  *            and toolkit events (e.g. "Gtk", "AWT").
>  *            Examples: "focus:", "Gtk:GtkWidget:button_press_event".
>  *
>+ * Adds an in-process callback function to an existing #AtspiEventListener.
>+ *
>  * Legal object event types:
>  *
>  *    (property change events)
>@@ -468,13 +473,13 @@ listener_entry_free (EventListenerEntry *e)
>  *            mouse:b3p
>  *            mouse:b3r
>  *
>- * NOTE: this string may be UTF-8, but should not contain byte value 56
>+ * NOTE: this character string may be UTF-8, but should not contain byte 
>+ * value 56
>  *            (ascii ':'), except as a delimiter, since non-UTF-8 string
>  *            delimiting functions are used internally.
>  *            In general, listening to
>  *            toolkit-specific events is not recommended.
>  *
>- * Add an in-process callback function to an existing AtspiEventListener.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>  **/
>@@ -494,14 +499,19 @@ atspi_event_listener_register (AtspiEventListener *listener,
> 
> /**
>  * atspi_event_listener_register_from_callback:
>- * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
>- *            an event type.
>+ * @callback: (scope notified): the #AtspiEventListenerCB to be registered 
>+ * against an event type.
>  * @user_data: (closure): User data to be passed to the callback.
>  * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
>  * @event_type: a character string indicating the type of events for which
>  *            notification is requested.  See #atspi_event_listener_register
>  * for a description of the format.
>- */
>+ * 
>+ * Registers an #AtspiEventListenerCB against an @event_type.
>+ *
>+ * Returns: #TRUE if successfull, otherwise #FALSE.
>+ *
>+ **/
> gboolean
> atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
> 				             void *user_data,
>@@ -568,7 +578,7 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
> }
> 
> /**
>- * atspi_event_listener_register_no_data: (skip)
>+ * atspi_event_listener_register_no_data:
>  * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
>  *            registered against an event type.
>  * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
>@@ -580,7 +590,10 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
>  *            and toolkit events (e.g. "Gtk", "AWT").
>  *            Examples: "focus:", "Gtk:GtkWidget:button_press_event".
>  *
>- * Like atspi_event_listener_register, but callback takes no user_data.
>+ * Registers an #AtspiEventListenetSimpleCB. The method is similar to 
>+ * #atspi_event_listener_register, but @callback takes no user_data.
>+ *
>+ * Returns: #TRUE if successfull, otherwise #FALSE.
>  **/
> gboolean
> atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
>@@ -607,7 +620,7 @@ is_superset (const gchar *super, const gchar *sub)
>  * @event_type: a string specifying the event type for which this
>  *             listener is to be deregistered.
>  *
>- * deregisters an #AtspiEventListener from the registry, for a specific
>+ * Deregisters an #AtspiEventListener from the registry, for a specific
>  *             event type.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>@@ -630,7 +643,7 @@ atspi_event_listener_deregister (AtspiEventListener *listener,
>  * @event_type: a string specifying the event type for which this
>  *             listener is to be deregistered.
>  *
>- * deregisters an #AtspiEventListenerCB from the registry, for a specific
>+ * Deregisters an #AtspiEventListenerCB from the registry, for a specific
>  *             event type.
>  *
>  * Returns: #TRUE if successful, otherwise #FALSE.
>-- 
>1.7.5.1
>
>
>From 328f54e10e1afe68ec0a3e1a3bff1712be947049 Mon Sep 17 00:00:00 2001
>From: Aline Bessa <alibezz@gmail.com>
>Date: Fri, 5 Aug 2011 20:23:09 -0300
>Subject: [PATCH 2/2] Adding descriptions to atspi-event-listener
> documentation
>
>---
> doc/libatspi/tmpl/atspi-constants.sgml      |   13 +++++++++++++
> doc/libatspi/tmpl/atspi-event-listener.sgml |   10 +++++++---
> doc/libatspi/tmpl/atspi-hyperlink.sgml      |   10 ----------
> doc/libatspi/tmpl/libatspi-unused.sgml      |    9 +++++++++
> 4 files changed, 29 insertions(+), 13 deletions(-)
>
>diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml
>index 862bcd2..805e44c 100644
>--- a/doc/libatspi/tmpl/atspi-constants.sgml
>+++ b/doc/libatspi/tmpl/atspi-constants.sgml
>@@ -424,6 +424,19 @@ atspi-constants
> @ATSPI_ROLE_FORM: 
> @ATSPI_ROLE_LINK: 
> @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
>+@ATSPI_ROLE_TABLE_ROW: 
>+@ATSPI_ROLE_TREE_ITEM: 
>+@ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
>+@ATSPI_ROLE_DOCUMENT_PRESENTATION: 
>+@ATSPI_ROLE_DOCUMENT_TEXT: 
>+@ATSPI_ROLE_DOCUMENT_WEB: 
>+@ATSPI_ROLE_DOCUMENT_EMAIL: 
>+@ATSPI_ROLE_COMMENT: 
>+@ATSPI_ROLE_LIST_BOX: 
>+@ATSPI_ROLE_GROUPING: 
>+@ATSPI_ROLE_IMAGE_MAP: 
>+@ATSPI_ROLE_NOTIFICATION: 
>+@ATSPI_ROLE_INFO_BAR: 
> @ATSPI_ROLE_LAST_DEFINED: 
> 
> <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-event-listener.sgml b/doc/libatspi/tmpl/atspi-event-listener.sgml
>index 00b0d79..118e42d 100644
>--- a/doc/libatspi/tmpl/atspi-event-listener.sgml
>+++ b/doc/libatspi/tmpl/atspi-event-listener.sgml
>@@ -1,12 +1,16 @@
> <!-- ##### SECTION Title ##### -->
>-AtspiEventListener
>+atspi-event-listener
> 
> <!-- ##### SECTION Short_Description ##### -->
>-
>+A generic interface implemented by objects for the receipt of event 
>+notifications.
> 
> <!-- ##### SECTION Long_Description ##### -->
> <para>
>-
>+A generic interface implemented by objects for the receipt of event 
>+notifications. atspi-event-listener is the interface via which clients of 
>+the atspi-registry receive notification of changes to an application's user 
>+interface and content. 
> </para>
> 
> <!-- ##### SECTION See_Also ##### -->
>diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>index 0cae0d5..dc6eab3 100644
>--- a/doc/libatspi/tmpl/atspi-hyperlink.sgml
>+++ b/doc/libatspi/tmpl/atspi-hyperlink.sgml
>@@ -33,16 +33,6 @@ AtspiHyperlink
> 
> @parent_class: 
> 
>-<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>-<para>
>-
>-</para>
>-
>-@app: 
>-@path: 
>-@Returns: 
>-
>-
> <!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### -->
> <para>
> 
>diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml
>index c12bdb1..2f0d56d 100644
>--- a/doc/libatspi/tmpl/libatspi-unused.sgml
>+++ b/doc/libatspi/tmpl/libatspi-unused.sgml
>@@ -50,3 +50,12 @@
> @data: 
> @Returns: 
> 
>+<!-- ##### FUNCTION atspi_hyperlink_new ##### -->
>+<para>
>+
>+</para>
>+
>+@app: 
>+@path: 
>+@Returns: 
>+
>-- 
>1.7.5.1
>

Thanks; it seems that I overlooked 193277 (types) and 193325 (hyperlink).

Everything is committed now as far as I can tell.

[Resetting QA Contact to newly introduced "at-spi-maint@gnome.bugs". 
Reason: So far it was impossible to watch changes in at-spi bug reports without following all the specific persons (Li Yuan, Bill Haneman, Jeff Wai, ...) and also their activity outside of at-spi reports.

IMPORTANT: Anyone interested in following all bug activity (including all maintainers) must watch the "at-spi-maint@gnome.bugs" dummy user by adding it to the 'Users to watch' list under Preferences->Email preferences. This is also the default procedure nowadays in GNOME when setting up new products.]

[Mass-resetting default assignee, see bug 705890. Please reclaim this bug report by setting the assignee to yourself if you still plan to work on this. Thanks!]

(In reply to comment #74)
> Thanks; it seems that I overlooked 193277 (types) and 193325 (hyperlink).
> 
> Everything is committed now as far as I can tell.

All the patches seems to be committed. Any reason to keep the bug open?

(In reply to Alejandro Piñeiro Iglesias (IRC: infapi00) from comment #77)
> All the patches seems to be committed. Any reason to keep the bug open?

No reply; closing.