summaryrefslogtreecommitdiff
path: root/atk/atksocket.c
diff options
context:
space:
mode:
authorMike Gorse <mgorse@linux-l2tz.site>2011-05-13 18:40:30 +0200
committerMike Gorse <mgorse@linux-l2tz.site>2011-05-13 18:40:30 +0200
commite03077a4cdb3049fb6c25fb88838d1570695cb78 (patch)
treead107cf2301a5c66eb60673898f2bc43aeb6e378 /atk/atksocket.c
parent7eb0e3abb5931ea1937ea71889f2d23d8fd7bd04 (diff)
downloadatk-e03077a4cdb3049fb6c25fb88838d1570695cb78.tar.gz
BGO#649307: Clarify AtkPlug and AtkSocket docs
Diffstat (limited to 'atk/atksocket.c')
-rw-r--r--atk/atksocket.c5
1 files changed, 5 insertions, 0 deletions
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
**/