diff options
author | Andrew Walton <awalton@src.gnome.org> | 2007-11-29 10:18:55 +0000 |
---|---|---|
committer | Andrew Walton <awalton@src.gnome.org> | 2007-11-29 10:18:55 +0000 |
commit | 0c867d344461515213e6e04de9f072e43ea2e646 (patch) | |
tree | 8522415f3d680fcbba37b1fd40ee3f7ea2ab1b2a /gio/gicon.c | |
parent | 09471fec46619a62fbe9b6e7a7b67c9a421f919e (diff) | |
download | glib-0c867d344461515213e6e04de9f072e43ea2e646.tar.gz |
Fixes unknown meaning in GAppLaunchContext docs. Clarify asynchronous ops.
* gappinfo.c:
Fixes unknown meaning in GAppLaunchContext docs.
* gfile.c:
Clarify asynchronous ops.
* gfileattribute.c:
Fix entity tag docs.
* gicon.c:
* gthemedicon.c:
Provides missing gtk-doc section, fixes API docs slighly.
* gsimpleasyncresult.c:
Fill in missing info in docs.
* gunixinputstream.c:
* gunixoutputstream.c:
Be more expressive in short description.
* gunixvolume.c:
Remove gtk-doc stubs for non-public API.
svn path=/trunk/; revision=5994
Diffstat (limited to 'gio/gicon.c')
-rw-r--r-- | gio/gicon.c | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/gio/gicon.c b/gio/gicon.c index a6631a189..5a2f39080 100644 --- a/gio/gicon.c +++ b/gio/gicon.c @@ -27,6 +27,23 @@ #include "gioalias.h" +/** + * SECTION:gicon + * @short_description: base class for icons + * + * #GIcon is a base class for implementing more complex icon classes. It + * contains a very minimal interface for checking the equality of two icons + * and hashing of icons. + * + * #GIcon does not provide the actual pixmap for the icon as this is out + * of gio's scope, however implementations of #GIcon may contain the name + * of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon). + * + * To obtain a hash of a #GIcon, see g_icon_hash(). + * + * To check if two #GIcons are equal, see g_icon_equal(). + **/ + static void g_icon_base_init (gpointer g_class); static void g_icon_class_init (gpointer g_class, gpointer class_data); |