From 4f11308e79cafe463593c5cdc62c75c050a10d32 Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Wed, 23 Nov 2005 17:54:55 +0000 Subject: Added "Since:" tags to all interfaces added after Pango 1.0. (#319116, 2005-11-23 Behdad Esfahbod * pango/fonts.c pango/pango-attributes.c pango/pango-context.c pango/pango-glyph-item.c pango/pango-layout.c pango/pango-script.c pango/pango-utils.c pango/pangofc-font.c pango/pangoft2-fontmap.c pango/opentype/pango-ot-buffer.c pango/opentype/pango-ot-ruleset.c: Added "Since:" tags to all interfaces added after Pango 1.0. (#319116, Brian Cameron) --- ChangeLog | 9 +++++++ pango/fonts.c | 4 ++++ pango/opentype/pango-ot-buffer.c | 49 +++++++++++++++++++++++++++++++++++++++ pango/opentype/pango-ot-ruleset.c | 14 +++++++++++ pango/pango-attributes.c | 10 ++++++++ pango/pango-context.c | 2 ++ pango/pango-glyph-item.c | 2 ++ pango/pango-layout.c | 5 ++++ pango/pango-script.c | 10 ++++++++ pango/pango-utils.c | 4 ++++ pango/pangofc-font.c | 2 ++ pango/pangoft2-fontmap.c | 2 ++ 12 files changed, 113 insertions(+) diff --git a/ChangeLog b/ChangeLog index 0cb5aeca..6f3c1088 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2005-11-23 Behdad Esfahbod + + * pango/fonts.c pango/pango-attributes.c pango/pango-context.c + pango/pango-glyph-item.c pango/pango-layout.c + pango/pango-script.c pango/pango-utils.c pango/pangofc-font.c + pango/pangoft2-fontmap.c pango/opentype/pango-ot-buffer.c + pango/opentype/pango-ot-ruleset.c: Added "Since:" tags to all + interfaces added after Pango 1.0. (#319116, Brian Cameron) + 2005-11-23 Behdad Esfahbod * configure.in (enable_explicit_deps): Fix typo when checking diff --git a/pango/fonts.c b/pango/fonts.c index 8d395486..60b6dffb 100644 --- a/pango/fonts.c +++ b/pango/fonts.c @@ -1196,6 +1196,8 @@ pango_font_get_metrics (PangoFont *font, * Gets the font map for which the font was created. * * Returns: the #PangoFontMap for the font + * + * Since: 1.10 **/ PangoFontMap * pango_font_get_font_map (PangoFont *font) @@ -1510,6 +1512,8 @@ pango_font_family_list_faces (PangoFontFamily *family, * by double-width characters. * * Return value: %TRUE if the family is monospace. + * + * Since: 1.4 **/ gboolean pango_font_family_is_monospace (PangoFontFamily *family) diff --git a/pango/opentype/pango-ot-buffer.c b/pango/opentype/pango-ot-buffer.c index c69abb0b..db3e0ba5 100644 --- a/pango/opentype/pango-ot-buffer.c +++ b/pango/opentype/pango-ot-buffer.c @@ -24,6 +24,12 @@ #define PANGO_SCALE_26_6 (PANGO_SCALE / (1<<6)) #define PANGO_UNITS_26_6(d) (PANGO_SCALE_26_6 * (d)) +/** + * pango_ot_buffer_new + * @font: a #PangoFcFont + * + * Since: 1.4 + **/ PangoOTBuffer * pango_ot_buffer_new (PangoFcFont *font) { @@ -49,6 +55,12 @@ pango_ot_buffer_new (PangoFcFont *font) return buffer; } +/** + * pango_ot_buffer_destroy + * @buffer: a #PangoOTBuffer + * + * Since: 1.4 + **/ void pango_ot_buffer_destroy (PangoOTBuffer *buffer) { @@ -57,6 +69,12 @@ pango_ot_buffer_destroy (PangoOTBuffer *buffer) g_free (buffer); } +/** + * pango_ot_buffer_clear + * @buffer: a #PangoOTBuffer + * + * Since: 1.4 + **/ void pango_ot_buffer_clear (PangoOTBuffer *buffer) { @@ -64,6 +82,15 @@ pango_ot_buffer_clear (PangoOTBuffer *buffer) buffer->applied_gpos = FALSE; } +/** + * pango_ot_buffer_add_glyph + * @buffer: a #PangoOTBuffer + * @glyph_index: + * @properties: + * @cluster: + * + * Since: 1.4 + **/ void pango_ot_buffer_add_glyph (PangoOTBuffer *buffer, guint glyph_index, @@ -75,6 +102,13 @@ pango_ot_buffer_add_glyph (PangoOTBuffer *buffer, } +/** + * pango_ot_buffer_set_rtl + * @buffer: a #PangoOTBuffer + * @rtl: %TRUE for right-to-left + * + * Since: 1.4 + **/ void pango_ot_buffer_set_rtl (PangoOTBuffer *buffer, gboolean rtl) @@ -102,6 +136,14 @@ pango_ot_buffer_set_zero_width_marks (PangoOTBuffer *buffer, buffer->zero_width_marks = zero_width_marks != FALSE; } +/** + * pango_ot_buffer_get_glyphs + * @buffer: a #PangoOTBuffer + * @glyph: + * @n_glyphs: + * + * Since: 1.4 + **/ void pango_ot_buffer_get_glyphs (PangoOTBuffer *buffer, PangoOTGlyph **glyphs, @@ -204,6 +246,13 @@ apply_gpos_rtl (PangoGlyphString *glyphs, } } +/** + * pango_ot_buffer_output + * @buffer: a #PangoOTBuffer + * @glyphs: a #PangoGlyphString + * + * Since: 1.4 + **/ void pango_ot_buffer_output (PangoOTBuffer *buffer, PangoGlyphString *glyphs) diff --git a/pango/opentype/pango-ot-ruleset.c b/pango/opentype/pango-ot-ruleset.c index 1049c539..23126582 100644 --- a/pango/opentype/pango-ot-ruleset.c +++ b/pango/opentype/pango-ot-ruleset.c @@ -137,6 +137,13 @@ pango_ot_ruleset_add_feature (PangoOTRuleset *ruleset, g_array_append_val (ruleset->rules, tmp_rule); } +/** + * pango_ot_ruleset_substitute: + * @ruleset: a #PangoOTRuleset. + * @buffer: a #PangoOTBuffer. + * + * Since: 1.4 + **/ void pango_ot_ruleset_substitute (PangoOTRuleset *ruleset, PangoOTBuffer *buffer) @@ -170,6 +177,13 @@ pango_ot_ruleset_substitute (PangoOTRuleset *ruleset, TT_GSUB_Apply_String (gsub, buffer->buffer); } +/** + * pango_ot_ruleset_position: + * @ruleset: a #PangoOTRuleset. + * @buffer: a #PangoOTBuffer. + * + * Since: 1.4 + **/ void pango_ot_ruleset_position (PangoOTRuleset *ruleset, PangoOTBuffer *buffer) diff --git a/pango/pango-attributes.c b/pango/pango-attributes.c index 7af76c06..0aabcda4 100644 --- a/pango/pango-attributes.c +++ b/pango/pango-attributes.c @@ -653,6 +653,8 @@ pango_attr_underline_new (PangoUnderline underline) * will use the foreground color. * * Return value: the new #PangoAttribute. + * + * Since: 1.8 **/ PangoAttribute * pango_attr_underline_color_new (guint16 red, @@ -701,6 +703,8 @@ pango_attr_strikethrough_new (gboolean strikethrough) * lines will use the foreground color. * * Return value: the new #PangoAttribute. + * + * Since: 1.8 **/ PangoAttribute * pango_attr_strikethrough_color_new (guint16 red, @@ -774,6 +778,8 @@ pango_attr_scale_new (double scale_factor) * text. * * Return value: the new #PangoAttribute. + * + * Since: 1.4 **/ PangoAttribute * pango_attr_fallback_new (gboolean enable_fallback) @@ -1782,6 +1788,8 @@ pango_attr_iterator_get_font (PangoAttrIterator *iterator, * * Return value: the new #PangoAttrList or %NULL if * no attributes of the given types were found. + * + * Since: 1.2 **/ PangoAttrList * pango_attr_list_filter (PangoAttrList *list, @@ -1849,6 +1857,8 @@ pango_attr_list_filter (PangoAttrList *list, * Return value: a list of all attributes for the current range. * To free this value, call pango_attribute_destroy() on * each value and g_slist_free() on the list. + * + * Since: 1.2 **/ GSList * pango_attr_iterator_get_attrs (PangoAttrIterator *iterator) diff --git a/pango/pango-context.c b/pango/pango-context.c index 42d200c1..c87ffd0a 100644 --- a/pango/pango-context.c +++ b/pango/pango-context.c @@ -1161,6 +1161,8 @@ itemize_state_finish (ItemizeState *state) * is specified explicitely rather than gotten from the #PangoContext. * * Return value: a GList of PangoItem structures. + * + * Since: 1.4 */ GList * pango_itemize_with_base_dir (PangoContext *context, diff --git a/pango/pango-glyph-item.c b/pango/pango-glyph-item.c index b774add8..73386dbb 100644 --- a/pango/pango-glyph-item.c +++ b/pango/pango-glyph-item.c @@ -132,6 +132,8 @@ pango_glyph_item_split (PangoGlyphItem *orig, * @glyph_item: a #PangoGlyphItem * * Frees a #PangoGlyphItem and memory to which it points. + * + * Since: 1.6 **/ void pango_glyph_item_free (PangoGlyphItem *glyph_item) diff --git a/pango/pango-layout.c b/pango/pango-layout.c index ec4f285c..179d83d4 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -517,6 +517,8 @@ pango_layout_set_font_description (PangoLayout *layout, * or %NULL if the font description from the layout's * context is inherited. This value is owned by the layout * and must not be modified or freed. + * + * Since: 1.8 **/ G_CONST_RETURN PangoFontDescription * pango_layout_get_font_description (PangoLayout *layout) @@ -587,6 +589,7 @@ pango_layout_get_justify (PangoLayout *layout) * base direction of the context, the interpretation of * %PANGO_ALIGN_LEFT and %PANGO_ALIGN_RIGHT are swapped. * + * Since: 1.4 **/ void pango_layout_set_auto_dir (PangoLayout *layout, @@ -613,6 +616,8 @@ pango_layout_set_auto_dir (PangoLayout *layout, * * Return value: %TRUE if the bidirectional base direction * is computed from the layout's contents, %FALSE otherwise. + * + * Since: 1.4 **/ gboolean pango_layout_get_auto_dir (PangoLayout *layout) diff --git a/pango/pango-script.c b/pango/pango-script.c index 00bf4347..5e305953 100644 --- a/pango/pango-script.c +++ b/pango/pango-script.c @@ -119,6 +119,8 @@ pango_script_for_unichar_bsearch (gunichar ch) * result is undefined. * * Return value: the #PangoScript for the character. + * + * Since: 1.4 **/ PangoScript pango_script_for_unichar (gunichar ch) @@ -144,6 +146,8 @@ pango_script_for_unichar (gunichar ch) * Return value: the new script iterator, initialized * to point at the first range in the text. If the string is * empty, it will point at an empty range. + * + * Since: 1.4 **/ PangoScriptIter * pango_script_iter_new (const char *text, @@ -173,6 +177,8 @@ pango_script_iter_new (const char *text, * @iter: a #PangoScriptIter * * Frees a #PangoScriptIter created with pango_script_iter_new(). + * + * Since: 1.4 **/ void pango_script_iter_free (PangoScriptIter *iter) @@ -190,6 +196,8 @@ pango_script_iter_free (PangoScriptIter *iter) * Gets information about the range to which @iter currently points. * The range is the set of locations p where *start <= p < *end. * (That is, it doesn't include the character stored at *end) + * + * Since: 1.4 **/ void pango_script_iter_get_range (PangoScriptIter *iter, @@ -263,6 +271,8 @@ get_pair_index (gunichar ch) * is returned. * * Return value: %TRUE if the iter was succesfully advanced. + * + * Since: 1.4 **/ gboolean pango_script_iter_next (PangoScriptIter *iter) diff --git a/pango/pango-utils.c b/pango/pango-utils.c index ebe83a3d..c252a63a 100644 --- a/pango/pango-utils.c +++ b/pango/pango-utils.c @@ -1744,6 +1744,8 @@ pango_lookup_aliases (const char *fontname, * * Return value: The direction corresponding to the first strong character. * If no such character is found, then %PANGO_DIRECTION_NEUTRAL is returned. + * + * Since: 1.4 */ PangoDirection pango_find_base_dir (const gchar *text, @@ -1778,6 +1780,8 @@ pango_find_base_dir (const gchar *text, * normally rendered on the screen. * * Return value: %TRUE if @ch is a zero-width character, %FALSE otherwise + * + * Since: 1.10 */ gboolean pango_is_zero_width (gunichar ch) diff --git a/pango/pangofc-font.c b/pango/pangofc-font.c index 2a19fe06..3eda0e5f 100644 --- a/pango/pangofc-font.c +++ b/pango/pangofc-font.c @@ -794,6 +794,8 @@ get_per_char (FT_Face face, * The other possibility would be to to make it public in something * like it's current form, and also expose glyph information * caching functionality similar to pango_ft2_font_set_glyph_info(). + * + * Since: 1.6 **/ void pango_fc_font_get_raw_extents (PangoFcFont *fcfont, diff --git a/pango/pangoft2-fontmap.c b/pango/pangoft2-fontmap.c index 0302caf7..de294eb6 100644 --- a/pango/pangoft2-fontmap.c +++ b/pango/pangoft2-fontmap.c @@ -194,6 +194,8 @@ pango_ft2_font_map_substitute_changed (PangoFT2FontMap *fontmap) * @dpi_y: dots per inch in the Y direction * * Sets the horizontal and vertical resolutions for the fontmap. + * + * Since: 1.2 **/ void pango_ft2_font_map_set_resolution (PangoFT2FontMap *fontmap, -- cgit v1.2.1