Improve documentation for functions allocating memory, on how the object

2006-01-31  Behdad Esfahbod  <behdad@gnome.org>

        * pango/fonts.c, pango/glyphstring.c pango/pango-attributes.c
        pango/pango-color.c, pango/pango-context.c
        pango/pango-coverage.c, pango/pango-fontset.c
        pango/pango-glyph-item.c, pango/pango-item.c
        pango/pango-layout.c, pango/pango-ot-buffer.c
        pango/pango-ot-info.c, pango/pango-ot-ruleset.c
        pango/pango-script.c, pango/pango-tabs.c pango/pango-utils.c
        pango/pangocairo-fcfontmap.c, pango/pangocairo-fontmap.c
        pango/pangox-fontcache.c, pango/pangoxft-render.c:
        Improve documentation for functions allocating memory,
        on how the object should be freed.

1 files changed, 5 insertions, 3 deletions

diff --git a/pango/pango-glyph-item.c b/pango/pango-glyph-item.c
index 89744df1..6cfd3826 100644
--- a/pango/pango-glyph-item.c
+++ b/pango/pango-glyph-item.c
@@ -31,7 +31,7 @@
 /**
  * pango_glyph_item_split:
  * @orig: a #PangoItem
- * @text: text to which positions in @orig apply.
+ * @text: text to which positions in @orig apply
  * @split_index: byte index of position to split item, relative to the start of the item
  * 
  * Modifies @orig to cover only the text after @split_index, and
@@ -43,9 +43,11 @@
  * zero-length item).
  *
  * This function is similar in function to pango_item_split() (and uses
- * it internally)
+ * it internally.)
  * 
- * Return value: new item representing text before @split_index
+ * Return value: the newly allocated item representing text before
+ *               @split_index, which should be freed
+ *               with pango_glyph_item_free().
  *
  * Since: 1.2
  **/