diff options
author | Alejandro Piñeiro <apinheiro@igalia.com> | 2013-05-14 20:22:50 +0200 |
---|---|---|
committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2013-05-22 15:11:04 +0200 |
commit | 7b852ac441c4728a883be9519153367204590073 (patch) | |
tree | 0e42975cfdc1c29776b5a065d8d10ed5eba02120 | |
parent | 31d9de0dbe8b46695844262e53accc624fdf7ecf (diff) | |
download | atk-7b852ac441c4728a883be9519153367204590073.tar.gz |
docs: Improve documentation for AtkPlug and AtkSocket
https://bugzilla.gnome.org/show_bug.cgi?id=700800
-rw-r--r-- | atk/atkplug.c | 27 | ||||
-rw-r--r-- | atk/atksocket.c | 43 |
2 files changed, 55 insertions, 15 deletions
diff --git a/atk/atkplug.c b/atk/atkplug.c index 9445df3..8a7a362 100644 --- a/atk/atkplug.c +++ b/atk/atkplug.c @@ -20,6 +20,16 @@ #include "atk.h" #include "atkplug.h" +/** + * SECTION:atkplug + * @Short_description: Toplevel for embedding into other processes + * @Title: AtkPlug + * @See_also: #AtkPlug + * + * See #AtkSocket + * + */ + static void atk_component_interface_init (AtkComponentIface *iface); static void atk_plug_class_init (AtkPlugClass *klass); @@ -58,16 +68,17 @@ atk_plug_new (void) } /** - * atk_plug_get_plug_id: + * atk_plug_get_id: * @obj: an #AtkPlug * - * Gets the unique ID of an #AtkPlug object, which can be used to embed inside - * of an #AtkSocket using atk_socket_embed(). - * Internally, this calls a class function that should be registered by the - * IPC layer (eg, at-spi2-atk). The implementor of an AtkSocket object - * should call this function (after atk-bridge is loaded) and pass the value - * to the process implementing the AtkPlug into which the AtkSocket is - * embedded. + * Gets the unique ID of an #AtkPlug object, which can be used to + * embed inside of an #AtkSocket using atk_socket_embed(). + * + * Internally, this calls a class function that should be registered + * by the IPC layer (usually at-spi2-atk). The implementor of an + * #AtkPlug object should call this function (after atk-bridge is + * loaded) and pass the value to the process implementing the + * #AtkSocket, so it could embed the plug. * * Returns: the unique ID for the plug * diff --git a/atk/atksocket.c b/atk/atksocket.c index cf36377..02847cf 100644 --- a/atk/atksocket.c +++ b/atk/atksocket.c @@ -20,6 +20,32 @@ #include "atk.h" #include "atksocket.h" +/** + * SECTION:atksocket + * @Short_description: Container for AtkPlug objects from other processes + * @Title: AtkSocket + * @See_also: #AtkPlug + * + * Together with #AtkPlug, #AtkSocket provides the ability to embed + * accessibles from one process into another in a fashion that is + * transparent to assistive technologies. #AtkSocket works as the + * container of #AtkPlug, embedding it using the method + * atk_socket_embed(). Any accessible contained in the #AtkPlug will + * appear to the assistive technologies as being inside the + * application that created the #AtkSocket. + * + * The communication between a #AtkSocket and a #AtkPlug is done by + * the IPC layer of the accessibility framework, normally implemented + * by the D-Bus based implementation of AT-SPI (at-spi2). If that is + * the case, at-spi-atk2 is the responsible to implement the abstract + * methods atk_plug_get_id() and atk_socket_embed(), so an ATK + * implementor shouldn't reimplement them. The process that contains + * the #AtkPlug is responsible to send the ID returned by + * atk_plug_id() to the process that contains the #AtkSocket, so it + * could call the method atk_socket_embed() in order to embed it. + * + */ + static void atk_socket_class_init (AtkSocketClass *klass); static void atk_socket_finalize (GObject *obj); @@ -78,13 +104,16 @@ atk_socket_new (void) * @obj: an #AtkSocket * @plug_id: the ID of an #AtkPlug * - * Embeds the children of an #AtkPlug as the children of the #AtkSocket. The - * plug may be in the same process or in a different process. - * THe class item used by this function should be filled in by the IPC layer - * (ie, at-spi2-atk). The implementor of the AtkSocket should call this - * function and pass the id for the plug as returned by atk_plug_get_id. - * It is the responsibility of the application to pass the plug id on to - * the process implementing the AtkSocket as needed. + * Embeds the children of an #AtkPlug as the children of the + * #AtkSocket. The plug may be in the same process or in a different + * process. + * + * The class item used by this function should be filled in by the IPC + * layer (usually at-spi2-atk). The implementor of the AtkSocket + * should call this function and pass the id for the plug as returned + * by atk_plug_get_id(). It is the responsibility of the application + * to pass the plug id on to the process implementing the #AtkSocket + * as needed. * * Since: 1.30 **/ |