[subset] fix up hb_subset_preprocess api comment.

This commit is contained in:
Garret Rieger 2022-12-08 22:48:27 +00:00
parent 13b0388351
commit 27201ed32b
3 changed files with 7 additions and 5 deletions

View File

@ -783,6 +783,7 @@ hb_subset_plan_execute_or_fail
hb_subset_plan_unicode_to_old_glyph_mapping hb_subset_plan_unicode_to_old_glyph_mapping
hb_subset_plan_new_to_old_glyph_mapping hb_subset_plan_new_to_old_glyph_mapping
hb_subset_plan_old_to_new_glyph_mapping hb_subset_plan_old_to_new_glyph_mapping
hb_subset_preprocess
hb_subset_flags_t hb_subset_flags_t
hb_subset_input_t hb_subset_input_t
hb_subset_sets_t hb_subset_sets_t
@ -791,7 +792,6 @@ hb_subset_plan_t
hb_link_t hb_link_t
hb_object_t hb_object_t
hb_subset_repack_or_fail hb_subset_repack_or_fail
hb_subset_preprocess
hb_subset_input_pin_axis_location hb_subset_input_pin_axis_location
hb_subset_input_pin_axis_to_default hb_subset_input_pin_axis_to_default
hb_subset_input_override_name_table hb_subset_input_override_name_table

View File

@ -21,7 +21,7 @@ hb_face_t* subset = hb_subset_or_fail (preprocessed, subset_input);
original face. The preprocessor does not change the functionality of the subsetter, just speeds original face. The preprocessor does not change the functionality of the subsetter, just speeds
things up. things up.
* The preprocessing operation may take longer then the time it takes to produce a subset from the * The preprocessing operation may take longer than the time it takes to produce a subset from the
source font. Thus the main performance gains are made when a preprocessed face is reused for source font. Thus the main performance gains are made when a preprocessed face is reused for
multiple subsetting operations. multiple subsetting operations.

View File

@ -449,12 +449,12 @@ hb_subset_input_pin_axis_location (hb_subset_input_t *input,
#endif #endif
/** /**
* hb_subset_preprocess * hb_subset_preprocess:
* @input: a #hb_face_t object. * @source: a #hb_face_t object.
* *
* Preprocesses the face and attaches data that will be needed by the * Preprocesses the face and attaches data that will be needed by the
* subsetter. Future subsetting operations can then use the precomputed data * subsetter. Future subsetting operations can then use the precomputed data
* to speed up the subsetting operation. Returns a new hb_face_t*. * to speed up the subsetting operation.
* *
* See docs/subset-preprocessing.md for more information. * See docs/subset-preprocessing.md for more information.
* *
@ -463,6 +463,8 @@ hb_subset_input_pin_axis_location (hb_subset_input_t *input,
* owned by the source face you will need to ensure that memory lives * owned by the source face you will need to ensure that memory lives
* as long as the returned hb_face_t*. * as long as the returned hb_face_t*.
* *
* Returns: a new hb_face_t*.
*
* Since: REPLACEME * Since: REPLACEME
**/ **/