diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2021-03-20 22:52:01 +0000 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-03-21 12:34:20 +0000 |
commit | 0ad5532347210a53490734b9b1dda31f73560a4d (patch) | |
tree | d5c282c14cc5d03d8c1a58c509a5eefff59d856e /gdk-pixbuf/gdk-pixbuf-animation.c | |
parent | 0c545e3f4e3fc321b6e8aea796871d3edceff685 (diff) | |
download | gdk-pixbuf-0ad5532347210a53490734b9b1dda31f73560a4d.tar.gz |
docs: Port to the gi-docgen syntax and style
Drop the gtk-doc SECTION markers, and move documentation to classes or
separate documents.
Diffstat (limited to 'gdk-pixbuf/gdk-pixbuf-animation.c')
-rw-r--r-- | gdk-pixbuf/gdk-pixbuf-animation.c | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/gdk-pixbuf/gdk-pixbuf-animation.c b/gdk-pixbuf/gdk-pixbuf-animation.c index c8f2695e3..9b7372e00 100644 --- a/gdk-pixbuf/gdk-pixbuf-animation.c +++ b/gdk-pixbuf/gdk-pixbuf-animation.c @@ -30,21 +30,30 @@ #include <glib/gstdio.h> /** - * SECTION:animation - * @Short_description: Animated images. - * @Title: Animations - * @See_also: #GdkPixbufLoader. + * GdkPixbufAnimation: + * + * An opaque object representing an animation. * * The GdkPixBuf library provides a simple mechanism to load and * represent animations. An animation is conceptually a series of - * frames to be displayed over time. The animation may not be - * represented as a series of frames internally; for example, it may - * be stored as a sprite and instructions for moving the sprite around - * a background. To display an animation you don't need to understand - * its representation, however; you just ask GdkPixBuf what should + * frames to be displayed over time. + * + * The animation may not be represented as a series of frames + * internally; for example, it may be stored as a sprite and + * instructions for moving the sprite around a background. + * + * To display an animation you don't need to understand its + * representation, however; you just ask `GdkPixbuf` what should * be displayed at a given point in time. */ +/** + * GdkPixbufAnimationIter: + * + * An opaque object representing an iterator which points to a + * certain position in an animation. + */ + typedef struct _GdkPixbufNonAnim GdkPixbufNonAnim; typedef struct _GdkPixbufNonAnimClass GdkPixbufNonAnimClass; |