docs: Improve docs for some apis

Various functions take hb_tag_t arrays. Those
arrays are expected to be 0-terminated. Document
that.
This commit is contained in:
Matthias Clasen 2022-08-31 15:03:09 -04:00 committed by Behdad Esfahbod
parent c96bfca380
commit 29d5c7f67a
1 changed files with 12 additions and 6 deletions

View File

@ -1186,9 +1186,12 @@ script_collect_features (hb_collect_features_context_t *c,
* hb_ot_layout_collect_features: * hb_ot_layout_collect_features:
* @face: #hb_face_t to work upon * @face: #hb_face_t to work upon
* @table_tag: #HB_OT_TAG_GSUB or #HB_OT_TAG_GPOS * @table_tag: #HB_OT_TAG_GSUB or #HB_OT_TAG_GPOS
* @scripts: The array of scripts to collect features for * @scripts: (nullable): The array of scripts to collect features for,
* @languages: The array of languages to collect features for * terminated by %HB_TAG_NONE
* @features: The array of features to collect * @languages: (nullable): The array of languages to collect features for,
* terminated by %HB_TAG_NONE
* @features: (nullable): The array of features to collect,
* terminated by %HB_TAG_NONE
* @feature_indexes: (out): The array of feature indexes found for the query * @feature_indexes: (out): The array of feature indexes found for the query
* *
* Fetches a list of all feature indexes in the specified face's GSUB table * Fetches a list of all feature indexes in the specified face's GSUB table
@ -1235,9 +1238,12 @@ hb_ot_layout_collect_features (hb_face_t *face,
* hb_ot_layout_collect_lookups: * hb_ot_layout_collect_lookups:
* @face: #hb_face_t to work upon * @face: #hb_face_t to work upon
* @table_tag: #HB_OT_TAG_GSUB or #HB_OT_TAG_GPOS * @table_tag: #HB_OT_TAG_GSUB or #HB_OT_TAG_GPOS
* @scripts: The array of scripts to collect lookups for * @scripts: (nullable): The array of scripts to collect lookups for,
* @languages: The array of languages to collect lookups for * terminated by %HB_TAG_NONE
* @features: The array of features to collect lookups for * @languages: (nullable): The array of languages to collect lookups for,
* terminated by %HB_TAG_NONE
* @features: (nullable): The array of features to collect lookups for,
* terminated by %HB_TAG_NONE
* @lookup_indexes: (out): The array of lookup indexes found for the query * @lookup_indexes: (out): The array of lookup indexes found for the query
* *
* Fetches a list of all feature-lookup indexes in the specified face's GSUB * Fetches a list of all feature-lookup indexes in the specified face's GSUB