From: Brian Cameron <bcameron@src.gnome.org>
Date: Thu, 28 Jun 2001 10:28:12 +0000 (+0000)
Subject: Cleaned up docs.
X-Git-Tag: EA_1_0~43
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=928d100e4156d1248d1277270c2ad1a44356a831;p=platform%2Fupstream%2Fatk.git

Cleaned up docs.
---

diff --git a/ChangeLog b/ChangeLog
index b93d9e8..49e20a8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,11 @@
 2001-06-28  Brian Cameron <brian.cameron@sun.com>
+	*atk/atkaction.c atk/atkcomponent.c atk/atkeditabletext.c
+	atk/atkhyperlink.c atk/atkobject.c atk/atkregistry.c
+	atk/atkstate.c atk/atkstateset.c atk/atkstreamablecontent.c
+	atk/atktable.c atk/atktext.c atk/atkutil.c atk/atkvalue.c
+	Cleaned up docs.
+
+2001-06-28  Brian Cameron <brian.cameron@sun.com>
 	*atk/atktable.h, atk/atktable.c
 	Updated signal handler definitions.
 
diff --git a/atk/atkaction.c b/atk/atkaction.c
index 9a5a90a..f7a2018 100755
--- a/atk/atkaction.c
+++ b/atk/atkaction.c
@@ -44,7 +44,7 @@ atk_action_get_type ()
  * @action: a #GObject instance that implements AtkActionIface
  * @i: the action index corresponding to the action to be performed 
  *
- * Perform the specified action on the object
+ * Perform the specified action on the object.
  **/
 void
 atk_action_do_action (AtkAction *obj,
@@ -93,7 +93,7 @@ atk_action_get_n_actions  (AtkAction *obj)
  * @action: a #GObject instance that implements AtkActionIface
  * @i: the action index corresponding to the action to be performed 
  *
- * Returns a description of the specified action of the object
+ * Returns a description of the specified action of the object.
  *
  * Returns a description string, or %NULL
  * if @action does not implement this interface.
diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c
index 19ba7ce..b0f06f2 100755
--- a/atk/atkcomponent.c
+++ b/atk/atkcomponent.c
@@ -166,7 +166,6 @@ atk_component_get_accessible_at_point (AtkComponent    *component,
  * @height: address of #gint to put height
  *
  * Gets the rectangle which gives the extent of the @component.
- *
  **/
 void
 atk_component_get_extents    (AtkComponent    *component,
@@ -216,7 +215,7 @@ atk_component_get_position   (AtkComponent    *component,
  * @x: address of #gint to put x coordinate position
  * @y: address of #gint to put y coordinate position
  *
- * Gets the position of the @component on the screen
+ * Gets the position of the @component on the screen.
  **/
 void
 atk_component_get_position_on_screen (AtkComponent    *component,
@@ -260,7 +259,7 @@ atk_component_get_size       (AtkComponent    *component,
  * atk_component_grab_focus:
  * @component: an #AtkComponent
  *
- * Grabs focus for this @component
+ * Grabs focus for this @component.
  **/
 void
 atk_component_grab_focus (AtkComponent    *component)
@@ -283,7 +282,7 @@ atk_component_grab_focus (AtkComponent    *component)
  * @width: width to set for @component
  * @height: height to set for @component
  *
- * Sets the extents of @component
+ * Sets the extents of @component.
  **/
 void
 atk_component_set_extents   (AtkComponent    *component,
@@ -308,7 +307,7 @@ atk_component_set_extents   (AtkComponent    *component,
  * @x: x coordinate
  * @y: y coordinate
  *
- * Sets the position of @component
+ * Sets the position of @component.
  **/
 void
 atk_component_set_position   (AtkComponent    *component,
@@ -331,7 +330,7 @@ atk_component_set_position   (AtkComponent    *component,
  * @width: width to set for @component
  * @height: height to set for @component
  *
- * Set the size of the @component in terms of width and height
+ * Set the size of the @component in terms of width and height.
  **/
 void
 atk_component_set_size       (AtkComponent    *component,
diff --git a/atk/atkeditabletext.c b/atk/atkeditabletext.c
index 2b2e0ad..e6316e6 100755
--- a/atk/atkeditabletext.c
+++ b/atk/atkeditabletext.c
@@ -54,7 +54,7 @@ atk_editable_text_get_type ()
  *@start_offset: start of range in which to set attributes
  *@end_offset: end of range in which to set attributes
  *
- *Sets the attributes for a specified range
+ *Sets the attributes for a specified range.
  *
  *Returns: %TRUE if attributes successfully set for the specified
  *range, otherwise %FALSE
@@ -88,7 +88,7 @@ atk_editable_text_set_run_attributes (AtkEditableText *text,
  * @text: an #AtkEditableText
  * @string: string to set for text contents of @text
  *
- * Set text contents of @text
+ * Set text contents of @text.
  **/
 void 
 atk_editable_text_set_text_contents (AtkEditableText  *text,
@@ -114,7 +114,7 @@ atk_editable_text_set_text_contents (AtkEditableText  *text,
  * the position at which to insert the text. After the call it
  * points at the position after the newly inserted text.
  *
- * Insert text at a given position
+ * Insert text at a given position.
  **/
 void 
 atk_editable_text_insert_text (AtkEditableText  *text,
@@ -189,7 +189,7 @@ atk_editable_text_cut_text  (AtkEditableText  *text,
  * @start_pos: start position
  * @end_pos: end position
  *
- * Delete text @start_pos up to, but not including @end_pos
+ * Delete text @start_pos up to, but not including @end_pos.
  **/
 void 
 atk_editable_text_delete_text (AtkEditableText  *text,
@@ -212,7 +212,7 @@ atk_editable_text_delete_text (AtkEditableText  *text,
  * @text: an #AtkEditableText
  * @position: position to paste
  *
- * Paste text from clipboard to specified @position 
+ * Paste text from clipboard to specified @position.
  **/
 void 
 atk_editable_text_paste_text (AtkEditableText  *text,
diff --git a/atk/atkhyperlink.c b/atk/atkhyperlink.c
index a9eee0b..492eabb 100755
--- a/atk/atkhyperlink.c
+++ b/atk/atkhyperlink.c
@@ -114,7 +114,7 @@ atk_hyperlink_get_uri (AtkHyperlink *link,
  * 
  * Multiple anchors are primarily used by client-side image maps.
  *
- * Returns: an #AtkObject associated with this hyperlinks i-th anchor.
+ * Returns: an #AtkObject associated with this hyperlinks i-th anchor
  **/
 AtkObject*
 atk_hyperlink_get_object (AtkHyperlink *link,
@@ -136,7 +136,7 @@ atk_hyperlink_get_object (AtkHyperlink *link,
  * atk_hyperlink_get_end_index:
  * @link: an #AtkHyperlink
  *
- * Gets the index with the hypertext document at which this link ends
+ * Gets the index with the hypertext document at which this link ends.
  *
  * Returns: the index with the hypertext document at which this link ends
  **/
@@ -159,7 +159,7 @@ atk_hyperlink_get_end_index (AtkHyperlink *link)
  * atk_hyperlink_get_start_index:
  * @link: an #AtkHyperlink
  *
- * Gets the index with the hypertext document at which this link begins 
+ * Gets the index with the hypertext document at which this link begins.
  *
  * Returns: the index with the hypertext document at which this link begins
  **/
@@ -186,7 +186,7 @@ atk_hyperlink_get_start_index (AtkHyperlink *link)
  * this method returns %TRUE if the link is still valid (with
  * respect to the document it references) and %FALSE otherwise.
  *
- * Returns: whether or not this link is still valid.
+ * Returns: whether or not this link is still valid
  **/
 gboolean
 atk_hyperlink_is_valid (AtkHyperlink *link)
@@ -207,7 +207,7 @@ atk_hyperlink_is_valid (AtkHyperlink *link)
  * atk_hyperlink_get_n_anchors:
  * @link: an #AtkHyperlink
  *
- * Gets the number of anchors associated with this hyperlink
+ * Gets the number of anchors associated with this hyperlink.
  *
  * Returns: the number of anchors associated with this hyperlink
  **/
diff --git a/atk/atkobject.c b/atk/atkobject.c
index 9c609fb..ff5290f 100755
--- a/atk/atkobject.c
+++ b/atk/atkobject.c
@@ -334,7 +334,7 @@ atk_implementor_get_type (void)
  * atk_object_get_name:
  * @accessible: an #AtkObject
  *
- * Gets the accessible name of the accessible
+ * Gets the accessible name of the accessible.
  *
  * Returns: a character string representing the accessible name of the object.
  **/
@@ -357,7 +357,7 @@ atk_object_get_name (AtkObject *accessible)
  * atk_object_get_description:
  * @accessible: an #AtkObject
  *
- * Gets the accessible description of the accessible
+ * Gets the accessible description of the accessible.
  *
  * Returns: a character string representing the accessible description
  * of the accessible.
@@ -382,7 +382,7 @@ atk_object_get_description (AtkObject *accessible)
  * atk_object_get_parent:
  * @accessible: an #AtkObject
  *
- * Gets the accessible parent of the accessible
+ * Gets the accessible parent of the accessible.
  *
  * Returns: a #AtkObject representing the accessible parent of the accessible
  **/
@@ -405,7 +405,7 @@ atk_object_get_parent (AtkObject *accessible)
  * atk_object_get_n_accessible_children:
  * @accessible: an #AtkObject
  *
- * Gets the number of accessible children of the accessible
+ * Gets the number of accessible children of the accessible.
  *
  * Returns: an integer representing the number of accessible children
  * of the accessible.
@@ -457,7 +457,7 @@ atk_object_ref_accessible_child (AtkObject   *accessible,
  * atk_object_ref_relation_set:
  * @accessible: an #AtkObject
  *
- * Gets the #AtkRelationSet associated with the object
+ * Gets the #AtkRelationSet associated with the object.
  *
  * Returns: an #AtkRelationSet representing the relation set of the object.
  **/
@@ -480,6 +480,8 @@ atk_object_ref_relation_set (AtkObject *accessible)
  * atk_role_register:
  * @name: a character string describing the new role.
  *
+ * Registers the role specified by @name.
+ *
  * Returns: an #AtkRole for the new role.
  **/
 AtkRole
@@ -494,7 +496,7 @@ atk_role_register (const gchar *name)
  * atk_object_get_role:
  * @accessible: an #AtkObject
  *
- * Gets the role of the accessible
+ * Gets the role of the accessible.
  *
  * Returns: an #AtkRole which is the role of the accessible
  **/
@@ -565,7 +567,7 @@ atk_object_get_index_in_parent (AtkObject *accessible)
  * @accessible: an #AtkObject
  * @name: a character string to be set as the accessible name
  *
- * Sets the accessible name of the accessible
+ * Sets the accessible name of the accessible.
  **/
 void
 atk_object_set_name (AtkObject    *accessible,
@@ -590,7 +592,7 @@ atk_object_set_name (AtkObject    *accessible,
  * @accessible: an #AtkObject
  * @description : a character string to be set as the accessible description
  *
- * Sets the accessible description of the accessible
+ * Sets the accessible description of the accessible.
  **/
 void
 atk_object_set_description (AtkObject   *accessible,
@@ -615,7 +617,7 @@ atk_object_set_description (AtkObject   *accessible,
  * @accessible: an #AtkObject
  * @parent : an #AtkObject to be set as the accessible parent
  *
- * Sets the accessible parent of the accessible
+ * Sets the accessible parent of the accessible.
  **/
 void
 atk_object_set_parent (AtkObject *accessible,
@@ -636,7 +638,7 @@ atk_object_set_parent (AtkObject *accessible,
  * @accessible: an #AtkObject
  * @role : an #AtkRole to be set as the role
  *
- * Sets the role of the accessible
+ * Sets the role of the accessible.
  **/
 void
 atk_object_set_role (AtkObject *accessible, 
diff --git a/atk/atkregistry.c b/atk/atkregistry.c
index 386cfeb..47526a3 100644
--- a/atk/atkregistry.c
+++ b/atk/atkregistry.c
@@ -170,7 +170,7 @@ atk_registry_set_factory_type (AtkRegistry *registry,
  * subclass
  *
  * Provides a #GType indicating the #AtkObjectFactory subclass
- * associated with type @type
+ * associated with @type.
  *
  * Returns: a #GType associated with type @type
  **/
diff --git a/atk/atkstate.c b/atk/atkstate.c
index bf8d7aa..2e2d608 100755
--- a/atk/atkstate.c
+++ b/atk/atkstate.c
@@ -57,7 +57,7 @@ static gchar* state_names[NUM_POSSIBLE_STATES] = {
  * atk_state_type_register:
  * @name: a character string describing the new state.
  *
- * Register a new object state
+ * Register a new object state.
  *
  * Returns: an #AtkState value for the new state.
  **/
@@ -77,7 +77,7 @@ atk_state_type_register (const gchar *name)
  * atk_state_type_get_name:
  * @type: The #AtkStateType whose name is required
  *
- * Gets the description string describing the #AtkStateType @type
+ * Gets the description string describing the #AtkStateType @type.
  *
  * Returns: the string describing the state
  */
@@ -102,7 +102,7 @@ atk_state_type_get_name (AtkStateType state)
  * atk_state_type_for_name:
  * @name: a character string state name
  *
- * Gets the #AtkStateType corresponding to the description string @name
+ * Gets the #AtkStateType corresponding to the description string @name.
  *
  * Returns: an #AtkStateType corresponding to @name 
  */
diff --git a/atk/atkstateset.c b/atk/atkstateset.c
index ba5512f..481543d 100755
--- a/atk/atkstateset.c
+++ b/atk/atkstateset.c
@@ -106,7 +106,7 @@ atk_state_set_is_empty (AtkStateSet   *set)
  * @type: an #AtkStateType
  *
  * Add a new state for the specified type to the current state set if
- * it is not already present
+ * it is not already present.
  *
  * Returns: %TRUE if  the state for @type is not already in @set.
  **/
@@ -134,7 +134,7 @@ atk_state_set_add_state (AtkStateSet   *set,
  * @types: an array of #AtkStateType
  * @n_types: The number of elements in the array
  *
- * Add the states for the specified types to the current state set
+ * Add the states for the specified types to the current state set.
  **/
 void
 atk_state_set_add_states (AtkStateSet   *set,
diff --git a/atk/atkstreamablecontent.c b/atk/atkstreamablecontent.c
index 7e0d97c..3d4bca3 100755
--- a/atk/atkstreamablecontent.c
+++ b/atk/atkstreamablecontent.c
@@ -97,7 +97,7 @@ atk_streamable_content_get_mime_type (AtkStreamableContent *streamable,
  * @streamable: a GObject instance that implements AtkStreamableContentIface
  * @mime_type: a gchar* representing the mime type
  *
- * Gets the content in the specified mime type
+ * Gets the content in the specified mime type.
  *
  * Returns: A #GIOChannel which contains the content in the specified mime
  * type.
diff --git a/atk/atktable.c b/atk/atktable.c
index cdd8f17..485422f 100755
--- a/atk/atktable.c
+++ b/atk/atktable.c
@@ -133,7 +133,7 @@ atk_table_base_init (gpointer *g_class)
  * @row: a #gint representing a row in @table
  * @column: a #gint representing a column in @table
  *
- * Get a reference to the table cell at @row, @column
+ * Get a reference to the table cell at @row, @column.
  *
  * Returns: a AtkObject* representing the referred to accessible
  **/
@@ -604,7 +604,6 @@ atk_table_get_selected_rows (AtkTable *table, gint **selected)
  *
  * Returns: a gint representing the number of selected columns,
  * or %0 if value does not implement this interface.
- *
  **/
 gint 
 atk_table_get_selected_columns (AtkTable *table, gint **selected)
@@ -894,7 +893,7 @@ atk_table_set_column_description (AtkTable       *table,
  * @column: a #gint representing a column in @table
  * @header: an #AtkTable
  *
- * Sets the specified column header to @header
+ * Sets the specified column header to @header.
  **/
 void
 atk_table_set_column_header (AtkTable  *table,
@@ -943,7 +942,7 @@ atk_table_set_row_description (AtkTable       *table,
  * @row: a #gint representing a row in @table
  * @header: an #AtkTable 
  *
- * Sets the specified row header to @header
+ * Sets the specified row header to @header.
  **/
 void
 atk_table_set_row_header (AtkTable  *table,
@@ -967,7 +966,7 @@ atk_table_set_row_header (AtkTable  *table,
  * @accessible: an #AtkObject representing the summary description
  * to set for @table
  *
- * Sets the summary description of the table
+ * Sets the summary description of the table.
  **/
 void
 atk_table_set_summary (AtkTable       *table,
diff --git a/atk/atktext.c b/atk/atktext.c
index 3765fef..1102621 100755
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -392,11 +392,12 @@ atk_text_get_character_count (AtkText *text)
  * @text: an #AtkText
  * @x: screen x-position of character
  * @y: screen y-position of character
- * @coords: specify whether coordinates are relative to the screen or widget window 
+ * @coords: specify whether coordinates are relative to the screen or
+ * widget window 
  *
- * Gets the offset of the character located at coordinates @x and @y. @x and @y are
- * interpreted as being relative to the screen or this widget's window depending
- * on @coords.
+ * Gets the offset of the character located at coordinates @x and @y. @x and @y
+ * are interpreted as being relative to the screen or this widget's window
+ * depending on @coords.
  *
  * Returns: the offset to the character which is located at
  * the specified @x and @y coordinates.
@@ -516,7 +517,7 @@ atk_text_add_selection (AtkText *text, gint start_offset,
  * of the text region is assigned the number 0, etc.  Note that adding,
  * moving or deleting a selected region can change the numbering.
  *
- * Removes the specified selection
+ * Removes the specified selection.
  *
  * Returns: %TRUE if success, %FALSE otherwise
  **/
@@ -547,7 +548,7 @@ atk_text_remove_selection (AtkText *text, gint selection_num)
  * @start_offset: the new start position of the selection
  * @end_offset: the new end position of the selection
  *
- * Changes the start and end offset of the specified selection
+ * Changes the start and end offset of the specified selection.
  *
  * Returns: %TRUE if success, %FALSE otherwise
  **/
@@ -606,8 +607,7 @@ atk_text_set_caret_offset (AtkText *text,
  * @attrib_set: The #AtkAttributeSet to free
  *
  * Frees the memory used by an #AtkAttributeSet, including all its
- * #AtkAttributes
- *
+ * #AtkAttributes.
  **/
 void
 AtkAttributeSet_free(AtkAttributeSet *attrib_set)
diff --git a/atk/atkutil.c b/atk/atkutil.c
index 08cc9a2..91a427a 100755
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -100,8 +100,7 @@ atk_add_focus_tracker (AtkFocusTracker   focus_tracker)
  * @tracker_id: the id of the focus tracker to remove
  *
  * Removes the specified focus tracker from the list of functions
- * to be called when any object receives focus
- *
+ * to be called when any object receives focus.
  **/
 void
 atk_remove_focus_tracker (guint            tracker_id)
@@ -132,7 +131,6 @@ atk_remove_focus_tracker (guint            tracker_id)
  *
  * Cause the focus tracker functions which have been specified to be
  * executed for the object.
- *
  **/
 void
 atk_focus_tracker_notify (AtkObject       *object)
diff --git a/atk/atkvalue.c b/atk/atkvalue.c
index 5ea64ee..3ed6807 100755
--- a/atk/atkvalue.c
+++ b/atk/atkvalue.c
@@ -44,7 +44,7 @@ atk_value_get_type ()
  * @obj: a GObject instance that implements AtkValueIface
  * @value: a #GValue representing the current accessible value
  *
- * Gets the value of this object
+ * Gets the value of this object.
  **/
 void
 atk_value_get_current_value (AtkValue *obj,
@@ -67,7 +67,7 @@ atk_value_get_current_value (AtkValue *obj,
  * @obj: a GObject instance that implements AtkValueIface
  * @value: a #GValue representing the maximum accessible value
  *
- * Gets the maximum value of this object
+ * Gets the maximum value of this object.
  **/
 void
 atk_value_get_maximum_value  (AtkValue *obj,
@@ -90,7 +90,7 @@ atk_value_get_maximum_value  (AtkValue *obj,
  * @obj: a GObject instance that implements AtkValueIface
  * @value: a #GValue representing the minimum accessible value
  *
- * Gets the minimum value of this object
+ * Gets the minimum value of this object.
  **/
 void
 atk_value_get_minimum_value (AtkValue *obj,
@@ -113,7 +113,7 @@ atk_value_get_minimum_value (AtkValue *obj,
  * @obj: a GObject instance that implements AtkValueIface
  * @value: a #GValue which is the desired new accessible value.
  *
- * Sets the value of this object
+ * Sets the value of this object.
  *
  * Returns: %TRUE if new value is successfully set, %FALSE otherwise.
  **/