From ce7af5623349df44c4787a44296645db405c5e0c Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Wed, 22 Sep 2010 15:45:33 -0400 Subject: [PATCH] Doc template changes --- docs/tmpl/atsui-fonts.sgml | 3 +++ docs/tmpl/bidi.sgml | 3 +++ docs/tmpl/coverage-maps.sgml | 4 ++++ docs/tmpl/engines.sgml | 4 ++++ docs/tmpl/fonts.sgml | 4 ++++ docs/tmpl/freetype-fonts.sgml | 6 ++++++ docs/tmpl/glyphs.sgml | 4 ++++ docs/tmpl/layout.sgml | 3 +++ docs/tmpl/main.sgml | 5 +++++ docs/tmpl/modules.sgml | 3 +++ docs/tmpl/opentype.sgml | 3 +++ docs/tmpl/pango-engine-lang.sgml | 3 +++ docs/tmpl/pango-engine-shape.sgml | 3 +++ docs/tmpl/pango-renderer.sgml | 3 +++ docs/tmpl/pango-version.sgml | 5 +++++ docs/tmpl/pangocairo.sgml | 5 +++++ docs/tmpl/pangofc-decoder.sgml | 3 +++ docs/tmpl/pangofc-font.sgml | 3 +++ docs/tmpl/pangofc-fontmap.sgml | 3 +++ docs/tmpl/scripts.sgml | 4 ++++ docs/tmpl/tab-stops.sgml | 3 +++ docs/tmpl/text-attributes.sgml | 4 ++++ docs/tmpl/utils.sgml | 5 +++++ docs/tmpl/vertical.sgml | 3 +++ docs/tmpl/win32-fonts.sgml | 9 +++++++++ docs/tmpl/x-fonts.sgml | 3 +++ docs/tmpl/xft-fonts.sgml | 3 +++ 27 files changed, 104 insertions(+) diff --git a/docs/tmpl/atsui-fonts.sgml b/docs/tmpl/atsui-fonts.sgml index 19b0344..c8b6aa0 100644 --- a/docs/tmpl/atsui-fonts.sgml +++ b/docs/tmpl/atsui-fonts.sgml @@ -18,6 +18,9 @@ MacOS systems using the ATSUI text rendering subsystem. + + + A string constant identifying the ATSUI renderer. The associated quark (see diff --git a/docs/tmpl/bidi.sgml b/docs/tmpl/bidi.sgml index 7e5171e..e02d1ec 100644 --- a/docs/tmpl/bidi.sgml +++ b/docs/tmpl/bidi.sgml @@ -28,6 +28,9 @@ pango_itemize_with_base_dir() + + + diff --git a/docs/tmpl/coverage-maps.sgml b/docs/tmpl/coverage-maps.sgml index 69c7162..7e0ced9 100644 --- a/docs/tmpl/coverage-maps.sgml +++ b/docs/tmpl/coverage-maps.sgml @@ -20,6 +20,9 @@ to represent that information. + + + Used to indicate how well a font can represent a particular Unicode @@ -56,6 +59,7 @@ to #PangoCoverageLevel. It is an opaque structure with no public fields. +@void: @Returns: diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml index 20de439..f9c56c6 100644 --- a/docs/tmpl/engines.sgml +++ b/docs/tmpl/engines.sgml @@ -31,6 +31,9 @@ function is used when building a catalog of all available modules. + + + The #PangoEngineInfo structure contains information about a particular @@ -103,6 +106,7 @@ specific. +@void: diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index baa0558..7b55dea 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -22,6 +22,9 @@ to load a font of a given description. + + + The #PangoFontDescription structure represents the description @@ -143,6 +146,7 @@ The #GObject type for #PangoFontMask. +@void: @Returns: diff --git a/docs/tmpl/freetype-fonts.sgml b/docs/tmpl/freetype-fonts.sgml index 06f5006..2ed58bd 100644 --- a/docs/tmpl/freetype-fonts.sgml +++ b/docs/tmpl/freetype-fonts.sgml @@ -18,6 +18,9 @@ text to bitmaps using the FreeType 2 library. + + + The #PangoFT2FontMap is the #PangoFontMap implementation for FreeType fonts. @@ -37,6 +40,7 @@ with the FreeType backend. See %PANGO_RENDER_TYPE_FC for the replacement. +@void: @Returns: @@ -210,6 +214,7 @@ Function type for doing final config tweaking on prepared FcPatterns. +@void: @Returns: @@ -218,5 +223,6 @@ Function type for doing final config tweaking on prepared FcPatterns. +@void: diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index be546c6..399319e 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -20,6 +20,9 @@ glyphs. + + + The %PANGO_SCALE macro represents the scale between dimensions used @@ -476,6 +479,7 @@ The #GObject type for #PangoGlyphString. +@void: @Returns: diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml index c60f9d5..54e385e 100644 --- a/docs/tmpl/layout.sgml +++ b/docs/tmpl/layout.sgml @@ -22,6 +22,9 @@ at once. + + + The #PangoLayout structure represents an entire paragraph diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index 3bfcb99..8373b12 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -20,6 +20,9 @@ various steps of this process. + + + The #PangoContext structure stores global information @@ -124,6 +127,7 @@ The #GObject type for #PangoDirection. +@void: @Returns: @@ -152,6 +156,7 @@ The #GObject type for #PangoDirection. +@void: @Returns: diff --git a/docs/tmpl/modules.sgml b/docs/tmpl/modules.sgml index 0fe8c42..faac809 100644 --- a/docs/tmpl/modules.sgml +++ b/docs/tmpl/modules.sgml @@ -18,6 +18,9 @@ modules that add engines to Pango at run time. + + + The #PangoIncludedModule structure for a statically linked module diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml index ca4b53b..cccc518 100644 --- a/docs/tmpl/opentype.sgml +++ b/docs/tmpl/opentype.sgml @@ -19,6 +19,9 @@ shaping engines Unstable + + + The PangoOTTag typedef is used to represent TrueType and OpenType diff --git a/docs/tmpl/pango-engine-lang.sgml b/docs/tmpl/pango-engine-lang.sgml index a5a91bf..73df49c 100644 --- a/docs/tmpl/pango-engine-lang.sgml +++ b/docs/tmpl/pango-engine-lang.sgml @@ -19,6 +19,9 @@ These engines are used in pango_break(). Unstable + + + diff --git a/docs/tmpl/pango-engine-shape.sgml b/docs/tmpl/pango-engine-shape.sgml index 5e66f2d..3d5dd3b 100644 --- a/docs/tmpl/pango-engine-shape.sgml +++ b/docs/tmpl/pango-engine-shape.sgml @@ -19,6 +19,9 @@ These engines are used in pango_shape(). Unstable + + + diff --git a/docs/tmpl/pango-renderer.sgml b/docs/tmpl/pango-renderer.sgml index 5444545..f8e524a 100644 --- a/docs/tmpl/pango-renderer.sgml +++ b/docs/tmpl/pango-renderer.sgml @@ -21,6 +21,9 @@ destinations can be created. + + + diff --git a/docs/tmpl/pango-version.sgml b/docs/tmpl/pango-version.sgml index 230946d..923fac8 100644 --- a/docs/tmpl/pango-version.sgml +++ b/docs/tmpl/pango-version.sgml @@ -22,6 +22,9 @@ at run-time. + + + This macro encodes the given Pango version into an integer. The numbers @@ -86,6 +89,7 @@ the provided version number. +@void: @Returns: @@ -94,6 +98,7 @@ the provided version number. +@void: @Returns: diff --git a/docs/tmpl/pangocairo.sgml b/docs/tmpl/pangocairo.sgml index 6a90782..32f3ca6 100644 --- a/docs/tmpl/pangocairo.sgml +++ b/docs/tmpl/pangocairo.sgml @@ -145,6 +145,9 @@ int main (int argc, char **argv) + + + @@ -162,6 +165,7 @@ int main (int argc, char **argv) +@void: @Returns: @@ -178,6 +182,7 @@ int main (int argc, char **argv) +@void: @Returns: diff --git a/docs/tmpl/pangofc-decoder.sgml b/docs/tmpl/pangofc-decoder.sgml index b8191c7..7b80410 100644 --- a/docs/tmpl/pangofc-decoder.sgml +++ b/docs/tmpl/pangofc-decoder.sgml @@ -18,6 +18,9 @@ for handling a font that is encoded in a custom way. + + + diff --git a/docs/tmpl/pangofc-font.sgml b/docs/tmpl/pangofc-font.sgml index a1b055c..80292a2 100644 --- a/docs/tmpl/pangofc-font.sgml +++ b/docs/tmpl/pangofc-font.sgml @@ -34,6 +34,9 @@ Fontconfig-based backend involves deriving from both + + + diff --git a/docs/tmpl/pangofc-fontmap.sgml b/docs/tmpl/pangofc-fontmap.sgml index ee6cca0..2896c4b 100644 --- a/docs/tmpl/pangofc-fontmap.sgml +++ b/docs/tmpl/pangofc-fontmap.sgml @@ -34,6 +34,9 @@ Fontconfig-based backend involves deriving from both + + + diff --git a/docs/tmpl/scripts.sgml b/docs/tmpl/scripts.sgml index a87e7fb..a70d3b4 100644 --- a/docs/tmpl/scripts.sgml +++ b/docs/tmpl/scripts.sgml @@ -19,6 +19,9 @@ and of ranges within a larger text string. + + + The #PangoScript enumeration identifies different writing @@ -252,6 +255,7 @@ The #GObject type for #PangoLanguage. +@void: @Returns: diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml index 03ae379..62b0202 100644 --- a/docs/tmpl/tab-stops.sgml +++ b/docs/tmpl/tab-stops.sgml @@ -18,6 +18,9 @@ that can be used to set tab stop positions in a #PangoLayout. + + + A #PangoTabArray struct contains an array diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml index 57469b8..98158f8 100644 --- a/docs/tmpl/text-attributes.sgml +++ b/docs/tmpl/text-attributes.sgml @@ -21,6 +21,9 @@ of attributes applied to a portion of text. + + + The #PangoAttrType @@ -653,6 +656,7 @@ The #GObject type for #PangoAttrList. +@void: @Returns: diff --git a/docs/tmpl/utils.sgml b/docs/tmpl/utils.sgml index 6ac6a66..c42b385 100644 --- a/docs/tmpl/utils.sgml +++ b/docs/tmpl/utils.sgml @@ -18,6 +18,9 @@ backends and modules, but may be useful for other purposes too. + + + @@ -166,6 +169,7 @@ backends and modules, but may be useful for other purposes too. +@void: @Returns: @@ -174,6 +178,7 @@ backends and modules, but may be useful for other purposes too. +@void: @Returns: diff --git a/docs/tmpl/vertical.sgml b/docs/tmpl/vertical.sgml index 83e33a1..5d0ab51 100644 --- a/docs/tmpl/vertical.sgml +++ b/docs/tmpl/vertical.sgml @@ -73,6 +73,9 @@ pango_attr_gravity_hint_new() + + + diff --git a/docs/tmpl/win32-fonts.sgml b/docs/tmpl/win32-fonts.sgml index 8ead0d0..eb208ad 100644 --- a/docs/tmpl/win32-fonts.sgml +++ b/docs/tmpl/win32-fonts.sgml @@ -18,6 +18,9 @@ Win32 systems and to render text in conjunction with Win32 APIs. + + + A string constant identifying the Win32 renderer. The associated quark (see @@ -31,6 +34,7 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map(). +@void: @Returns: @@ -133,6 +137,7 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map(). +@void: @Returns: @@ -141,6 +146,7 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map(). +@void: @Returns: @@ -156,6 +162,7 @@ HFONTs by their LOGFONT descriptions. +@void: @Returns: @@ -201,6 +208,7 @@ HFONTs by their LOGFONT descriptions. +@void: @Returns: @@ -209,6 +217,7 @@ HFONTs by their LOGFONT descriptions. +@void: diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml index ca76af7..33fd2f4 100644 --- a/docs/tmpl/x-fonts.sgml +++ b/docs/tmpl/x-fonts.sgml @@ -21,6 +21,9 @@ or Cairo backend instead. + + + A string constant identifying the X renderer. The associated quark (see diff --git a/docs/tmpl/xft-fonts.sgml b/docs/tmpl/xft-fonts.sgml index 76e755a..d996eba 100644 --- a/docs/tmpl/xft-fonts.sgml +++ b/docs/tmpl/xft-fonts.sgml @@ -42,6 +42,9 @@ overriding the #PangoXftRendererClass virtual functions + + + #PangoXftFont is an implementation of #PangoFcFont using the Xft -- 2.7.4