summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-11-29 19:27:49 +0100
committerJavier Jardón <jjardon@gnome.org>2010-11-29 19:51:25 +0100
commit0edfe5f8e702d526e916b6ccd737441ed074e7e4 (patch)
treec2de2506bd04a1e82a72b43153c149293a5f8d0f
parent2bdf93aa170f079f53bf37ac59586258e44e27df (diff)
downloadatk-0edfe5f8e702d526e916b6ccd737441ed074e7e4.tar.gz
docs: Add AtkSocket and AtkPlug to the docs
-rw-r--r--atk/atkplug.c2
-rw-r--r--atk/atksocket.c4
-rw-r--r--docs/atk-docs.sgml4
-rw-r--r--docs/atk-sections.txt35
4 files changed, 45 insertions, 0 deletions
diff --git a/atk/atkplug.c b/atk/atkplug.c
index 0da67af..242e947 100644
--- a/atk/atkplug.c
+++ b/atk/atkplug.c
@@ -65,6 +65,8 @@ atk_plug_new (void)
* of an #AtkSocket using atk_socket_embed().
*
* Returns: the unique ID for the plug
+ *
+ * Since: 1.30
**/
gchar*
atk_plug_get_id (AtkPlug* obj)
diff --git a/atk/atksocket.c b/atk/atksocket.c
index 197c80e..7886e07 100644
--- a/atk/atksocket.c
+++ b/atk/atksocket.c
@@ -64,6 +64,8 @@ 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.
+ *
+ * Since: 1.30
**/
void
atk_socket_embed (AtkSocket* obj, gchar* plug_id)
@@ -90,6 +92,8 @@ atk_socket_embed (AtkSocket* obj, gchar* plug_id)
* Determines whether or not the socket has an embedded plug.
*
* Returns: TRUE if a plug is embedded in the socket
+ *
+ * Since: 1.30
**/
gboolean
atk_socket_is_occupied (AtkSocket* obj)
diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index 2685e97..1aad45c 100644
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -12,12 +12,14 @@
<!ENTITY atk-AtkImage SYSTEM "xml/atkimage.xml">
<!ENTITY atk-AtkNoOpObject SYSTEM "xml/atknoopobject.xml">
<!ENTITY atk-AtkNoOpObjectFactory SYSTEM "xml/atknoopobjectfactory.xml">
+ <!ENTITY atk-AtkPlug SYSTEM "xml/atkplug.xml">
<!ENTITY atk-AtkObject SYSTEM "xml/atkobject.xml">
<!ENTITY atk-AtkObjectFactory SYSTEM "xml/atkobjectfactory.xml">
<!ENTITY atk-AtkRegistry SYSTEM "xml/atkregistry.xml">
<!ENTITY atk-AtkRelation SYSTEM "xml/atkrelation.xml">
<!ENTITY atk-AtkRelationSet SYSTEM "xml/atkrelationset.xml">
<!ENTITY atk-AtkSelection SYSTEM "xml/atkselection.xml">
+ <!ENTITY atk-AtkSocket SYSTEM "xml/atksocket.xml">
<!ENTITY atk-AtkState SYSTEM "xml/atkstate.xml">
<!ENTITY atk-AtkStateSet SYSTEM "xml/atkstateset.xml">
<!ENTITY atk-AtkStreamableContent SYSTEM "xml/atkstreamablecontent.xml">
@@ -50,10 +52,12 @@
&atk-AtkNoOpObjectFactory;
&atk-AtkObject;
&atk-AtkObjectFactory;
+ &atk-AtkPlug;
&atk-AtkRegistry;
&atk-AtkRelation;
&atk-AtkRelationSet;
&atk-AtkSelection;
+ &atk-AtkSocket;
&atk-AtkState;
&atk-AtkStateSet;
&atk-AtkStreamableContent;
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index b388f9d..3432424 100644
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -595,3 +595,38 @@ ATK_IS_GOBJECT_ACCESSIBLE_CLASS
ATK_GOBJECT_ACCESSIBLE_GET_CLASS
AtkGObjectAccessibleClass
</SECTION>
+
+<SECTION>
+<FILE>atkplug</FILE>
+<TITLE>AtkPlug</TITLE>
+AtkPlug
+atk_plug_new
+atk_plug_get_id
+<SUBSECTION Standard>
+ATK_IS_PLUG
+ATK_IS_PLUG_CLASS
+ATK_PLUG
+ATK_PLUG_CLASS
+ATK_PLUG_GET_CLASS
+ATK_TYPE_PLUG
+AtkPlugClass
+atk_plug_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atksocket</FILE>
+<TITLE>AtkSocket</TITLE>
+AtkSocket
+atk_socket_new
+atk_socket_embed
+atk_socket_is_occupied
+<SUBSECTION Standard>
+ATK_IS_SOCKET
+ATK_IS_SOCKET_CLASS
+ATK_SOCKET
+ATK_SOCKET_CLASS
+ATK_SOCKET_GET_CLASS
+ATK_TYPE_SOCKET
+AtkSocketClass
+atk_socket_get_type
+</SECTION>