From 1040078ce60b4641e5a3cdad6a2cef14660e63a3 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Tue, 9 Feb 2010 18:02:51 -0500 Subject: Update API documentation. Also, start fixing some Gtk-Doc warnings. There's a lot. --- e-util/e-icon-factory.c | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) (limited to 'e-util/e-icon-factory.c') diff --git a/e-util/e-icon-factory.c b/e-util/e-icon-factory.c index 4f4b8d3a40..61b0b6acf0 100644 --- a/e-util/e-icon-factory.c +++ b/e-util/e-icon-factory.c @@ -125,11 +125,13 @@ e_icon_factory_get_icon (const gchar *icon_name, /** * e_icon_factory_pixbuf_scale - * Scales pixbuf to desired size. - * @param pixbuf Pixbuf to be scaled. - * @param width Desired width, if less or equal to 0, then changed to 1. - * @param height Desired height, if less or equal to 0, then changed to 1. - * @return Scaled pixbuf. + * @pixbuf: a #GdkPixbuf + * @width: desired width, if less or equal to 0, then changed to 1 + * @height: desired height, if less or equal to 0, then changed to 1 + * + * Scales @pixbuf to desired size. + * + * Returns: a scaled #GdkPixbuf **/ GdkPixbuf * e_icon_factory_pixbuf_scale (GdkPixbuf *pixbuf, gint width, gint height) @@ -151,9 +153,12 @@ e_icon_factory_pixbuf_scale (GdkPixbuf *pixbuf, gint width, gint height) /** * e_icon_factory_create_thumbnail - * Creates system thumbnail for a file filename. - * @param filename The file name to create the thumbnail for. - * @return Path to system thumbnail of the file; NULL if couldn't create it. Free it with g_free. + * @filename: the file name to create the thumbnail for + * + * Creates system thumbnail for @filename. + * + * Returns: Path to system thumbnail of the file; %NULL if couldn't + * create it. Free it with g_free(). **/ gchar * e_icon_factory_create_thumbnail (const gchar *filename) -- cgit v1.2.3