After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 701503 - Fix documentation for atk_object_get_attributes()
Fix documentation for atk_object_get_attributes()
Status: RESOLVED FIXED
Product: atk
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: ATK maintainer(s)
ATK maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2013-06-03 09:51 UTC by Mario Sánchez Prada
Modified: 2013-06-03 10:27 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Patch proposal (1.31 KB, patch)
2013-06-03 09:55 UTC, Mario Sánchez Prada 		committed Details | Review

Description Mario Sánchez Prada 2013-06-03 09:51:47 UTC 
Current documentation for atk_object_get_attributes() is as follows:

  """
  * Returns: (transfer none): an #AtkAttributeSet consisting of all explicit
  * properties/annotations applied to the object, or an empty set if the object
  * has no name-value pair attributes assigned to it.
  """

... which is wrong since it should be stated that is (transfer full) instead, and suggest to use atk_attribute_set_free() to free that memory once used, which is btw what is said for atk_text_get_default_attributes[1], which is a very similar function in the AtkText interface.

I've checked GTK+ and WebKit and they are already assuming transfer-full in their respective implementations, so I would say I fix in the documentation here would be in order.

[1] https://developer.gnome.org/atk/unstable/AtkText.html#atk-text-get-default-attributes
Comment 1 Mario Sánchez Prada 2013-06-03 09:55:07 UTC 
Created attachment 245904 [details] [review]
Patch proposal

This should be enough, I guess
Comment 2 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-03 10:21:45 UTC 
Review of attachment 245904 [details] [review]:

Looks good
Comment 3 Mario Sánchez Prada 2013-06-03 10:25:34 UTC 
Comment on attachment 245904 [details] [review]
Patch proposal

Committed. Thanks!