diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2022-01-24 14:42:52 -0500 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2022-01-25 15:31:25 -0500 |
| commit | 2173190e3651d52fb4c85aeaf88f36144ddf556b (patch) | |
| tree | 7f56dc482339f8b3df41b30d0c062e33f4f80aba /pango | |
| parent | ff04aaa22877c0c867df157a93d78679c1408ae3 (diff) | |
| download | pango-2173190e3651d52fb4c85aeaf88f36144ddf556b.tar.gz | |
layout iter: Add docs
Diffstat (limited to 'pango')
| -rw-r--r-- | pango/pango-layout-iter.c | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/pango/pango-layout-iter.c b/pango/pango-layout-iter.c index 91d37b46..93941ac2 100644 --- a/pango/pango-layout-iter.c +++ b/pango/pango-layout-iter.c @@ -6,6 +6,20 @@ #include "pango-layout-line-private.h" #include "pango-layout-run-private.h" +/** + * PangoLayoutIter: + * + * A `PangoLayoutIter` can be used to iterate over the visual + * extents of a `PangoLayout` or `PangoLines`. + * + * To obtain a `PangoLayoutIter`, use [method@Pango.Layout.get_iter] + * or [method@Pango.Lines.get_iter]. + * + * The `PangoLayoutIter` structure is opaque, and has no user-visible + * fields. + */ + + /* {{{ PangoLayoutIter implementation */ struct _PangoLayoutIter |