[subset] fix hb_subset_input_old_to_new_gid_mapping method comment.

This commit is contained in:
Garret Rieger 2023-05-05 06:00:30 +00:00
parent 374a9a9f5e
commit d339298f37

View file

@ -521,14 +521,13 @@ hb_subset_preprocess (hb_face_t *source)
}
/**
* hb_subset_input_set_old_to_new_glyph_mapping:
* hb_subset_input_old_to_new_glyph_mapping:
* @input: a #hb_subset_input_t object.
* @mapping: a mapping from original glyphs to new ids.
*
* Returns a map which specifies an explicit mapping from old to new glyph
* Returns a map which can be used to provide an explicit mapping from old to new glyph
* id's in the produced subset. The caller should populate the map as desired.
* If this map is left empty then glyph ids will be automatically mapped to new
* values by the subsetter. If populated, the mapping must be unique, that
* values by the subsetter. If populated, the mapping must be unique. That
* is no two original glyph ids can be mapped to the same new id.
* Additionally, if a mapping is provided then the retain gids option cannot
* be enabled.
@ -542,6 +541,8 @@ hb_subset_preprocess (hb_face_t *source)
* use cases (for example ots will reject unsorted coverage tables). So it's
* recommended, if possible, to supply a monotonic mapping.
*
* Return value: (transfer none): pointer to the #hb_map_t of the custom glyphs ID map.
*
* Since: REPLACEME
**/
HB_EXTERN hb_map_t*