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, 6 insertions, 2 deletions

diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index 77a266fd..dd92b944 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -204,7 +204,9 @@ pango_layout_finalize (GObject *object)
  * Create a new #PangoLayout object with attributes initialized to
  * default values for a particular #PangoContext.
  * 
- * Return value: the new #PangoLayout, with a reference count of one.
+ * Return value: the newly allocated #PangoLayout, with a reference
+ *               count of one, which should be freed with
+ *               g_object_unref().
  **/
 PangoLayout *
 pango_layout_new (PangoContext *context)
@@ -229,7 +231,9 @@ pango_layout_new (PangoContext *context)
  * tab array, and text from the original layout are all copied by
  * value.
  * 
- * Return value: the new #PangoLayout.
+ * Return value: the newly allocated #PangoLayout, with a reference
+ *               count of one, which should be freed with
+ *               g_object_unref().
  **/
 PangoLayout*
 pango_layout_copy (PangoLayout *src)