summaryrefslogtreecommitdiff
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
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.
-rw-r--r--ChangeLog13
-rw-r--r--ChangeLog.pre-1-013
-rw-r--r--ChangeLog.pre-1-1013
-rw-r--r--ChangeLog.pre-1-213
-rw-r--r--ChangeLog.pre-1-413
-rw-r--r--ChangeLog.pre-1-613
-rw-r--r--ChangeLog.pre-1-813
-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
-rw-r--r--pango/pangowin32-fontcache.c8
-rw-r--r--pango/pangox-fontcache.c10
13 files changed, 124 insertions, 20 deletions
diff --git a/ChangeLog b/ChangeLog
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-0 b/ChangeLog.pre-1-0
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-0
+++ b/ChangeLog.pre-1-0
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-10
+++ b/ChangeLog.pre-1-10
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-2 b/ChangeLog.pre-1-2
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-2
+++ b/ChangeLog.pre-1-2
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-4
+++ b/ChangeLog.pre-1-4
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-6
+++ b/ChangeLog.pre-1-6
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8
index 4b8b9ec1..75fe64e4 100644
--- a/ChangeLog.pre-1-8
+++ b/ChangeLog.pre-1-8
@@ -1,3 +1,16 @@
+2002-03-12 Matthias Clasen <maclas@gmx.de>
+
+ * 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.
+
Thu Mar 7 22:55:13 2002 Owen Taylor <otaylor@redhat.com>
===== Released 1.0.0 =====
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>
diff --git a/pango/pangowin32-fontcache.c b/pango/pangowin32-fontcache.c
index 9d71d738..f05d341c 100644
--- a/pango/pangowin32-fontcache.c
+++ b/pango/pangowin32-fontcache.c
@@ -66,7 +66,7 @@ free_cache_entry (LOGFONT *logfont,
* pango_win32_font_cache_free:
* @cache: a #PangoWin32FontCache
*
- * Free a #PangoWin32FontCache and all associated memory. All fonts loaded
+ * Frees a #PangoWin32FontCache and all associated memory. All fonts loaded
* through this font cache will be freed along with the cache.
**/
void
@@ -115,7 +115,7 @@ logfont_equal (gconstpointer v1,
/**
* pango_win32_font_cache_new:
*
- * Create a font cache.
+ * Creates a font cache.
*
* Return value: The new font cache. This must be freed with
* pango_win32_font_cache_free().
@@ -156,7 +156,7 @@ cache_entry_unref (PangoWin32FontCache *cache,
* @cache: a #PangoWin32FontCache
* @logfont: a pointer to a LOGFONT structure describing the font to load.
*
- * Create a #HFONT from a LOGFONT. The
+ * Creates a #HFONT from a LOGFONT. The
* result may be newly loaded, or it may have been previously
* stored
*
@@ -327,7 +327,7 @@ pango_win32_font_cache_load (PangoWin32FontCache *cache,
* @cache: a #PangoWin32FontCache
* @hfont: the HFONT to unload
*
- * Free a font structure previously loaded with pango_win32_font_cache_load()
+ * Frees a font structure previously loaded with pango_win32_font_cache_load().
**/
void
pango_win32_font_cache_unload (PangoWin32FontCache *cache,
diff --git a/pango/pangox-fontcache.c b/pango/pangox-fontcache.c
index ff606f03..b1e3ae60 100644
--- a/pango/pangox-fontcache.c
+++ b/pango/pangox-fontcache.c
@@ -64,7 +64,7 @@ free_cache_entry (char *xlfd, CacheEntry *entry, PangoXFontCache *cache)
* pango_x_font_cache_free:
* @cache: a #PangoXFontCache
*
- * Free a #PangoXFontCache and all associated memory. All fonts loaded
+ * Frees a #PangoXFontCache and all associated memory. All fonts loaded
* through this font cache will be freed along with the cache.
**/
void
@@ -84,7 +84,7 @@ pango_x_font_cache_free (PangoXFontCache *cache)
* pango_x_font_cache_new:
* @display: an X display.
*
- * Create a font cache for the specified display.
+ * Creates a font cache for the specified display.
*
* Return value: The new font cache. This must be freed with
* pango_x_font_cache_free().
@@ -128,9 +128,9 @@ cache_entry_unref (PangoXFontCache *cache, CacheEntry *entry)
* @cache: a #PangoXFontCache
* @xlfd: the X Logical Font Description to load.
*
- * Load a #XFontStruct from a X Logical Font Description. The
+ * Loads a #XFontStruct from a X Logical Font Description. The
* result may be newly loaded, or it may have been previously
- * stored
+ * stored.
*
* Return value: The font structure, or %NULL if the font could
* not be loaded. In order to free this structure, you must call
@@ -227,7 +227,7 @@ pango_x_font_cache_load (PangoXFontCache *cache,
* @cache: a #PangoXFontCache
* @fs: the font structure to unload
*
- * Free a font structure previously loaded with pango_x_font_cache_load()
+ * Frees a font structure previously loaded with pango_x_font_cache_load().
**/
void
pango_x_font_cache_unload (PangoXFontCache *cache,