[glibmm] Gio::Resource docs: Suppress inappropriate doxygen links
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Gio::Resource docs: Suppress inappropriate doxygen links
- Date: Fri, 2 Jan 2015 11:52:31 +0000 (UTC)
commit 3bd36da8786f7f9690dc4f8c2b10a413517e6ac8
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Fri Jan 2 12:49:45 2015 +0100
Gio::Resource docs: Suppress inappropriate doxygen links
* gio/src/resource.hg: Insert '%' before 'Resource' where doxygen shall not
generate a link to Gio::Resource.
gio/src/resource.hg | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/gio/src/resource.hg b/gio/src/resource.hg
index a74c469..dbb289e 100644
--- a/gio/src/resource.hg
+++ b/gio/src/resource.hg
@@ -38,7 +38,7 @@ _WRAP_GERROR(ResourceError, GResourceError, G_RESOURCE_ERROR, NO_GTYPE)
_WRAP_ENUM(ResourceFlags, GResourceFlags)
_WRAP_ENUM(ResourceLookupFlags, GResourceLookupFlags)
-/** Resource framework.
+/** %Resource framework.
*
* Applications and libraries often contain binary or textual data that is
* really part of the application, rather than user data. For instance
@@ -48,17 +48,17 @@ _WRAP_ENUM(ResourceLookupFlags, GResourceLookupFlags)
*
* The Gio::Resource API and the <tt>glib-compile-resources</tt> 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
+ * maintain the files as normal files, so it's 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
* the resource files is efficient (as they are already in memory, shared with other instances) and
* simple (no need to check for things like I/O errors or locate the files in the filesystem). It
* also makes it easier to create relocatable applications.
*
- * Resource files can also be marked as compressed. Such files will be included in the resource bundle
+ * %Resource files can also be marked as compressed. Such files will be included in the resource bundle
* in a compressed form, but will be automatically uncompressed when the resource is used. This
* 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
+ * %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.
* The only options currently supported are:
*
@@ -79,7 +79,7 @@ _WRAP_ENUM(ResourceLookupFlags, GResourceLookupFlags)
* abort.</dd>
* </dl>
*
- * Resource bundles are created by the <tt>glib-compile-resources</tt> program
+ * %Resource bundles are created by the <tt>glib-compile-resources</tt> 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.
*
@@ -106,7 +106,7 @@ _WRAP_ENUM(ResourceLookupFlags, GResourceLookupFlags)
* path prefixes (like in the above example) to avoid conflicts.
*
* You can then use <tt>glib-compile-resources</tt> to compile the xml to a binary bundle
- * that you can load with Gio::Resource::create_from_file(). However, its more common to use the
--generate-source and
+ * that you can load with Gio::Resource::create_from_file(). However, it's more common to use the
--generate-source and
* --generate-header arguments to create a source file and header to link directly into your application.
*
* Once a Gio::Resource has been created and registered all the data in it can be accessed globally in the
process by
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]