diff options
| author | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
|---|---|---|
| committer | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
| commit | 5247f12f3649726471080440de0d37b78c1cec33 (patch) | |
| tree | 69bd070ba8cb8b12234319e354f5cb856d0c551f /gio/gfileicon.c | |
| parent | 6d071b4ab6d60aecf9532d1aac2128dd0c08f917 (diff) | |
| download | glib-5247f12f3649726471080440de0d37b78c1cec33.tar.gz | |
Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes.
Fixes GCancellable inaccuracies. Removes unnecessary incomplete
gtk-doc headers in private files.
svn path=/trunk/; revision=5953
Diffstat (limited to 'gio/gfileicon.c')
| -rw-r--r-- | gio/gfileicon.c | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/gio/gfileicon.c b/gio/gfileicon.c index 6e46e7f95..be3f3fe9e 100644 --- a/gio/gfileicon.c +++ b/gio/gfileicon.c @@ -25,6 +25,16 @@ #include "gfileicon.h" #include "gsimpleasyncresult.h" +/** + * SECTION:gfileicon + * @short_description: Icons for given files. + * @see_also: #GIcon, #GLoadableIcon. + * @include: gio/gfileicon.h + * + * #GFileIcon gets the default icon for a #GFile. + * + **/ + static void g_file_icon_icon_iface_init (GIconIface *iface); static void g_file_icon_loadable_icon_iface_init (GLoadableIconIface *iface); static void g_file_icon_load_async (GLoadableIcon *icon, @@ -80,9 +90,11 @@ g_file_icon_init (GFileIcon *file) /** * g_file_icon_new: - * @file: + * @file: a #GFile. + * + * Creates a new icon for a file. * - * Returns: + * Returns: a #GIcon for the given @file, or %NULL on error. **/ GIcon * g_file_icon_new (GFile *file) @@ -99,9 +111,11 @@ g_file_icon_new (GFile *file) /** * g_file_icon_get_file: - * @icon: + * @icon: a #GIcon. + * + * Gets the #GFile associated with the given @icon. * - * Returns: + * Returns: a #GFile, or %NULL. **/ GFile * g_file_icon_get_file (GFileIcon *icon) |