Formatting cleanup

This commit is contained in:
Matthias Clasen 2012-04-06 21:22:17 -04:00
parent 8db4b949b8
commit 5ce66bed3d

View File

@ -134,7 +134,7 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* *
* Gets the #GResource Error Quark. * Gets the #GResource Error Quark.
* *
* Return value: a #GQuark. * Return value: a #GQuark
* *
* Since: 2.32 * Since: 2.32
*/ */
@ -146,12 +146,12 @@ g_resource_error_quark (void)
/** /**
* g_resource_ref: * g_resource_ref:
* @resource: A #GResource. * @resource: A #GResource
* *
* Atomically increments the reference count of @array by one. This * Atomically increments the reference count of @array by one. This
* function is MT-safe and may be called from any thread. * function is MT-safe and may be called from any thread.
* *
* Returns: The passed in #GResource. * Returns: The passed in #GResource
* *
* Since: 2.32 * Since: 2.32
**/ **/
@ -164,7 +164,7 @@ g_resource_ref (GResource *resource)
/** /**
* g_resource_unref: * g_resource_unref:
* @resource: A #GResource. * @resource: A #GResource
* *
* Atomically decrements the reference count of @resource by one. If the * Atomically decrements the reference count of @resource by one. If the
* reference count drops to 0, all memory allocated by the array is * reference count drops to 0, all memory allocated by the array is
@ -203,8 +203,8 @@ g_resource_new_from_table (GvdbTable *table)
/** /**
* g_resource_new_from_data: * g_resource_new_from_data:
* @data: A #GBytes. * @data: A #GBytes
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Creates a GResource from a reference to the binary resource bundle. * Creates a GResource from a reference to the binary resource bundle.
* This will keep a reference to @data while the resource lives, so * This will keep a reference to @data while the resource lives, so
@ -213,7 +213,7 @@ g_resource_new_from_table (GvdbTable *table)
* If you want to use this resource in the global resource namespace you need * If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register(). * to register it with g_resources_register().
* *
* Return value: (transfer full): a new #GResource, or %NULL on error. * Return value: (transfer full): a new #GResource, or %NULL on error
* *
* Since: 2.32 * Since: 2.32
**/ **/
@ -239,8 +239,8 @@ g_resource_new_from_data (GBytes *data,
/** /**
* g_resource_load: * g_resource_load:
* @filename: (type filename): the path of a filename to load, in the GLib filename encoding. * @filename: (type filename): the path of a filename to load, in the GLib filename encoding
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Loads a binary resource bundle and creates a #GResource representation of it, allowing * Loads a binary resource bundle and creates a #GResource representation of it, allowing
* you to query it for data. * you to query it for data.
@ -248,7 +248,7 @@ g_resource_new_from_data (GBytes *data,
* If you want to use this resource in the global resource namespace you need * If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register(). * to register it with g_resources_register().
* *
* Return value: (transfer full): a new #GResource, or %NULL on error. * Return value: (transfer full): a new #GResource, or %NULL on error
* *
* Since: 2.32 * Since: 2.32
**/ **/
@ -265,8 +265,9 @@ g_resource_load (const gchar *filename,
return g_resource_new_from_table (table); return g_resource_new_from_table (table);
} }
static gboolean do_lookup (GResource *resource, static
const char *path, gboolean do_lookup (GResource *resource,
const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
gsize *size, gsize *size,
guint32 *flags, guint32 *flags,
@ -330,10 +331,10 @@ static gboolean do_lookup (GResource *resource,
/** /**
* g_resource_open_stream: * g_resource_open_stream:
* @resource: A #GResource. * @resource: A #GResource
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the resource and * Looks for a file at the specified @path in the resource and
* returns a #GInputStream that lets you read the data. * returns a #GInputStream that lets you read the data.
@ -341,13 +342,13 @@ static gboolean do_lookup (GResource *resource,
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: (transfer full): #GInputStream or %NULL on error. * Returns: (transfer full): #GInputStream or %NULL on error.
* Free the returned object with g_object_unref(). * Free the returned object with g_object_unref()
* *
* Since: 2.32 * Since: 2.32
**/ **/
GInputStream * GInputStream *
g_resource_open_stream (GResource *resource, g_resource_open_stream (GResource *resource,
const char *path, const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -380,10 +381,10 @@ g_resource_open_stream (GResource *resource,
/** /**
* g_resource_lookup_data: * g_resource_lookup_data:
* @resource: A #GResource. * @resource: A #GResource
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the resource and * Looks for a file at the specified @path in the resource and
* returns a #GBytes that lets you directly access the data in * returns a #GBytes that lets you directly access the data in
@ -401,13 +402,13 @@ g_resource_open_stream (GResource *resource,
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: (transfer full): #GBytes or %NULL on error. * Returns: (transfer full): #GBytes or %NULL on error.
* Free the returned object with g_bytes_unref(). * Free the returned object with g_bytes_unref()
* *
* Since: 2.32 * Since: 2.32
**/ **/
GBytes * GBytes *
g_resource_lookup_data (GResource *resource, g_resource_lookup_data (GResource *resource,
const char *path, const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -477,27 +478,27 @@ g_resource_lookup_data (GResource *resource,
/** /**
* g_resource_get_info: * g_resource_get_info:
* @resource: A #GResource. * @resource: A #GResource
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @size: (out) (allow-none): a location to place the length of the contents of the file, * @size: (out) (allow-none): a location to place the length of the contents of the file,
* or %NULL if the length is not needed * or %NULL if the length is not needed
* @flags: (out) (allow-none): a location to place the flags about the file, * @flags: (out) (allow-none): a location to place the flags about the file,
* or %NULL if the length is not needed * or %NULL if the length is not needed
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the resource and * Looks for a file at the specified @path in the resource and
* if found returns information about it. * if found returns information about it.
* *
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: %TRUE if the file was found. %FALSE if there were errors. * Returns: %TRUE if the file was found. %FALSE if there were errors
* *
* Since: 2.32 * Since: 2.32
**/ **/
gboolean gboolean
g_resource_get_info (GResource *resource, g_resource_get_info (GResource *resource,
const char *path, const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
gsize *size, gsize *size,
guint32 *flags, guint32 *flags,
@ -508,10 +509,10 @@ g_resource_get_info (GResource *resource,
/** /**
* g_resource_enumerate_children: * g_resource_enumerate_children:
* @resource: A #GResource. * @resource: A #GResource
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Returns all the names of children at the specified @path in the resource. * Returns all the names of children at the specified @path in the resource.
* The return result is a %NULL terminated list of strings which should * The return result is a %NULL terminated list of strings which should
@ -523,9 +524,9 @@ g_resource_get_info (GResource *resource,
* *
* Since: 2.32 * Since: 2.32
**/ **/
char ** gchar **
g_resource_enumerate_children (GResource *resource, g_resource_enumerate_children (GResource *resource,
const char *path, const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -571,8 +572,7 @@ static GStaticResource *lazy_register_resources;
static void static void
g_resources_register_unlocked (GResource *resource) g_resources_register_unlocked (GResource *resource)
{ {
registered_resources = g_list_prepend (registered_resources, registered_resources = g_list_prepend (registered_resources, g_resource_ref (resource));
g_resource_ref (resource));
} }
static void static void
@ -584,15 +584,14 @@ g_resources_unregister_unlocked (GResource *resource)
} }
else else
{ {
registered_resources = g_list_remove (registered_resources, registered_resources = g_list_remove (registered_resources, resource);
resource);
g_resource_unref (resource); g_resource_unref (resource);
} }
} }
/** /**
* g_resources_register: * g_resources_register:
* @resource: A #GResource. * @resource: A #GResource
* *
* Registers the resource with the process-global set of resources. * Registers the resource with the process-global set of resources.
* Once a resource is registered the files in it can be accessed * Once a resource is registered the files in it can be accessed
@ -610,7 +609,7 @@ g_resources_register (GResource *resource)
/** /**
* g_resources_unregister: * g_resources_unregister:
* @resource: A #GResource. * @resource: A #GResource
* *
* Unregisters the resource from the process-global set of resources. * Unregisters the resource from the process-global set of resources.
* *
@ -626,9 +625,9 @@ g_resources_unregister (GResource *resource)
/** /**
* g_resources_open_stream: * g_resources_open_stream:
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the set of * Looks for a file at the specified @path in the set of
* globally registred resources and returns a #GInputStream * globally registred resources and returns a #GInputStream
@ -637,12 +636,12 @@ g_resources_unregister (GResource *resource)
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: (transfer full): #GInputStream or %NULL on error. * Returns: (transfer full): #GInputStream or %NULL on error.
* Free the returned object with g_object_unref(). * Free the returned object with g_object_unref()
* *
* Since: 2.32 * Since: 2.32
**/ **/
GInputStream * GInputStream *
g_resources_open_stream (const char *path, g_resources_open_stream (const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -686,9 +685,9 @@ g_resources_open_stream (const char *path,
/** /**
* g_resources_lookup_data: * g_resources_lookup_data:
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the set of * Looks for a file at the specified @path in the set of
* globally registred resources and returns a #GBytes that * globally registred resources and returns a #GBytes that
@ -706,12 +705,12 @@ g_resources_open_stream (const char *path,
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: (transfer full): #GBytes or %NULL on error. * Returns: (transfer full): #GBytes or %NULL on error.
* Free the returned object with g_bytes_unref(). * Free the returned object with g_bytes_unref()
* *
* Since: 2.32 * Since: 2.32
**/ **/
GBytes * GBytes *
g_resources_lookup_data (const char *path, g_resources_lookup_data (const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -755,9 +754,9 @@ g_resources_lookup_data (const char *path,
/** /**
* g_resources_enumerate_children: * g_resources_enumerate_children:
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Returns all the names of children at the specified @path in the set of * Returns all the names of children at the specified @path in the set of
* globally registred resources. * globally registred resources.
@ -770,8 +769,8 @@ g_resources_lookup_data (const char *path,
* *
* Since: 2.32 * Since: 2.32
**/ **/
char ** gchar **
g_resources_enumerate_children (const char *path, g_resources_enumerate_children (const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
GError **error) GError **error)
{ {
@ -832,25 +831,25 @@ g_resources_enumerate_children (const char *path,
/** /**
* g_resources_get_info: * g_resources_get_info:
* @path: A pathname inside the resource. * @path: A pathname inside the resource
* @lookup_flags: A #GResourceLookupFlags. * @lookup_flags: A #GResourceLookupFlags
* @size: (out) (allow-none): a location to place the length of the contents of the file, * @size: (out) (allow-none): a location to place the length of the contents of the file,
* or %NULL if the length is not needed * or %NULL if the length is not needed
* @flags: (out) (allow-none): a location to place the flags about the file, * @flags: (out) (allow-none): a location to place the flags about the file,
* or %NULL if the length is not needed * or %NULL if the length is not needed
* @error: return location for a #GError, or %NULL. * @error: return location for a #GError, or %NULL
* *
* Looks for a file at the specified @path in the set of * Looks for a file at the specified @path in the set of
* globally registred resources and if found returns information about it. * globally registred resources and if found returns information about it.
* *
* @lookup_flags controls the behaviour of the lookup. * @lookup_flags controls the behaviour of the lookup.
* *
* Returns: %TRUE if the file was found. %FALSE if there were errors. * Returns: %TRUE if the file was found. %FALSE if there were errors
* *
* Since: 2.32 * Since: 2.32
**/ **/
gboolean gboolean
g_resources_get_info (const char *path, g_resources_get_info (const gchar *path,
GResourceLookupFlags lookup_flags, GResourceLookupFlags lookup_flags,
gsize *size, gsize *size,
guint32 *flags, guint32 *flags,
@ -915,7 +914,7 @@ g_resources_get_info (const char *path,
*/ */
static void static void
register_lazy_static_resources_unlocked () register_lazy_static_resources_unlocked (void)
{ {
GStaticResource *list; GStaticResource *list;
@ -939,7 +938,7 @@ register_lazy_static_resources_unlocked ()
} }
static void static void
register_lazy_static_resources () register_lazy_static_resources (void)
{ {
if (g_atomic_pointer_get (&lazy_register_resources) == NULL) if (g_atomic_pointer_get (&lazy_register_resources) == NULL)
return; return;
@ -951,14 +950,14 @@ register_lazy_static_resources ()
/** /**
* g_static_resource_init: * g_static_resource_init:
* @static_resource: pointer to a static #GStaticResource. * @static_resource: pointer to a static #GStaticResource
* *
* Initializes a GResource from static data using a * Initializes a GResource from static data using a
* GStaticResource. * GStaticResource.
* *
* This is normally used by code generated by * This is normally used by code generated by
* <link linkend="glib-compile-resources">glib-compile-resources</link> and is * <link linkend="glib-compile-resources">glib-compile-resources</link>
* not typically used by other code. * and is not typically used by other code.
* *
* Since: 2.32 * Since: 2.32
**/ **/
@ -977,13 +976,13 @@ g_static_resource_init (GStaticResource *static_resource)
/** /**
* g_static_resource_fini: * g_static_resource_fini:
* @static_resource: pointer to a static #GStaticResource. * @static_resource: pointer to a static #GStaticResource
* *
* Finalized a GResource initialized by g_static_resource_init (). * Finalized a GResource initialized by g_static_resource_init().
* *
* This is normally used by code generated by * This is normally used by code generated by
* <link linkend="glib-compile-resources">glib-compile-resources</link> and is * <link linkend="glib-compile-resources">glib-compile-resources</link>
* not typically used by other code. * and is not typically used by other code.
* *
* Since: 2.32 * Since: 2.32
**/ **/
@ -1009,15 +1008,15 @@ g_static_resource_fini (GStaticResource *static_resource)
/** /**
* g_static_resource_get_resource: * g_static_resource_get_resource:
* @static_resource: pointer to a static #GStaticResource. * @static_resource: pointer to a static #GStaticResource
* *
* Gets the GResource that was registred by a call to g_static_resource_init (). * Gets the GResource that was registred by a call to g_static_resource_init().
* *
* This is normally used by code generated by * This is normally used by code generated by
* <link linkend="glib-compile-resources">glib-compile-resources</link> and is * <link linkend="glib-compile-resources">glib-compile-resources</link>
* not typically used by other code. * and is not typically used by other code.
* *
* Return value: (transfer none): a #GResource. * Return value: (transfer none): a #GResource
* *
* Since: 2.32 * Since: 2.32
**/ **/