Improve pango_cairo_font_map_get_default() docs.

2007-12-10  Behdad Esfahbod  <behdad@gnome.org>

        * pango/pangocairo-fontmap.c: Improve
        pango_cairo_font_map_get_default() docs.

svn path=/trunk/; revision=2521

diff --git a/ChangeLog b/ChangeLog
index b7ad3b4..db65be0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2007-12-10  Behdad Esfahbod  <behdad@gnome.org>
 
+       * pango/pangocairo-fontmap.c: Improve
+       pango_cairo_font_map_get_default() docs.
+
+2007-12-10  Behdad Esfahbod  <behdad@gnome.org>
+
        Bug 399573 – replace strtoul in pango-markup.c with pango_scan_int()
 
        * pango/pango-markup.c (span_parse_func): Use pango_scan_int() and

diff --git a/pango/pangocairo-fontmap.c b/pango/pangocairo-fontmap.c
index 796ac46..cb7dd9d 100644 (file)
--- a/pango/pangocairo-fontmap.c
+++ b/pango/pangocairo-fontmap.c
@@ -149,7 +149,12 @@ pango_cairo_font_map_new_for_font_type (cairo_font_type_t fonttype)
 /**
  * pango_cairo_font_map_get_default:
  *
- * Gets a default font map to use with Cairo.
+ * Gets a default #PangoCairoFontMap to use with Cairo.
+ *
+ * Note that the type of the returned object will depend
+ * on the particular font backend Cairo was compiled to use;
+ * You generally should only use the #PangoFontMap and
+ * #PangoCairoFontMap interfaces on the returned object.
  *
  * Return value: the default Cairo fontmap for #Pango. This
  *  object is owned by Pango and must not be freed.