Updated comments for gtk-doc by Oisin Boydell
authorLucy Brophy <lbrophy@src.gnome.org>
Tue, 29 May 2001 14:30:48 +0000 (14:30 +0000)
committerLucy Brophy <lbrophy@src.gnome.org>
Tue, 29 May 2001 14:30:48 +0000 (14:30 +0000)
atk/atkobject.h
atk/atkstate.c

index 5ed83ea..7a09b69 100755 (executable)
@@ -90,7 +90,7 @@ extern "C" {
  *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
  *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
  *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
- *@ATK_ROLE_STATUS_BAR: An object which reports messages of minor importance to the user
+ *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
  *@ATK_ROLE_TABLE: An object used to rpesent information in terms of rows and columns
  *@ATK_ROLE_TABLE_CELL: A cell in a table
  *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
@@ -163,7 +163,7 @@ typedef enum
   ATK_ROLE_SLIDER,
   ATK_ROLE_SPLIT_PANE,
   ATK_ROLE_SPIN_BUTTON,
-  ATK_ROLE_STATUS_BAR,
+  ATK_ROLE_STATUSBAR,
   ATK_ROLE_TABLE,
   ATK_ROLE_TABLE_CELL,
   ATK_ROLE_TABLE_COLUMN_HEADER,
index 2c0c045..6956269 100755 (executable)
@@ -56,6 +56,8 @@ static gchar* state_names[NUM_POSSIBLE_STATES] = {
  * atk_state_type_register:
  * @name: a character string describing the new state.
  *
+ * Register a new object state
+ *
  * Returns: an #AtkState value for the new state.
  **/
 AtkStateType
@@ -74,6 +76,8 @@ 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
+ *
  * Returns: the string describing the state
  */
 G_CONST_RETURN gchar*
@@ -97,6 +101,8 @@ 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
+ *
  * Returns: an #AtkStateType corresponding to @name 
  */
 AtkStateType