Commit 6d08bcab authored by Behdad Esfahbod's avatar Behdad Esfahbod
Browse files

Bug 685167 - migrate docs to no-tmpl flavour

Patch from Rafał Mużyło.
parent bb5c4c84
......@@ -592,7 +592,7 @@ if $have_cairo ; then : ; else
fi
fi
GTK_DOC_CHECK([1.0])
GTK_DOC_CHECK([1.15], [--flavour no-tmpl])
AC_ARG_ENABLE(man,
AC_HELP_STRING([--enable-man],
......
......@@ -123,10 +123,6 @@
<title>Index of new symbols in 1.26</title>
<xi:include href="xml/api-index-1.26.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-28" role="1.28">
<title>Index of new symbols in 1.28</title>
<xi:include href="xml/api-index-1.28.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-30" role="1.30">
<title>Index of new symbols in 1.30</title>
<xi:include href="xml/api-index-1.30.xml"><xi:fallback /></xi:include>
......
......@@ -262,6 +262,7 @@ pango_font_map_load_fontset
pango_font_map_list_families
pango_font_map_get_shape_engine_type
pango_font_map_get_serial
pango_font_map_changed
<SUBSECTION>
PangoFontset
PANGO_TYPE_FONTSET
......
<!-- ##### SECTION Title ##### -->
Bidirectional Text
<!-- ##### SECTION Short_Description ##### -->
Types and functions to help with handling bidirectional text
<!-- ##### SECTION Long_Description ##### -->
<para>
Pango supports bidirectional text (like Arabic and Hebrew) automatically.
Some applications however, need some help to correctly handle bidirectional
text.
</para>
<para>
The #PangoDirection type can be used with pango_context_set_base_dir() to
instruct Pango about direction of text, though in most cases Pango detects
that correctly and automatically. The rest of the facilities in this section
are used internally by Pango already, and are provided to help applications
that need more direct control over bidirectional setting of text.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
pango_context_get_base_dir(),
pango_context_set_base_dir(),
pango_itemize_with_base_dir()
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### ENUM PangoDirection ##### -->
<para>
</para>
@PANGO_DIRECTION_LTR:
@PANGO_DIRECTION_RTL:
@PANGO_DIRECTION_TTB_LTR:
@PANGO_DIRECTION_TTB_RTL:
@PANGO_DIRECTION_WEAK_LTR:
@PANGO_DIRECTION_WEAK_RTL:
@PANGO_DIRECTION_NEUTRAL:
<!-- ##### FUNCTION pango_unichar_direction ##### -->
<para>
</para>
@ch:
@Returns:
<!-- ##### FUNCTION pango_find_base_dir ##### -->
<para>
</para>
@text:
@length:
@Returns:
<!-- ##### FUNCTION pango_get_mirror_char ##### -->
<para>
</para>
@ch:
@mirrored_ch:
@Returns:
<!-- ##### ENUM PangoBidiType ##### -->
<para>
</para>
@PANGO_BIDI_TYPE_L:
@PANGO_BIDI_TYPE_LRE:
@PANGO_BIDI_TYPE_LRO:
@PANGO_BIDI_TYPE_R:
@PANGO_BIDI_TYPE_AL:
@PANGO_BIDI_TYPE_RLE:
@PANGO_BIDI_TYPE_RLO:
@PANGO_BIDI_TYPE_PDF:
@PANGO_BIDI_TYPE_EN:
@PANGO_BIDI_TYPE_ES:
@PANGO_BIDI_TYPE_ET:
@PANGO_BIDI_TYPE_AN:
@PANGO_BIDI_TYPE_CS:
@PANGO_BIDI_TYPE_NSM:
@PANGO_BIDI_TYPE_BN:
@PANGO_BIDI_TYPE_B:
@PANGO_BIDI_TYPE_S:
@PANGO_BIDI_TYPE_WS:
@PANGO_BIDI_TYPE_ON:
<!-- ##### FUNCTION pango_bidi_type_for_unichar ##### -->
<para>
</para>
@ch:
@Returns:
<!-- ##### SECTION Title ##### -->
CoreText Fonts
<!-- ##### SECTION Short_Description ##### -->
Font handling with CoreText fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
The macros and functions in this section are used to access fonts natively on
OS X using the CoreText text rendering subsystem.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO PANGO_RENDER_TYPE_CORE_TEXT ##### -->
<para>
A string constant identifying the CoreText renderer. The associated quark (see
g_quark_from_string()) is used to identify the renderer in pango_find_map().
</para>
<!-- ##### FUNCTION pango_core_text_font_get_ctfont ##### -->
<para>
</para>
@font:
@Returns:
<!-- ##### SECTION Title ##### -->
Coverage Maps
<!-- ##### SECTION Short_Description ##### -->
Unicode character range coverage storage
<!-- ##### SECTION Long_Description ##### -->
<para>
It is often necessary in Pango to determine if a particular font can
represent a particular character, and also how well it can represent
that character. The #PangoCoverage is a data structure that is used
to represent that information.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### ENUM PangoCoverageLevel ##### -->
<para>
Used to indicate how well a font can represent a particular Unicode
character point for a particular script.
</para>
@PANGO_COVERAGE_NONE: The character is not representable with the font.
@PANGO_COVERAGE_FALLBACK: The character is represented in a way that may be
comprehensible but is not the correct graphical form.
For instance, a Hangul character represented as a
a sequence of Jamos, or a Latin transliteration of
a Cyrillic word.
@PANGO_COVERAGE_APPROXIMATE: The character is represented as basically the correct
graphical form, but with a stylistic variant inappropriate for
the current script.
@PANGO_COVERAGE_EXACT: The character is represented as the correct graphical form.
<!-- ##### MACRO PANGO_TYPE_COVERAGE_LEVEL ##### -->
<para>
The #GObject type for #PangoCoverageLevel.
</para>
<!-- ##### STRUCT PangoCoverage ##### -->
<para>
The #PangoCoverage structure represents a map from Unicode characters
to #PangoCoverageLevel. It is an opaque structure with no public fields.
</para>
<!-- ##### FUNCTION pango_coverage_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION pango_coverage_ref ##### -->
<para>
</para>
@coverage:
@Returns:
<!-- ##### FUNCTION pango_coverage_unref ##### -->
<para>
</para>
@coverage:
<!-- ##### FUNCTION pango_coverage_copy ##### -->
<para>
</para>
@coverage:
@Returns:
<!-- ##### FUNCTION pango_coverage_get ##### -->
<para>
</para>
@coverage:
@index_:
@Returns:
<!-- ##### FUNCTION pango_coverage_max ##### -->
<para>
</para>
@coverage:
@other:
<!-- ##### FUNCTION pango_coverage_set ##### -->
<para>
</para>
@coverage:
@index_:
@level:
<!-- ##### FUNCTION pango_coverage_to_bytes ##### -->
<para>
</para>
@coverage:
@bytes:
@n_bytes:
<!-- ##### FUNCTION pango_coverage_from_bytes ##### -->
<para>
</para>
@bytes:
@n_bytes:
@Returns:
<!-- ##### SECTION Title ##### -->
Engines
<!-- ##### SECTION Short_Description ##### -->
Language-specific and rendering-system-specific processing
<!-- ##### SECTION Long_Description ##### -->
<para>
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
<firstterm>engines</firstterm>. Each <firstterm>engine</firstterm>
has an associated <firstterm>engine type</firstterm> and
<firstterm>render type</firstterm>. These two types are represented by
strings.
</para>
<para>
Each dynamically-loaded module exports several functions which provide
the public API. These functions are script_engine_list(),
script_engine_init() and script_engine_exit, and
script_engine_create(). The latter three functions are used when
creating engines from the module at run time, while the first
function is used when building a catalog of all available modules.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT PangoEngineInfo ##### -->
<para>
The #PangoEngineInfo structure contains information about a particular
engine. It contains the following fields:
</para>
@id: a unique string ID for the engine.
@engine_type: a string identifying the engine type.
@render_type: a string identifying the render type.
@scripts: array of scripts this engine supports.
@n_scripts: number of items in @scripts.
<!-- ##### STRUCT PangoEngineScriptInfo ##### -->
<para>
The #PangoEngineScriptInfo structure contains
information about how the shaper covers a particular
script.
</para>
@script: a #PangoScript. The value %PANGO_SCRIPT_COMMON has
the special meaning here of "all scripts"
@langs: a semicolon separated list of languages that this
engine handles for this script. 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>
</para>
<!-- ##### STRUCT PangoEngineClass ##### -->
<para>
</para>
<!-- ##### MACRO PANGO_RENDER_TYPE_NONE ##### -->
<para>
A string constant defining the render type
for engines that are not rendering-system
specific.
</para>
<!-- ##### FUNCTION script_engine_list ##### -->
<para>
</para>
@engines: location to store a pointer to an array of engines.
@n_engines: location to store the number of elements in @engines.
<!-- ##### FUNCTION script_engine_init ##### -->
<para>
</para>
@module:
<!-- ##### FUNCTION script_engine_exit ##### -->
<para>
</para>
@void:
<!-- ##### FUNCTION script_engine_create ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### SECTION Title ##### -->
Fonts
<!-- ##### SECTION Short_Description ##### -->
Structures representing abstract fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
Pango supports a flexible architecture where a
particular rendering architecture can supply an
implementation of fonts. The #PangoFont structure
represents an abstract rendering-system-independent font.
Pango provides routines to list available fonts, and
to load a font of a given description.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT PangoFontDescription ##### -->
<para>
The #PangoFontDescription structure represents the description
of an ideal font. These structures are used both to list
what fonts are available on the system and also for specifying
the characteristics of a font to load.
</para>
<!-- ##### MACRO PANGO_TYPE_FONT_DESCRIPTION ##### -->
<para>
The #GObject type for #PangoFontDescription.
</para>
<!-- ##### ENUM PangoStyle ##### -->
<para>
</para>
@PANGO_STYLE_NORMAL:
@PANGO_STYLE_OBLIQUE:
@PANGO_STYLE_ITALIC:
<!-- ##### MACRO PANGO_TYPE_STYLE ##### -->
<para>
The #GObject type for #PangoStyle.
</para>
<!-- ##### ENUM PangoWeight ##### -->
<para>
An enumeration specifying the weight (boldness) of a font. This is a numerical
value ranging from 100 to 900, but there are some predefined values:
</para>
@PANGO_WEIGHT_THIN: the thin weight (= 100; Since: 1.24)
@PANGO_WEIGHT_ULTRALIGHT: the ultralight weight (= 200)
@PANGO_WEIGHT_LIGHT: the light weight (= 300)
@PANGO_WEIGHT_BOOK: the book weight (= 380; Since: 1.24)
@PANGO_WEIGHT_NORMAL: the default weight (= 400)
@PANGO_WEIGHT_MEDIUM: the normal weight (= 500; Since: 1.24)
@PANGO_WEIGHT_SEMIBOLD: the semibold weight (= 600)
@PANGO_WEIGHT_BOLD: the bold weight (= 700)
@PANGO_WEIGHT_ULTRABOLD: the ultrabold weight (= 800)
@PANGO_WEIGHT_HEAVY: the heavy weight (= 900)
@PANGO_WEIGHT_ULTRAHEAVY: the ultraheavy weight (= 1000; Since: 1.24)
<!-- ##### MACRO PANGO_TYPE_WEIGHT ##### -->
<para>
The #GObject type for #PangoWeight.
</para>
<!-- ##### ENUM PangoVariant ##### -->
<para>
An enumeration specifying capitalization variant of the font.
</para>
@PANGO_VARIANT_NORMAL: A normal font.
@PANGO_VARIANT_SMALL_CAPS: A font with the lower case characters
replaced by smaller variants of the capital characters.
<!-- ##### MACRO PANGO_TYPE_VARIANT ##### -->
<para>
The #GObject type for #PangoVariant.
</para>
<!-- ##### ENUM PangoStretch ##### -->
<para>
An enumeration specifying the width of the font relative to other designs
within a family.
</para>
@PANGO_STRETCH_ULTRA_CONDENSED: ultra condensed width
@PANGO_STRETCH_EXTRA_CONDENSED: extra condensed width
@PANGO_STRETCH_CONDENSED: condensed width
@PANGO_STRETCH_SEMI_CONDENSED: semi condensed width
@PANGO_STRETCH_NORMAL: the normal width
@PANGO_STRETCH_SEMI_EXPANDED: semi expanded width
@PANGO_STRETCH_EXPANDED: expanded width
@PANGO_STRETCH_EXTRA_EXPANDED: extra expanded width
@PANGO_STRETCH_ULTRA_EXPANDED: ultra expanded width
<!-- ##### MACRO PANGO_TYPE_STRETCH ##### -->
<para>
The #GObject type for #PangoStretch.
</para>
<!-- ##### ENUM PangoFontMask ##### -->
<para>
The bits in a #PangoFontMask correspond to fields in a
#PangoFontDescription that have been set.
</para>
@PANGO_FONT_MASK_FAMILY: the font family is specified.
@PANGO_FONT_MASK_STYLE: the font style is specified.
@PANGO_FONT_MASK_VARIANT: the font variant is specified.
@PANGO_FONT_MASK_WEIGHT: the font weight is specified.
@PANGO_FONT_MASK_STRETCH: the font stretch is specified.
@PANGO_FONT_MASK_SIZE: the font size is specified.
@PANGO_FONT_MASK_GRAVITY: the font gravity is specified (Since: 1.16.)
<!-- ##### MACRO PANGO_TYPE_FONT_MASK ##### -->
<para>
The #GObject type for #PangoFontMask.
</para>
<!-- ##### FUNCTION pango_font_description_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION pango_font_description_copy ##### -->
<para>
</para>
@desc:
@Returns:
<!-- ##### FUNCTION pango_font_description_copy_static ##### -->
<para>
</para>
@desc:
@Returns:
<!-- ##### FUNCTION pango_font_description_hash ##### -->
<para>
</para>
@desc:
@Returns:
<!-- ##### FUNCTION pango_font_description_equal ##### -->
<para>
</para>
@desc1:
@desc2:
@Returns:
<!-- ##### FUNCTION pango_font_description_free ##### -->
<para>
</para>
@desc:
<!-- ##### FUNCTION pango_font_descriptions_free ##### -->
<para>
</para>
@descs:
@n_descs:
<!-- ##### FUNCTION pango_font_description_set_family ##### -->
<para>
</para>
@desc:
@family: