From e02efc9b767b6c8648b2b27555dca44e9d6cbf80 Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Thu, 17 Nov 2005 04:57:49 +0000 Subject: Various documentation improvements. 2005-11-16 Behdad Esfahbod * docs/pango_markup.sgml docs/tmpl/coverage-maps.sgml docs/tmpl/engines.sgml docs/tmpl/fonts.sgml docs/tmpl/freetype-fonts.sgml docs/tmpl/glyphs.sgml docs/tmpl/layout.sgml docs/tmpl/main.sgml docs/tmpl/modules.sgml docs/tmpl/opentype.sgml docs/tmpl/pango-engine-lang.sgml docs/tmpl/pango-engine-shape.sgml docs/tmpl/pango-renderer.sgml docs/tmpl/pangocairo.sgml docs/tmpl/pangofc-decoder.sgml docs/tmpl/pangofc-font.sgml docs/tmpl/pangofc-fontmap.sgml docs/tmpl/scripts.sgml docs/tmpl/tab-stops.sgml docs/tmpl/text-attributes.sgml docs/tmpl/win32-fonts.sgml docs/tmpl/x-fonts.sgml docs/tmpl/xft-fonts.sgml pango/break.c pango/ellipsize.c pango/fonts.c pango/pango-attributes.c pango/pango-color.c pango/pango-context.c pango/pango-coverage.c pango/pango-fontmap.c pango/pango-glyph-item.c pango/pango-layout.c pango/pango-markup.c pango/pango-tabs.c pango/pango-types.h pango/pango-utils.c pango/pangoft2-render.c pango/pangox.c pango/pangoxft-render.c: Various documentation improvements. --- ChangeLog | 23 ++++++++++++++++++++ docs/pango_markup.sgml | 4 ++-- docs/tmpl/coverage-maps.sgml | 3 --- docs/tmpl/engines.sgml | 3 --- docs/tmpl/fonts.sgml | 14 ++++++------ docs/tmpl/freetype-fonts.sgml | 3 --- docs/tmpl/glyphs.sgml | 17 ++++++--------- docs/tmpl/layout.sgml | 9 +++----- docs/tmpl/main.sgml | 14 ++++++++---- docs/tmpl/modules.sgml | 3 --- docs/tmpl/opentype.sgml | 11 ++++------ docs/tmpl/pango-engine-lang.sgml | 3 --- docs/tmpl/pango-engine-shape.sgml | 3 --- docs/tmpl/pango-renderer.sgml | 3 --- docs/tmpl/pangocairo.sgml | 3 --- docs/tmpl/pangofc-decoder.sgml | 3 --- docs/tmpl/pangofc-font.sgml | 3 --- docs/tmpl/pangofc-fontmap.sgml | 3 --- docs/tmpl/scripts.sgml | 3 --- docs/tmpl/tab-stops.sgml | 7 ++---- docs/tmpl/text-attributes.sgml | 45 +++++++++++++++++++-------------------- docs/tmpl/win32-fonts.sgml | 7 ++---- docs/tmpl/x-fonts.sgml | 7 ++---- docs/tmpl/xft-fonts.sgml | 3 --- pango/break.c | 4 ++-- pango/ellipsize.c | 8 +++---- pango/fonts.c | 18 ++++++++-------- pango/pango-attributes.c | 38 +++++++++++++++++---------------- pango/pango-color.c | 2 +- pango/pango-context.c | 6 +++--- pango/pango-coverage.c | 2 +- pango/pango-fontmap.c | 6 +++--- pango/pango-glyph-item.c | 2 +- pango/pango-layout.c | 4 ++-- pango/pango-markup.c | 10 ++++----- pango/pango-tabs.c | 27 +++++++++++------------ pango/pango-types.h | 2 +- pango/pango-utils.c | 2 +- pango/pangoft2-render.c | 8 +++---- pango/pangox.c | 2 +- pango/pangoxft-render.c | 4 ++-- 41 files changed, 156 insertions(+), 186 deletions(-) diff --git a/ChangeLog b/ChangeLog index 52c140ff..d45ba58d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,26 @@ +2005-11-16 Behdad Esfahbod + + * docs/pango_markup.sgml docs/tmpl/coverage-maps.sgml + docs/tmpl/engines.sgml docs/tmpl/fonts.sgml + docs/tmpl/freetype-fonts.sgml docs/tmpl/glyphs.sgml + docs/tmpl/layout.sgml docs/tmpl/main.sgml + docs/tmpl/modules.sgml docs/tmpl/opentype.sgml + docs/tmpl/pango-engine-lang.sgml + docs/tmpl/pango-engine-shape.sgml + docs/tmpl/pango-renderer.sgml docs/tmpl/pangocairo.sgml + docs/tmpl/pangofc-decoder.sgml docs/tmpl/pangofc-font.sgml + docs/tmpl/pangofc-fontmap.sgml docs/tmpl/scripts.sgml + docs/tmpl/tab-stops.sgml docs/tmpl/text-attributes.sgml + docs/tmpl/win32-fonts.sgml docs/tmpl/x-fonts.sgml + docs/tmpl/xft-fonts.sgml pango/break.c pango/ellipsize.c + pango/fonts.c pango/pango-attributes.c pango/pango-color.c + pango/pango-context.c pango/pango-coverage.c + pango/pango-fontmap.c pango/pango-glyph-item.c + pango/pango-layout.c pango/pango-markup.c pango/pango-tabs.c + pango/pango-types.h pango/pango-utils.c + pango/pangoft2-render.c pango/pangox.c pango/pangoxft-render.c: + Various documentation improvements. + 2005-11-15 Behdad Esfahbod * pango/pango-types.h: Added % to PANGO_DIRECTION_LTR in doc comments. diff --git a/docs/pango_markup.sgml b/docs/pango_markup.sgml index 3b4c1a5c..72b0179d 100644 --- a/docs/pango_markup.sgml +++ b/docs/pango_markup.sgml @@ -1,12 +1,12 @@ -Pango Text Attribute Markup +Text Attribute Markup 3 Pango Library -Pango Text Attribute MarkupSimple +Text Attribute MarkupSimple markup language to encode text with attributes diff --git a/docs/tmpl/coverage-maps.sgml b/docs/tmpl/coverage-maps.sgml index 5dc89ff1..d673d65e 100644 --- a/docs/tmpl/coverage-maps.sgml +++ b/docs/tmpl/coverage-maps.sgml @@ -17,9 +17,6 @@ to represent that information. - - - Used to indicate how well a font can represent a particular ISO 10646 diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml index 063c7454..fb7fdfd2 100644 --- a/docs/tmpl/engines.sgml +++ b/docs/tmpl/engines.sgml @@ -28,9 +28,6 @@ function is used when building a catalog of all available modules. - - - The #PangoEngineInfo structure contains information about a particular diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index 4e5caa62..34232cfa 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -19,9 +19,6 @@ to load a font of a given description. - - - The #PangoFontDescription structure represents the description @@ -535,7 +532,7 @@ pango_font_init() on the structure. The #PangoFont structure contains one member -which the implementation fills in: +which the implementation fills in. @@ -751,7 +748,8 @@ pointer to a appropriate #PangoFontMapClass, then call pango_font_map_init() on the structure. -The #PangoFont structure contains one member which the implementation fills in: +The #PangoFontMap structure contains one member which the implementation +fills in. @@ -932,10 +930,10 @@ a particular #PangoFontset implementation. -#PangoFontSetSimple is a implementation of the abstract -#PangoFontSet base class in terms of an array of fonts, +#PangoFontsetSimple is a implementation of the abstract +#PangoFontset base class in terms of an array of fonts, which the creator provides when constructing the -#PangoFontSetSimple. +#PangoFontsetSimple. diff --git a/docs/tmpl/freetype-fonts.sgml b/docs/tmpl/freetype-fonts.sgml index b554fe57..9877c200 100644 --- a/docs/tmpl/freetype-fonts.sgml +++ b/docs/tmpl/freetype-fonts.sgml @@ -14,9 +14,6 @@ Functions for shape engines to manipulate FreeType fonts - - - The #PangoFT2FontMap is the #PangoFontMap implementation for FreeType fonts. diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index 0f9c1bfe..a25e5895 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -17,15 +17,12 @@ glyphs. - - - -The PANGO_SCALE macro represents the scale between dimensions used +The %PANGO_SCALE macro represents the scale between dimensions used for Pango distances and device units. (The definition of device units is dependent on the output device; it will typically be pixels -for a screen, and points for a printer.) PANGO_SCALE is currently +for a screen, and points for a printer.) %PANGO_SCALE is currently 1024, but this may be changed in the future. @@ -214,12 +211,12 @@ information for a single glyph. The #PangoGlyphUnit type is used to store dimensions within -Pango. Dimensions are stored in 1/PANGO_SCALE of a device unit. +Pango. Dimensions are stored in 1/%PANGO_SCALE of a device unit. (A device unit might be a pixel for screen display, or -a point on a printer.) PANGO_SCALE is currently 1024, and -is unlikely to change, but you should not depend on its -exact value. The PANGO_PIXELS() macro can be used to convert -from glyph units into device units with correct rounding. +a point on a printer.) %PANGO_SCALE is currently 1024, and +may change in the future (unlikely though), but you should not +depend on its exact value. The PANGO_PIXELS() macro can be used +to convert from glyph units into device units with correct rounding. diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml index 8b84b65d..d358115a 100644 --- a/docs/tmpl/layout.sgml +++ b/docs/tmpl/layout.sgml @@ -9,7 +9,7 @@ Highlevel layout driver objects While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount -of code. The objects and functions in this structure provide a +of code. The objects and functions in this section provide a high-level driver for formatting entire paragraphs of text at once. @@ -19,9 +19,6 @@ at once. - - - The #PangoLayout structure represents and entire paragraph @@ -53,11 +50,11 @@ fields. -A PangoLayoutIter structure can be used to +A #PangoLayoutIter structure can be used to iterate over the visual extents of a #PangoLayout. -The PangoLayoutIter structure is opaque, and +The #PangoLayoutIter structure is opaque, and has no user-visible fields. diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index cbb6b880..713fa998 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -17,9 +17,6 @@ various steps of this process. - - - The #PangoContext structure stores global information @@ -308,6 +305,15 @@ Determines the direction of a character; either Unicode bidirectional algorithm. + + + + + +@ch: +@Returns: + + @@ -390,7 +396,7 @@ about the attributes of a single character. (e.g. letter + diacritics) is considered a unit, while in others, each decomposed character in the grapheme is a unit. In the - default implementation of #pango_break, this + default implementation of pango_break(), this bit is set on all grapheme boundaries except those following Latin, Cyrillic or Greek base characters. diff --git a/docs/tmpl/modules.sgml b/docs/tmpl/modules.sgml index a4dd32ac..2d74a8ad 100644 --- a/docs/tmpl/modules.sgml +++ b/docs/tmpl/modules.sgml @@ -14,9 +14,6 @@ Support for loadable modules - - - The #PangoIncludedModule structure for a statically linked module diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml index fde93bee..8cfe4405 100644 --- a/docs/tmpl/opentype.sgml +++ b/docs/tmpl/opentype.sgml @@ -14,9 +14,6 @@ Obtaining information from OpenType tables - - - The PangoOTTag typedef is used to represent TrueType and OpenType @@ -28,10 +25,10 @@ create PangoOTTags manually. -The PangoOTInfo struct contains the various +The #PangoOTInfo struct contains the various tables associated with an OpenType font. It contains only private fields and should only be accessed via the pango_ot_info_* functions -which are documented below. To obtain a PangoOTInfo, +which are documented below. To obtain a #PangoOTInfo, use pango_ot_info_new(). @@ -56,11 +53,11 @@ use pango_ot_info_new(). -The PangoOTRuleSet structure holds a +The #PangoOTRuleSet structure holds a set of features selected from the tables in an OpenType font. (A feature is an operation such as adjusting glyph positioning that should be applied to a text feature such as a certain -type of accent.) A PangoOTRuleSet +type of accent.) A #PangoOTRuleSet is created with pango_ot_ruleset_new(), features are addded to it with pango_ot_ruleset_add_feature(), then it is applied to a #PangoGlyphString with pango_ot_ruleset_shape(). diff --git a/docs/tmpl/pango-engine-lang.sgml b/docs/tmpl/pango-engine-lang.sgml index 42ddfb07..79b08f21 100644 --- a/docs/tmpl/pango-engine-lang.sgml +++ b/docs/tmpl/pango-engine-lang.sgml @@ -14,9 +14,6 @@ Rendering-system independent script engines - - - diff --git a/docs/tmpl/pango-engine-shape.sgml b/docs/tmpl/pango-engine-shape.sgml index 8b6c8b98..d1aff7d0 100644 --- a/docs/tmpl/pango-engine-shape.sgml +++ b/docs/tmpl/pango-engine-shape.sgml @@ -14,9 +14,6 @@ Rendering-system dependent script engines - - - diff --git a/docs/tmpl/pango-renderer.sgml b/docs/tmpl/pango-renderer.sgml index 5ffd48bc..f88a679b 100644 --- a/docs/tmpl/pango-renderer.sgml +++ b/docs/tmpl/pango-renderer.sgml @@ -18,9 +18,6 @@ destinations can be created. - - - diff --git a/docs/tmpl/pangocairo.sgml b/docs/tmpl/pangocairo.sgml index da1d7e3f..0c58c923 100644 --- a/docs/tmpl/pangocairo.sgml +++ b/docs/tmpl/pangocairo.sgml @@ -139,9 +139,6 @@ int main (int argc, char **argv) - - - diff --git a/docs/tmpl/pangofc-decoder.sgml b/docs/tmpl/pangofc-decoder.sgml index b8191c73..ad033b6a 100644 --- a/docs/tmpl/pangofc-decoder.sgml +++ b/docs/tmpl/pangofc-decoder.sgml @@ -15,9 +15,6 @@ 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 6bea63f4..c87b2617 100644 --- a/docs/tmpl/pangofc-font.sgml +++ b/docs/tmpl/pangofc-font.sgml @@ -31,9 +31,6 @@ Fontconfig-based backend involves deriving from both - - - diff --git a/docs/tmpl/pangofc-fontmap.sgml b/docs/tmpl/pangofc-fontmap.sgml index e24dc050..34c99b77 100644 --- a/docs/tmpl/pangofc-fontmap.sgml +++ b/docs/tmpl/pangofc-fontmap.sgml @@ -31,9 +31,6 @@ Fontconfig-based backend involves deriving from both - - - diff --git a/docs/tmpl/scripts.sgml b/docs/tmpl/scripts.sgml index 6c6fd580..f68c9341 100644 --- a/docs/tmpl/scripts.sgml +++ b/docs/tmpl/scripts.sgml @@ -16,9 +16,6 @@ and of ranges within a larger text string. - - - diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml index d131b162..b06289b8 100644 --- a/docs/tmpl/tab-stops.sgml +++ b/docs/tmpl/tab-stops.sgml @@ -2,7 +2,7 @@ Tab Stops -Structures for storing Tab Stops +Structures for storing tab stops @@ -14,12 +14,9 @@ Structures for storing Tab Stops - - - -A PangoTabArray struct contains an array +A #PangoTabArray struct contains an array of tab stops. Each tab stop has an alignment and a position. diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml index f69700f7..8d56424b 100644 --- a/docs/tmpl/text-attributes.sgml +++ b/docs/tmpl/text-attributes.sgml @@ -18,11 +18,9 @@ of attributes applied to a portion of text. - - - +The #PangoAttrType distinguishes between different types of attributes. Along with the predefined values, it is possible to allocate additional values for custom attributes using pango_attr_type_register(). The predefined @@ -37,7 +35,7 @@ attribute is listed in parentheses after the description. @PANGO_ATTR_WEIGHT: font weight (#PangoAttrInt) @PANGO_ATTR_VARIANT: font variant (normal or small caps) (#PangoAttrInt) @PANGO_ATTR_STRETCH: font stretch (#PangoAttrInt) -@PANGO_ATTR_SIZE: font size in points divided by PANGO_SCALE (#PangoAttrInt) +@PANGO_ATTR_SIZE: font size in points divided by %PANGO_SCALE (#PangoAttrInt) @PANGO_ATTR_FONT_DESC: font description (#PangoAttrFontDesc) @PANGO_ATTR_FOREGROUND: foreground color (#PangoAttrColor) @PANGO_ATTR_BACKGROUND: background color (#PangoAttrColor) @@ -45,7 +43,7 @@ attribute is listed in parentheses after the description. @PANGO_ATTR_STRIKETHROUGH: whether the text is struck-through (#PangoAttrInt) @PANGO_ATTR_RISE: baseline displacement (#PangoAttrInt) @PANGO_ATTR_SHAPE: shape (#PangoAttrShape) -@PANGO_ATTR_SCALE: font size scale factor (#PangoAttrScale) +@PANGO_ATTR_SCALE: font size scale factor (#PangoAttrFloat) @PANGO_ATTR_FALLBACK: whether fallback is enabled (#PangoAttrInt) @PANGO_ATTR_LETTER_SPACING: @PANGO_ATTR_UNDERLINE_COLOR: @@ -84,7 +82,7 @@ applies. @klass: the class structure holding information about the type of the attribute @start_index: the start index of the range (in bytes). @end_index: end index of the range (in bytes). The character at this index - not included in the range. + is not included in the range. @@ -97,7 +95,7 @@ a string value. -The #PangoAttrColor structure is used to represent attributes that +The #PangoAttrLanguage structure is used to represent attributes that are languages. @@ -116,7 +114,7 @@ are colors. The #PangoAttrInt structure is used to represent attributes with -a integer or enumeration value. +an integer or enumeration value. @attr: the common portion of the attribute @@ -160,12 +158,12 @@ set font size. @attr: the common portion of the attribute -@size: size of font, in units of 1/PANGO_SCALE of a point (for - PANGO_ATTR_SIZE) or of a device uni (for PANGO_ATTR_ABSOLUTE_SIZE) +@size: size of font, in units of 1/%PANGO_SCALE of a point (for + %PANGO_ATTR_SIZE) or of a device uni (for %PANGO_ATTR_ABSOLUTE_SIZE) @absolute: whether the font size is in device units or points. This field is only present for compatibility with Pango-1.8.0 - (PANGO_ATTR_ABSOLUTE_SIZE was added in 1.8.1); and always will - be %FALSE for PANGO_ATTR_SIZE and %TRUE for PANGO_ATTR_ABSOLUTE_SIZE. + (%PANGO_ATTR_ABSOLUTE_SIZE was added in 1.8.1); and always will + be %FALSE for %PANGO_ATTR_SIZE and %TRUE for %PANGO_ATTR_ABSOLUTE_SIZE. @@ -368,9 +366,9 @@ whether text should be underlined, and if so, the type of underlining. -@PANGO_UNDERLINE_NONE: no underline should be drawn. -@PANGO_UNDERLINE_SINGLE: a single underline should be drawn. -@PANGO_UNDERLINE_DOUBLE: a double underline should be drawn. +@PANGO_UNDERLINE_NONE: no underline should be drawn +@PANGO_UNDERLINE_SINGLE: a single underline should be drawn +@PANGO_UNDERLINE_DOUBLE: a double underline should be drawn @PANGO_UNDERLINE_LOW: a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining @@ -380,7 +378,7 @@ of underlining. @PANGO_UNDERLINE_ERROR: a wavy underline should be drawn below. This underline is typically used to indicate an error such as a possilble mispelling; in some - cases an contrasting color may automatically + cases a contrasting color may automatically be used. This type of underlining is available since Pango 1.4. @@ -416,11 +414,12 @@ The GObject type for #PangoUnderline. - +A copy function passed to attribute new functions that take +user data. -@data: -@Returns: +@data: the user data +@Returns: a new copy of @data. @@ -510,7 +509,7 @@ The scale factor for three magnification steps (1.2 * 1.2 * 1.2). -The PangoColor structure is used to +The #PangoColor structure is used to represent a color in an uncalibrated RGB colorspace. @@ -557,11 +556,11 @@ The GObject type for #PangoColor. -The PangoLanguage structure is used to +The #PangoLanguage structure is used to represent a language. -PangoLanguage pointers can be efficiently +#PangoLanguage pointers can be efficiently copied and compared with each other. @@ -730,7 +729,7 @@ to filter out a subset of attributes for a list. The #PangoAttrIterator structure is used to represent an -iterator through a #PangoList. A new iterator is created +iterator through a #PangoAttrList. A new iterator is created with pango_attr_list_get_iterator(). Once the iterator is created, it can be advanced through the style changes in the text using pango_attr_iterator_next(). At each diff --git a/docs/tmpl/win32-fonts.sgml b/docs/tmpl/win32-fonts.sgml index 50a9133f..d0aca19f 100644 --- a/docs/tmpl/win32-fonts.sgml +++ b/docs/tmpl/win32-fonts.sgml @@ -14,9 +14,6 @@ Functions for shape engines to manipulate Win32 fonts - - - A string constant identifying the Win32 renderer. The associated quark (see @@ -145,8 +142,8 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map(). -A PangoWin32FontCache caches -HFONTs by their LOGFONT descriptions. +A #PangoWin32FontCache caches +#HFONTs by their #LOGFONT descriptions. diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml index ee19346b..875fa26b 100644 --- a/docs/tmpl/x-fonts.sgml +++ b/docs/tmpl/x-fonts.sgml @@ -17,9 +17,6 @@ unpredictable results. Use the Xft - - - A string constant identifying the X renderer. The associated quark (see @@ -269,8 +266,8 @@ glyph index. -A PangoXFontCache caches -XFontStructs for a single display by their XLFD name. +A #PangoXFontCache caches +#XFontStructs for a single display by their XLFD name. diff --git a/docs/tmpl/xft-fonts.sgml b/docs/tmpl/xft-fonts.sgml index a572c94b..fc4d6cae 100644 --- a/docs/tmpl/xft-fonts.sgml +++ b/docs/tmpl/xft-fonts.sgml @@ -39,9 +39,6 @@ overring the #PangoXftRendererClass virtual functions - - - diff --git a/pango/break.c b/pango/break.c index cc123add..9626e5a4 100644 --- a/pango/break.c +++ b/pango/break.c @@ -421,7 +421,7 @@ typedef enum * engine overrides it. Normally you should use pango_break() * instead; this function is mostly useful for chaining up * from a language engine override. Unlike pango_break(), - * @analysis can be NULL, but only do that if you know what + * @analysis can be %NULL, but only do that if you know what * you're doing. (If you need an analysis to pass to pango_break(), * you need to pango_itemize() or use pango_get_log_attrs().) * @@ -442,7 +442,7 @@ pango_default_break (const gchar *text, */ /* FIXME one cheesy optimization here would be to memset attrs to 0 - * before we start, and then never assign FALSE to anything + * before we start, and then never assign %FALSE to anything */ const gchar *next; diff --git a/pango/ellipsize.c b/pango/ellipsize.c index 8a7b190a..d81b9e76 100644 --- a/pango/ellipsize.c +++ b/pango/ellipsize.c @@ -84,11 +84,11 @@ struct _EllipsizeState RunInfo *run_info; /* Array of information about each run */ int n_runs; - int total_width; /* Original width of line in pango units */ + int total_width; /* Original width of line in Pango units */ int gap_center; /* Goal for center of gap */ PangoGlyphItem *ellipsis_run; /* Run created to hold ellipsis */ - int ellipsis_width; /* Width of ellipsis, in pango units */ + int ellipsis_width; /* Width of ellipsis, in Pango units */ int ellipsis_is_cjk; /* Whether the first character in the ellipsized * is wide; this triggers us to try to use a * mid-line ellipsis instead of a baseline @@ -97,12 +97,12 @@ struct _EllipsizeState PangoAttrIterator *line_start_attr; /* Cached PangoAttrIterator for the start of the run */ LineIter gap_start_iter; /* Iteratator pointig to the first cluster in gap */ - int gap_start_x; /* x position of start of gap, in pango units */ + int gap_start_x; /* x position of start of gap, in Pango units */ PangoAttrIterator *gap_start_attr; /* Attribute iterator pointing to a range containing * the first character in gap */ LineIter gap_end_iter; /* Iterator pointing to last cluster in gap */ - int gap_end_x; /* x position of end of gap, in pango units */ + int gap_end_x; /* x position of end of gap, in Pango units */ }; /* Compute global information needed for the itemization process diff --git a/pango/fonts.c b/pango/fonts.c index ebea1783..352e561e 100644 --- a/pango/fonts.c +++ b/pango/fonts.c @@ -379,7 +379,7 @@ pango_font_description_get_size (const PangoFontDescription *desc) /** * pango_font_description_set_absolute_size: * @desc: a #PangoFontDescription - * @size: the new size, in pango units. There are #PANGO_SCALE Pango units in one + * @size: the new size, in Pango units. There are #PANGO_SCALE Pango units in one * device unit. For an output backend where a device unit is a pixel, a @size * value of 10 * PANGO_SCALE gives a 10 pixel font. * @@ -447,7 +447,7 @@ pango_font_description_get_set_fields (const PangoFontDescription *desc) * settings for those fields, to clear a family name set with * pango_font_description_set_family_static() so that it won't * be returned by subsequent calls to pango_font_description_get_family(), - * you must actually call pango_font_description_set_family (desc, NULL); + * you must actually call pango_font_description_set_family (desc, %NULL); **/ void pango_font_description_unset_fields (PangoFontDescription *desc, @@ -1141,7 +1141,7 @@ pango_font_get_coverage (PangoFont *font, * pango_font_find_shaper: * @font: a #PangoFont * @language: the language tag - * @ch: the ISO-10646 character code. + * @ch: a unicode character. * * Finds the best matching shaper for a font for a particular * language tag and character point. @@ -1310,7 +1310,7 @@ pango_font_metrics_unref (PangoFontMetrics *metrics) * actual drawn ink. It is necessary to lay out the text to figure * where the ink will be.) * - * Return value: the ascent, in pango units. (1 point == #PANGO_SCALE pango units.) + * Return value: the ascent, in Pango units. (1 point == #PANGO_SCALE Pango units.) **/ int pango_font_metrics_get_ascent (PangoFontMetrics *metrics) @@ -1330,7 +1330,7 @@ pango_font_metrics_get_ascent (PangoFontMetrics *metrics) * actual drawn ink. It is necessary to lay out the text to figure * where the ink will be.) * - * Return value: the descent, in pango units. (1 point == #PANGO_SCALE pango units.) + * Return value: the descent, in Pango units. (1 point == #PANGO_SCALE Pango units.) **/ int pango_font_metrics_get_descent (PangoFontMetrics *metrics) @@ -1349,7 +1349,7 @@ pango_font_metrics_get_descent (PangoFontMetrics *metrics) * determining the initial size for a window. Actual characters in * text will be wider and narrower than this. * - * Return value: the character width, in pango units. (1 point == #PANGO_SCALE pango units.) + * Return value: the character width, in Pango units. (1 point == #PANGO_SCALE Pango units.) **/ int pango_font_metrics_get_approximate_char_width (PangoFontMetrics *metrics) @@ -1370,7 +1370,7 @@ pango_font_metrics_get_approximate_char_width (PangoFontMetrics *metrics) * is generally somewhat more accurate than the result of * pango_font_metrics_get_approximate_digit_width(). * - * Return value: the digit width, in pango units. (1 point == #PANGO_SCALE pango units.) + * Return value: the digit width, in Pango units. (1 point == #PANGO_SCALE Pango units.) **/ int pango_font_metrics_get_approximate_digit_width (PangoFontMetrics *metrics) @@ -1532,7 +1532,7 @@ pango_font_family_list_faces (PangoFontFamily *family, * of pango_font_metrics_get_approximate_char_width() may be affected * by double-width characters. * - * Return value: TRUE if the family is monospace. + * Return value: %TRUE if the family is monospace. **/ gboolean pango_font_family_is_monospace (PangoFontFamily *family) @@ -1611,7 +1611,7 @@ pango_font_face_get_face_name (PangoFontFace *face) * List the available sizes for a font. This is only applicable to bitmap * fonts. For scalable fonts, stores %NULL at the location pointed to by * @sizes and 0 at the location pointed to by @n_sizes. The sizes returned - * are in pango units and are sorted in ascending order. + * are in Pango units and are sorted in ascending order. * * Since: 1.4 **/ diff --git a/pango/pango-attributes.c b/pango/pango-attributes.c index c4b8cd93..7af76c06 100644 --- a/pango/pango-attributes.c +++ b/pango/pango-attributes.c @@ -72,11 +72,11 @@ pango_attr_type_register (const gchar *name) /** * pango_attribute_copy: - * @attr: a #PangoAttribute. + * @attr: a #PangoAttribute * * Make a copy of an attribute. * - * Return value: a newly allocated #PangoAttribute. + * Return value: the new #PangoAttribute. **/ PangoAttribute * pango_attribute_copy (const PangoAttribute *attr) @@ -595,13 +595,13 @@ pango_attr_font_desc_equal (const PangoAttribute *attr1, /** * pango_attr_font_desc_new: - * @desc: + * @desc: the font description * - * Create a new font description attribute. (This attribute + * Create a new font description attribute. This attribute * allows setting family, style, weight, variant, stretch, - * and size simultaneously.) + * and size simultaneously. * - * Return value: + * Return value: the new #PangoAttribute. **/ PangoAttribute * pango_attr_font_desc_new (const PangoFontDescription *desc) @@ -625,7 +625,7 @@ pango_attr_font_desc_new (const PangoFontDescription *desc) * pango_attr_underline_new: * @underline: the underline style. * - * Create a new underline-style object. + * Create a new underline-style attribute. * * Return value: the new #PangoAttribute. **/ @@ -673,7 +673,7 @@ pango_attr_underline_color_new (guint16 red, * pango_attr_strikethrough_new: * @strikethrough: %TRUE if the text should be struck-through. * - * Create a new font strike-through attribute. + * Create a new strike-through attribute. * * Return value: the new #PangoAttribute. **/ @@ -859,19 +859,19 @@ pango_attr_shape_equal (const PangoAttribute *attr1, /** * pango_attr_shape_new_with_data: * @ink_rect: ink rectangle to assign to each character - * @logical_rect: logical rectangle assign to each character + * @logical_rect: logical rectangle to assign to each character * @data: user data pointer * @copy_func: function to copy @data when the attribute * is copied. If %NULL, @data is simply copied * as a pointer. * @destroy_func: function to free @data when the attribute - * is freed, or %NULL. + * is freed, or %NULL * * Like pango_attr_shape_new(), but a user data pointer is also - * provided; this pointer can be accessed when rendering later + * provided; this pointer can be accessed when later * rendering the glyph. * - * Return value: the newly created attribute + * Return value: the new #PangoAttribute. * * Since: 1.8 **/ @@ -908,14 +908,14 @@ pango_attr_shape_new_with_data (const PangoRectangle *ink_rect, /** * pango_attr_shape_new: * @ink_rect: ink rectangle to assign to each character - * @logical_rect: logical rectangle assign to each character + * @logical_rect: logical rectangle to assign to each character * * Create a new shape attribute. A shape is used to impose a * particular ink and logical rect on the result of shaping a * particular glyph. This might be used, for instance, for * embedding a picture or a widget inside a PangoLayout. * - * Return value: the newly created attribute + * Return value: the new #PangoAttribute **/ PangoAttribute * pango_attr_shape_new (const PangoRectangle *ink_rect, @@ -946,7 +946,7 @@ pango_attr_list_get_type (void) * * Create a new empty attribute list with a reference count of 1. * - * Return value: the newly allocated #PangoAttrList. + * Return value: new #PangoAttrList. **/ PangoAttrList * pango_attr_list_new (void) @@ -966,7 +966,9 @@ pango_attr_list_new (void) * * Increase the reference count of the given attribute list by one. * - * Return value: The attribute list passed in (since 1.10) + * Return value: The attribute list passed in + * + * Since: 1.10 **/ PangoAttrList * pango_attr_list_ref (PangoAttrList *list) @@ -1618,7 +1620,7 @@ pango_attr_iterator_get (PangoAttrIterator *iterator, * @iterator: a #PangoAttrIterator * @desc: a #PangoFontDescription to fill in with the current values. * The family name in this structure will be set using - * pango_font_description_set_family_static using values from + * pango_font_description_set_family_static() using values from * an attribute in the #PangoAttrList associated with the iterator, * so if you plan to keep it around, you must call: * pango_font_description_set_family (desc, pango_font_description_get_family (desc)). @@ -1778,7 +1780,7 @@ pango_attr_iterator_get_font (PangoAttrIterator *iterator, * of @list for which @func returns %TRUE and inserts them into * a new list. * - * Return value: a newly allocated #PangoAttrList or %NULL if + * Return value: the new #PangoAttrList or %NULL if * no attributes of the given types were found. **/ PangoAttrList * diff --git a/pango/pango-color.c b/pango/pango-color.c index 18f18392..3c0c8a1a 100644 --- a/pango/pango-color.c +++ b/pango/pango-color.c @@ -47,7 +47,7 @@ pango_color_get_type (void) * not that useful otherwise (since colors can just be copied * by assignment in C). * - * Return value: an allocated #PangoColor + * Return value: the new #PangoColor **/ PangoColor* pango_color_copy (const PangoColor *src) diff --git a/pango/pango-context.c b/pango/pango-context.c index 3ee465ff..cc2dee6a 100644 --- a/pango/pango-context.c +++ b/pango/pango-context.c @@ -1158,7 +1158,7 @@ itemize_state_finish (ItemizeState *state) * This must be >= 0. * @base_dir: base direction to use for bidirectional processing * @attrs: the set of attributes that apply to @text. - * @cached_iter: Cached attribute iterator, or NULL + * @cached_iter: Cached attribute iterator, or %NULL * * Like pango_itemize(), but the base direction to use when * computing bidirectional levels (see pango_context_set_base_dir ()), @@ -1231,7 +1231,7 @@ itemize_with_font (PangoContext *context, * after @start_index. * This must be >= 0. * @attrs: the set of attributes that apply to @text. - * @cached_iter: Cached attribute iterator, or NULL + * @cached_iter: Cached attribute iterator, or %NULL * * Breaks a piece of text into segments with consistent * directional level and shaping engine. Each byte of @text will @@ -1353,7 +1353,7 @@ update_metrics_from_items (PangoFontMetrics *metrics, * The process of determining such metrics is slow, so it is best * to always make sure some real language tag will be used. * - * Get overall metric information for a font particular font + * Get overall metric information for a particular font * description. Since the metrics may be substantially different for * different scripts, a language tag can be provided to indicate that * the metrics should be retrieved that correspond to the script(s) diff --git a/pango/pango-coverage.c b/pango/pango-coverage.c index 62638280..4b49c661 100644 --- a/pango/pango-coverage.c +++ b/pango/pango-coverage.c @@ -439,7 +439,7 @@ pango_coverage_get_uint32 (guchar **ptr) * Convert data generated from pango_converage_to_bytes() back * to a #PangoCoverage * - * Return value: a newly allocated #PangoCoverage, or NULL if + * Return value: a newly allocated #PangoCoverage, or %NULL if * the data was invalid. **/ PangoCoverage * diff --git a/pango/pango-fontmap.c b/pango/pango-fontmap.c index 80fcfbd3..bc741c33 100644 --- a/pango/pango-fontmap.c +++ b/pango/pango-fontmap.c @@ -66,9 +66,9 @@ pango_font_map_load_font (PangoFontMap *fontmap, /** * pango_font_map_list_families: * @fontmap: a #PangoFontMap - * @families: location to store a pointer to an array of PangoFontFamily *. + * @families: location to store a pointer to an array of #PangoFontFamily *. * This array should be freed with g_free(). - * @n_families: location to store the number of elements in @descs + * @n_families: location to store the number of elements in @families * * List all families for a fontmap. **/ @@ -230,7 +230,7 @@ pango_font_map_real_load_fontset (PangoFontMap *fontmap, /** * pango_font_map_get_shape_engine_type: - * @fontmap: a #PangoFontmap + * @fontmap: a #PangoFontMap * * Returns the render ID for shape engines for this fontmap. * See the render_type field of diff --git a/pango/pango-glyph-item.c b/pango/pango-glyph-item.c index 065871f8..b774add8 100644 --- a/pango/pango-glyph-item.c +++ b/pango/pango-glyph-item.c @@ -594,7 +594,7 @@ pango_glyph_item_apply_attrs (PangoGlyphItem *glyph_item, * negative values will give ugly results. * * Adds spacing between the graphemes of @glyph_item to - * give the effect of typographic letter spacing.b + * give the effect of typographic letter spacing. * * Since: 1.6 **/ diff --git a/pango/pango-layout.c b/pango/pango-layout.c index 45e1e2ed..65d06097 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -362,7 +362,7 @@ pango_layout_get_wrap (PangoLayout *layout) * @layout: a #PangoLayout. * @indent: the amount by which to indentset * - * Sets the width in pango units to indent each paragraph. A negative value + * Sets the width in Pango units to indent each paragraph. A negative value * of @indent will produce a hanging indent. That is, the first line will * have the full width, and subsequent lines will be indented by the * absolute value of @indent. @@ -384,7 +384,7 @@ pango_layout_set_indent (PangoLayout *layout, * pango_layout_get_indent: * @layout: a #PangoLayout * - * Gets the paragraph indent width in pango units. A negative value + * Gets the paragraph indent width in Pango units. A negative value * indicates a hanging indent. * * Return value: the indent diff --git a/pango/pango-markup.c b/pango/pango-markup.c index d2d39409..a2769124 100644 --- a/pango/pango-markup.c +++ b/pango/pango-markup.c @@ -552,10 +552,10 @@ static const GMarkupParser pango_markup_parser = { * @markup_text: markup to parse (see markup format) * @length: length of @markup_text, or -1 if nul-terminated * @accel_marker: character that precedes an accelerator, or 0 for none - * @attr_list: address of return location for a #PangoAttrList, or NULL - * @text: address of return location for text with tags stripped, or NULL - * @accel_char: address of return location for accelerator char, or NULL - * @error: address of return location for errors, or NULL + * @attr_list: address of return location for a #PangoAttrList, or %NULL + * @text: address of return location for text with tags stripped, or %NULL + * @accel_char: address of return location for accelerator char, or %NULL + * @error: address of return location for errors, or %NULL * * * Parses marked-up text (see @@ -570,7 +570,7 @@ static const GMarkupParser pango_markup_parser = { * Two @accel_marker characters following each other produce a single * literal @accel_marker character. * - * Return value: FALSE if @error is set, otherwise TRUE + * Return value: %FALSE if @error is set, otherwise %TRUE **/ gboolean pango_parse_markup (const char *markup_text, diff --git a/pango/pango-tabs.c b/pango/pango-tabs.c index 09eeefb8..5728733b 100644 --- a/pango/pango-tabs.c +++ b/pango/pango-tabs.c @@ -59,10 +59,10 @@ init_tabs (PangoTabArray *array, gint start, gint end) * @positions_in_pixels: whether positions are in pixel units * * Creates an array of @initial_size tab stops. Tab stops are specified in - * pixel units if @positions_in_pixels is TRUE, otherwise in Pango + * pixel units if @positions_in_pixels is %TRUE, otherwise in Pango * units. All stops are initially at position 0. * - * Return value: a #PangoTabArray + * Return value: the new #PangoTabArray **/ PangoTabArray* pango_tab_array_new (gint initial_size, @@ -107,7 +107,7 @@ pango_tab_array_new (gint initial_size, * tab stop. You must provide an alignment * and position for @size tab stops. * - * Return value: a new #PangoTabArray + * Return value: the new #PangoTabArray **/ PangoTabArray * pango_tab_array_new_with_positions (gint size, @@ -170,7 +170,7 @@ pango_tab_array_get_type (void) * * Copies a #PangoTabArray * - * Return value: Newly-allocated #PangoTabArray + * Return value: the new #PangoTabArray. **/ PangoTabArray* pango_tab_array_copy (PangoTabArray *src) @@ -226,6 +226,7 @@ pango_tab_array_get_size (PangoTabArray *tab_array) * * Resizes a tab array. You must subsequently initialize any tabs that * were added as a result of growing the array. + * **/ void pango_tab_array_resize (PangoTabArray *tab_array, @@ -256,7 +257,7 @@ pango_tab_array_resize (PangoTabArray *tab_array, * @tab_array: a #PangoTabArray * @tab_index: the index of a tab stop * @alignment: tab alignment - * @location: tab location in pango units + * @location: tab location in Pango units * * Sets the alignment and location of a tab stop. * @alignment must always be #PANGO_TAB_LEFT in the current @@ -285,12 +286,10 @@ pango_tab_array_set_tab (PangoTabArray *tab_array, * pango_tab_array_get_tab: * @tab_array: a #PangoTabArray * @tab_index: tab stop index - * @alignment: location to store alignment - * @location: location to store tab position + * @alignment: location to store alignment, or %NULL + * @location: location to store tab position, or %NULL * * Gets the alignment and position of a tab stop. - * @alignment or @location may be NULL if you aren't - * interested in their value. * **/ void @@ -313,10 +312,10 @@ pango_tab_array_get_tab (PangoTabArray *tab_array, /** * pango_tab_array_get_tabs: * @tab_array: a #PangoTabArray - * @alignments: location to store an array of tab stop alignments - * @locations: location to store an array of tab positions + * @alignments: location to store an array of tab stop alignments, or %NULL + * @locations: location to store an array of tab positions, or %NULL * - * If non-NULL, @alignments and @locations are filled with allocated + * If non-%NULL, @alignments and @locations are filled with allocated * arrays of length pango_tab_array_get_size(). You must free the * returned array. * @@ -352,10 +351,10 @@ pango_tab_array_get_tabs (PangoTabArray *tab_array, * pango_tab_array_get_positions_in_pixels: * @tab_array: a #PangoTabArray * - * Returns TRUE if the tab positions are in pixels, FALSE if they are + * Returns %TRUE if the tab positions are in pixels, %FALSE if they are * in Pango units. * - * Return value: whether positions are in pixels + * Return value: whether positions are in pixels. **/ gboolean pango_tab_array_get_positions_in_pixels (PangoTabArray *tab_array) diff --git a/pango/pango-types.h b/pango/pango-types.h index 4b59e9b3..1e3a0305 100644 --- a/pango/pango-types.h +++ b/pango/pango-types.h @@ -160,7 +160,7 @@ void pango_matrix_concat (PangoMatrix *matrix, * or %PANGO_DIRECTION_WEAK_RTL, since every character is either * neutral or has a strong direction; on the other hand * %PANGO_DIRECTION_NEUTRAL doesn't make sense to pass - * to pango_log2vis_get_embedding_levels(). + * to pango_itemize_with_base_dir(). * * The %PANGO_DIRECTION_TTB_LTR, %PANGO_DIRECTION_TTB_RTL * values come from an earlier interpretation of this diff --git a/pango/pango-utils.c b/pango/pango-utils.c index 32d93828..d7584561 100644 --- a/pango/pango-utils.c +++ b/pango/pango-utils.c @@ -1278,7 +1278,7 @@ pango_language_from_string (const char *language) * %NULL is allowed and matches nothing but '*' * @range_list: a list of language ranges, separated by ';' characters. * each element must either be '*', or a RFC 3066 language range - * canonicalized as by pango_language_from_string(). + * canonicalized as by pango_language_from_string() * * Checks if a language tag matches one of the elements in a list of * language ranges. A language tag is considered to match a range diff --git a/pango/pangoft2-render.c b/pango/pangoft2-render.c index 49908ca5..1ad03b09 100644 --- a/pango/pangoft2-render.c +++ b/pango/pangoft2-render.c @@ -448,7 +448,7 @@ pango_ft2_renderer_draw_trapezoid (PangoRenderer *renderer, * @y: the Y position of the top of the layout (in Pango units) * * Render a #PangoLayout onto a FreeType2 bitmap, with he - * location specified in fixed-point pango units rather than + * location specified in fixed-point Pango units rather than * pixels. (Using this will avoid extra inaccuracies from * rounding to integer pixels multiple times, even if the * final glyph positions are integers.) @@ -499,11 +499,11 @@ pango_ft2_render_layout (FT_Bitmap *bitmap, * pango_ft2_render_layout_line_subpixel: * @bitmap: a FT_Bitmap to render the line onto * @line: a #PangoLayoutLine - * @x: the x position of start of string (in pango units) - * @y: the y position of baseline (in pango units) + * @x: the x position of start of string (in Pango units) + * @y: the y position of baseline (in Pango units) * * Render a #PangoLayoutLine onto a FreeType2 bitmap, with he - * location specified in fixed-point pango units rather than + * location specified in fixed-point Pango units rather than * pixels. (Using this will avoid extra inaccuracies from * rounding to integer pixels multiple times, even if the * final glyph positions are integers.) diff --git a/pango/pangox.c b/pango/pangox.c index 92bd91b7..a3b273ab 100644 --- a/pango/pangox.c +++ b/pango/pangox.c @@ -820,7 +820,7 @@ get_font_metrics_from_subfonts (PangoFont *font, if (get_int_prop (avg_width_atom, fs, &avg_width)) { - /* convert decipoints --> pango units. + /* convert decipoints --> Pango units. * Resolution is in (points * PANGO_SCALE) / pixel, * avg_width in decipoints. * We want pixels * PANGO_SCALE diff --git a/pango/pangoxft-render.c b/pango/pangoxft-render.c index b97bb859..c1825b31 100644 --- a/pango/pangoxft-render.c +++ b/pango/pangoxft-render.c @@ -639,8 +639,8 @@ pango_xft_render_layout (XftDraw *draw, * @color: the foreground color in which to draw the layout line * (may be overriden by color attributes) * @line: a #PangoLayoutLine - * @x: the x position of start of string (in pango units) - * @y: the y position of baseline (in pango units) + * @x: the x position of start of string (in Pango units) + * @y: the y position of baseline (in Pango units) * * Render a #PangoLayoutLine onto a #XftDraw * -- cgit v1.2.1