From e03077a4cdb3049fb6c25fb88838d1570695cb78 Mon Sep 17 00:00:00 2001 From: Mike Gorse Date: Fri, 13 May 2011 18:40:30 +0200 Subject: [PATCH] BGO#649307: Clarify AtkPlug and AtkSocket docs --- atk/atkplug.c | 5 +++++ atk/atksocket.c | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/atk/atkplug.c b/atk/atkplug.c index 242e947..9445df3 100644 --- a/atk/atkplug.c +++ b/atk/atkplug.c @@ -63,6 +63,11 @@ atk_plug_new (void) * * 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. * * Returns: the unique ID for the plug * diff --git a/atk/atksocket.c b/atk/atksocket.c index 7886e07..ff31d5d 100644 --- a/atk/atksocket.c +++ b/atk/atksocket.c @@ -64,6 +64,11 @@ atk_socket_new (void) * * 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. * * Since: 1.30 **/ -- 2.7.4