From adf1db25a516e1a8b02b89de216e2b42ef1d7639 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Fri, 5 May 2000 23:36:18 +0000 Subject: a bit of updating to shaper docs --- docs/tmpl/engines.sgml | 57 +++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 29 deletions(-) (limited to 'docs') diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml index b7c3a91a..a23565a2 100644 --- a/docs/tmpl/engines.sgml +++ b/docs/tmpl/engines.sgml @@ -2,30 +2,24 @@ Engines -Modules to do language-specific and rendering-system-specific -processing. +language-specific and rendering-system-specific processing. -Pango utilizes a module architecture in which -the language-specific and render-system-specific -components are provided by loadable modules. Each -loadable module supplies one or more -engines. -Each engine has an associated -engine type and -render type. These two -types are represented by strings. +Pango utilizes a module architecture in which the language-specific +and render-system-specific components are provided by loadable +modules. Each loadable module supplies one or more +engines. Each engine +has an associated engine type and +render type. These two types are represented by +strings. -Each dynamically-loaded module exports several -functions which provide the public API. These -functions are script_engine_list(), -script_engine_load() and script_engine_unload(). -The latter two functions are used for loading -and unloading modules, while the first function -is used when building a catalog of all available -modules. +Each dynamically-loaded module exports several functions which provide +the public API. These functions are script_engine_list(), +script_engine_load() and script_engine_unload(). The latter two +functions are used for loading and unloading modules, while the first +function is used when building a catalog of all available modules. @@ -35,9 +29,8 @@ modules. -The #PangoEngineInfo structure contains -information about a particular engine. It -contains the following fields: +The #PangoEngineInfo structure contains information about a particular +engine. It contains the following fields: @@ -242,8 +235,10 @@ specific. -Function to be provided by a module to list -the engines that the module supplies. +Function to be provided by a module to list the engines that the +module supplies. The function stores a pointer to an array +of #PangoEngineInfo structures and the length of that array in +the given location. @engines: location to store a pointer to an array of engines. @@ -252,21 +247,25 @@ the engines that the module supplies. -Function to be provided by a module to load -a particular engine. +Function to be provided by a module to load a particular engine. -@id: the ID from the #ScriptEngineInfo structure of the +@id: the ID from the #PangoEngineInfo structure of the module to load. @Returns: the newly created script engine. -Function to be provided by a module to unload -an engine. +Function to be provided by a module to unload an engine loaded +with script_engine_load(). @engine: the engine to unload. + + + + + -- cgit v1.2.1