[docs] Miscellaneous missing docs

This commit is contained in:
Khaled Hosny 2020-12-30 23:58:37 +02:00 committed by Behdad Esfahbod
parent a31a51cdec
commit 3d7a361648
12 changed files with 62 additions and 21 deletions

View File

@ -145,7 +145,6 @@ hb_position_t
hb_tag_t hb_tag_t
hb_script_t hb_script_t
hb_user_data_key_t hb_user_data_key_t
hb_var_int_t
HB_TAG HB_TAG
HB_TAG_NONE HB_TAG_NONE
HB_TAG_MAX HB_TAG_MAX
@ -163,6 +162,7 @@ HB_FEATURE_GLOBAL_START
<SUBSECTION Private> <SUBSECTION Private>
HB_BEGIN_DECLS HB_BEGIN_DECLS
HB_END_DECLS HB_END_DECLS
hb_var_int_t
int16_t int16_t
int32_t int32_t
int64_t int64_t
@ -573,7 +573,6 @@ hb_ot_layout_get_glyphs_in_class
hb_ot_layout_get_ligature_carets hb_ot_layout_get_ligature_carets
hb_ot_layout_get_size_params hb_ot_layout_get_size_params
hb_ot_layout_glyph_class_t hb_ot_layout_glyph_class_t
hb_ot_layout_glyph_sequence_func_t
hb_ot_layout_has_glyph_classes hb_ot_layout_has_glyph_classes
hb_ot_layout_has_positioning hb_ot_layout_has_positioning
hb_ot_layout_has_substitution hb_ot_layout_has_substitution

View File

@ -38,10 +38,10 @@ HB_BEGIN_DECLS
/** /**
* hb_memory_mode_t: * hb_memory_mode_t:
* @HB_MEMORY_MODE_DUPLICATE * @HB_MEMORY_MODE_DUPLICATE: HarfBuzz immediately makes a copy of the data.
* @HB_MEMORY_MODE_READONLY * @HB_MEMORY_MODE_READONLY: HarfBuzz client will never modify the data
* @HB_MEMORY_MODE_WRITABLE * @HB_MEMORY_MODE_WRITABLE: HarfBuzz client made a copy of the data solely for HarfBuzz.
* @HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE * @HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE: See above
* *
* Data type holding the memory modes available to * Data type holding the memory modes available to
* client programs. * client programs.

View File

@ -402,7 +402,7 @@ hb_coretext_font_create (CTFontRef ct_font)
} }
/** /**
* hb_coretext_face_get_ct_font: * hb_coretext_font_get_ct_font:
* @font: #hb_font_t to work upon * @font: #hb_font_t to work upon
* *
* Fetches the CTFontRef associated with the specified * Fetches the CTFontRef associated with the specified

View File

@ -957,6 +957,8 @@ _hb_directwrite_font_release (void *data)
* hb_directwrite_face_create: * hb_directwrite_face_create:
* @font_face: a DirectWrite IDWriteFontFace object. * @font_face: a DirectWrite IDWriteFontFace object.
* *
* Constructs a new face object from the specified DirectWrite IDWriteFontFace.
*
* Return value: #hb_face_t object corresponding to the given input * Return value: #hb_face_t object corresponding to the given input
* *
* Since: 2.4.0 * Since: 2.4.0
@ -974,6 +976,8 @@ hb_directwrite_face_create (IDWriteFontFace *font_face)
* hb_directwrite_face_get_font_face: * hb_directwrite_face_get_font_face:
* @face: a #hb_face_t object * @face: a #hb_face_t object
* *
* Gets the DirectWrite IDWriteFontFace associated with @face.
*
* Return value: DirectWrite IDWriteFontFace object corresponding to the given input * Return value: DirectWrite IDWriteFontFace object corresponding to the given input
* *
* Since: 2.5.0 * Since: 2.5.0

View File

@ -235,7 +235,7 @@ hb_face_create (hb_blob_t *blob,
* *
* Fetches the singleton empty face object. * Fetches the singleton empty face object.
* *
* Return value: (transfer full) The empty face object * Return value: (transfer full): The empty face object
* *
* Since: 0.9.2 * Since: 0.9.2
**/ **/

View File

@ -58,6 +58,19 @@ HB_EXTERN hb_face_t *
hb_face_create (hb_blob_t *blob, hb_face_create (hb_blob_t *blob,
unsigned int index); unsigned int index);
/**
* hb_reference_table_func_t:
* @face: an #hb_face_t to reference table for
* @tag: the tag of the table to reference
* @user_data: User data pointer passed by the caller
*
* Callback function for hb_face_create_for_tables().
*
* Return value: (transfer full): A pointer to the @tag table within @face
*
* Since: 0.9.2
*/
typedef hb_blob_t * (*hb_reference_table_func_t) (hb_face_t *face, hb_tag_t tag, void *user_data); typedef hb_blob_t * (*hb_reference_table_func_t) (hb_face_t *face, hb_tag_t tag, void *user_data);
/* calls destroy() when not needing user_data anymore */ /* calls destroy() when not needing user_data anymore */

View File

@ -70,6 +70,8 @@ fail:
* hb_gdi_face_create: * hb_gdi_face_create:
* @hfont: a HFONT object. * @hfont: a HFONT object.
* *
* Constructs a new face object from the specified GDI HFONT.
*
* Return value: #hb_face_t object corresponding to the given input * Return value: #hb_face_t object corresponding to the given input
* *
* Since: 2.6.0 * Since: 2.6.0

View File

@ -36,7 +36,11 @@
HB_BEGIN_DECLS HB_BEGIN_DECLS
/* /**
* HB_MAP_VALUE_INVALID:
*
* Unset #hb_map_t value.
*
* Since: 1.7.7 * Since: 1.7.7
*/ */
#define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1) #define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1)

View File

@ -85,6 +85,13 @@ hb_ot_tag_from_language (hb_language_t language);
/** /**
* hb_ot_var_axis_t: * hb_ot_var_axis_t:
* @tag: axis tag
* @name_id: axis name identifier
* @min_value: minimum value of the axis
* @default_value: default value of the axis
* @max_value: maximum value of the axis
*
* Use #hb_ot_var_axis_info_t instead.
* *
* Since: 1.4.2 * Since: 1.4.2
* Deprecated: 2.2.0 * Deprecated: 2.2.0

View File

@ -41,9 +41,11 @@
* hb_ot_meta_get_entry_tags: * hb_ot_meta_get_entry_tags:
* @face: a face object * @face: a face object
* @start_offset: iteration's start offset * @start_offset: iteration's start offset
* @entries_count:(inout) (allow-none): buffer size as input, filled size as output * @entries_count:(inout) (optional): buffer size as input, filled size as output
* @entries: (out caller-allocates) (array length=entries_count): entries tags buffer * @entries: (out caller-allocates) (array length=entries_count): entries tags buffer
* *
* Fetches all available feature types.
*
* Return value: Number of all available feature types. * Return value: Number of all available feature types.
* *
* Since: 2.6.0 * Since: 2.6.0

View File

@ -36,34 +36,38 @@
HB_BEGIN_DECLS HB_BEGIN_DECLS
/** /**
* hb_tag_t: * HB_OT_TAG_VAR_AXIS_ITALIC:
* @HB_OT_TAG_VAR_AXIS_ITALIC: Registered tag for the roman/italic axis *
* Registered tag for the roman/italic axis.
*/ */
#define HB_OT_TAG_VAR_AXIS_ITALIC HB_TAG('i','t','a','l') #define HB_OT_TAG_VAR_AXIS_ITALIC HB_TAG('i','t','a','l')
/** /**
* hb_tag_t: * HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE:
* @HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE: Registered tag for the optical-size axis
* *
* Registered tag for the optical-size axis.
* <note>Note: The optical-size axis supersedes the OpenType `size` feature.</note> * <note>Note: The optical-size axis supersedes the OpenType `size` feature.</note>
*/ */
#define HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE HB_TAG('o','p','s','z') #define HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE HB_TAG('o','p','s','z')
/** /**
* hb_tag_t: * HB_OT_TAG_VAR_AXIS_SLANT:
* @HB_OT_TAG_VAR_AXIS_SLANT: Registered tag for the slant axis *
* Registered tag for the slant axis
*/ */
#define HB_OT_TAG_VAR_AXIS_SLANT HB_TAG('s','l','n','t') #define HB_OT_TAG_VAR_AXIS_SLANT HB_TAG('s','l','n','t')
/** /**
* hb_tag_t: * HB_OT_TAG_VAR_AXIS_WIDTH:
* @HB_OT_TAG_VAR_AXIS_WIDTH: Registered tag for the width axis *
* Registered tag for the width axis.
*/ */
#define HB_OT_TAG_VAR_AXIS_WIDTH HB_TAG('w','d','t','h') #define HB_OT_TAG_VAR_AXIS_WIDTH HB_TAG('w','d','t','h')
/** /**
* hb_tag_t: * HB_OT_TAG_VAR_AXIS_WEIGHT:
* @HB_OT_TAG_VAR_AXIS_WEIGHT: Registered tag for the weight axis *
* Registered tag for the weight axis.
*/ */
#define HB_OT_TAG_VAR_AXIS_WEIGHT HB_TAG('w','g','h','t') #define HB_OT_TAG_VAR_AXIS_WEIGHT HB_TAG('w','g','h','t')
@ -88,6 +92,8 @@ hb_ot_var_get_axis_count (hb_face_t *face);
* hb_ot_var_axis_flags_t: * hb_ot_var_axis_flags_t:
* @HB_OT_VAR_AXIS_FLAG_HIDDEN: The axis should not be exposed directly in user interfaces. * @HB_OT_VAR_AXIS_FLAG_HIDDEN: The axis should not be exposed directly in user interfaces.
* *
* Flags for #hb_ot_var_axis_info_t.
*
* Since: 2.2.0 * Since: 2.2.0
*/ */
typedef enum { /*< flags >*/ typedef enum { /*< flags >*/

View File

@ -36,7 +36,11 @@
HB_BEGIN_DECLS HB_BEGIN_DECLS
/* /**
* HB_SET_VALUE_INVALID:
*
* Unset #hb_set_t value.
*
* Since: 0.9.21 * Since: 0.9.21
*/ */
#define HB_SET_VALUE_INVALID ((hb_codepoint_t) -1) #define HB_SET_VALUE_INVALID ((hb_codepoint_t) -1)