diff options
Diffstat (limited to 'pango/pango-ot-buffer.c')
| -rw-r--r-- | pango/pango-ot-buffer.c | 95 |
1 files changed, 51 insertions, 44 deletions
diff --git a/pango/pango-ot-buffer.c b/pango/pango-ot-buffer.c index bec4365a..c48edae2 100644 --- a/pango/pango-ot-buffer.c +++ b/pango/pango-ot-buffer.c @@ -38,16 +38,16 @@ G_DEFINE_BOXED_TYPE (PangoOTBuffer, pango_ot_buffer, pango_ot_buffer_destroy) /** - * pango_ot_buffer_new - * @font: a #PangoFcFont + * pango_ot_buffer_new: + * @font: a `PangoFcFont` * - * Creates a new #PangoOTBuffer for the given OpenType font. + * Creates a new `PangoOTBuffer` for the given OpenType font. * - * Return value: the newly allocated #PangoOTBuffer, which should - * be freed with pango_ot_buffer_destroy(). + * Return value: the newly allocated `PangoOTBuffer`, which should + * be freed with [method@PangoOT.Buffer.destroy]. * * Since: 1.4 - **/ + */ PangoOTBuffer * pango_ot_buffer_new (PangoFcFont *font) { @@ -59,13 +59,13 @@ pango_ot_buffer_new (PangoFcFont *font) } /** - * pango_ot_buffer_destroy - * @buffer: a #PangoOTBuffer + * pango_ot_buffer_destroy: + * @buffer: a `PangoOTBuffer` * - * Destroys a #PangoOTBuffer and free all associated memory. + * Destroys a `PangoOTBuffer` and free all associated memory. * * Since: 1.4 - **/ + */ void pango_ot_buffer_destroy (PangoOTBuffer *buffer) { @@ -74,13 +74,13 @@ pango_ot_buffer_destroy (PangoOTBuffer *buffer) } /** - * pango_ot_buffer_clear - * @buffer: a #PangoOTBuffer + * pango_ot_buffer_clear: + * @buffer: a `PangoOTBuffer` * - * Empties a #PangoOTBuffer, make it ready to add glyphs to. + * Empties a `PangoOTBuffer`, make it ready to add glyphs to. * * Since: 1.4 - **/ + */ void pango_ot_buffer_clear (PangoOTBuffer *buffer) { @@ -88,17 +88,19 @@ pango_ot_buffer_clear (PangoOTBuffer *buffer) } /** - * pango_ot_buffer_add_glyph - * @buffer: a #PangoOTBuffer - * @glyph: the glyph index to add, like a #PangoGlyph + * pango_ot_buffer_add_glyph: + * @buffer: a `PangoOTBuffer` + * @glyph: the glyph index to add, like a `PangoGlyph` * @properties: the glyph properties * @cluster: the cluster that this glyph belongs to * - * Appends a glyph to a #PangoOTBuffer, with @properties identifying which - * features should be applied on this glyph. See pango_ot_ruleset_add_feature(). + * Appends a glyph to a `PangoOTBuffer`, with @properties identifying which + * features should be applied on this glyph. + * + * See [method@PangoOT.Ruleset.add_feature]. * * Since: 1.4 - **/ + */ void pango_ot_buffer_add_glyph (PangoOTBuffer *buffer, guint glyph, @@ -109,15 +111,17 @@ pango_ot_buffer_add_glyph (PangoOTBuffer *buffer, } /** - * pango_ot_buffer_set_rtl - * @buffer: a #PangoOTBuffer + * pango_ot_buffer_set_rtl: + * @buffer: a `PangoOTBuffer` * @rtl: %TRUE for right-to-left text * - * Sets whether glyphs will be rendered right-to-left. This setting - * is needed for proper horizontal positioning of right-to-left scripts. + * Sets whether glyphs will be rendered right-to-left. + * + * This setting is needed for proper horizontal positioning + * of right-to-left scripts. * * Since: 1.4 - **/ + */ void pango_ot_buffer_set_rtl (PangoOTBuffer *buffer, gboolean rtl) @@ -127,37 +131,38 @@ pango_ot_buffer_set_rtl (PangoOTBuffer *buffer, /** * pango_ot_buffer_set_zero_width_marks - * @buffer: a #PangoOTBuffer + * @buffer: a `PangoOTBuffer` * @zero_width_marks: %TRUE if characters with a mark class should - * be forced to zero width. + * be forced to zero width * * Sets whether characters with a mark class should be forced to zero width. + * * This setting is needed for proper positioning of Arabic accents, * but will produce incorrect results with standard OpenType Indic * fonts. * * Since: 1.6 - **/ + */ void -pango_ot_buffer_set_zero_width_marks (PangoOTBuffer *buffer, - gboolean zero_width_marks) +pango_ot_buffer_set_zero_width_marks (PangoOTBuffer *buffer, + gboolean zero_width_marks) { } /** * pango_ot_buffer_get_glyphs - * @buffer: a #PangoOTBuffer + * @buffer: a `PangoOTBuffer` * @glyphs: (array length=n_glyphs) (out) (optional): location to - * store the array of glyphs, or %NULL - * @n_glyphs: (out) (optional): location to store the number of - * glyphs, or %NULL + * store the array of glyphs + * @n_glyphs: (out) (optional): location to store the number of glyphs + * + * Gets the glyph array contained in a `PangoOTBuffer`. * - * Gets the glyph array contained in a #PangoOTBuffer. The glyphs are - * owned by the buffer and should not be freed, and are only valid as long - * as buffer is not modified. + * The glyphs are owned by the buffer and should not be freed, + * and are only valid as long as buffer is not modified. * * Since: 1.4 - **/ + */ void pango_ot_buffer_get_glyphs (const PangoOTBuffer *buffer, PangoOTGlyph **glyphs, @@ -172,15 +177,17 @@ pango_ot_buffer_get_glyphs (const PangoOTBuffer *buffer, /** * pango_ot_buffer_output - * @buffer: a #PangoOTBuffer - * @glyphs: a #PangoGlyphString + * @buffer: a `PangoOTBuffer` + * @glyphs: a `PangoGlyphString` + * + * Exports the glyphs in a `PangoOTBuffer` into a `PangoGlyphString`. * - * Exports the glyphs in a #PangoOTBuffer into a #PangoGlyphString. This is - * typically used after the OpenType layout processing is over, to convert the - * resulting glyphs into a generic Pango glyph string. + * This is typically used after the OpenType layout processing + * is over, to convert the resulting glyphs into a generic Pango + * glyph string. * * Since: 1.4 - **/ + */ void pango_ot_buffer_output (const PangoOTBuffer *buffer, PangoGlyphString *glyphs) |