docs: Clarify clearing the builder after ending the build process

There is no need to call g_variant_builder_clear() after the
g_variant_builder_end(). This is mentioned in docs of the former
function, but not in the docs of the latter one. Add them there too.
This commit is contained in:
Krzesimir Nowak 2016-05-11 09:37:21 +02:00 committed by Colin Walters
parent bcbd8d73ce
commit 89d8dc979b

View File

@ -3591,7 +3591,10 @@ g_variant_make_array_type (GVariant *element)
* It is not permissible to use @builder in any way after this call
* except for reference counting operations (in the case of a
* heap-allocated #GVariantBuilder) or by reinitialising it with
* g_variant_builder_init() (in the case of stack-allocated).
* g_variant_builder_init() (in the case of stack-allocated). This
* means that for the stack-allocated builders there is no need to
* call g_variant_builder_clear() after the call to
* g_variant_builder_end().
*
* It is an error to call this function in any way that would create an
* inconsistent value to be constructed (ie: insufficient number of