ref: 81445c034aca36040b6311dc71a2cbed9548b262
parent: a41e560b213d72f36c37b7b25960839de7d29fd0
author: Alexei Podtelezhnikov <[email protected]>
date: Sat Jun 22 18:54:57 EDT 2019
Doc polishing.
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -210,7 +210,7 @@
*
* 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.
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -975,7 +975,8 @@
* 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 ::
--- a/include/freetype/ftoutln.h
+++ b/include/freetype/ftoutln.h
@@ -466,8 +466,6 @@
*
* @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 @@
* 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