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 588083 - [PATCH] Information about return value of some AtkText methods can be clearer
[PATCH] Information about return value of some AtkText methods can be clearer
Status: RESOLVED FIXED
Product: atk
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: Li Yuan
Li Yuan
Depends on:
Blocks:
 
 
Reported: 2009-07-08 15:17 UTC by Alejandro Piñeiro Iglesias (IRC: infapi00)
Modified: 2011-06-02 18:43 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add extra documentation (2.27 KB, patch)
2009-07-08 15:19 UTC, Alejandro Piñeiro Iglesias (IRC: infapi00)
none Details | Review

Description Alejandro Piñeiro Iglesias (IRC: infapi00) 2009-07-08 15:17:37 UTC
In all the following methods:
  atk_text_get_text
  atk_text_get_text_after_offset
  atk_text_get_text_at_offset
  atk_text_get_text_before_offset
  atk_text_get_selection

the documentation says they return a string (gchar *). Although you can extrapolate that this is a newly created string as it returns a gchar*, but not a const gchar*, I think that it should be good to explicitly mention it on the documentation, as it can be confusing at a first sight.

I will add a proposal patch in the next comment.
Comment 1 Alejandro Piñeiro Iglesias (IRC: infapi00) 2009-07-08 15:19:07 UTC
Created attachment 138039 [details] [review]
Add extra documentation

Add extra documentation related to the return value on some atktext methods
Comment 2 Alejandro Piñeiro Iglesias (IRC: infapi00) 2011-06-02 18:43:53 UTC
Patch committed. Closing bug.