From 3393db942a1778d2eb441f959ff260eed42442ba Mon Sep 17 00:00:00 2001 From: Bilal Elmoussaoui Date: Tue, 22 Nov 2022 12:54:04 +0100 Subject: [PATCH] docs/cogl-pango: Make use of gi-docgen annotations Part-of: --- cogl/cogl-pango/cogl-pango-fontmap.c | 8 -------- cogl/cogl-pango/cogl-pango.h | 22 +++++++++++----------- 2 files changed, 11 insertions(+), 19 deletions(-) diff --git a/cogl/cogl-pango/cogl-pango-fontmap.c b/cogl/cogl-pango/cogl-pango-fontmap.c index 714ba6546..d979244db 100644 --- a/cogl/cogl-pango/cogl-pango-fontmap.c +++ b/cogl/cogl-pango/cogl-pango-fontmap.c @@ -26,14 +26,6 @@ * SOFTWARE. */ -/** - * SECTION:cogl-pango - * @short_description: COGL-based text rendering using Pango - * - * FIXME - * - */ - #include "cogl-config.h" /* This is needed to get the Pango headers to export stuff needed to diff --git a/cogl/cogl-pango/cogl-pango.h b/cogl/cogl-pango/cogl-pango.h index cd57e6b00..c0012177e 100644 --- a/cogl/cogl-pango/cogl-pango.h +++ b/cogl/cogl-pango/cogl-pango.h @@ -82,9 +82,9 @@ cogl_pango_font_map_new (void); * cogl_pango_font_map_create_context: * @font_map: a #CoglPangoFontMap * - * Create a #PangoContext for the given @font_map. + * Create a [class@Pango.Context] for the given @font_map. * - * Returns: (transfer full): the newly created context: free with g_object_unref(). + * Returns: (transfer full): the newly created context: free with [method@GObject.Object.unref]. */ COGL_EXPORT PangoContext * cogl_pango_font_map_create_context (CoglPangoFontMap *font_map); @@ -95,8 +95,10 @@ cogl_pango_font_map_create_context (CoglPangoFontMap *font_map); * @dpi: The resolution in "dots per inch". (Physical inches aren't * actually involved; the terminology is conventional.) * - * Sets the resolution for the @font_map. This is a scale factor - * between points specified in a #PangoFontDescription and Cogl units. + * Sets the resolution for the @font_map. + * + * This is a scale factor between points specified in a + * [struct@Pango.FontDescription] and Cogl units. * The default value is %96, meaning that a 10 point font will be 13 * units high. (10 * 96. / 72. = 13.3). * @@ -138,7 +140,7 @@ cogl_pango_ensure_glyph_cache_for_layout (PangoLayout *layout); * @value: %TRUE to enable the use of mipmapping * * Sets whether the renderer for the passed font map should use - * mipmapping when rendering a #PangoLayout. + * mipmapping when rendering a [class@Pango.Layout]. * * Since: 1.0 */ @@ -150,7 +152,7 @@ cogl_pango_font_map_set_use_mipmapping (CoglPangoFontMap *font_map, * cogl_pango_font_map_get_use_mipmapping: * @font_map: a #CoglPangoFontMap * - * Retrieves whether the #CoglPangoRenderer used by @font_map will use + * Retrieves whether the [class@CoglPango.Renderer] used by @font_map will use * mipmapping when rendering the glyphs. * * Return value: %TRUE if mipmapping is used, %FALSE otherwise. @@ -164,7 +166,7 @@ cogl_pango_font_map_get_use_mipmapping (CoglPangoFontMap *font_map); * cogl_pango_font_map_get_renderer: * @font_map: a #CoglPangoFontMap * - * Retrieves the #CoglPangoRenderer for the passed @font_map. + * Retrieves the [class@CoglPango.Renderer] for the passed @font_map. * * Return value: (transfer none): a #PangoRenderer * @@ -182,8 +184,7 @@ cogl_pango_font_map_get_renderer (CoglPangoFontMap *font_map); * @color: color to use when rendering the layout * * Draws a solidly coloured @layout on the given @framebuffer at (@x, - * @y) within the @framebuffer's current model-view coordinate - * space. + * @y) within the `framebuffer`'s current model-view coordinate space. * * Since: 1.14 */ @@ -203,8 +204,7 @@ cogl_pango_show_layout (CoglFramebuffer *framebuffer, * @color: color to use when rendering the line * * Draws a solidly coloured @line on the given @framebuffer at (@x, - * @y) within the @framebuffer's current model-view coordinate - * space. + * @y) within the `framebuffer`'s current model-view coordinate space. * * Since: 1.14 */