diff options
Diffstat (limited to 'pango/pango-glyph-item.c')
| -rw-r--r-- | pango/pango-glyph-item.c | 80 |
1 files changed, 39 insertions, 41 deletions
diff --git a/pango/pango-glyph-item.c b/pango/pango-glyph-item.c index 08bb8762..cbda8f09 100644 --- a/pango/pango-glyph-item.c +++ b/pango/pango-glyph-item.c @@ -32,27 +32,27 @@ * pango_glyph_item_split: * @orig: a `PangoItem` * @text: text to which positions in @orig apply - * @split_index: byte index of position to split item, relative to the start of the item + * @split_index: byte index of position to split item, relative to the + * start of the item * * Modifies @orig to cover only the text after @split_index, and * returns a new item that covers the text before @split_index that * used to be in @orig. * - * You can think of @split_index as the length of - * the returned item. @split_index may not be 0, and it may not be - * greater than or equal to the length of @orig (that is, there must - * be at least one byte assigned to each item, you can't create a - * zero-length item). + * You can think of @split_index as the length of the returned item. + * @split_index may not be 0, and it may not be greater than or equal + * to the length of @orig (that is, there must be at least one byte + * assigned to each item, you can't create a zero-length item). * * This function is similar in function to pango_item_split() (and uses * it internally.) * * Return value: the newly allocated item representing text before - * @split_index, which should be freed - * with pango_glyph_item_free(). + * @split_index, which should be freed + * with pango_glyph_item_free(). * * Since: 1.2 - **/ + */ PangoGlyphItem * pango_glyph_item_split (PangoGlyphItem *orig, const char *text, @@ -134,16 +134,16 @@ pango_glyph_item_split (PangoGlyphItem *orig, /** * pango_glyph_item_copy: - * @orig: (nullable): a `PangoGlyphItem`, may be %NULL + * @orig: (nullable): a `PangoGlyphItem` * * Make a deep copy of an existing `PangoGlyphItem` structure. * - * Return value: (nullable): the newly allocated `PangoGlyphItem`, which should - * be freed with pango_glyph_item_free(), or %NULL - * if @orig was %NULL. + * Return value: (nullable): the newly allocated `PangoGlyphItem`, + * which should be freed with pango_glyph_item_free(), or %NULL + * if @orig was %NULL. * * Since: 1.20 - **/ + */ PangoGlyphItem * pango_glyph_item_copy (PangoGlyphItem *orig) { @@ -162,12 +162,12 @@ pango_glyph_item_copy (PangoGlyphItem *orig) /** * pango_glyph_item_free: - * @glyph_item: (nullable): a `PangoGlyphItem`, may be %NULL + * @glyph_item: (nullable): a `PangoGlyphItem` * * Frees a `PangoGlyphItem` and resources to which it points. * * Since: 1.6 - **/ + */ void pango_glyph_item_free (PangoGlyphItem *glyph_item) { @@ -189,7 +189,7 @@ G_DEFINE_BOXED_TYPE (PangoGlyphItem, pango_glyph_item, /** * pango_glyph_item_iter_copy: - * @orig: (nullable): a `PangoGlyphItem`Iter, may be %NULL + * @orig: (nullable): a `PangoGlyphItem`Iter * * Make a shallow copy of an existing `PangoGlyphItemIter` structure. * @@ -198,7 +198,7 @@ G_DEFINE_BOXED_TYPE (PangoGlyphItem, pango_glyph_item, * if @orig was %NULL. * * Since: 1.22 - **/ + */ PangoGlyphItemIter * pango_glyph_item_iter_copy (PangoGlyphItemIter *orig) { @@ -216,12 +216,12 @@ pango_glyph_item_iter_copy (PangoGlyphItemIter *orig) /** * pango_glyph_item_iter_free: - * @iter: (nullable): a `PangoGlyphItemIter`, may be %NULL + * @iter: (nullable): a `PangoGlyphItemIter` * * Frees a `PangoGlyphItem`Iter. * * Since: 1.22 - **/ + */ void pango_glyph_item_iter_free (PangoGlyphItemIter *iter) { @@ -247,7 +247,7 @@ G_DEFINE_BOXED_TYPE (PangoGlyphItemIter, pango_glyph_item_iter, * %FALSE if we were already on the last cluster. * * Since: 1.22 - **/ + */ gboolean pango_glyph_item_iter_next_cluster (PangoGlyphItemIter *iter) { @@ -337,7 +337,7 @@ pango_glyph_item_iter_next_cluster (PangoGlyphItemIter *iter) * %FALSE if we were already on the first cluster. * * Since: 1.22 - **/ + */ gboolean pango_glyph_item_iter_prev_cluster (PangoGlyphItemIter *iter) { @@ -433,7 +433,7 @@ pango_glyph_item_iter_prev_cluster (PangoGlyphItemIter *iter) * Return value: %FALSE if there are no clusters in the glyph item * * Since: 1.22 - **/ + */ gboolean pango_glyph_item_iter_init_start (PangoGlyphItemIter *iter, PangoGlyphItem *glyph_item, @@ -472,7 +472,7 @@ pango_glyph_item_iter_init_start (PangoGlyphItemIter *iter, * Return value: %FALSE if there are no clusters in the glyph item * * Since: 1.22 - **/ + */ gboolean pango_glyph_item_iter_init_end (PangoGlyphItemIter *iter, PangoGlyphItem *glyph_item, @@ -514,7 +514,7 @@ append_attrs (PangoGlyphItem *glyph_item, g_slist_concat (glyph_item->item->analysis.extra_attrs, attrs); } -/* Make a deep copy of a #GSList of PangoAttribute +/* Make a deep copy of a GSList of PangoAttribute */ static GSList * attr_slist_copy (GSList *attrs) @@ -564,11 +564,10 @@ split_before_cluster_start (ApplyAttrsState *state) * Splits a shaped item (`PangoGlyphItem`) into multiple items based * on an attribute list. * - * The idea is that if you have attributes - * that don't affect shaping, such as color or underline, to avoid - * affecting shaping, you filter them out ([method@Pango.AttrList.filter]), - * apply the shaping process and then reapply them to the result using - * this function. + * The idea is that if you have attributes that don't affect shaping, + * such as color or underline, to avoid affecting shaping, you filter + * them out ([method@Pango.AttrList.filter]), apply the shaping process + * and then reapply them to the result using this function. * * All attributes that start or end inside a cluster are applied * to that cluster; for instance, if half of a cluster is underlined @@ -586,7 +585,7 @@ split_before_cluster_start (ApplyAttrsState *state) * g_slist_free(). * * Since: 1.2 - **/ + */ GSList * pango_glyph_item_apply_attrs (PangoGlyphItem *glyph_item, const char *text, @@ -721,7 +720,7 @@ pango_glyph_item_apply_attrs (PangoGlyphItem *glyph_item, * @glyph_item: a `PangoGlyphItem` * @text: text that @glyph_item corresponds to * (glyph_item->item->offset is an offset from the - * start of @text) + * start of @text) * @log_attrs: (array): logical attributes for the item * (the first logical attribute refers to the position * before the first character in the item) @@ -803,22 +802,21 @@ pango_glyph_item_letter_space (PangoGlyphItem *glyph_item, * @glyph_item: a `PangoGlyphItem` * @text: text that @glyph_item corresponds to * (glyph_item->item->offset is an offset from the - * start of @text) + * start of @text) * @logical_widths: (array): an array whose length is the number of - * characters in glyph_item (equal to - * glyph_item->item->num_chars) to be filled in with - * the resulting character widths. + * characters in glyph_item (equal to glyph_item->item->num_chars) + * to be filled in with the resulting character widths. * - * Given a `PangoGlyphItem` and the corresponding text, determine the width - * corresponding to each character. + * Given a `PangoGlyphItem` and the corresponding text, determine the + * width corresponding to each character. * - * When multiple characters compose a single cluster, the width of the entire - * cluster is divided equally among the characters. + * When multiple characters compose a single cluster, the width of the + * entire cluster is divided equally among the characters. * * See also [method@Pango.GlyphString.get_logical_widths]. * * Since: 1.26 - **/ + */ void pango_glyph_item_get_logical_widths (PangoGlyphItem *glyph_item, const char *text, |