summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@gnome.org>2005-11-17 08:02:09 +0000
committerBehdad Esfahbod <behdad@src.gnome.org>2005-11-17 08:02:09 +0000
commitb9331c51d17a00fc7fe9a81dd1c1691dd23819be (patch)
treec3fb68d609dab317af34f5078f71235ceee3724a /docs
parentd4a4b736fa97361a8f5f7d010c1b34cb48d34925 (diff)
downloadpango-b9331c51d17a00fc7fe9a81dd1c1691dd23819be.tar.gz
More documentation improvements.
2005-11-17 Behdad Esfahbod <behdad@gnome.org> * docs/tmpl/coverage-maps.sgml docs/tmpl/fonts.sgml docs/tmpl/glyphs.sgml docs/tmpl/layout.sgml docs/tmpl/main.sgml docs/tmpl/scripts.sgml docs/tmpl/tab-stops.sgml docs/tmpl/text-attributes.sgml pango/break.c pango/fonts.c pango/pango-fontset.c pango/pango-layout.c pango/pango-script.c pango/pango-utils.c pango/pangofc-decoder.c pango/pangofc-decoder.h pango/pangofc-font.c pango/pangofc-font.h pango/pangoxft-font.c: More documentation improvements.
Diffstat (limited to 'docs')
-rw-r--r--docs/tmpl/coverage-maps.sgml2
-rw-r--r--docs/tmpl/fonts.sgml28
-rw-r--r--docs/tmpl/glyphs.sgml2
-rw-r--r--docs/tmpl/layout.sgml21
-rw-r--r--docs/tmpl/main.sgml2
-rw-r--r--docs/tmpl/scripts.sgml4
-rw-r--r--docs/tmpl/tab-stops.sgml4
-rw-r--r--docs/tmpl/text-attributes.sgml10
8 files changed, 36 insertions, 37 deletions
diff --git a/docs/tmpl/coverage-maps.sgml b/docs/tmpl/coverage-maps.sgml
index d673d65e..f88fa32f 100644
--- a/docs/tmpl/coverage-maps.sgml
+++ b/docs/tmpl/coverage-maps.sgml
@@ -36,7 +36,7 @@ character point for a particular script.
<!-- ##### MACRO PANGO_TYPE_COVERAGE_LEVEL ##### -->
<para>
-The GObject type for #PangoCoverageLevel.
+The #GObject type for #PangoCoverageLevel.
</para>
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index 34232cfa..0d777992 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -30,7 +30,7 @@ the characteristics of a font to load.
<!-- ##### MACRO PANGO_TYPE_FONT_DESCRIPTION ##### -->
<para>
-The GObject type for #PangoFontDescription.
+The #GObject type for #PangoFontDescription.
</para>
@@ -45,7 +45,7 @@ The GObject type for #PangoFontDescription.
<!-- ##### MACRO PANGO_TYPE_STYLE ##### -->
<para>
-The GObject type for #PangoStyle.
+The #GObject type for #PangoStyle.
</para>
@@ -66,7 +66,7 @@ value ranging from 100 to 900, but there are some predefined values:
<!-- ##### MACRO PANGO_TYPE_WEIGHT ##### -->
<para>
-The GObject type for #PangoWeight.
+The #GObject type for #PangoWeight.
</para>
@@ -82,7 +82,7 @@ An enumeration specifying capitalization variant of the font.
<!-- ##### MACRO PANGO_TYPE_VARIANT ##### -->
<para>
-The GObject type for #PangoVariant.
+The #GObject type for #PangoVariant.
</para>
@@ -105,7 +105,7 @@ within a family.
<!-- ##### MACRO PANGO_TYPE_STRETCH ##### -->
<para>
-The GObject type for #PangoStretch.
+The #GObject type for #PangoStretch.
</para>
@@ -125,7 +125,7 @@ The bits in a #PangoFontMask correspond to fields in a
<!-- ##### MACRO PANGO_TYPE_FONT_MASK ##### -->
<para>
-The GObject type for #PangoFontMask.
+The #GObject type for #PangoFontMask.
</para>
@@ -424,7 +424,7 @@ of their meaning.
<!-- ##### MACRO PANGO_TYPE_FONT_METRICS ##### -->
<para>
-The GObject type for #PangoFontMetrics.
+The #GObject type for #PangoFontMetrics.
</para>
@@ -538,7 +538,7 @@ which the implementation fills in.
<!-- ##### MACRO PANGO_TYPE_FONT ##### -->
<para>
-The GObject type for #PangoFont.
+The #GObject type for #PangoFont.
</para>
@@ -629,7 +629,7 @@ slant, weight, width and other aspects.
<!-- ##### MACRO PANGO_TYPE_FONT_FAMILY ##### -->
<para>
-The GObject type for #PangoFontFamily.
+The #GObject type for #PangoFontFamily.
</para>
@@ -687,7 +687,7 @@ the same family, slant, weight, width, but varying sizes.
<!-- ##### MACRO PANGO_TYPE_FONT_FACE ##### -->
<para>
-The GObject type for #PangoFontFace.
+The #GObject type for #PangoFontFace.
</para>
@@ -755,7 +755,7 @@ fills in.
<!-- ##### MACRO PANGO_TYPE_FONT_MAP ##### -->
<para>
-The GObject type for #PangoFontMap.
+The #GObject type for #PangoFontMap.
</para>
@@ -869,7 +869,7 @@ set of metrics for the entire fontset.
<!-- ##### MACRO PANGO_TYPE_FONTSET ##### -->
<para>
-The GObject type for #PangoFontset.
+The #GObject type for #PangoFontset.
</para>
@@ -882,7 +882,7 @@ a particular #PangoFontset implementation.
@parent_class:
@get_font: a function to get the font in the fontset that contains the
- best glyph for the given unicode character; see pango_fontset_get_font().
+ best glyph for the given Unicode character; see pango_fontset_get_font().
@get_metrics: a function to get overall metric information for the fonts
in the fontset; see pango_fontset_get_metrics().
@get_language: a function to get the language of the fontset.
@@ -939,7 +939,7 @@ which the creator provides when constructing the
<!-- ##### MACRO PANGO_TYPE_FONTSET_SIMPLE ##### -->
<para>
-The GObject type for #PangoFontsetSimple.
+The #GObject type for #PangoFontsetSimple.
</para>
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index a25e5895..c8fc63c3 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -275,7 +275,7 @@ each of which contains a list of #PangoGlyphItem.
<!-- ##### MACRO PANGO_TYPE_GLYPH_STRING ##### -->
<para>
-The GObject type for #PangoGlyphString.
+The #GObject type for #PangoGlyphString.
</para>
diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml
index d358115a..5f798c0c 100644
--- a/docs/tmpl/layout.sgml
+++ b/docs/tmpl/layout.sgml
@@ -219,7 +219,7 @@ enough space for a full word.
<!-- ##### MACRO PANGO_TYPE_WRAP_MODE ##### -->
<para>
-The GObject type for #PangoWrapMode.
+The #GObject type for #PangoWrapMode.
</para>
@@ -254,7 +254,7 @@ The GObject type for #PangoWrapMode.
<!-- ##### MACRO PANGO_TYPE_ELLIPSIZE_MODE ##### -->
<para>
-The GObject type for #PangoEllipsizeMode.
+The #GObject type for #PangoEllipsizeMode.
</para>
@@ -389,8 +389,7 @@ The GObject type for #PangoEllipsizeMode.
<para>
A PangoAlignment describes how to align the lines of a #PangoLayout within the
available space. If the #PangoLayout is set to justify
-using pango_layout_set_justify(), then this only has an effect
-for partial lines.
+using pango_layout_set_justify(), this only has effect for partial lines.
</para>
@PANGO_ALIGN_LEFT: Put all available space on the right
@@ -399,7 +398,7 @@ for partial lines.
<!-- ##### MACRO PANGO_TYPE_ALIGNMENT ##### -->
<para>
-The GObject type for #PangoAlignment.
+The #GObject type for #PangoAlignment.
</para>
@@ -700,12 +699,12 @@ Routines for rendering PangoLayout objects are provided in
code specific to each rendering system.
</para>
-@layout: the parent layout for this line.
-@start_index: the start of the line as byte index into @layout->text.
-@length: the length of the line in bytes.
-@runs: a list containing the runs of the line in visual order.
-@is_paragraph_start: %TRUE if this is the first line of the paragraph.
-@resolved_dir:
+@layout: the parent layout for this line
+@start_index: the start of the line as byte index into @layout->text
+@length: the length of the line in bytes
+@runs: a list containing the runs of the line in visual order
+@is_paragraph_start: %TRUE if this is the first line of the paragraph
+@resolved_dir: the resolved #PangoDirection of the line
<!-- ##### TYPEDEF PangoLayoutRun ##### -->
<para>
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index 0f5695f6..bd8a17f3 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -64,7 +64,7 @@ fields:
<!-- ##### MACRO PANGO_TYPE_DIRECTION ##### -->
<para>
-The GObject type for #PangoDirection.
+The #GObject type for #PangoDirection.
</para>
diff --git a/docs/tmpl/scripts.sgml b/docs/tmpl/scripts.sgml
index f68c9341..f454678e 100644
--- a/docs/tmpl/scripts.sgml
+++ b/docs/tmpl/scripts.sgml
@@ -31,7 +31,7 @@ url="http://www.unicode.org/reports/tr24/">Unicode Standard Annex
#24: Script names</ulink>).
</para>
-@PANGO_SCRIPT_INVALID_CODE: a value never used for any unicode character
+@PANGO_SCRIPT_INVALID_CODE: a value never used for any Unicode character
@PANGO_SCRIPT_COMMON: a character used by multiple different scripts
@PANGO_SCRIPT_INHERITED: a mark glyph that takes its script from the
base glyph to which it is attached.
@@ -97,7 +97,7 @@ url="http://www.unicode.org/reports/tr24/">Unicode Standard Annex
<!-- ##### MACRO PANGO_TYPE_SCRIPT ##### -->
<para>
-The GObject type for #PangoScript
+The #GObject type for #PangoScript
</para>
diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml
index b06289b8..757280ad 100644
--- a/docs/tmpl/tab-stops.sgml
+++ b/docs/tmpl/tab-stops.sgml
@@ -23,7 +23,7 @@ of tab stops. Each tab stop has an alignment and a position.
<!-- ##### MACRO PANGO_TYPE_TAB_ARRAY ##### -->
<para>
-The GObject type for #PangoTabArray.
+The #GObject type for #PangoTabArray.
</para>
@@ -37,7 +37,7 @@ A #PangoTabAlign specifies where a tab stop appears relative to the text.
<!-- ##### MACRO PANGO_TYPE_TAB_ALIGN ##### -->
<para>
-The GObject type for #PangoTabAlign.
+The #GObject type for #PangoTabAlign.
</para>
diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml
index 8d56424b..ba17fed1 100644
--- a/docs/tmpl/text-attributes.sgml
+++ b/docs/tmpl/text-attributes.sgml
@@ -52,7 +52,7 @@ attribute is listed in parentheses after the description.
<!-- ##### MACRO PANGO_TYPE_ATTR_TYPE ##### -->
<para>
-The GObject type for #PangoAttrType.
+The #GObject type for #PangoAttrType.
</para>
@@ -384,7 +384,7 @@ of underlining.
<!-- ##### MACRO PANGO_TYPE_UNDERLINE ##### -->
<para>
-The GObject type for #PangoUnderline.
+The #GObject type for #PangoUnderline.
</para>
@@ -522,7 +522,7 @@ represent a color in an uncalibrated RGB colorspace.
<!-- ##### MACRO PANGO_TYPE_COLOR ##### -->
<para>
-The GObject type for #PangoColor.
+The #GObject type for #PangoColor.
</para>
@@ -567,7 +567,7 @@ copied and compared with each other.
<!-- ##### MACRO PANGO_TYPE_LANGUAGE ##### -->
<para>
-The GObject type for #PangoLanguage.
+The #GObject type for #PangoLanguage.
</para>
@@ -618,7 +618,7 @@ for more than one paragraph of text.
<!-- ##### MACRO PANGO_TYPE_ATTR_LIST ##### -->
<para>
-The GObject type for #PangoAttrList.
+The #GObject type for #PangoAttrList.
</para>