summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2002-03-12 00:15:07 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2002-03-12 00:15:07 +0000
commit4810649b54cc95d6926beaaa1305a4e5a205e0ce (patch)
treebbcf8498b83dd15f08f5a8d933b9b0d6f3a9259e /docs
parent13a1cc80eb461e482d8055e701756ecee9fb5da5 (diff)
downloadpango-4810649b54cc95d6926beaaa1305a4e5a205e0ce.tar.gz
Minor doc edits.
* pango/pangowin32-fontcache.c, pango/pangox-fontcache.c: Minor doc edits. * docs/tmpl/win32-fonts.sgml: Document PangoWin32FontCache. * docs/tmpl/x-fonts.sgml: Document PangoXFontCache. * docs/tmpl/glyphs.sgml: Document PangoGlyphInfo. * docs/tmpl/opentype.sgml: Document PangoOTInfo, PangoOTTag, PangoOTTableType.
Diffstat (limited to 'docs')
-rw-r--r--docs/tmpl/glyphs.sgml10
-rw-r--r--docs/tmpl/opentype.sgml19
-rw-r--r--docs/tmpl/win32-fonts.sgml3
-rw-r--r--docs/tmpl/x-fonts.sgml3
4 files changed, 24 insertions, 11 deletions
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index 04d2ba5f..a43b2905 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -124,12 +124,14 @@ form of a string. It contains the following fields.
<!-- ##### STRUCT PangoGlyphInfo ##### -->
<para>
-
+The #PangoGlyphInfo structure represents a single glyph together with
+positioning information and visual attributes.
+It contains the following fields.
</para>
-@glyph:
-@geometry:
-@attr:
+@glyph: the glyph itself.
+@geometry: the positional information about the glyph.
+@attr: the visual attributes of the glyph.
<!-- ##### STRUCT PangoGlyphGeometry ##### -->
<para>
diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml
index 42656151..8e3a0d4e 100644
--- a/docs/tmpl/opentype.sgml
+++ b/docs/tmpl/opentype.sgml
@@ -16,13 +16,20 @@ OpenType Font Handling
<!-- ##### TYPEDEF PangoOTTag ##### -->
<para>
-
+The <type>PangoOTTag</type> typedef is used to represent TrueType and OpenType
+four letter tags inside Pango. Use the <function>FT_MAKE_TAG()</function> macro
+defined in the FreeType2 header <filename>freetype/freetype.h</filename> to
+create <type>PangoOTTag</type>s manually.
</para>
<!-- ##### STRUCT PangoOTInfo ##### -->
<para>
-
+The <structname>PangoOTInfo</structname> struct contains the various
+tables associated with an OpenType font. It contains only private fields and
+should only be accessed via the <function>pango_ot_info_*</function> functions
+which are documented below. To obtain a <structname>PangoOTInfo</structname>,
+use pango_ot_info_new().
</para>
@@ -34,11 +41,13 @@ OpenType Font Handling
<!-- ##### ENUM PangoOTTableType ##### -->
<para>
-
+The <type>PangoOTTableType</type> enumeration values are used to
+identify the various OpenType tables in the
+<function>pango_ot_info_*</function> functions.
</para>
-@PANGO_OT_TABLE_GSUB:
-@PANGO_OT_TABLE_GPOS:
+@PANGO_OT_TABLE_GSUB: The GSUB table.
+@PANGO_OT_TABLE_GPOS: The GPOS table.
<!-- ##### FUNCTION pango_ot_info_new ##### -->
<para>
diff --git a/docs/tmpl/win32-fonts.sgml b/docs/tmpl/win32-fonts.sgml
index 9c801fd2..e887a105 100644
--- a/docs/tmpl/win32-fonts.sgml
+++ b/docs/tmpl/win32-fonts.sgml
@@ -85,7 +85,8 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map().
<!-- ##### STRUCT PangoWin32FontCache ##### -->
<para>
-
+A <structname>PangoWin32FontCache</structname> caches
+<structname>HFONT</structname>s by their <structname>LOGFONT</structname> descriptions.
</para>
diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml
index a97a0c1b..eabc2afa 100644
--- a/docs/tmpl/x-fonts.sgml
+++ b/docs/tmpl/x-fonts.sgml
@@ -176,7 +176,8 @@ glyph index.
<!-- ##### STRUCT PangoXFontCache ##### -->
<para>
-
+A <structname>PangoXFontCache</structname> caches
+<structname>XFontStruct</structname>s for a single display by their XLFD name.
</para>