Remove comments about signals. The description should be in files in

[platform/upstream/atk.git] / docs / tmpl / atkselection.sgml

diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml
index 0169daa..b3a6148 100644 (file)
--- a/docs/tmpl/atkselection.sgml
+++ b/docs/tmpl/atkselection.sgml
@@ -2,41 +2,35 @@
 AtkSelection
 
 <!-- ##### SECTION Short_Description ##### -->
-accessibility interface for determining what the current selected 
-children are, as well as modify the selection set
+
+The ATK interface implemented by container objects whose #AtkObject children
+can be selected.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-The AtkSelection interface provides the standard mechanism for an 
-assistive technology to determine what the current selected children are, 
-as well as modify the selection set. Any object that has children that 
-can be selected should support the AtkSelection interface.
+#AtkSelection should be implemented by UI components with children which
+are exposed by #atk_object_ref_child and #atk_object_get_n_children, if
+the use of the parent UI component ordinarily involves selection of one
+or more of the objects corresponding to those #AtkObject children - for
+example, selectable lists.
 </para>
-
-<!-- ##### SECTION See_Also ##### -->
 <para>
-
+Note that other types of "selection" (for instance text selection) are
+accomplished a other ATK interfaces - #AtkSelection is limited to the
+selection/deselection of children.
 </para>
 
-<!-- ##### STRUCT AtkSelection ##### -->
+<!-- ##### SECTION See_Also ##### -->
 <para>
-
+#AtkText
 </para>
 
-
-<!-- ##### STRUCT AtkSelectionIface ##### -->
+<!-- ##### STRUCT AtkSelection ##### -->
 <para>
+The AtkAction structure does not contain any fields.
 
 </para>
 
-@parent: 
-@add_selection: 
-@clear_selection: 
-@ref_selection: 
-@get_selection_count: 
-@is_child_selected: 
-@remove_selection: 
-@select_all_selection: 
 
 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
 <para>
@@ -45,7 +39,6 @@ can be selected should support the AtkSelection interface.
 
 @selection: 
 @i: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -55,7 +48,6 @@ can be selected should support the AtkSelection interface.
 </para>
 
 @selection: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -95,7 +87,6 @@ can be selected should support the AtkSelection interface.
 
 @selection: 
 @i: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
@@ -105,7 +96,14 @@ can be selected should support the AtkSelection interface.
 </para>
 
 @selection: 
-<!-- # Unused Parameters # -->
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
+<para>
+The "selection-changed" signal is emitted by an object which implements 
+AtkSelection interface when the selection changes.
+</para>
+
+@atkselection: the object which received the signal.
+