From f4a9ab9847427582a0d1a4edc1ab82430fe3d7ec Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Sat, 21 Jan 2006 19:51:25 +0000 Subject: Make matrix parameter const. 2006-01-21 Behdad Esfahbod * pango/pango-types.h, pango/pango-utils.h (pango_matrix_get_font_scale_factor): Make matrix parameter const. * pango/fonts.c, pango/pango-context.c, pango/pango-coverage.c, pango/pango-fontset.c, pango/pango-layout.c, pango/pango-renderer.c, pango/pango-types.h, pango/pango-utils.c, pango/pangocairo-atsuifont.c, pango/pangofc-font.c, pango/pangoft2-fontmap.c, pango/pangowin32-fontmap.c, pango/pangowin32.c, pango/pangox-fontmap.c, pango/pangoxft-font.c: Replace "Returns:" with "Return value:" in docs. --- pango/fonts.c | 4 ++-- pango/pango-context.c | 4 ++-- pango/pango-coverage.c | 2 +- pango/pango-fontset.c | 8 ++++---- pango/pango-layout.c | 2 +- pango/pango-renderer.c | 2 +- pango/pango-types.h | 2 +- pango/pango-utils.c | 4 ++-- pango/pangocairo-atsuifont.c | 2 +- pango/pangofc-font.c | 4 ++-- pango/pangoft2-fontmap.c | 2 +- pango/pangowin32-fontmap.c | 4 ++-- pango/pangowin32.c | 4 ++-- pango/pangox-fontmap.c | 4 ++-- pango/pangoxft-font.c | 6 +++--- 15 files changed, 27 insertions(+), 27 deletions(-) (limited to 'pango') diff --git a/pango/fonts.c b/pango/fonts.c index 07392f50..0c0b4fa5 100644 --- a/pango/fonts.c +++ b/pango/fonts.c @@ -1180,7 +1180,7 @@ pango_font_get_glyph_extents (PangoFont *font, * be provided to indicate that the metrics should be retrieved that * correspond to the script(s) used by that language. * - * Returns: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() + * Return value: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() * when finished using the object. **/ PangoFontMetrics * @@ -1196,7 +1196,7 @@ pango_font_get_metrics (PangoFont *font, * * Gets the font map for which the font was created. * - * Returns: the #PangoFontMap for the font + * Return value: the #PangoFontMap for the font * * Since: 1.10 **/ diff --git a/pango/pango-context.c b/pango/pango-context.c index e1b408f5..4f75df39 100644 --- a/pango/pango-context.c +++ b/pango/pango-context.c @@ -160,7 +160,7 @@ pango_context_set_matrix (PangoContext *context, * Gets the transformation matrix that will be applied when * rendering with this context. See pango_context_set_matrix(). * - * Returns: the matrix, or %NULL if no matrix has been set + * Return value: the matrix, or %NULL if no matrix has been set * (which is the same as the identity matrix). The returned * matrix is owned by Pango and must not be modified or * freed. @@ -1368,7 +1368,7 @@ update_metrics_from_items (PangoFontMetrics *metrics, * be a composite of the metrics for the fonts loaded for the * individual families. * - * Returns: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() + * Return value: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() * when finished using the object. **/ PangoFontMetrics * diff --git a/pango/pango-coverage.c b/pango/pango-coverage.c index 2aedea15..500dee24 100644 --- a/pango/pango-coverage.c +++ b/pango/pango-coverage.c @@ -112,7 +112,7 @@ pango_coverage_copy (PangoCoverage *coverage) * * Increase the reference count on the #PangoCoverage by one * - * Returns: @coverage + * Return value: @coverage **/ PangoCoverage * pango_coverage_ref (PangoCoverage *coverage) diff --git a/pango/pango-fontset.c b/pango/pango-fontset.c index acf8fd52..f40330b2 100644 --- a/pango/pango-fontset.c +++ b/pango/pango-fontset.c @@ -50,7 +50,7 @@ PANGO_DEFINE_TYPE_ABSTRACT (PangoFontset, pango_fontset, * Returns the font in the fontset that contains the best glyph for the * Unicode character @wc. * - * Returns: a #PangoFont. The caller must call g_object_unref when finished + * Return value: a #PangoFont. The caller must call g_object_unref when finished * with the font. **/ PangoFont * @@ -69,7 +69,7 @@ pango_fontset_get_font (PangoFontset *fontset, * * Get overall metric information for the fonts in the fontset. * - * Returns: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() + * Return value: a #PangoFontMetrics object. The caller must call pango_font_metrics_unref() * when finished using the object. **/ PangoFontMetrics * @@ -234,7 +234,7 @@ static PangoFontsetClass *simple_parent_class; /* Parent class structure for Pan * * Creates a new #PangoFontsetSimple for the given language. * - * Returns: a newly-allocated #PangoFontsetSimple. + * Return value: a newly-allocated #PangoFontsetSimple. **/ PangoFontsetSimple * pango_fontset_simple_new (PangoLanguage *language) @@ -319,7 +319,7 @@ pango_fontset_simple_append (PangoFontsetSimple *fontset, * * Returns the number of fonts in the fontset. * - * Returns: the size of @fontset. + * Return value: the size of @fontset. **/ int pango_fontset_simple_size (PangoFontsetSimple *fontset) diff --git a/pango/pango-layout.c b/pango/pango-layout.c index c3e45171..2143b164 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -3419,7 +3419,7 @@ pango_layout_line_get_type(void) * grapheme in the line and @trailing being set to the number of characters * in that grapheme. The reverse is true for a left-to-right line. * - * Returns: %FALSE if @x_pos was outside the line, %TRUE if inside + * Return value: %FALSE if @x_pos was outside the line, %TRUE if inside **/ gboolean pango_layout_line_x_to_index (PangoLayoutLine *line, diff --git a/pango/pango-renderer.c b/pango/pango-renderer.c index 31e14077..cb7095b2 100644 --- a/pango/pango-renderer.c +++ b/pango/pango-renderer.c @@ -1230,7 +1230,7 @@ pango_renderer_set_matrix (PangoRenderer *renderer, * Gets the transformation matrix that will be applied when * rendering. See pango_renderer_set_matrix(). * - * Returns: the matrix, or %NULL if no matrix has been set + * Return value: the matrix, or %NULL if no matrix has been set * (which is the same as the identity matrix). The returned * matrix is owned by Pango and must not be modified or * freed. diff --git a/pango/pango-types.h b/pango/pango-types.h index e01b8911..6a198a60 100644 --- a/pango/pango-types.h +++ b/pango/pango-types.h @@ -123,7 +123,7 @@ void pango_matrix_rotate (PangoMatrix *matrix, double degrees); void pango_matrix_concat (PangoMatrix *matrix, const PangoMatrix *new_matrix); -double pango_matrix_get_font_scale_factor (PangoMatrix *matrix); +double pango_matrix_get_font_scale_factor (const PangoMatrix *matrix); #define PANGO_SCALE 1024 #define PANGO_PIXELS(d) (((int)(d) + 512) >> 10) diff --git a/pango/pango-utils.c b/pango/pango-utils.c index 4b3adc3d..56313fda 100644 --- a/pango/pango-utils.c +++ b/pango/pango-utils.c @@ -1164,7 +1164,7 @@ pango_matrix_concat (PangoMatrix *matrix, * Since: 1.12 **/ double -pango_matrix_get_font_scale_factor (PangoMatrix *matrix) +pango_matrix_get_font_scale_factor (const PangoMatrix *matrix) { /* * Based on cairo-matrix.c:_cairo_matrix_compute_scale_factors() @@ -1336,7 +1336,7 @@ pango_language_from_string (const char *language) * or the range is a prefix of the tag, and the character after the * tag is '-'. * - * Returns: %TRUE if a match was found. + * Return value: %TRUE if a match was found. **/ gboolean pango_language_matches (PangoLanguage *language, diff --git a/pango/pangocairo-atsuifont.c b/pango/pangocairo-atsuifont.c index e28a92d1..149d7a2d 100644 --- a/pango/pangocairo-atsuifont.c +++ b/pango/pangocairo-atsuifont.c @@ -57,7 +57,7 @@ static cairo_font_face_t *pango_cairo_atsui_font_get_font_face (PangoCairoFont * * * Returns the ATSUFontID of a font. * - * Returns: the ATSUFontID associated to @cafont. + * Return value: the ATSUFontID associated to @cafont. * * Since: 1.12 */ diff --git a/pango/pangofc-font.c b/pango/pangofc-font.c index 786df91c..b53dd5fa 100644 --- a/pango/pangofc-font.c +++ b/pango/pangofc-font.c @@ -532,7 +532,7 @@ pango_fc_font_real_get_glyph (PangoFcFont *font, * This face will be kept around until you call * pango_fc_font_unlock_face(). * - * Returns: the FreeType FT_Face associated with @font. + * Return value: the FreeType FT_Face associated with @font. * * Since: 1.4 **/ @@ -706,7 +706,7 @@ pango_fc_font_kern_glyphs (PangoFcFont *font, * * This will return any custom decoder set on this font. * - * Returns: The custom decoder + * Return value: The custom decoder * * Since: 1.6 **/ diff --git a/pango/pangoft2-fontmap.c b/pango/pangoft2-fontmap.c index 3b04da82..69ebf2db 100644 --- a/pango/pangoft2-fontmap.c +++ b/pango/pangoft2-fontmap.c @@ -262,7 +262,7 @@ pango_ft2_get_context (double dpi_x, double dpi_y) * global PangoFT2 fontmap is deprecated; use pango_ft2_font_map_new() * instead. * - * Returns: a #PangoFT2FontMap. + * Return value: a #PangoFT2FontMap. **/ PangoFontMap * pango_ft2_font_map_for_display (void) diff --git a/pango/pangowin32-fontmap.c b/pango/pangowin32-fontmap.c index 5ea88542..ca81ea01 100644 --- a/pango/pangowin32-fontmap.c +++ b/pango/pangowin32-fontmap.c @@ -207,7 +207,7 @@ pango_win32_font_map_class_init (PangoWin32FontMapClass *class) * not be freed. If the font map is no longer needed, it can * be released with pango_win32_shutdown_display(). * - * Returns: a #PangoFontMap. + * Return value: a #PangoFontMap. **/ PangoFontMap * pango_win32_font_map_for_display (void) @@ -997,7 +997,7 @@ pango_win32_font_entry_remove (PangoWin32Face *face, * * Obtains the font cache associated with the given font map. * - * Returns: the #PangoWin32FontCache of @font_map. + * Return value: the #PangoWin32FontCache of @font_map. **/ PangoWin32FontCache * pango_win32_font_map_get_font_cache (PangoFontMap *font_map) diff --git a/pango/pangowin32.c b/pango/pangowin32.c index 843109bb..beda66f6 100644 --- a/pango/pangowin32.c +++ b/pango/pangowin32.c @@ -179,7 +179,7 @@ pango_win32_get_dc (void) * * Returns wether debugging is turned on. * - * Returns: %TRUE if debugging is turned on. + * Return value: %TRUE if debugging is turned on. * * Since: 1.2 */ @@ -1351,7 +1351,7 @@ font_get_cmap (PangoFont *font) * * Obtains the index of the glyph for @wc in @font. * - * Returns: the glyph index for @wc. + * Return value: the glyph index for @wc. **/ gint pango_win32_font_get_glyph_index (PangoFont *font, diff --git a/pango/pangox-fontmap.c b/pango/pangox-fontmap.c index 016090e5..b073b4ec 100644 --- a/pango/pangox-fontmap.c +++ b/pango/pangox-fontmap.c @@ -268,7 +268,7 @@ static GList *fontmaps = NULL; * not be freed. If the font map for a display is no longer needed, it can * be released with pango_x_shutdown_display(). * - * Returns: a #PangoXFontMap for @display. + * Return value: a #PangoXFontMap for @display. **/ PangoFontMap * pango_x_font_map_for_display (Display *display) @@ -1339,7 +1339,7 @@ pango_x_make_matching_xlfd (PangoFontMap *fontmap, char *xlfd, const char *chars * * Obtains the font cache associated with the given font map. * - * Returns: the #PangoXFontCache of @font_map. + * Return value: the #PangoXFontCache of @font_map. **/ PangoXFontCache * pango_x_font_map_get_font_cache (PangoFontMap *font_map) diff --git a/pango/pangoxft-font.c b/pango/pangoxft-font.c index 83fe2a54..4a0c9819 100644 --- a/pango/pangoxft-font.c +++ b/pango/pangoxft-font.c @@ -475,7 +475,7 @@ pango_xft_font_real_shutdown (PangoFcFont *fcfont) * * Returns the XftFont of a font. * - * Returns: the XftFont associated to @font. + * Return value: the XftFont associated to @font. **/ XftFont * pango_xft_font_get_font (PangoFont *font) @@ -491,7 +491,7 @@ pango_xft_font_get_font (PangoFont *font) * * Returns the X display of the XftFont of a font. * - * Returns: the X display of the XftFont associated to @font. + * Return value: the X display of the XftFont associated to @font. **/ Display * pango_xft_font_get_display (PangoFont *font) @@ -538,7 +538,7 @@ pango_xft_font_get_unknown_glyph (PangoFont *font, * * Use pango_fc_font_lock_face() instead. * - * Returns: the FreeType FT_Face associated with @font. + * Return value: the FreeType FT_Face associated with @font. * * Since: 1.2 **/ -- cgit v1.2.1