Add entries to fix warning when generating documentation.

2004-07-20  Padraig O'Briain  <padraig.obriain@sun.com>

	* docs/atk-sections.txt: Add entries to fix warning when generating
	documentation.

	* docs/tmpl/atkcomponent.sgml docs/tmpl/atkhyperlink.sgml
	docs/tmpl/atkhypertext.sgml docs/tmpl/atkobject.sgml
	docs/tmpl/atkrelation.sgml docs/tmpl/atkselection.sgml
	docs/tmpl/atktable.sgml docs/tmpl/atktext.sgml: Changes to generated
	files.

diff --git a/ChangeLog b/ChangeLog
index 923b125..5e3b2f7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2004-07-20  Padraig O'Briain  <padraig.obriain@sun.com>
 
+       * docs/atk-sections.txt: Add entries to fix warning when generating
+       documentation.
+
+       * docs/tmpl/atkcomponent.sgml docs/tmpl/atkhyperlink.sgml 
+       docs/tmpl/atkhypertext.sgml docs/tmpl/atkobject.sgml 
+       docs/tmpl/atkrelation.sgml docs/tmpl/atkselection.sgml 
+       docs/tmpl/atktable.sgml docs/tmpl/atktext.sgml: Changes to generated
+       files.
+
+2004-07-20  Padraig O'Briain  <padraig.obriain@sun.com>
+
        * ===== Released Version 1.7.2, interface age 2, binary age 702 ====
 
        * NEWS: Updated.

diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index 5e8bca5..9744c1b 100644 (file)
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -40,10 +40,12 @@ AtkComponentIface
 ATK_COMPONENT
 ATK_IS_COMPONENT
 ATK_TYPE_COMPONENT
+ATK_TYPE_RECTANGLE
 ATK_COMPONENT_GET_IFACE
 AtkFocusHandler
 AtkRectangle
 atk_component_get_type
+atk_rectangle_get_type
 </SECTION>
 
 <SECTION>

diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml
index 3ff5e5b..59c2b3e 100644 (file)
--- a/docs/tmpl/atkcomponent.sgml
+++ b/docs/tmpl/atkcomponent.sgml
@@ -32,16 +32,6 @@ The AtkComponent structure does not contain any fields.
 </para>
 
 
-<!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
-<para>
-The 'bounds-changed" signal is emitted when the bposition or size of the 
-a component changes.
-</para>
-
-@atkcomponent: the object which received the signal.
-<!-- # Unused Parameters # -->
-@arg1: The AtkRectangle giving the new position and size.
-
 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
 <para>
 
@@ -183,3 +173,12 @@ a component changes.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkComponent::bounds-changed ##### -->
+<para>
+The 'bounds-changed" signal is emitted when the bposition or size of the 
+a component changes.
+</para>
+
+@atkcomponent: the object which received the signal.
+@arg1: The AtkRectangle giving the new position and size.
+

diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml
index 6489483..3d6708c 100644 (file)
--- a/docs/tmpl/atkhyperlink.sgml
+++ b/docs/tmpl/atkhyperlink.sgml
@@ -22,33 +22,6 @@ The AtkHyperlink structure should not be accessed directly.
 </para>
 
 
-<!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
-<para>
-The signal link-activated is emitted when a link is activated.
-</para>
-
-@atkhyperlink: the object which received the signal.
-
-<!-- ##### ARG AtkHyperlink:end-index ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:selected-link ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkHyperlink:start-index ##### -->
-<para>
-
-</para>
-
 <!-- ##### ENUM AtkHyperlinkStateFlags ##### -->
 <para>
 
@@ -130,3 +103,30 @@ The signal link-activated is emitted when a link is activated.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
+<para>
+The signal link-activated is emitted when a link is activated.
+</para>
+
+@atkhyperlink: the object which received the signal.
+
+<!-- ##### ARG AtkHyperlink:end-index ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:selected-link ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkHyperlink:start-index ##### -->
+<para>
+
+</para>
+

diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml
index 3b91fdf..e8ba992 100644 (file)
--- a/docs/tmpl/atkhypertext.sgml
+++ b/docs/tmpl/atkhypertext.sgml
@@ -20,15 +20,6 @@ The AtkHypertext structure does not contain any fields.
 </para>
 
 
-<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
-<para>
-The "link-selected" signal is emitted by an AtkHyperText object when one of
-the hyperlinks associated with the object is selected.
-</para>
-
-@atkhypertext: the object which received the signal.
-@arg1: the index of the hyperlink which is selected
-
 <!-- ##### FUNCTION atk_hypertext_get_link ##### -->
 <para>
 
@@ -58,3 +49,12 @@ the hyperlinks associated with the object is selected.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
+<para>
+The "link-selected" signal is emitted by an AtkHyperText object when one of
+the hyperlinks associated with the object is selected.
+</para>
+
+@atkhypertext: the object which received the signal.
+@arg1: the index of the hyperlink which is selected
+

diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml
index 94c56a2..448292d 100644 (file)
--- a/docs/tmpl/atkobject.sgml
+++ b/docs/tmpl/atkobject.sgml
@@ -38,138 +38,6 @@ The AtkObject structure should not be accessed directly.
 </para>
 
 
-<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
-<para>
-The "active-descendant-changed" signal is emitted by an object which has
-the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
-object changes. For instance, a table will emit the signal when the cell
-in the table which has focus changes.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: the newly focused object.
-
-<!-- ##### SIGNAL AtkObject::children-changed ##### -->
-<para>
-The signal "children-changed" is emitted when a child is added or
-removed form an object. It supports two details: "add" and "remove"
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The index of the added or removed child
-@arg2: The child which was added or removed
-
-<!-- ##### SIGNAL AtkObject::focus-event ##### -->
-<para>
-The signal "focus-event" is emitted when an object gains or loses focus.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: A boolean value which indicates whether the object gained or lost focus.
-
-<!-- ##### SIGNAL AtkObject::property-change ##### -->
-<para>
-The signal "property-change" is emitted when an object's property
-value changes. The detail identifies the name of the property whose
-value has changed.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The new value of the property which changed.
-
-<!-- ##### SIGNAL AtkObject::state-change ##### -->
-<para>
-The "state-change" signal is emitted  when an object's state changes.
-The detail value identifies the state type which has changed.
-</para>
-
-@atkobject: the object which received the signal.
-@arg1: The name of the state which has changed
-@arg2: A boolean which indicates whether the state has been set or unset.
-
-<!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
-<para>
-The "visible-data-changed" signal is emitted when the visual appearance of 
-the object changed.
-</para>
-
-@atkobject: the object which received the signal.
-
-<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-name ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-parent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-role ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-table-summary ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkObject:accessible-value ##### -->
-<para>
-
-</para>
-
 <!-- ##### ENUM AtkRole ##### -->
 <para>
 </para>
@@ -250,6 +118,7 @@ the object changed.
 @ATK_ROLE_APPLICATION: 
 @ATK_ROLE_AUTOCOMPLETE: 
 @ATK_ROLE_EDITBAR: 
+@ATK_ROLE_EMBEDDED: 
 @ATK_ROLE_LAST_DEFINED: 
 
 <!-- ##### FUNCTION atk_role_register ##### -->
@@ -551,3 +420,135 @@ atk_object_connect_property_change_handler().
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
+<para>
+The "active-descendant-changed" signal is emitted by an object which has
+the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
+object changes. For instance, a table will emit the signal when the cell
+in the table which has focus changes.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: the newly focused object.
+
+<!-- ##### SIGNAL AtkObject::children-changed ##### -->
+<para>
+The signal "children-changed" is emitted when a child is added or
+removed form an object. It supports two details: "add" and "remove"
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The index of the added or removed child
+@arg2: The child which was added or removed
+
+<!-- ##### SIGNAL AtkObject::focus-event ##### -->
+<para>
+The signal "focus-event" is emitted when an object gains or loses focus.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: A boolean value which indicates whether the object gained or lost focus.
+
+<!-- ##### SIGNAL AtkObject::property-change ##### -->
+<para>
+The signal "property-change" is emitted when an object's property
+value changes. The detail identifies the name of the property whose
+value has changed.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The new value of the property which changed.
+
+<!-- ##### SIGNAL AtkObject::state-change ##### -->
+<para>
+The "state-change" signal is emitted  when an object's state changes.
+The detail value identifies the state type which has changed.
+</para>
+
+@atkobject: the object which received the signal.
+@arg1: The name of the state which has changed
+@arg2: A boolean which indicates whether the state has been set or unset.
+
+<!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
+<para>
+The "visible-data-changed" signal is emitted when the visual appearance of 
+the object changed.
+</para>
+
+@atkobject: the object which received the signal.
+
+<!-- ##### ARG AtkObject:accessible-component-layer ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-name ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-parent ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-role ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-caption ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-table-summary ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkObject:accessible-value ##### -->
+<para>
+
+</para>
+

diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml
index 90316f7..657872d 100644 (file)
--- a/docs/tmpl/atkrelation.sgml
+++ b/docs/tmpl/atkrelation.sgml
@@ -26,16 +26,6 @@ The AtkRelation structure should not be accessed directly.
 </para>
 
 
-<!-- ##### ARG AtkRelation:relation-type ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG AtkRelation:target ##### -->
-<para>
-
-</para>
-
 <!-- ##### ENUM AtkRelationType ##### -->
 <para>
 
@@ -113,3 +103,13 @@ The AtkRelation structure should not be accessed directly.
 @Returns: 
 
 
+<!-- ##### ARG AtkRelation:relation-type ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG AtkRelation:target ##### -->
+<para>
+
+</para>
+

diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml
index 009f466..b3a6148 100644 (file)
--- a/docs/tmpl/atkselection.sgml
+++ b/docs/tmpl/atkselection.sgml
@@ -32,14 +32,6 @@ The AtkAction structure does not contain any fields.
 </para>
 
 
-<!-- ##### 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.
-
 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
 <para>
 
@@ -107,3 +99,11 @@ AtkSelection interface when the selection changes.
 @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.
+

diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml
index 57ce664..96d6dc7 100644 (file)
--- a/docs/tmpl/atktable.sgml
+++ b/docs/tmpl/atktable.sgml
@@ -40,72 +40,6 @@ The AtkTable structure does not contain any fields.
 </para>
 
 
-<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
-<para>
-The "column-deleted" signal is emitted by an object which implements the 
-AtkTable interface when a column is deleted.
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first column deleted.
-@arg2: The number of columns deleted.
-
-<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
-<para>
-The "column-inserted" signal is emitted by an object which implements the 
-AtkTable interface when a column is inserted.
-
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the column inserted.
-@arg2: The number of colums inserted.
-
-<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
-<para>
-The "column-reordered" signal is emitted by an object which implements the 
-AtkTable interface when the columns are reordered.
-</para>
-
-@atktable: the object which received the signal.
-
-<!-- ##### SIGNAL AtkTable::model-changed ##### -->
-<para>
-The "model-changed" signal is emitted by an object which implements the 
-AtkTable interface when the model displayed by the table changes.
-</para>
-
-@atktable: the object which received the signal.
-
-<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
-<para>
-The "row-deleted" signal is emitted by an object which implements the 
-AtkTable interface when a column is inserted.
-
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first row deleted.
-@arg2: The number of rows deleted.
-
-<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
-<para>
-The "row-inserted" signal is emitted by an object which implements the 
-AtkTable interface when a column is inserted.
-</para>
-
-@atktable: the object which received the signal.
-@arg1: The index of the first row deleted.
-@arg2: The number of rows deleted.
-
-<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
-<para>
-The "row-reordered" signal is emitted by an object which implements the 
-AtkTable interface when the columns are reordered.
-</para>
-
-@atktable: the object which received the signal.
-
 <!-- ##### FUNCTION atk_table_ref_at ##### -->
 <para>
 
@@ -395,3 +329,69 @@ AtkTable interface when the columns are reordered.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
+<para>
+The "column-deleted" signal is emitted by an object which implements the 
+AtkTable interface when a column is deleted.
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first column deleted.
+@arg2: The number of columns deleted.
+
+<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
+<para>
+The "column-inserted" signal is emitted by an object which implements the 
+AtkTable interface when a column is inserted.
+
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the column inserted.
+@arg2: The number of colums inserted.
+
+<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
+<para>
+The "column-reordered" signal is emitted by an object which implements the 
+AtkTable interface when the columns are reordered.
+</para>
+
+@atktable: the object which received the signal.
+
+<!-- ##### SIGNAL AtkTable::model-changed ##### -->
+<para>
+The "model-changed" signal is emitted by an object which implements the 
+AtkTable interface when the model displayed by the table changes.
+</para>
+
+@atktable: the object which received the signal.
+
+<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
+<para>
+The "row-deleted" signal is emitted by an object which implements the 
+AtkTable interface when a column is inserted.
+
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first row deleted.
+@arg2: The number of rows deleted.
+
+<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
+<para>
+The "row-inserted" signal is emitted by an object which implements the 
+AtkTable interface when a column is inserted.
+</para>
+
+@atktable: the object which received the signal.
+@arg1: The index of the first row deleted.
+@arg2: The number of rows deleted.
+
+<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
+<para>
+The "row-reordered" signal is emitted by an object which implements the 
+AtkTable interface when the columns are reordered.
+</para>
+
+@atktable: the object which received the signal.
+

diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml
index 760a063..38e3945 100644 (file)
--- a/docs/tmpl/atktext.sgml
+++ b/docs/tmpl/atktext.sgml
@@ -38,44 +38,6 @@ The AtkText structure does not contain any fields.
 </para>
 
 
-<!-- ##### SIGNAL AtkText::text-attributes-changed ##### -->
-<para>
-The "text-attributes-changed" signal is emitted when the text attributes of 
-the text of an object which implements AtkText changes.
-</para>
-
-@atktext: the object which received the signal.
-
-<!-- ##### SIGNAL AtkText::text-caret-moved ##### -->
-<para>
-The "text-caret-moved" signal is emitted when the caret position of 
-the text of an object which implements AtkText changes.
-</para>
-
-@atktext: the object which received the signal.
-@arg1: The new position of the text caret.
-
-<!-- ##### SIGNAL AtkText::text-changed ##### -->
-<para>
-The "text-changed" signal is emitted when the text of the object which 
-implements the AtkText interface changes, This signal will have a detail 
-which is either "insert" or "delete" which identifies whether the text 
-change was an insertion or a deletion
-</para>
-
-@atktext: the object which received the signal.
-@arg1: The position of the insertion or deletion.
-@arg2: The length of text inserted or deleted.
-
-<!-- ##### SIGNAL AtkText::text-selection-changed ##### -->
-<para>
-The "text-selection-changed" signal is emitted when the selected text of 
-an object which implements AtkText changes.
-
-</para>
-
-@atktext: the object which received the signal.
-
 <!-- ##### ENUM AtkTextBoundary ##### -->
 <para>
 
@@ -435,3 +397,41 @@ an object which implements AtkText changes.
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkText::text-attributes-changed ##### -->
+<para>
+The "text-attributes-changed" signal is emitted when the text attributes of 
+the text of an object which implements AtkText changes.
+</para>
+
+@atktext: the object which received the signal.
+
+<!-- ##### SIGNAL AtkText::text-caret-moved ##### -->
+<para>
+The "text-caret-moved" signal is emitted when the caret position of 
+the text of an object which implements AtkText changes.
+</para>
+
+@atktext: the object which received the signal.
+@arg1: The new position of the text caret.
+
+<!-- ##### SIGNAL AtkText::text-changed ##### -->
+<para>
+The "text-changed" signal is emitted when the text of the object which 
+implements the AtkText interface changes, This signal will have a detail 
+which is either "insert" or "delete" which identifies whether the text 
+change was an insertion or a deletion
+</para>
+
+@atktext: the object which received the signal.
+@arg1: The position of the insertion or deletion.
+@arg2: The length of text inserted or deleted.
+
+<!-- ##### SIGNAL AtkText::text-selection-changed ##### -->
+<para>
+The "text-selection-changed" signal is emitted when the selected text of 
+an object which implements AtkText changes.
+
+</para>
+
+@atktext: the object which received the signal.
+