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
This commit is contained in:
Philip Withnall 2014-06-23 09:35:02 +01:00
parent c0dab09f95
commit d2514073b9

View File

@ -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 keyvalue
* 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.