Document PangoOTBuffer and PangoOTGlyph.

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

        * doc/tmpl/opentype.sgml: Document PangoOTBuffer and PangoOTGlyph.

        * pango/pango-ot-buffer.c, pango/pango-ot-info.c,
        pango/pango-ot-ruleset.c: Document remaining symbols.

7 files changed, 16 insertions, 26 deletions

diff --git a/docs/tmpl/freetype-fonts.sgml b/docs/tmpl/freetype-fonts.sgml
index 9877c200..e39ba6bb 100644
--- a/docs/tmpl/freetype-fonts.sgml
+++ b/docs/tmpl/freetype-fonts.sgml
@@ -91,8 +91,6 @@ Function type for doing final config tweaking on prepared FcPatterns.
 @dpi_x: 
 @dpi_y: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@dpi: 
 
 
 <!-- ##### FUNCTION pango_ft2_render ##### -->
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index 9c365968..1232cd36 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -177,8 +177,6 @@ horizontal origin.
 
 @matrix: 
 @new_matrix: 
-<!-- # Unused Parameters # -->
-@new: 
 
 
 <!-- ##### FUNCTION pango_matrix_get_font_scale_factor ##### -->
diff --git a/docs/tmpl/modules.sgml b/docs/tmpl/modules.sgml
index 2d74a8ad..e552e387 100644
--- a/docs/tmpl/modules.sgml
+++ b/docs/tmpl/modules.sgml
@@ -60,8 +60,6 @@ matches the language tag for this entry's map exactly or just approximately.
 @map: 
 @script: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@wc: 
 
 
 <!-- ##### FUNCTION pango_map_get_engines ##### -->
diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml
index 8cfe4405..d62bb3d9 100644
--- a/docs/tmpl/opentype.sgml
+++ b/docs/tmpl/opentype.sgml
@@ -35,21 +35,28 @@ use pango_ot_info_new().
 
 <!-- ##### STRUCT PangoOTBuffer ##### -->
 <para>
-
+The #PangoOTBuffer structure is used to store strings of glyphs associated
+with a #PangoFcFont, suitable for OpenType layout processing.  It contains
+only private fields and should only be accessed via the
+<function>pango_ot_buffer_*</function> functions which are documented below.
+To obtain a #PangoOTBuffer, use pango_ot_buffer_new().
 </para>
 
 
 <!-- ##### STRUCT PangoOTGlyph ##### -->
 <para>
-
+The #PangoOTGlyph structure represents a single glyph together with
+information used for OpenType layout processing of the glyph.
+It contains the following fields.
 </para>
 
-@glyph: 
-@properties: 
-@cluster: 
-@component: 
-@ligID: 
-@property_cache: 
+@glyph: the glyph itself.
+@properties: the properties value, identifying which features should be
+	     applied on this glyph.  See pango_ruleset_add_feature().
+@cluster: the cluster that this glyph belongs to.
+@component: a component value, set by the OpenType layout engine.
+@ligID: a ligature index value, set by the OpenType layout engine.
+@property_cache: for internal use.
 
 <!-- ##### STRUCT PangoOTRuleset ##### -->
 <para>
@@ -81,8 +88,6 @@ identify the various OpenType tables in the
 
 @face: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@font: 
 
 
 <!-- ##### FUNCTION pango_ot_info_find_script ##### -->
@@ -191,7 +196,7 @@ identify the various OpenType tables in the
 </para>
 
 @buffer: 
-@glyph_index: 
+@glyph: 
 @properties: 
 @cluster: 
 
diff --git a/docs/tmpl/pango-renderer.sgml b/docs/tmpl/pango-renderer.sgml
index ba7fd16e..f5f2bd9c 100644
--- a/docs/tmpl/pango-renderer.sgml
+++ b/docs/tmpl/pango-renderer.sgml
@@ -130,8 +130,6 @@ The #GObject type for #PangoRenderPart.
 @y2: 
 @x12: 
 @x22: 
-<!-- # Unused Parameters # -->
-@y1: 
 
 
 <!-- ##### FUNCTION pango_renderer_draw_glyph ##### -->
diff --git a/docs/tmpl/pangocairo.sgml b/docs/tmpl/pangocairo.sgml
index 0c58c923..93172ac4 100644
--- a/docs/tmpl/pangocairo.sgml
+++ b/docs/tmpl/pangocairo.sgml
@@ -168,9 +168,6 @@ int main (int argc, char **argv)
 
 @fontmap: 
 @dpi: 
-<!-- # Unused Parameters # -->
-@dpi_x: 
-@dpi_y: 
 
 
 <!-- ##### FUNCTION pango_cairo_font_map_get_resolution ##### -->
diff --git a/docs/tmpl/pangofc-fontmap.sgml b/docs/tmpl/pangofc-fontmap.sgml
index 34c99b77..68a349f1 100644
--- a/docs/tmpl/pangofc-fontmap.sgml
+++ b/docs/tmpl/pangofc-fontmap.sgml
@@ -78,8 +78,6 @@ Fontconfig-based backend involves deriving from both
 
 @fcfontmap: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@fontmap: 
 
 
 <!-- ##### FUNCTION pango_fc_font_map_shutdown ##### -->
@@ -88,8 +86,6 @@ Fontconfig-based backend involves deriving from both
 </para>
 
 @fcfontmap: 
-<!-- # Unused Parameters # -->
-@fontmap: 
 
 
 <!-- ##### FUNCTION pango_fc_font_map_add_decoder_find_func ##### -->