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

[docs] Update hb-common documentation

This commit is contained in:
Khaled Hosny 2020-12-24 22:23:47 +02:00
parent e8c21e003d
commit 8586f15957
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/hb-common.cc
View File

@ -524,8 +524,9 @@ hb_script_to_iso15924_tag (hb_script_t script)
* Fetches the #hb_direction_t of a script when it is * Fetches the #hb_direction_t of a script when it is
* set horizontally. All right-to-left scripts will return * set horizontally. All right-to-left scripts will return
* #HB_DIRECTION_RTL. All left-to-right scripts will return * #HB_DIRECTION_RTL. All left-to-right scripts will return
* #HB_DIRECTION_LTR. Scripts that cannot be written * #HB_DIRECTION_LTR. Scripts that can be written either
* horizontally will return #HB_DIRECTION_INVALID. * horizontally or vertically will return #HB_DIRECTION_INVALID.
* Unknown scripts will return #HB_DIRECTION_LTR.
* *
* Return value: The horizontal #hb_direction_t of @script * Return value: The horizontal #hb_direction_t of @script
* *

16
src/hb-common.h
View File

@ -136,8 +136,8 @@ typedef union _hb_var_int_t {
/** /**
* hb_tag_t: * hb_tag_t:
* *
* Data type for tag identifiers. Tags are arrays of four * Data type for tag identifiers. Tags are four
* bytes, each of which holds a character. * byte integers, each byte representing a character.
* *
* Tags are used to identify tables, design-variation axes, * Tags are used to identify tables, design-variation axes,
* scripts, languages, font features, and baselines with * scripts, languages, font features, and baselines with
@ -236,8 +236,8 @@ hb_direction_to_string (hb_direction_t direction);
* HB_DIRECTION_IS_FORWARD: * HB_DIRECTION_IS_FORWARD:
* @dir: #hb_direction_t to test * @dir: #hb_direction_t to test
* *
* Tests whether a text direction is forward. Requires * Tests whether a text direction moves forward (from left to right, or from
* that the direction be valid. * top to bottom). Requires that the direction be valid.
* *
**/ **/
#define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4) #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4)
@ -245,8 +245,8 @@ hb_direction_to_string (hb_direction_t direction);
* HB_DIRECTION_IS_BACKWARD: * HB_DIRECTION_IS_BACKWARD:
* @dir: #hb_direction_t to test * @dir: #hb_direction_t to test
* *
* Tests whether a text direction is backward. Requires * Tests whether a text direction moves backward (from right to left, or from
* that the direction be valid. * bottom to top). Requires that the direction be valid.
* *
**/ **/
#define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5) #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5)
@ -433,11 +433,9 @@ hb_language_get_default (void);
* @HB_SCRIPT_NYIAKENG_PUACHUE_HMONG * @HB_SCRIPT_NYIAKENG_PUACHUE_HMONG
* @HB_SCRIPT_WANCHO * @HB_SCRIPT_WANCHO
* @HB_SCRIPT_INVALID: #HB_TAG_NONE * @HB_SCRIPT_INVALID: #HB_TAG_NONE
* @_HB_SCRIPT_MAX_VALUE: Dummy value
* @_HB_SCRIPT_MAX_VALUE_SIGNED: Dummy value
* *
* Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding * Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding
* to the four-letter values defined at https://unicode.org/iso15924/ . * to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/).
* *
* See also the Script (sc) property of the Unicode Character Database. * See also the Script (sc) property of the Unicode Character Database.
* *