Improve docs.

2006-07-19  Behdad Esfahbod  <behdad@gnome.org>

        * pango/pango-layout.c (pango_layout_get_extents): Improve docs.

diff --git a/ChangeLog b/ChangeLog
index 6ed0f37..6df1188 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-07-19  Behdad Esfahbod  <behdad@gnome.org>
+
+       * pango/pango-layout.c (pango_layout_get_extents): Improve docs.
+
 2006-07-17  Richard Hult  <richard@imendio.com>
 
        Bug 347021 – atsui crash when a matching font cannot be found.

diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index bd76a26..11cd603 100644 (file)
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -2215,9 +2215,14 @@ pango_layout_get_extents_internal (PangoLayout    *layout,
                  or %NULL to indicate that the result is not needed.
  * 
  * Computes the logical and ink extents of @layout. Logical extents
- * are usually what you want for positioning things. The extents
- * are given in layout coordinates; layout coordinates begin at the
- * top left corner of the layout. 
+ * are usually what you want for positioning things.  Note that both extents
+ * may have non-zero x and y.  You may want to use those to offset where you
+ * render the layout.  Not doing that is a very typical bug that shows up as
+ * right-to-left layouts not being correctly positioned in a layout with
+ * a set width.
+ *
+ * The extents are given in layout coordinates and in Pango units; layout
+ * coordinates begin at the top left corner of the layout. 
  */
 void
 pango_layout_get_extents (PangoLayout    *layout,