summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2012-08-16 20:51:57 -0400
committerBehdad Esfahbod <behdad@behdad.org>2012-08-16 21:10:10 -0400
commit8168660e5f1906aed2a45d30529058f51473bcef (patch)
tree8c5a9172672404c0f85bc78f3ba31a566cb52aba /docs
parentfeff5a6e2682048a07a6ba09af83254e290bf394 (diff)
parent656d473b52e3edea621c0681d2ba14363f257e84 (diff)
downloadpango-8168660e5f1906aed2a45d30529058f51473bcef.tar.gz
Merge branch 'harfbuzz-ng-external'
Conflicts: configure.in docs/tmpl/text-attributes.sgml modules/arabic/arabic-ot.c modules/indic/indic-ot.c pango/opentype/Makefile.am pango/opentype/hb-blob.c pango/opentype/hb-buffer-private.h pango/opentype/hb-common.h pango/opentype/hb-ot-layout-gsubgpos-private.hh pango/opentype/hb-private.h pango/pango-ot-info.c
Diffstat (limited to 'docs')
-rw-r--r--docs/tmpl/atsui-fonts.sgml3
-rw-r--r--docs/tmpl/fonts.sgml29
-rw-r--r--docs/tmpl/glyphs.sgml30
-rw-r--r--docs/tmpl/layout.sgml22
-rw-r--r--docs/tmpl/main.sgml9
-rw-r--r--docs/tmpl/text-attributes.sgml15
6 files changed, 48 insertions, 60 deletions
diff --git a/docs/tmpl/atsui-fonts.sgml b/docs/tmpl/atsui-fonts.sgml
index c8b6aa06..f19081bd 100644
--- a/docs/tmpl/atsui-fonts.sgml
+++ b/docs/tmpl/atsui-fonts.sgml
@@ -23,8 +23,7 @@ MacOS systems using the ATSUI text rendering subsystem.
<!-- ##### MACRO PANGO_RENDER_TYPE_ATSUI ##### -->
<para>
-A string constant identifying the ATSUI renderer. The associated quark (see
-g_quark_from_string()) is used to identify the renderer in pango_find_map().
+
</para>
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index 7b55dea7..d4ce3160 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -442,24 +442,15 @@ the documentation of the corresponding getters for documentation
of their meaning.
</para>
-@ref_count: reference count. Used internally. See pango_font_metrics_ref()
- and pango_font_metrics_unref().
-@ascent: the distance from the baseline to the highest point of the glyphs of
- the font. This is positive in practically all fonts.
-@descent: the distance from the baseline to the lowest point of the glyphs of
- the font. This is positive in practically all fonts.
-@approximate_char_width: approximate average width of the regular glyphs of
- the font. Note that for this calculation, East Asian characters
- (those passing g_unichar_iswide()) are counted as double-width.
- This produces a more uniform value for this measure across languages
- and results in more uniform and more expected UI sizes.
-@approximate_digit_width: approximate average width of the glyphs for digits
- of the font.
-@underline_position: position of the underline. This is normally negative.
-@underline_thickness: thickness of the underline.
-@strikethrough_position: position of the strikethrough line. This is
- normally positive.
-@strikethrough_thickness: thickness of the strikethrough line.
+@ref_count:
+@ascent:
+@descent:
+@approximate_char_width:
+@approximate_digit_width:
+@underline_position:
+@underline_thickness:
+@strikethrough_position:
+@strikethrough_thickness:
<!-- ##### MACRO PANGO_TYPE_FONT_METRICS ##### -->
<para>
@@ -984,7 +975,7 @@ a particular #PangoFontset implementation.
@fontset:
@font:
-@data:
+@user_data:
@Returns:
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index 399319eb..5d4be350 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -395,11 +395,9 @@ The storage for the glyph information is owned
by the structure which simplifies memory management.
</para>
-@num_glyphs: the number of glyphs in the string.
-@glyphs: an array of #PangoGlyphInfo structures of length <structfield>num_glyphs</structfield>.
-@log_clusters: for each glyph, byte index of the starting character for the
-cluster. The indices are relative to the start of the text
-corresponding to the PangoGlyphString.
+@num_glyphs:
+@glyphs:
+@log_clusters:
<!-- ##### STRUCT PangoGlyphItem ##### -->
<para>
@@ -410,10 +408,8 @@ of shaping text with #PangoLayout is a list of #PangoLayoutLine,
each of which contains a list of #PangoGlyphItem.
</para>
-@item: a #PangoItem structure that provides information
- about a segment of text.
-@glyphs: the glyphs obtained by shaping the text
- corresponding to @item.
+@item:
+@glyphs:
<!-- ##### STRUCT PangoGlyphItemIter ##### -->
<para>
@@ -457,14 +453,14 @@ None of the members of a #PangoGlyphItemIter should be modified manually.
</para>
-@glyph_item: the #PangoGlyphItem this iterator iterates over
-@text: the UTF-8 text that @glyph_item refers to
-@start_glyph: starting glyph of the cluster
-@start_index: starting text index of the cluster
-@start_char: starting number of characters of the cluster
-@end_glyph: ending glyph of the cluster
-@end_index: ending text index of the cluster
-@end_char: ending number of characters of the cluster
+@glyph_item:
+@text:
+@start_glyph:
+@start_index:
+@start_char:
+@end_glyph:
+@end_index:
+@end_char:
@Since: 1.22
<!-- ##### MACRO PANGO_TYPE_GLYPH_STRING ##### -->
diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml
index 4be6a59a..a3f22a03 100644
--- a/docs/tmpl/layout.sgml
+++ b/docs/tmpl/layout.sgml
@@ -124,8 +124,8 @@ has no user-visible fields.
</para>
-@layout:
-@Returns:
+@layout:
+@Returns:
<!-- ##### FUNCTION pango_layout_set_markup ##### -->
@@ -478,9 +478,9 @@ The #GObject type for #PangoAlignment.
</para>
-@layout:
-@n_attrs:
-@Returns:
+@layout:
+@n_attrs:
+@Returns:
<!-- ##### FUNCTION pango_layout_index_to_pos ##### -->
@@ -845,12 +845,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: the resolved #PangoDirection of the line
+@layout:
+@start_index:
+@length:
+@runs:
+@is_paragraph_start:
+@resolved_dir:
<!-- ##### TYPEDEF PangoLayoutRun ##### -->
<para>
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index 8373b123..f3759cec 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -36,11 +36,10 @@ The #PangoItem structure stores information about
a segment of text. It contains the following fields:
</para>
-@offset: the offset of the segment from the beginning of the
- string in bytes.
-@length: the length of the segment in bytes.
-@num_chars: the length of the segment in characters.
-@analysis: the properties of the segment.
+@offset:
+@length:
+@num_chars:
+@analysis:
<!-- ##### STRUCT PangoAnalysis ##### -->
<para>
diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml
index d12c0414..edcd3ec9 100644
--- a/docs/tmpl/text-attributes.sgml
+++ b/docs/tmpl/text-attributes.sgml
@@ -465,8 +465,10 @@ A copy function passed to attribute new functions that take
user data.
</para>
-@data: the user data
+@user_data:
@Returns: a new copy of @data.
+<!-- # Unused Parameters # -->
+@data: the user data
<!-- ##### FUNCTION pango_attr_scale_new ##### -->
@@ -578,10 +580,9 @@ The #PangoColor structure is used to
represent a color in an uncalibrated RGB color-space.
</para>
-@red: the red component of the color. This is a value between 0 and
- 65535, with 65535 indicating full intensity
-@green: the green component of the color
-@blue: the blue component of the color
+@red:
+@green:
+@blue:
<!-- ##### MACRO PANGO_TYPE_COLOR ##### -->
<para>
@@ -740,8 +741,10 @@ to filter out a subset of attributes for a list.
</para>
@attribute: a #PangoAttribute
-@data: callback data passed to pango_attr_list_filter()
+@user_data:
@Returns: %TRUE if the attribute should be filtered out
+<!-- # Unused Parameters # -->
+@data: callback data passed to pango_attr_list_filter()
<!-- ##### FUNCTION pango_attr_list_get_iterator ##### -->