summaryrefslogtreecommitdiff
path: root/atk/atkstate.c
diff options
context:
space:
mode:
authorJoanmarie Diggs <jdiggs@igalia.com>2014-11-13 09:11:04 -0500
committerJoanmarie Diggs <jdiggs@igalia.com>2014-11-14 07:06:03 -0500
commitbe5805852c8888585575da00c98807196b396610 (patch)
treed9dfb42dd3a5582cad878deb21604eaca4de29ac /atk/atkstate.c
parentf460594f554f798214c94e5df6e8735bb16bb2ce (diff)
downloadat-spi2-core-be5805852c8888585575da00c98807196b396610.tar.gz
Improve documentation related to AtkState and AtkStateSet
https://bugzilla.gnome.org/show_bug.cgi?id=740066
Diffstat (limited to 'atk/atkstate.c')
-rwxr-xr-xatk/atkstate.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/atk/atkstate.c b/atk/atkstate.c
index 2334fe85..b715c966 100755
--- a/atk/atkstate.c
+++ b/atk/atkstate.c
@@ -25,12 +25,12 @@
/**
* SECTION:atkstate
- * @Short_description: An AtkState describes a component's particular state.
+ * @Short_description: An AtkState describes a single state of an object.
* @Title:AtkState
*
- * An AtkState describes a component's particular state. The actual
- * state of an component is described by its AtkStateSet, which is a
- * set of AtkStates.
+ * An AtkState describes a single state of an object. The full set of states
+ * that apply to an object at a given time are contained in its #AtkStateSet.
+ * See also #atk_object_ref_state_set and #atk_object_notify_state_change.
*/
static guint last_type = ATK_STATE_LAST_DEFINED;