gresource: Clarify error docs for g_resource_enumerate_children()
authorPhilip Withnall <philip.withnall@collabora.co.uk>
Tue, 28 Jul 2015 09:13:12 +0000 (10:13 +0100)
committerPhilip Withnall <philip.withnall@collabora.co.uk>
Tue, 28 Jul 2015 09:14:17 +0000 (10:14 +0100)
Document that it returns G_RESOURCE_ERROR_NOT_FOUND if the path doesn’t
exist.

gio/gresource.c

index 245b25c..e711f7c 100644 (file)
@@ -530,6 +530,9 @@ g_resource_get_info (GResource             *resource,
  * The return result is a %NULL terminated list of strings which should
  * be released with g_strfreev().
  *
+ * If @path is invalid or does not exist in the #GResource,
+ * %G_RESOURCE_ERROR_NOT_FOUND will be returned.
+ *
  * @lookup_flags controls the behaviour of the lookup.
  *
  * Returns: (array zero-terminated=1) (transfer full): an array of constant strings