summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKjell Ahlstedt <kjell.ahlstedt@bredband.net>2014-04-11 18:52:39 +0200
committerMatthias Clasen <mclasen@redhat.com>2014-12-11 09:20:55 -0500
commit4621142e0cf6bede6262695d3de020c3ffc93e20 (patch)
treefa695c237db530a25acd22f86ec834072a301180
parent28c39fb0f84487c7d6f671a1c66cd876d8c6da9f (diff)
downloadgtk+-4621142e0cf6bede6262695d3de020c3ffc93e20.tar.gz
docs: Explain 'icon theme context' better in gtkicontheme.c
Add links from gtk_icon_theme_list_contexts() to gtk_icon_theme_list_icons(), and from there to the Icon Theme Specification and the Icon Naming Specification. https://bugzilla.gnome.org/show_bug.cgi?id=461249
-rw-r--r--gtk/gtkicontheme.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index ea44a81d63..563a709da1 100644
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -2543,12 +2543,16 @@ add_key_to_list (gpointer key,
* @icon_theme: a #GtkIconTheme
* @context: (allow-none): a string identifying a particular type of
* icon, or %NULL to list all icons.
- *
+ *
* Lists the icons in the current icon theme. Only a subset
* of the icons can be listed by providing a context string.
* The set of values for the context string is system dependent,
* but will typically include such values as “Applications” and
- * “MimeTypes”.
+ * “MimeTypes”. Contexts are explained in the
+ * [Icon Theme Specification](http://www.freedesktop.org/wiki/Specifications/icon-theme-spec).
+ * The standard contexts are listed in the
+ * [Icon Naming Specification](http://www.freedesktop.org/wiki/Specifications/icon-naming-spec).
+ * Also see gtk_icon_theme_list_contexts().
*
* Returns: (element-type utf8) (transfer full): a #GList list
* holding the names of all the icons in the theme. You must
@@ -2610,7 +2614,8 @@ gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
* @icon_theme: a #GtkIconTheme
*
* Gets the list of contexts available within the current
- * hierarchy of icon themes
+ * hierarchy of icon themes.
+ * See gtk_icon_theme_list_icons() for details about contexts.
*
* Returns: (element-type utf8) (transfer full): a #GList list
* holding the names of all the contexts in the theme. You must first