walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[Docs] Minor 

update GTK-Doc comments in hb-ot-layout.
This commit is contained in:
Nathan Willis 2019-04-22 19:25:42 +01:00 committed by Khaled Hosny
parent eb10ef46aa
commit 70331ca485
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/hb-ot-layout.cc
View File

@ -76,7 +76,7 @@
* Tests whether a face includes any kerning data in the 'kern' table. * Tests whether a face includes any kerning data in the 'kern' table.
* Does NOT test for kerning lookups in the GPOS table. * Does NOT test for kerning lookups in the GPOS table.
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
**/ **/
bool bool
@ -92,7 +92,7 @@ hb_ot_layout_has_kerning (hb_face_t *face)
* Tests whether a face includes any state-machine kerning in the 'kern' table. * Tests whether a face includes any state-machine kerning in the 'kern' table.
* Does NOT examine the GPOS table. * Does NOT examine the GPOS table.
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
**/ **/
bool bool
@ -112,7 +112,7 @@ hb_ot_layout_has_machine_kerning (hb_face_t *face)
* *
* Does NOT examine the GPOS table. * Does NOT examine the GPOS table.
* *
* Return value: true is data found, false otherwise * Return value: %true is data found, false otherwise
* *
**/ **/
bool bool
@ -268,7 +268,7 @@ _hb_ot_layout_set_glyph_props (hb_font_t *font,
* *
* Tests whether a face has any glyph classes defined in its GDEF table. * Tests whether a face has any glyph classes defined in its GDEF table.
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -444,7 +444,7 @@ hb_ot_layout_table_get_script_tags (hb_face_t *face,
* Fetches the index if a given script tag in the specified face's GSUB table * Fetches the index if a given script tag in the specified face's GSUB table
* or GPOS table. * or GPOS table.
* *
* Return value: true if the script is found, false otherwise * Return value: %true if the script is found, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -598,7 +598,7 @@ hb_ot_layout_table_get_feature_tags (hb_face_t *face,
* Fetches the index for a given feature tag in the specified face's GSUB table * Fetches the index for a given feature tag in the specified face's GSUB table
* or GPOS table. * or GPOS table.
* *
* Return value: true if the feature is found, false otherwise * Return value: %true if the feature is found, false otherwise
**/ **/
bool bool
hb_ot_layout_table_find_feature (hb_face_t *face, hb_ot_layout_table_find_feature (hb_face_t *face,
@ -663,7 +663,7 @@ hb_ot_layout_script_get_language_tags (hb_face_t *face,
* Fetches the index of a given language tag in the specified face's GSUB table * Fetches the index of a given language tag in the specified face's GSUB table
* or GPOS table, underneath the specified script tag. * or GPOS table, underneath the specified script tag.
* *
* Return value: true if the language tag is found, false otherwise * Return value: %true if the language tag is found, false otherwise
* *
* Since: ?? * Since: ??
* Deprecated: ?? * Deprecated: ??
@ -697,7 +697,7 @@ hb_ot_layout_script_find_language (hb_face_t *face,
* Fetches the index of a given language tag in the specified face's GSUB table * Fetches the index of a given language tag in the specified face's GSUB table
* or GPOS table, underneath the specified script index. * or GPOS table, underneath the specified script index.
* *
* Return value: true if the language tag is found, false otherwise * Return value: %true if the language tag is found, false otherwise
* *
* Since: 2.0.0 * Since: 2.0.0
**/ **/
@ -739,7 +739,7 @@ hb_ot_layout_script_select_language (hb_face_t *face,
* Fetches the index of a requested feature in the given face's GSUB or GPOS table, * Fetches the index of a requested feature in the given face's GSUB or GPOS table,
* underneath the specified script and language. * underneath the specified script and language.
* *
* Return value: true if the feature is found, false otherwise * Return value: %true if the feature is found, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -770,7 +770,7 @@ hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
* Fetches the tag of a requested feature index in the given face's GSUB or GPOS table, * Fetches the tag of a requested feature index in the given face's GSUB or GPOS table,
* underneath the specified script and language. * underneath the specified script and language.
* *
* Return value: true if the feature is found, false otherwise * Return value: %true if the feature is found, false otherwise
* *
* Since: 0.9.30 * Since: 0.9.30
**/ **/
@ -877,7 +877,7 @@ hb_ot_layout_language_get_feature_tags (hb_face_t *face,
* Fetches the index of a given feature tag in the specified face's GSUB table * Fetches the index of a given feature tag in the specified face's GSUB table
* or GPOS table, underneath the specified script and language. * or GPOS table, underneath the specified script and language.
* *
* Return value: true if the feature is found, false otherwise * Return value: %true if the feature is found, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -1196,7 +1196,7 @@ hb_ot_layout_collect_lookups (hb_face_t *face,
* @glyphs_before: (out): Array of glyphs preceding the substitution range * @glyphs_before: (out): Array of glyphs preceding the substitution range
* @glyphs_input: (out): Array of input glyphs that would be substituted by the lookup * @glyphs_input: (out): Array of input glyphs that would be substituted by the lookup
* @glyphs_after: (out): Array of glyphs following the substitution range * @glyphs_after: (out): Array of glyphs following the substitution range
* @glyphs_output: (out): Array of glyphs that would be the substitued output of the lookup * @glyphs_output: (out): Array of glyphs that would be the substituted output of the lookup
* *
* Fetches a list of all glyphs affected by the specified lookup in the * Fetches a list of all glyphs affected by the specified lookup in the
* specified face's GSUB table or GPOS table. * specified face's GSUB table or GPOS table.
@ -1245,7 +1245,7 @@ hb_ot_layout_lookup_collect_glyphs (hb_face_t *face,
* @face: #hb_face_t to work upon * @face: #hb_face_t to work upon
* @table_tag: HB_OT_TAG_GSUB or HB_OT_TAG_GPOS * @table_tag: HB_OT_TAG_GSUB or HB_OT_TAG_GPOS
* @coords: The variation coordinates to query * @coords: The variation coordinates to query
* @num_coords: The number of variation coorinates * @num_coords: The number of variation coordinates
* @variations_index: (out): The array of feature variations found for the query * @variations_index: (out): The array of feature variations found for the query
* *
* Fetches a list of feature variations in the specified face's GSUB table * Fetches a list of feature variations in the specified face's GSUB table
@ -1310,7 +1310,7 @@ hb_ot_layout_feature_with_variations_get_lookups (hb_face_t *face,
* *
* Tests whether the specified face includes any GSUB substitutions. * Tests whether the specified face includes any GSUB substitutions.
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -1331,7 +1331,7 @@ hb_ot_layout_has_substitution (hb_face_t *face)
* Tests whether a specified lookup in the specified face would * Tests whether a specified lookup in the specified face would
* trigger a substitution on the given glyph sequence. * trigger a substitution on the given glyph sequence.
* *
* Return value: true if a substitution would be triggered, false otherwise * Return value: %true if a substitution would be triggered, false otherwise
* *
* Since: 0.9.7 * Since: 0.9.7
**/ **/
@ -1488,7 +1488,7 @@ hb_ot_layout_lookups_substitute_closure (hb_face_t *face,
* hb_ot_layout_has_positioning: * hb_ot_layout_has_positioning:
* @face: #hb_face_t to work upon * @face: #hb_face_t to work upon
* *
* Return value: true if the face has GPOS data, false otherwise * Return value: %true if the face has GPOS data, false otherwise
* *
**/ **/
hb_bool_t hb_bool_t
@ -1561,7 +1561,7 @@ hb_ot_layout_position_finish_offsets (hb_font_t *font, hb_buffer_t *buffer)
* For more information on this distinction, see the [`size` feature documentation]( * For more information on this distinction, see the [`size` feature documentation](
* https://docs.microsoft.com/en-us/typography/opentype/spec/features_pt#tag-size). * https://docs.microsoft.com/en-us/typography/opentype/spec/features_pt#tag-size).
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
* Since: 0.9.10 * Since: 0.9.10
**/ **/
@ -1625,7 +1625,7 @@ hb_ot_layout_get_size_params (hb_face_t *face,
* Fetches name indices from feature parameters for "Stylistic Set" ('ssXX') or * Fetches name indices from feature parameters for "Stylistic Set" ('ssXX') or
* "Character Variant" ('cvXX') features. * "Character Variant" ('cvXX') features.
* *
* Return value: true if data found, false otherwise * Return value: %true if data found, false otherwise
* *
* Since: 2.0.0 * Since: 2.0.0
**/ **/