summaryrefslogtreecommitdiff
path: root/gio/gicon.c
diff options
context:
space:
mode:
Diffstat (limited to 'gio/gicon.c')
-rw-r--r--gio/gicon.c17
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);