From 1b5a2e0809b2f90fea891cbd7e6e2caee1dcb01f Mon Sep 17 00:00:00 2001 From: Khaled Hosny Date: Fri, 25 Feb 2022 04:22:33 +0200 Subject: [PATCH] [doc] Various fixes to newly added documentation --- docs/harfbuzz-docs.xml | 1 - docs/harfbuzz-sections.txt | 10 ++++++++++ src/hb-buffer.h | 1 + src/hb-subset-plan.cc | 18 +++++++++++++----- 4 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/harfbuzz-docs.xml b/docs/harfbuzz-docs.xml index 7d3fb108f..75c5e049a 100644 --- a/docs/harfbuzz-docs.xml +++ b/docs/harfbuzz-docs.xml @@ -141,7 +141,6 @@ Index of new symbols in 1.8.1 Index of new symbols in 1.8.0 Index of new symbols in 1.7.7 - Index of new symbols in 1.7.5 Index of new symbols in 1.7.2 Index of new symbols in 1.6.0 Index of new symbols in 1.5.0 diff --git a/docs/harfbuzz-sections.txt b/docs/harfbuzz-sections.txt index 82f1b318d..a6760c102 100644 --- a/docs/harfbuzz-sections.txt +++ b/docs/harfbuzz-sections.txt @@ -756,6 +756,7 @@ hb_style_get_value hb_subset_flags_t hb_subset_input_t hb_subset_sets_t +hb_subset_plan_t hb_subset_input_create_or_fail hb_subset_input_reference hb_subset_input_destroy @@ -766,5 +767,14 @@ hb_subset_input_set_flags hb_subset_input_unicode_set hb_subset_input_glyph_set hb_subset_input_set +hb_subset_plan_create_or_fail +hb_subset_plan_reference +hb_subset_plan_destroy +hb_subset_plan_set_user_data +hb_subset_plan_get_user_data +hb_subset_plan_execute_or_fail +hb_subset_plan_codepoint_to_old_glyph_mapping +hb_subset_plan_new_to_old_glyph_mapping +hb_subset_plan_old_to_new_glyph_mapping hb_subset_or_fail diff --git a/src/hb-buffer.h b/src/hb-buffer.h index cad45979e..8e73a090e 100644 --- a/src/hb-buffer.h +++ b/src/hb-buffer.h @@ -373,6 +373,7 @@ hb_buffer_guess_segment_properties (hb_buffer_t *buffer); * flag indicating that the @HB_GLYPH_FLAG_UNSAFE_TO_CONCAT * glyph-flag should be produced by the shaper. By default * it will not be produced since it incurs a cost. Since: REPLACEME + * * Flags for #hb_buffer_t. * * Since: 0.9.20 diff --git a/src/hb-subset-plan.cc b/src/hb-subset-plan.cc index fc1e4db51..1c5d45a02 100644 --- a/src/hb-subset-plan.cc +++ b/src/hb-subset-plan.cc @@ -607,9 +607,11 @@ hb_subset_plan_destroy (hb_subset_plan_t *plan) * hb_subset_plan_old_to_new_glyph_mapping: * @plan: a subsetting plan. * - * Return value: - * the mapping between glyphs in the original font to glyphs - * in the subset that will be produced by @plan. + * Returns the mapping between glyphs in the original font to glyphs in the + * subset that will be produced by @plan + * + * Return value: (transfer none): + * A pointer to the #hb_map_t of the mapping. * * Since: REPLACEME **/ @@ -620,12 +622,15 @@ hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t *plan) } /** - * hb_subset_plan_old_to_new_glyph_mapping: + * hb_subset_plan_new_to_old_glyph_mapping: * @plan: a subsetting plan. * * Returns the mapping between glyphs in the subset that will be produced by * @plan and the glyph in the original font. * + * Return value: (transfer none): + * A pointer to the #hb_map_t of the mapping. + * * Since: REPLACEME **/ const hb_map_t* @@ -635,12 +640,15 @@ hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t *plan) } /** - * hb_subset_plan_old_to_new_glyph_mapping: + * hb_subset_plan_codepoint_to_old_glyph_mapping: * @plan: a subsetting plan. * * Returns the mapping between codepoints in the original font and the * associated glyph id in the original font. * + * Return value: (transfer none): + * A pointer to the #hb_map_t of the mapping. + * * Since: REPLACEME **/ const hb_map_t*