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 684705 - AtkText insert-text, remove-text and update-text lacks documentation
AtkText insert-text, remove-text and update-text lacks documentation
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: 2012-09-24 10:42 UTC by Alejandro Piñeiro Iglesias (IRC: infapi00)
Modified: 2013-08-13 09:49 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Adds the documentation (1.94 KB, patch)
2012-09-24 10:46 UTC, Alejandro Piñeiro Iglesias (IRC: infapi00)
none Details | Review

Description Alejandro Piñeiro Iglesias (IRC: infapi00) 2012-09-24 10:42:08 UTC
This signals were added by this bug:

https://bugzilla.gnome.org/show_bug.cgi?id=638377

They don't have any documentation at all, and don't mark text-changed as deprecated.
Comment 1 Alejandro Piñeiro Iglesias (IRC: infapi00) 2012-09-24 10:46:57 UTC
Created attachment 225054 [details] [review]
Adds the documentation

This patch update the documentation for AtkText:: signals:

     * text-changed: marked as deprecated
     * text-insert: explain usage and parameters
     * text-remove: explain usage and parameters

The pending thing is text-update. Anyway, I don't know which documentation to add. I made the same question when the signals were added:
https://mail.gnome.org/archives/gnome-accessibility-devel/2010-December/msg00008.html

Almost two years ago, wihout answer. I was able to infer text-insert and text-remove documentation because Mozilla and WebkitGTK are already implementing those signals (GTK and Clutter are still using text-changed::<detail>). Bug 638377 also updated at-spi2-atk, but not used -update at all. As far as I see, nobody is implementing or using text-update. I'm tempted to just remove that signal (it was added without any ABI change, so removing it could be also safe).
Comment 2 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-08-13 09:48:54 UTC
'text-update' is still incomplete, but the other 2 were fixed with this commit:

commit 10782c952a715562a611b7b69d5b20cf3b389519
Author: Alejandro Piñeiro <apinheiro@igalia.com>
Date:   Tue Aug 13 11:46:50 2013 +0200

    doc: little update on 'text-insert' and 'text-remove' documentation
    
    https://bugzilla.gnome.org/show_bug.cgi?id=684705

I will manage 'text-update' outside this bug, as the discussion is still ongoing:
https://mail.gnome.org/archives/gnome-accessibility-devel/2013-August/msg00013.html