[pango/line-breaker: 17/33] layout iter: Add docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pango/line-breaker: 17/33] layout iter: Add docs
- Date: Tue, 25 Jan 2022 20:35:43 +0000 (UTC)
commit 2173190e3651d52fb4c85aeaf88f36144ddf556b
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Jan 24 14:42:52 2022 -0500
layout iter: Add docs
pango/pango-layout-iter.c | 14 ++++++++++++++
1 file changed, 14 insertions(+)
---
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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]