diff options
| -rw-r--r-- | ChangeLog | 21 | ||||
| -rw-r--r-- | pango/fonts.c | 4 | ||||
| -rw-r--r-- | pango/pango-context.c | 4 | ||||
| -rw-r--r-- | pango/pango-coverage.c | 2 | ||||
| -rw-r--r-- | pango/pango-fontset.c | 8 | ||||
| -rw-r--r-- | pango/pango-layout.c | 2 | ||||
| -rw-r--r-- | pango/pango-renderer.c | 2 | ||||
| -rw-r--r-- | pango/pango-types.h | 2 | ||||
| -rw-r--r-- | pango/pango-utils.c | 11 | ||||
| -rw-r--r-- | pango/pangocairo-fontmap.c | 2 | ||||
| -rw-r--r-- | pango/pangofc-font.c | 4 | ||||
| -rw-r--r-- | pango/pangoft2-fontmap.c | 2 | ||||
| -rw-r--r-- | pango/pangowin32-fontmap.c | 4 | ||||
| -rw-r--r-- | pango/pangowin32.c | 4 | ||||
| -rw-r--r-- | pango/pangox-fontmap.c | 4 | ||||
| -rw-r--r-- | pango/pangoxft-font.c | 6 |
16 files changed, 53 insertions, 29 deletions
@@ -1,3 +1,24 @@ +2006-01-21 Behdad Esfahbod <behdad@gnome.org> + + * pango/pangocairo-fontmap.c (pango_cairo_context_get_font_options): + Fix typo in docs. + +2006-01-21 Behdad Esfahbod <behdad@gnome.org> + + * pango/pango-utils.c (pango_matrix_get_font_scale_factor): Fix docs. + +2006-01-21 Behdad Esfahbod <behdad@gnome.org> + + * pango/pango-types.h, pango/pango-utils.c + (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/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. + 2006-01-16 Behdad Esfahbod <behdad@gnome.org> * pango/Makefile.am: Move GLIB_CFLAGS before external libraries' diff --git a/pango/fonts.c b/pango/fonts.c index 88cc1cb4..89f81dfd 100644 --- a/pango/fonts.c +++ b/pango/fonts.c @@ -1202,7 +1202,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 * @@ -1218,7 +1218,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 a37cd856..f53d2ef9 100644 --- a/pango/pango-context.c +++ b/pango/pango-context.c @@ -159,7 +159,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. @@ -1371,7 +1371,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 4b49c661..86be76a3 100644 --- a/pango/pango-coverage.c +++ b/pango/pango-coverage.c @@ -111,7 +111,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 d0feb62c..66df6552 100644 --- a/pango/pango-fontset.c +++ b/pango/pango-fontset.c @@ -48,7 +48,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 * @@ -67,7 +67,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 * @@ -232,7 +232,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) @@ -317,7 +317,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 89e30cbc..0a1ae92f 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -3418,7 +3418,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 3bc45a81..98cd0cca 100644 --- a/pango/pango-renderer.c +++ b/pango/pango-renderer.c @@ -1228,7 +1228,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 519b6bc1..799af7a2 100644 --- a/pango/pango-utils.c +++ b/pango/pango-utils.c @@ -1160,14 +1160,17 @@ pango_matrix_concat (PangoMatrix *matrix, * pango_matrix_get_font_scale_factor: * @matrix: a #PangoMatrix, may be %NULL * - * Return value: the scale factor of @matrix on the height of the font. + * Returns the scale factor of a matrix on the height of the font. * That is, the scale factor in the direction perpendicular to the - * vector that the X coordinate is mapped to, or 1.0 if @matrix is %NULL. + * vector that the X coordinate is mapped to. + * + * Return value: the scale factor of @matrix on the height of the font, + * or 1.0 if @matrix is %NULL. * * 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() @@ -1338,7 +1341,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-fontmap.c b/pango/pangocairo-fontmap.c index 9fd7d87a..9b7a4c83 100644 --- a/pango/pangocairo-fontmap.c +++ b/pango/pangocairo-fontmap.c @@ -372,7 +372,7 @@ pango_cairo_context_set_font_options (PangoContext *context, } /** - * pango_cairo_get_font_options: + * pango_cairo_context_get_font_options: * @context: a #PangoContext, from pango_cairo_font_map_create_context() * * Retrieves any font rendering options previously set with diff --git a/pango/pangofc-font.c b/pango/pangofc-font.c index f80ed4a9..63023b8b 100644 --- a/pango/pangofc-font.c +++ b/pango/pangofc-font.c @@ -521,7 +521,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 **/ @@ -697,7 +697,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 de294eb6..52c869f5 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 171883fa..04900336 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 bd1908a9..5f6ab280 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 aaa28aad..56e0ba16 100644 --- a/pango/pangox-fontmap.c +++ b/pango/pangox-fontmap.c @@ -266,7 +266,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) @@ -1334,7 +1334,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 c8208713..f2d7013e 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 **/ |