[MATH] Fix more docs

This commit is contained in:
Behdad Esfahbod 2016-09-27 16:51:38 +02:00
parent 46cc4a3a2a
commit c3e21a6620
2 changed files with 34 additions and 9 deletions

View File

@ -1238,7 +1238,7 @@ hb_ot_layout_substitute_lookup (OT::hb_apply_context_t *c,
* *
* Return value: #TRUE if face has a MATH table and #FALSE otherwise * Return value: #TRUE if face has a MATH table and #FALSE otherwise
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_bool_t hb_bool_t
hb_ot_math_has_data (hb_face_t *face) hb_ot_math_has_data (hb_face_t *face)
@ -1260,7 +1260,7 @@ hb_ot_math_has_data (hb_face_t *face)
* *
* Return value: the requested constant or 0 * Return value: the requested constant or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_position_t hb_position_t
hb_ot_math_get_constant (hb_font_t *font, hb_ot_math_get_constant (hb_font_t *font,
@ -1278,7 +1278,7 @@ hb_ot_math_get_constant (hb_font_t *font,
* *
* Return value: the italics correction of the glyph or 0 * Return value: the italics correction of the glyph or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_position_t hb_position_t
hb_ot_math_get_glyph_italics_correction (hb_font_t *font, hb_ot_math_get_glyph_italics_correction (hb_font_t *font,
@ -1296,7 +1296,7 @@ hb_ot_math_get_glyph_italics_correction (hb_font_t *font,
* *
* Return value: the top accent attachment of the glyph or 0 * Return value: the top accent attachment of the glyph or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_position_t hb_position_t
hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font, hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font,
@ -1314,7 +1314,7 @@ hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font,
* *
* Return value: #TRUE if the glyph is an extended shape and #FALSE otherwise * Return value: #TRUE if the glyph is an extended shape and #FALSE otherwise
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_bool_t hb_bool_t
hb_ot_math_is_glyph_extended_shape (hb_face_t *face, hb_ot_math_is_glyph_extended_shape (hb_face_t *face,
@ -1340,7 +1340,7 @@ hb_ot_math_is_glyph_extended_shape (hb_face_t *face,
* *
* Return value: requested kerning or 0 * Return value: requested kerning or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_position_t hb_position_t
hb_ot_math_get_glyph_kerning (hb_font_t *font, hb_ot_math_get_glyph_kerning (hb_font_t *font,
@ -1370,7 +1370,7 @@ hb_ot_math_get_glyph_kerning (hb_font_t *font,
* *
* Return value: the total number of size variants available or 0 * Return value: the total number of size variants available or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
unsigned int unsigned int
hb_ot_math_get_glyph_variants (hb_font_t *font, hb_ot_math_get_glyph_variants (hb_font_t *font,
@ -1400,7 +1400,7 @@ hb_ot_math_get_glyph_variants (hb_font_t *font,
* *
* Return value: requested min connector overlap or 0 * Return value: requested min connector overlap or 0
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
hb_position_t hb_position_t
hb_ot_math_get_min_connector_overlap (hb_font_t *font, hb_ot_math_get_min_connector_overlap (hb_font_t *font,
@ -1429,7 +1429,7 @@ hb_ot_math_get_min_connector_overlap (hb_font_t *font,
* *
* Return value: the total number of parts in the glyph assembly * Return value: the total number of parts in the glyph assembly
* *
* Since: 1.4 * Since: 1.4.0
**/ **/
unsigned int unsigned int
hb_ot_math_get_glyph_assembly (hb_font_t *font, hb_ot_math_get_glyph_assembly (hb_font_t *font,

View File

@ -47,6 +47,11 @@ HB_BEGIN_DECLS
/* Types */ /* Types */
/**
* hb_ot_math_constant_t:
*
* Since: 1.4.0
*/
typedef enum { typedef enum {
HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN = 0, HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN = 0,
HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN = 1, HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN = 1,
@ -106,6 +111,11 @@ typedef enum {
HB_OT_MATH_CONSTANT_RADICAL_DEGREE_BOTTOM_RAISE_PERCENT = 55 HB_OT_MATH_CONSTANT_RADICAL_DEGREE_BOTTOM_RAISE_PERCENT = 55
} hb_ot_math_constant_t; } hb_ot_math_constant_t;
/**
* hb_ot_math_kern_t:
*
* Since: 1.4.0
*/
typedef enum { typedef enum {
HB_OT_MATH_KERN_TOP_RIGHT = 0, HB_OT_MATH_KERN_TOP_RIGHT = 0,
HB_OT_MATH_KERN_TOP_LEFT = 1, HB_OT_MATH_KERN_TOP_LEFT = 1,
@ -113,15 +123,30 @@ typedef enum {
HB_OT_MATH_KERN_BOTTOM_LEFT = 3 HB_OT_MATH_KERN_BOTTOM_LEFT = 3
} hb_ot_math_kern_t; } hb_ot_math_kern_t;
/**
* hb_ot_math_glyph_variant_t:
*
* Since: 1.4.0
*/
typedef struct hb_ot_math_glyph_variant_t { typedef struct hb_ot_math_glyph_variant_t {
hb_codepoint_t glyph; hb_codepoint_t glyph;
hb_position_t advance; hb_position_t advance;
} hb_ot_math_glyph_variant_t; } hb_ot_math_glyph_variant_t;
/**
* hb_ot_math_glyph_part_flags_t:
*
* Since: 1.4.0
*/
typedef enum { /*< flags >*/ typedef enum { /*< flags >*/
HB_MATH_GLYPH_PART_FLAG_EXTENDER = 0x00000001u /* Extender glyph */ HB_MATH_GLYPH_PART_FLAG_EXTENDER = 0x00000001u /* Extender glyph */
} hb_ot_math_glyph_part_flags_t; } hb_ot_math_glyph_part_flags_t;
/**
* hb_ot_math_glyph_part_t:
*
* Since: 1.4.0
*/
typedef struct hb_ot_math_glyph_part_t { typedef struct hb_ot_math_glyph_part_t {
hb_codepoint_t glyph; hb_codepoint_t glyph;
hb_position_t start_connector_length; hb_position_t start_connector_length;