doc: update documentation for selected_link method and property

[platform/upstream/atk.git] / atk / atkplug.c

diff --git a/atk/atkplug.c b/atk/atkplug.c
index 242e947..8a7a362 100644 (file)
--- 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,11 +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().
+ * 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
  *