Revise atk-docs.sgml to add indices for deprecated and new

symbols, and modify the inline docs so that the parser can find them.
Bug #313183.

diff --git a/ChangeLog b/ChangeLog
index afacece..2709dba 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2006-06-23 Bill Haneman <bill.haneman@sun.com>
+
+       * docs/atk-docs.sgml: Add index sections.
+       * atk/*.c: Fix 'Since' and 'Deprecated' tags so that
+       index xsl parser can find them.  Bug #313183.
+       
 2006-06-21 Bill Haneman <bill.haneman@sun.com>
 
        * atk/atkstateset.c:

diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c
index f36725d..6e9bd57 100755 (executable)
--- a/atk/atkcomponent.c
+++ b/atk/atkcomponent.c
@@ -385,7 +385,7 @@ atk_component_get_mdi_zorder (AtkComponent *component)
  * (fully opaque).
  *
  * Returns: An alpha value from 0 to 1.0, inclusive.
- * @Since: ATK 1.12
+ * Since: ATK 1.12
  **/
 gdouble
 atk_component_get_alpha (AtkComponent    *component)

diff --git a/atk/atkdocument.c b/atk/atkdocument.c
index bc49444..17d55bd 100755 (executable)
--- a/atk/atkdocument.c
+++ b/atk/atkdocument.c
@@ -136,7 +136,7 @@ atk_document_get_locale (AtkDocument *document)
  * Gets an AtkAttributeSet which describes document-wide
  *          attributes as name-value pairs.
  *
- * @Since: ATK 1.12
+ * Since: ATK 1.12
  *
  * Returns: An AtkAttributeSet containing the explicitly
  *          set name-value-pair attributes associated with this document
@@ -167,7 +167,7 @@ atk_document_get_attributes (AtkDocument *document)
  * @attribute_name: a character string representing the name of the attribute
  *            whose value is being queried.
  *
- * @Since: ATK 1.12
+ * Since: ATK 1.12
  *
  * Returns: a string value associated with the named attribute for this
  *    document, or NULL if a value for #attribute_name has not been specified
@@ -200,7 +200,7 @@ atk_document_get_attribute_value (AtkDocument *document,
  *            whose value is being set.
  * @attribute_value: a string value to be associated with #attribute_name.
  *
- * @Since: ATK 1.12
+ * Since: ATK 1.12
  *
  * Returns: TRUE if #value is successfully associated with #attribute_name
  *          for this document, FALSE otherwise (e.g. if the document does not

diff --git a/atk/atkimage.c b/atk/atkimage.c
index 30c2705..2f9edea 100755 (executable)
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -191,7 +191,7 @@ atk_image_get_image_position (AtkImage *image,
  * atk_image_get_image_locale: 
  * @image: An #AtkImage
  *
- * @Since ATK 1.12
+ * Since ATK 1.12
  *
  * Returns a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale. 
  *

diff --git a/atk/atkobject.c b/atk/atkobject.c
index 77b3df2..2d2921f 100755 (executable)
--- a/atk/atkobject.c
+++ b/atk/atkobject.c
@@ -738,7 +738,7 @@ atk_object_get_role (AtkObject *accessible)
  *
  * Gets the layer of the accessible.
  *
- * @Deprecated: Use atk_component_get_layer instead.
+ * Deprecated: Use atk_component_get_layer instead.
  *
  * Returns: an #AtkLayer which is the layer of the accessible
  **/
@@ -763,7 +763,7 @@ atk_object_get_layer (AtkObject *accessible)
  * Gets the zorder of the accessible. The value G_MININT will be returned 
  * if the layer of the accessible is not ATK_LAYER_MDI.
  *
- * @Deprecated: Use atk_component_get_mdi_zorder instead.
+ * Deprecated: Use atk_component_get_mdi_zorder instead.
  *
  * Returns: a gint which is the zorder of the accessible, i.e. the depth at 
  * which the component is shown in relation to other components in the same 
@@ -1037,7 +1037,7 @@ atk_implementor_ref_accessible (AtkImplementor *implementor)
  * as distinct from strongly-typed object data available via other get/set methods.
  * Not all objects have explicit "name-value pair" #AtkAttributeSet properties.
  *
- * @Since ATK 1.12
+ * Since: ATK 1.12
  *
  * Returns: an #AtkAttributeSet consisting of all explicit properties/annotations applied to 
  * the object, or an empty set if the object has no name-value pair attributes assigned to it.

diff --git a/atk/atkobject.h b/atk/atkobject.h
index d98de44..13b5325 100755 (executable)
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -488,7 +488,7 @@ void                      (* initialize)                         (AtkObject
 
   /*           
    * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs. 
-   * @since ATK 1.12
+   * Since ATK 1.12
    */
   AtkAttributeSet*       (*get_attributes)            (AtkObject                  *accessible);
   AtkFunction             pad1;

diff --git a/atk/atkrelation.c b/atk/atkrelation.c
index 3a6ef0c..99f9f8e 100755 (executable)
--- a/atk/atkrelation.c
+++ b/atk/atkrelation.c
@@ -312,7 +312,7 @@ delete_object_while_in_relation (gpointer callback_data,
  * Adds the specified AtkObject to the target for the relation, if it is
  * not already present.
  *
- * Since: 1.9
+ * Since: ATK 1.9
  **/
 void
 atk_relation_add_target (AtkRelation *relation,

diff --git a/atk/atkrelationset.c b/atk/atkrelationset.c
index adcf494..7de1d62 100755 (executable)
--- a/atk/atkrelationset.c
+++ b/atk/atkrelationset.c
@@ -276,7 +276,7 @@ atk_relation_set_finalize (GObject *object)
  * of that type. If it is does contain a relation of that typea the target
  * is added to the relation.
  *
- * Since: 1.9
+ * Since: ATK 1.9
  **/
 void
 atk_relation_set_add_relation_by_type (AtkRelationSet  *set,

diff --git a/atk/atkutil.c b/atk/atkutil.c
index 908d3cb..1aca841 100755 (executable)
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -322,7 +322,7 @@ atk_get_root (void)
  *
  * Gets the currently focused object.
  * 
- * @Since: ATK 1.6
+ * Since: ATK 1.6
  *
  * Returns: the currently focused object for the current application
  **/

diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index 4b332ec..42aaa51 100644 (file)
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -60,5 +60,28 @@
     &atk-AtkUtil;
     &atk-AtkValue;
   </chapter>
+
+  <index>
+    <title>Index</title>
+  </index>
+  <index role="deprecated">
+    <title>Index of deprecated symbols</title>
+  </index>
+  <index role="ATK 1.3">
+    <title>Index of new symbols in ATK 1.3</title>
+  </index>  
+  <index role="ATK 1.4">
+    <title>Index of new symbols in ATK 1.4</title>
+  </index>  
+  <index role="ATK 1.6">
+    <title>Index of new symbols in ATK 1.6</title>
+  </index>  
+  <index role="ATK 1.9">
+    <title>Index of new symbols in ATK 1.9</title>
+  </index>  
+  <index role="ATK 1.12">
+    <title>Index of new symbols in ATK 1.12</title>
+  </index>  
+
 </book>
 

diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml
index 3133191..7f1f552 100644 (file)
--- a/docs/tmpl/atkobject.sgml
+++ b/docs/tmpl/atkobject.sgml
@@ -262,6 +262,7 @@ the object changed.
 @ATK_ROLE_PAGE: 
 @ATK_ROLE_SECTION: 
 @ATK_ROLE_REDUNDANT_OBJECT: 
+@ATK_ROLE_FORM: 
 @ATK_ROLE_LAST_DEFINED: 
 
 <!-- ##### FUNCTION atk_role_register ##### -->

diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml
index 8b3faeb..6015d3b 100644 (file)
--- a/docs/tmpl/atkrelation.sgml
+++ b/docs/tmpl/atkrelation.sgml
@@ -58,6 +58,8 @@ The AtkRelation structure should not be accessed directly.
 @ATK_RELATION_EMBEDDED_BY: 
 @ATK_RELATION_POPUP_FOR: 
 @ATK_RELATION_PARENT_WINDOW_OF: 
+@ATK_RELATION_DESCRIBED_BY: 
+@ATK_RELATION_DESCRIPTION_FOR: 
 @ATK_RELATION_LAST_DEFINED: 
 
 <!-- ##### FUNCTION atk_relation_type_register ##### -->

diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml
index b48b2d2..82dd62f 100644 (file)
--- a/docs/tmpl/atkstate.sgml
+++ b/docs/tmpl/atkstate.sgml
@@ -59,6 +59,9 @@ an component is described by its AtkStateSet, which is a set of AtkStates.
 @ATK_STATE_INVALID_ENTRY: 
 @ATK_STATE_SUPPORTS_AUTOCOMPLETION: 
 @ATK_STATE_SELECTABLE_TEXT: 
+@ATK_STATE_DEFAULT: 
+@ATK_STATE_ANIMATED: 
+@ATK_STATE_VISITED: 
 @ATK_STATE_LAST_DEFINED: 
 
 <!-- ##### TYPEDEF AtkState ##### -->