[subset] document return values.

This commit is contained in:
Garret Rieger 2022-02-17 17:16:31 -08:00
parent 27a6c895ba
commit fc1548cf71
2 changed files with 8 additions and 4 deletions

View File

@ -607,7 +607,8 @@ hb_subset_plan_destroy (hb_subset_plan_t *plan)
* hb_subset_plan_old_to_new_glyph_mapping:
* @plan: a subsetting plan.
*
* Returns the mapping between glyphs in the original font to glyphs
* Return value:
* the mapping between glyphs in the original font to glyphs
* in the subset that will be produced by @plan.
*
* Since: REPLACEME

View File

@ -355,11 +355,14 @@ hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input)
/**
* hb_subset_from_plan_or_fail:
* hb_subset_plan_execute_or_fail:
* @plan: a subsetting plan.
*
* Subsets a font according to provided plan. Returns nullptr
* if the subset operation fails.
* Executes the provided subsetting @plan.
*
* Return value:
* on success returns a reference to generated font subset. If the subsetting operation fails
* returns nullptr.
*
* Since: REPLACEME
**/