summaryrefslogtreecommitdiff
path: root/gtk/gtkimage.h
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-02-18 18:17:56 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2021-03-11 16:37:30 +0000
commite8b6e6cad0b07a1a64ac7af1133f59fddc522e6c (patch)
tree65463c1fd125fbfe06e162807ff9af26a3b52a05 /gtk/gtkimage.h
parent701f1b837b30c504617374d445bb2ba799f87d49 (diff)
downloadgtk+-e8b6e6cad0b07a1a64ac7af1133f59fddc522e6c.tar.gz
docs: Clean up the first paragraph for various symbols
The documentation engine will use the first paragraph as the summary for a type or constant.
Diffstat (limited to 'gtk/gtkimage.h')
-rw-r--r--gtk/gtkimage.h15
1 files changed, 8 insertions, 7 deletions
diff --git a/gtk/gtkimage.h b/gtk/gtkimage.h
index 6700b3d525..c63b37a1c1 100644
--- a/gtk/gtkimage.h
+++ b/gtk/gtkimage.h
@@ -49,13 +49,14 @@ typedef struct _GtkImage GtkImage;
* @GTK_IMAGE_GICON: the widget contains a #GIcon
* @GTK_IMAGE_PAINTABLE: the widget contains a #GdkPaintable
*
- * Describes the image data representation used by a #GtkImage. If you
- * want to get the image from the widget, you can only get the
- * currently-stored representation. e.g. if the
- * gtk_image_get_storage_type() returns #GTK_IMAGE_PAINTABLE, then you can
- * call gtk_image_get_paintable(). For empty images, you can request any
- * storage type (call any of the "get" functions), but they will all
- * return %NULL values.
+ * Describes the image data representation used by a [class@Gtk.Image].
+ *
+ * If you want to get the image from the widget, you can only get the
+ * currently-stored representation; for instance, if the gtk_image_get_storage_type()
+ * returns %GTK_IMAGE_PAINTABLE, then you can call gtk_image_get_paintable().
+ *
+ * For empty images, you can request any storage type (call any of the "get"
+ * functions), but they will all return %NULL values.
*/
typedef enum
{