From b56f79bbd9f11808c08e2f8bff001bf048ae0b04 Mon Sep 17 00:00:00 2001 From: Noah Levitt Date: Fri, 25 Jul 2003 13:29:17 +0000 Subject: Get rid of explicit tables detailing the members of structs, use the 2003-07-25 Noah Levitt * docs/tmpl/engines.sgml: * docs/tmpl/glyphs.sgml: * docs/tmpl/main.sgml: Get rid of explicit tables detailing the members of structs, use the automatic things instead. (#117857) --- ChangeLog | 7 +++ ChangeLog.pre-1-10 | 7 +++ ChangeLog.pre-1-4 | 7 +++ ChangeLog.pre-1-6 | 7 +++ ChangeLog.pre-1-8 | 7 +++ docs/tmpl/engines.sgml | 164 +++++++++---------------------------------------- docs/tmpl/glyphs.sgml | 63 +++---------------- docs/tmpl/main.sgml | 86 +++----------------------- 8 files changed, 81 insertions(+), 267 deletions(-) diff --git a/ChangeLog b/ChangeLog index ac8eeaae..75849141 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2003-07-25 Noah Levitt + + * docs/tmpl/engines.sgml: + * docs/tmpl/glyphs.sgml: + * docs/tmpl/main.sgml: Get rid of explicit tables detailing the + members of structs, use the automatic things instead. (#117857) + 2003-07-25 Sven Neumann * pango/pangoft2.c (pango_ft2_render_layout_line): removed diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10 index ac8eeaae..75849141 100644 --- a/ChangeLog.pre-1-10 +++ b/ChangeLog.pre-1-10 @@ -1,3 +1,10 @@ +2003-07-25 Noah Levitt + + * docs/tmpl/engines.sgml: + * docs/tmpl/glyphs.sgml: + * docs/tmpl/main.sgml: Get rid of explicit tables detailing the + members of structs, use the automatic things instead. (#117857) + 2003-07-25 Sven Neumann * pango/pangoft2.c (pango_ft2_render_layout_line): removed diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4 index ac8eeaae..75849141 100644 --- a/ChangeLog.pre-1-4 +++ b/ChangeLog.pre-1-4 @@ -1,3 +1,10 @@ +2003-07-25 Noah Levitt + + * docs/tmpl/engines.sgml: + * docs/tmpl/glyphs.sgml: + * docs/tmpl/main.sgml: Get rid of explicit tables detailing the + members of structs, use the automatic things instead. (#117857) + 2003-07-25 Sven Neumann * pango/pangoft2.c (pango_ft2_render_layout_line): removed diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6 index ac8eeaae..75849141 100644 --- a/ChangeLog.pre-1-6 +++ b/ChangeLog.pre-1-6 @@ -1,3 +1,10 @@ +2003-07-25 Noah Levitt + + * docs/tmpl/engines.sgml: + * docs/tmpl/glyphs.sgml: + * docs/tmpl/main.sgml: Get rid of explicit tables detailing the + members of structs, use the automatic things instead. (#117857) + 2003-07-25 Sven Neumann * pango/pangoft2.c (pango_ft2_render_layout_line): removed diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8 index ac8eeaae..75849141 100644 --- a/ChangeLog.pre-1-8 +++ b/ChangeLog.pre-1-8 @@ -1,3 +1,10 @@ +2003-07-25 Noah Levitt + + * docs/tmpl/engines.sgml: + * docs/tmpl/glyphs.sgml: + * docs/tmpl/main.sgml: Get rid of explicit tables detailing the + members of structs, use the automatic things instead. (#117857) + 2003-07-25 Sven Neumann * pango/pangoft2.c (pango_ft2_render_layout_line): removed diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml index 1f27d225..4b88affd 100644 --- a/docs/tmpl/engines.sgml +++ b/docs/tmpl/engines.sgml @@ -31,121 +31,49 @@ function is used when building a catalog of all available modules. The #PangoEngineInfo structure contains information about a particular engine. It contains the following fields: - - - - - - -gchar *id; -a unique string ID for the engine. - - -gchar *engine_type; -a string identifying the engine type. - - - -gchar *render type; -a string identifying the render type. - - - -#PangoEngineRange *ranges; -a pointer to an array of #PangoEngineRange - structures. Each structure contains information - about a range of Unicode code points that - this engine handles. - - - -gint n_ranges; -the number of elements in ranges. - - - -@id: -@engine_type: -@render_type: -@ranges: -@n_ranges: +@id: a unique string ID for the engine. +@engine_type: a string identifying the engine type. +@render_type: a string identifying the render type. +@ranges: a pointer to an array of #PangoEngineRange + structures. Each structure contains information + about a range of Unicode code points that + this engine handles. +@n_ranges: the number of elements in ranges. The PangoEngineRange structure contains information about a range of Unicode code points. It contains the following fields: - - - - - - -guint32 start; -the first code point in the range. - - - -guint32 end; -the last code point for the range. - - - -gchar *langs; -A semicolon separated list of languages that this - engine handles for this range. This may be empty, - in which case the engine is saying that it is a - fallback choice for all languages for this range, - but should not be used if another engine - indicates that it is specific for the language for - a given code point. An entry in this list of "*" - indicates that this engine is specific to all - languages for this range. - - - -@start: -@end: -@langs: +@start: the first code point in the range. +@end: the last code point for the range. +@langs: a semicolon separated list of languages that this + engine handles for this range. This may be empty, + in which case the engine is saying that it is a + fallback choice for all languages for this range, + but should not be used if another engine + indicates that it is specific for the language for + a given code point. An entry in this list of "*" + indicates that this engine is specific to all + languages for this range. The #PangoEngine structure contains basic information common to all script engines. It contains the following fields: - - - - - - -gchar *id; -a unique string ID for this language engine. - - - -gchar *type; -The "type" of the engine. (Is this engine type or render type??). - - - -gint length; -the length of the entire structure in bytes. This is - provided so that new functions can be added at the - end of subtypes of #PangoEngine without breaking - older modules. - - - -@id: -@type: -@length: +@id: a unique string ID for this language engine. +@type: the "type" of the engine. (Is this engine type or render type??). +@length: the length of the entire structure in bytes. This is + provided so that new functions can be added at the + end of subtypes of #PangoEngine without breaking + older modules. @@ -153,27 +81,10 @@ The #PangoEngineLang structure extends the basic #PangoEngine structure to engines that deal with the rendering-system independent part of of the rendering pipeline. It contains the following fields: - - - - - - -#PangoEngine engine; -A nested structure containing basic engine data. - - - -void (*script_break) (...); -A function that provides an implementation - for pango_break(). - - - -@engine: -@script_break: +@engine: a nested structure containing basic engine data. +@script_break: a function that provides an implementation for pango_break(). @@ -181,27 +92,10 @@ The #PangoEngineShape structure extends the basic #PangoEngine structure to engines that deal with the rendering-system dependent part of of the rendering pipeline. It contains the following fields: - - - - - - -#PangoEngine engine; -A nested structure containing basic engine data. - - - - void (*script_shape) (...); -A function that provides an implementation - for pango_shape. - - - -@engine: -@script_shape: +@engine: a nested structure containing basic engine data. +@script_shape: a function that provides an implementation for pango_shape. @get_coverage: diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index 5b92c72b..ac0583c8 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -118,34 +118,12 @@ It contains the following fields. The #PangoGlyphGeometry structure contains width and positioning -information for a single glyph. Distances are in -1/64ths of a point. - - - - - - -#PangoGlyphUnit width; -the logical width to use for the the character. - - - -#PangoCFont *x_offset; -horizontal offset from nominal character position. - - - -#PangoCFont *y_offset; -vertical offset from nominal character position. - - - +information for a single glyph. -@width: -@x_offset: -@y_offset: +@width: the logical width to use for the the character. +@x_offset: horizontal offset from nominal character position. +@y_offset: vertical offset from nominal character position. @@ -191,37 +169,12 @@ of glyphs with geometry and visual attribute information. The storage for the glyph information is owned by the structure which simplifies memory management. - -#PangoGlyphString contains the following publically -accessible fields - - - - - -gint #num_glyphs; -the number of glyphs in the string. - - - -PangoGlyphInfo *#glyphs; -an array of #PangoGlyphInfo structures of length num_glyphs. - - - -gint *#log_clusters; -for each glyph, byte index of the starting character for the +@num_glyphs: the number of glyphs in the string. +@glyphs: an array of #PangoGlyphInfo structures of length num_glyphs. +@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: +corresponding to the PangoGlyphString. diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index f9804cbc..8f06a701 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -20,100 +20,32 @@ various steps of this process. The #PangoContext structure stores global information -used to control the itemization process. It contains -the following fields: - - - - - - -gchar *lang; -the global default language in the standard form - "fr" or "fr_FR". (This may be overriden - with the @lang_info parameter to pango_itemize().) - - - -gchar *render_type; -a string identifier for the rendering system to use, - for instance %PANGO_RENDER_TYPE_X - - - +used to control the itemization process. - The #PangoItem structure stores information about a segment of text. It contains the following fields: - - - - - - -gint offset; -the offset of the segment from the beginning of the - string in bytes. - - - -gint length; -the length of the segment in bytes. - - - -gint num_chars; -the length of the segment in characters. - - - -gint analysis; -the properties of the segment. - - - -@offset: -@length: -@num_chars: -@analysis: +@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. The #PangoAnalysis structure stores information about the properties of a segment of text. It has the following fields: - - - - - - -#PangoEngineShape *shape_engine; -the engine for doing rendering-system-dependent processing - - - -#PangoEngineLang *lang_engine; -the engine for doing rendering-system-independent processing - - - -guint8 level; -the bidrectional level for this segment. - - - -@shape_engine: -@lang_engine: +@shape_engine: the engine for doing rendering-system-dependent processing. +@lang_engine: the engine for doing rendering-system-independent processing. @font: -@level: +@level: the bidrectional level for this segment. @language: @extra_attrs: -- cgit v1.2.1