diff options
author | Noah Levitt <nlevitt@columbia.edu> | 2003-07-25 13:27:16 +0000 |
---|---|---|
committer | Noah Levitt <nlevitt@src.gnome.org> | 2003-07-25 13:27:16 +0000 |
commit | 0b732c153346329684435cf73319a3795ec9dcd7 (patch) | |
tree | 71289d5d5fe977b6b7d9a5538beabd677faddf45 /docs | |
parent | 19fd07c7962396917af2c7f29e40f1478f826cab (diff) | |
download | pango-0b732c153346329684435cf73319a3795ec9dcd7.tar.gz |
Get rid of explicit tables detailing the members of structs, use the
2003-07-25 Noah Levitt <nlevitt@columbia.edu>
* 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)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/tmpl/engines.sgml | 164 | ||||
-rw-r--r-- | docs/tmpl/glyphs.sgml | 63 | ||||
-rw-r--r-- | docs/tmpl/main.sgml | 86 |
3 files changed, 46 insertions, 267 deletions
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. <para> The #PangoEngineInfo structure contains information about a particular engine. It contains the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>gchar *id;</entry> -<entry>a unique string ID for the engine.</entry> -</row> -<row> -<entry>gchar *engine_type;</entry> -<entry>a string identifying the engine type.</entry> -</row> - -<row> -<entry>gchar *render type;</entry> -<entry>a string identifying the render type.</entry> -</row> - -<row> -<entry>#PangoEngineRange *ranges;</entry> -<entry>a pointer to an array of #PangoEngineRange - structures. Each structure contains information - about a range of Unicode code points that - this engine handles.</entry> -</row> - -<row> -<entry>gint n_ranges;</entry> -<entry>the number of elements in <structfield>ranges</structfield>.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@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 <structfield>ranges</structfield>. <!-- ##### STRUCT PangoEngineRange ##### --> <para> The PangoEngineRange structure contains information about a range of Unicode code points. It contains the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>guint32 start;</entry> -<entry>the first code point in the range.</entry> -</row> - -<row> -<entry>guint32 end;</entry> -<entry>the last code point for the range.</entry> -</row> - -<row> -<entry>gchar *langs;</entry> -<entry>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.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@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. <!-- ##### STRUCT PangoEngine ##### --> <para> The #PangoEngine structure contains basic information common to all script engines. It contains the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>gchar *id;</entry> -<entry>a unique string ID for this language engine.</entry> -</row> - -<row> -<entry>gchar *type;</entry> -<entry>The "type" of the engine. (Is this engine type or render type??).</entry> -</row> - -<row> -<entry>gint length;</entry> -<entry>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.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@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. <!-- ##### STRUCT PangoEngineLang ##### --> <para> @@ -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: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>#PangoEngine engine;</entry> -<entry>A nested structure containing basic engine data.</entry> -</row> - -<row> -<entry>void (*script_break) (...);</entry> -<entry>A function that provides an implementation - for pango_break().</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@engine: -@script_break: +@engine: a nested structure containing basic engine data. +@script_break: a function that provides an implementation for pango_break(). <!-- ##### STRUCT PangoEngineShape ##### --> <para> @@ -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: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>#PangoEngine engine;</entry> -<entry>A nested structure containing basic engine data.</entry> -</row> - -<row> -<entry> void (*script_shape) (...);</entry> -<entry>A function that provides an implementation - for pango_shape.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@engine: -@script_shape: +@engine: a nested structure containing basic engine data. +@script_shape: a function that provides an implementation for pango_shape. @get_coverage: <!-- ##### MACRO PANGO_ENGINE_TYPE_LANG ##### --> diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index 8791947a..5377a65a 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -118,34 +118,12 @@ It contains the following fields. <!-- ##### STRUCT PangoGlyphGeometry ##### --> <para> The #PangoGlyphGeometry structure contains width and positioning -information for a single glyph. Distances are in -1/64ths of a point. - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>#PangoGlyphUnit width;</entry> -<entry>the logical width to use for the the character.</entry> -</row> - -<row> -<entry>#PangoCFont *x_offset;</entry> -<entry>horizontal offset from nominal character position.</entry> -</row> - -<row> -<entry>#PangoCFont *y_offset;</entry> -<entry>vertical offset from nominal character position.</entry> -</row> - -</tbody></tgroup></informaltable> +information for a single glyph. </para> -@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. <!-- ##### TYPEDEF PangoGlyphUnit ##### --> <para> @@ -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. </para> -<para> -#PangoGlyphString contains the following publically -accessible fields -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>gint #num_glyphs;</entry> -<entry>the number of glyphs in the string.</entry> -</row> - -<row> -<entry>PangoGlyphInfo *#glyphs;</entry> -<entry>an array of #PangoGlyphInfo structures of length <structfield>num_glyphs</structfield>.</entry> -</row> - -<row> -<entry>gint *#log_clusters;</entry> -<entry>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 <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.</entry> -</row> - -</tbody></tgroup></informaltable> -</para> - -@num_glyphs: -@glyphs: -@log_clusters: +corresponding to the PangoGlyphString. <!-- ##### STRUCT PangoGlyphItem ##### --> <para> 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. <!-- ##### STRUCT PangoContext ##### --> <para> The #PangoContext structure stores global information -used to control the itemization process. It contains -the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>gchar *lang;</entry> -<entry>the global default language in the standard form - "fr" or "fr_FR". (This may be overriden - with the @lang_info parameter to pango_itemize().)</entry> -</row> - -<row> -<entry>gchar *render_type;</entry> -<entry>a string identifier for the rendering system to use, - for instance %PANGO_RENDER_TYPE_X</entry> -</row> - -</tbody></tgroup></informaltable> +used to control the itemization process. </para> - <!-- ##### STRUCT PangoItem ##### --> <para> The #PangoItem structure stores information about a segment of text. It contains the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>gint offset;</entry> -<entry>the offset of the segment from the beginning of the - string in bytes.</entry> -</row> - -<row> -<entry>gint length;</entry> -<entry>the length of the segment in bytes.</entry> -</row> - -<row> -<entry>gint num_chars;</entry> -<entry>the length of the segment in characters.</entry> -</row> - -<row> -<entry>gint analysis;</entry> -<entry>the properties of the segment.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@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. <!-- ##### STRUCT PangoAnalysis ##### --> <para> The #PangoAnalysis structure stores information about the properties of a segment of text. It has the following fields: - -<informaltable pgwide="1" frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/> -<tbody> - -<row> -<entry>#PangoEngineShape *shape_engine;</entry> -<entry>the engine for doing rendering-system-dependent processing</entry> -</row> - -<row> -<entry>#PangoEngineLang *lang_engine;</entry> -<entry>the engine for doing rendering-system-independent processing</entry> -</row> - -<row> -<entry>guint8 level;</entry> -<entry>the bidrectional level for this segment.</entry> -</row> - -</tbody></tgroup></informaltable> </para> -@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: |