summaryrefslogtreecommitdiff
path: root/girepository
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2014-06-23 09:35:02 +0100
committerPhilip Withnall <philip.withnall@collabora.co.uk>2014-06-23 09:36:01 +0100
commit3aeb5f0a98b2913b9e96e09028ad4942d8dac715 (patch)
treeddcffe1b9df6712c78b8231f7bf003b24013fda7 /girepository
parented3aa4a67b88c7cd1374571f716d661bc4209158 (diff)
downloadgobject-introspection-3aeb5f0a98b2913b9e96e09028ad4942d8dac715.tar.gz
gibaseinfo: Expand g_base_info_iterate_attributes() documentation
Clarify what an attribute is, in response to a question on gir-devel-list. https://bugzilla.gnome.org/show_bug.cgi?id=732078
Diffstat (limited to 'girepository')
-rw-r--r--girepository/gibaseinfo.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/girepository/gibaseinfo.c b/girepository/gibaseinfo.c
index 4bbe850a..25c98b0e 100644
--- a/girepository/gibaseinfo.c
+++ b/girepository/gibaseinfo.c
@@ -562,7 +562,10 @@ _attribute_blob_find_first (GIBaseInfo *info,
*
* Iterate over all attributes associated with this node. The iterator
* structure is typically stack allocated, and must have its first
- * member initialized to %NULL.
+ * member initialized to %NULL. Attributes are arbitrary namespaced key–value
+ * pairs which can be attached to almost any item. They are intended for use
+ * by software higher in the toolchain than bindings, and are distinct from
+ * normal GIR annotations.
*
* Both the @name and @value should be treated as constants
* and must not be freed.