Updated comments for gtk-doc by Oisin Boydell

[platform/upstream/atk.git] / atk / atkstate.c

diff --git a/atk/atkstate.c b/atk/atkstate.c
index 2c0c045..6956269 100755 (executable)
--- a/atk/atkstate.c
+++ b/atk/atkstate.c
@@ -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