Improve docs.

2008-02-15  Behdad Esfahbod  <behdad@gnome.org>

        * pango/pango-layout.c: Improve docs.

svn path=/trunk/; revision=2567

diff --git a/ChangeLog b/ChangeLog
index dcce2e8..d3563bd 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2008-02-15  Behdad Esfahbod  <behdad@gnome.org>
+
+       * pango/pango-layout.c: Improve docs.
+
 2008-02-14  Tor Lillqvist  <tml@novell.com>
 
        Bug 515484 – Pango on Windows is missing non-TrueType 

diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index fcc3b11..6a38bf2 100644 (file)
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -589,7 +589,7 @@ pango_layout_get_spacing (PangoLayout *layout)
 /**
  * pango_layout_set_attributes:
  * @layout: a #PangoLayout
- * @attrs: a #PangoAttrList
+ * @attrs: a #PangoAttrList, can be %NULL
  *
  * Sets the text attributes for a layout object.
  * References @attrs, so the caller can unref its reference.
@@ -995,6 +995,12 @@ pango_layout_is_ellipsized (PangoLayout *layout)
  *          positive.
  *
  * Sets the text of the layout.
+ *
+ * Note that if you have used
+ * pango_layout_set_markup() or pango_layout_set_markup_with_accel() on
+ * @layout before, you may want to call pango_layout_set_attributes() to clear
+ * the attributes set on the layout from the markup as this function does not
+ * clear attributes.
  **/
 void
 pango_layout_set_text (PangoLayout *layout,