From 81445c034aca36040b6311dc71a2cbed9548b262 Mon Sep 17 00:00:00 2001 From: Alexei Podtelezhnikov Date: Sat, 22 Jun 2019 22:54:57 -0400 Subject: [PATCH] Doc polishing. --- include/freetype/ftglyph.h | 2 +- include/freetype/ftimage.h | 3 ++- include/freetype/ftoutln.h | 8 ++++---- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h index 4067c2e62..fedab8491 100644 --- a/include/freetype/ftglyph.h +++ b/include/freetype/ftglyph.h @@ -210,7 +210,7 @@ FT_BEGIN_HEADER * * As the outline is extracted from a glyph slot, its coordinates are * expressed normally in 26.6 pixels, unless the flag @FT_LOAD_NO_SCALE - * was used in @FT_Load_Glyph() or @FT_Load_Char(). + * was used in @FT_Load_Glyph or @FT_Load_Char. * * The outline's tables are always owned by the object and are destroyed * with it. diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h index 6eeefe3b1..face34fe4 100644 --- a/include/freetype/ftimage.h +++ b/include/freetype/ftimage.h @@ -975,7 +975,8 @@ FT_BEGIN_HEADER * FT_Raster_Params * * @description: - * A structure to hold the arguments used by a raster's render function. + * A structure to hold the parameters used by a raster's render function, + * passed as an argument to @FT_Outline_Render. * * @fields: * target :: diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h index 75c3d0159..b72327b70 100644 --- a/include/freetype/ftoutln.h +++ b/include/freetype/ftoutln.h @@ -466,8 +466,6 @@ FT_BEGIN_HEADER * * @description: * Render an outline within a bitmap using the current scan-convert. - * This function uses an @FT_Raster_Params structure as an argument, - * allowing advanced features like direct composition, translucency, etc. * * @input: * library :: @@ -485,8 +483,10 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * You should know what you are doing and how @FT_Raster_Params works to - * use this function. + * This advanced function uses @FT_Raster_Params as an argument, + * allowing FreeType rasterizer to be used for direct composition, + * translucency, etc. You should know how to set up @FT_Raster_Params + * for this function to work. * * The field `params.source` will be set to `outline` before the scan * converter is called, which means that the value you give to it is