Documentation improvements.

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

        * pango/pangofc-font.h, pango/pangoft2-render.c, pango/pangowin32.c,
        pango/pangoxft-render.c, docs/tmpl/xft-fonts.sgml,
        docs/tmp/atsui-fonts.sgml: Documentation improvements.

7 files changed, 34 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index f4e8f88a..8a4af404 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2006-01-28  Behdad Esfahbod  <behdad@gnome.org>
 
+	* pango/pangofc-font.h, pango/pangoft2-render.c, pango/pangowin32.c,
+	pango/pangoxft-render.c, docs/tmpl/xft-fonts.sgml,
+	docs/tmp/atsui-fonts.sgml: Documentation improvements.
+
+2006-01-28  Behdad Esfahbod  <behdad@gnome.org>
+
 	* configure.in: Use AC_HELP_STRING everywhere. Bump required version
 	to 2.56.
 
diff --git a/docs/tmpl/atsui-fonts.sgml b/docs/tmpl/atsui-fonts.sgml
index 6b3297b4..aa6f536e 100644
--- a/docs/tmpl/atsui-fonts.sgml
+++ b/docs/tmpl/atsui-fonts.sgml
@@ -17,6 +17,8 @@ Font handling and rendering with ATSUI fonts
 <!-- ##### STRUCT PangoCairoATSUIFont ##### -->
 <para>
 
+The #PangoCairoATSUIFont is #PangoFont used to represent
+an ATSUI font used with the cairo backend.
 </para>
 
 
diff --git a/docs/tmpl/xft-fonts.sgml b/docs/tmpl/xft-fonts.sgml
index fc4d6cae..00f345ae 100644
--- a/docs/tmpl/xft-fonts.sgml
+++ b/docs/tmpl/xft-fonts.sgml
@@ -41,13 +41,16 @@ overring the #PangoXftRendererClass virtual functions
 
 <!-- ##### STRUCT PangoXftFont ##### -->
 <para>
-
+#PangoXftFont is an implementation of #PangoFcFont using the Xft
+library for rendering.  It is used in conjunction with #PangoXftFontMap.
 </para>
 
 
 <!-- ##### STRUCT PangoXftFontMap ##### -->
 <para>
-
+#PangoXftFontMap is an implementation of #PangoFcFontMap suitable for
+the Xft library as the renderer.  It is used in to create fonts of
+type #PangoXftFont.
 </para>
 
 
diff --git a/pango/pangofc-font.h b/pango/pangofc-font.h
index afc5e96b..198fb7c6 100644
--- a/pango/pangofc-font.h
+++ b/pango/pangofc-font.h
@@ -58,7 +58,7 @@ typedef struct _PangoFcFontClass PangoFcFontClass;
 /**
  * PangoFcFont:
  * 
- * #PangoFcFontMap is a base class for font implementations
+ * #PangoFcFont is a base class for font implementations
  * using the FontConfig and FreeType libraries and is used in
  * conjunction with #PangoFcFontMap. When deriving from this
  * class, you need to implement all of its virtual functions
diff --git a/pango/pangoft2-render.c b/pango/pangoft2-render.c
index 2f40bd97..c7713f69 100644
--- a/pango/pangoft2-render.c
+++ b/pango/pangoft2-render.c
@@ -555,7 +555,7 @@ pango_ft2_render_layout_line (FT_Bitmap       *bitmap,
  * pango_ft2_render_transformed:
  * @bitmap:  the FreeType2 bitmap onto which to draw the string
  * @font:    the font in which to draw the string
- * @matrix: a #PangoMatrix, or %NULL to use an identity transformation
+ * @matrix:  a #PangoMatrix, or %NULL to use an identity transformation
  * @glyphs:  the glyph string to draw
  * @x:       the x position of the start of the string (in Pango
  *           units in user space coordinates)
diff --git a/pango/pangowin32.c b/pango/pangowin32.c
index beda66f6..c72d81e1 100644
--- a/pango/pangowin32.c
+++ b/pango/pangowin32.c
@@ -395,6 +395,24 @@ pango_win32_render (HDC               hdc,
   g_free (dX);
 }
 
+/**
+ * pango_win32_render_transformed:
+ * @hdc:     a windows device context
+ * @matrix:  a #PangoMatrix, or %NULL to use an identity transformation
+ * @font:    the font in which to draw the string
+ * @glyphs:  the glyph string to draw
+ * @x:       the x position of the start of the string (in Pango
+ *           units in user space coordinates)
+ * @y:       the y position of the baseline (in Pango units
+ *           in user space coordinates)
+ *
+ * Renders a #PangoGlyphString onto a windows DC, possibly
+ * transforming the layed-out coordinates through a transformation
+ * matrix. Note that the transformation matrix for @font is not
+ * changed, so to produce correct rendering results, the @font
+ * must have been loaded using a #PangoContext with an identical
+ * transformation matrix to that passed in to this function.
+ **/
 void 
 pango_win32_render_transformed (HDC                hdc,
 				const PangoMatrix *matrix,
diff --git a/pango/pangoxft-render.c b/pango/pangoxft-render.c
index b58212ce..ea6c99ff 100644
--- a/pango/pangoxft-render.c
+++ b/pango/pangoxft-render.c
@@ -676,7 +676,7 @@ pango_xft_render_layout_line (XftDraw         *draw,
  * @draw:    an #XftDraw
  * @color:   the color in which to draw the glyphs
  * @font:    the font in which to draw the string
- * @matrix: a #PangoMatrix, or %NULL to use an identity transformation
+ * @matrix:  a #PangoMatrix, or %NULL to use an identity transformation
  * @glyphs:  the glyph string to draw
  * @x:       the x position of the start of the string (in Pango
  *           units in user space coordinates)