X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgresource.c;h=d9c1699c8780502245022b931faa64662b41dd07;hb=627b49b39039d43a784fa9890f473d1ca8d52417;hp=646708a4dace3548f5ec90a0b51b0c5940c60fb6;hpb=111803030d54b192ca1edd25bbde90130eaff2a9;p=platform%2Fupstream%2Fglib.git
diff --git a/gio/gresource.c b/gio/gresource.c
index 646708a..d9c1699 100644
--- a/gio/gresource.c
+++ b/gio/gresource.c
@@ -45,12 +45,13 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* @short_description: Resource framework
* @include: gio/gio.h
*
- * Applications and libraries often contain binary or textual data that is really part of the
- * application, rather than user data. For instance #GtkBuilder .ui files, splashscreen images,
- * GMenu markup xml, CSS files, icons, etc. These are often shipped as files in $datadir/appname, or
+ * Applications and libraries often contain binary or textual data that is
+ * really part of the application, rather than user data. For instance
+ * #GtkBuilder .ui files, splashscreen images, GMenu markup xml, CSS files,
+ * icons, etc. These are often shipped as files in `$datadir/appname`, or
* manually included as literal strings in the code.
*
- * The #GResource API and the glib-compile-resources program
+ * The #GResource API and the [glib-compile-resources][glib-compile-resources] program
* provide a convenient and efficient alternative to this which has some nice properties. You
* maintain the files as normal files, so its easy to edit them, but during the build the files
* are combined into a binary bundle that is linked into the executable. This means that loading
@@ -63,23 +64,23 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* is very useful e.g. for larger text files that are parsed once (or rarely) and then thrown away.
*
* Resource files can also be marked to be preprocessed, by setting the value of the
- * preprocess attribute to a comma-separated list of preprocessing options.
+ * `preprocess` attribute to a comma-separated list of preprocessing options.
* The only options currently supported are:
*
- * xml-stripblanks which will use the xmllint command
+ * `xml-stripblanks` which will use the xmllint command
* to strip ignorable whitespace from the xml file. For this to work,
* the `XMLLINT` environment variable must be set to the full path to
* the xmllint executable, or xmllint must be in the `PATH`; otherwise
* the preprocessing step is skipped.
*
- * to-pixdata which will use the gdk-pixbuf-pixdata command to convert
+ * `to-pixdata` which will use the gdk-pixbuf-pixdata command to convert
* images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
* the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata
* program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be
* set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will
* abort.
*
- * Resource bundles are created by the glib-compile-resources program
+ * Resource bundles are created by the [glib-compile-resources][glib-compile-resources] program
* which takes an xml file that describes the bundle, and a set of files that the xml references. These
* are combined into a binary resource bundle.
*
@@ -105,7 +106,7 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* Note that all resources in the process share the same namespace, so use java-style
* path prefixes (like in the above example) to avoid conflicts.
*
- * You can then use glib-compile-resources to compile the xml to a
+ * You can then use [glib-compile-resources][glib-compile-resources] to compile the xml to a
* binary bundle that you can load with g_resource_load(). However, its more common to use the --generate-source and
* --generate-header arguments to create a source file and header to link directly into your application.
*
@@ -133,7 +134,7 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
*
* Gets the #GResource Error Quark.
*
- * Return value: a #GQuark
+ * Returns: a #GQuark
*
* Since: 2.32
*/
@@ -208,7 +209,7 @@ g_resource_new_from_table (GvdbTable *table)
* If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register().
*
- * Return value: (transfer full): a new #GResource, or %NULL on error
+ * Returns: (transfer full): a new #GResource, or %NULL on error
*
* Since: 2.32
**/
@@ -243,7 +244,7 @@ g_resource_new_from_data (GBytes *data,
* If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register().
*
- * Return value: (transfer full): a new #GResource, or %NULL on error
+ * Returns: (transfer full): a new #GResource, or %NULL on error
*
* Since: 2.32
**/
@@ -954,7 +955,7 @@ register_lazy_static_resources (void)
* GStaticResource.
*
* This is normally used by code generated by
- * glib-compile-resources
+ * [glib-compile-resources][glib-compile-resources]
* and is not typically used by other code.
*
* Since: 2.32
@@ -979,7 +980,7 @@ g_static_resource_init (GStaticResource *static_resource)
* Finalized a GResource initialized by g_static_resource_init().
*
* This is normally used by code generated by
- * glib-compile-resources
+ * [glib-compile-resources][glib-compile-resources]
* and is not typically used by other code.
*
* Since: 2.32
@@ -1011,10 +1012,10 @@ g_static_resource_fini (GStaticResource *static_resource)
* Gets the GResource that was registered by a call to g_static_resource_init().
*
* This is normally used by code generated by
- * glib-compile-resources
+ * [glib-compile-resources][glib-compile-resources]
* and is not typically used by other code.
*
- * Return value: (transfer none): a #GResource
+ * Returns: (transfer none): a #GResource
*
* Since: 2.32
**/