minhngoc25a
/
freetype2
mirror of git://git.savannah.gnu.org/freetype/freetype2.git
2
1
Fork 2
Code Issues 4 Releases Wiki Activity

* include/*.*: `Markify' header files. 

Change header file comments to markodwn syntax.

Applied `markify' from https://github.com/nikramakrishnan/freetype-docs
commit 993cc36ef28600bfb6c5c5612ace4cd2b9138fe8.
This commit is contained in:
Nikhil Ramakrishnan 2018-07-26 17:35:57 +05:30 committed by nikramakrishnan
parent f7237ed3d7
commit 628ca693b6
50 changed files with 1116 additions and 1116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/freetype/config/ftheader.h
View File

@ -77,16 +77,16 @@
* FreeType~2 header files. They can be used directly in #include * FreeType~2 header files. They can be used directly in #include
* statements as in: * statements as in:
* *
* { * ```
* #include FT_FREETYPE_H * #include FT_FREETYPE_H
* #include FT_MULTIPLE_MASTERS_H * #include FT_MULTIPLE_MASTERS_H
* #include FT_GLYPH_H * #include FT_GLYPH_H
* } * ```
* *
* There are several reasons why we are now using macros to name * There are several reasons why we are now using macros to name
* public header files. The first one is that such macros are not * public header files. The first one is that such macros are not
* limited to the infamous 8.3~naming rule required by DOS (and * limited to the infamous 8.3~naming rule required by DOS (and
* `FT_MULTIPLE_MASTERS_H' is a lot more meaningful than `ftmm.h'). * `FT_MULTIPLE_MASTERS_H` is a lot more meaningful than `ftmm.h`).
* *
* The second reason is that it allows for more flexibility in the * The second reason is that it allows for more flexibility in the
* way FreeType~2 is installed on a given system. * way FreeType~2 is installed on a given system.
@ -436,7 +436,7 @@
* *
* @description: * @description:
* A macro used in #include statements to name the file containing the * A macro used in #include statements to name the file containing the
* definitions of TrueType four-byte `tags' which identify blocks in * definitions of TrueType four-byte 'tags' which identify blocks in
* SFNT-based font formats (i.e., TrueType and OpenType). * SFNT-based font formats (i.e., TrueType and OpenType).
* *
*/ */
@ -612,7 +612,7 @@
* *
* @description: * @description:
* A macro used in #include statements to name the file containing the * A macro used in #include statements to name the file containing the
* optional FreeType~2 API which accesses embedded `name' strings in * optional FreeType~2 API which accesses embedded 'name' strings in
* SFNT-based font formats (i.e., TrueType and OpenType). * SFNT-based font formats (i.e., TrueType and OpenType).
* *
*/ */

548
include/freetype/freetype.h
View File

File diff suppressed because it is too large Load Diff

8
include/freetype/ftadvanc.h
View File

@ -62,7 +62,7 @@ FT_BEGIN_HEADER
* FT_ADVANCE_FLAG_FAST_ONLY * FT_ADVANCE_FLAG_FAST_ONLY
* *
* @description: * @description:
* A bit-flag to be OR-ed with the `flags' parameter of the * A bit-flag to be OR-ed with the 'flags' parameter of the
* @FT_Get_Advance and @FT_Get_Advances functions. * @FT_Get_Advance and @FT_Get_Advances functions.
* *
* If set, it indicates that you want these functions to fail if the * If set, it indicates that you want these functions to fail if the
@ -103,7 +103,7 @@ FT_BEGIN_HEADER
* @output: * @output:
* padvance :: * padvance ::
* The advance value. If scaling is performed (based on * The advance value. If scaling is performed (based on
* the value of `load_flags'), the advance value is in * the value of `load_flags`), the advance value is in
* 16.16 format. Otherwise, it is in font units. * 16.16 format. Otherwise, it is in font units.
* *
* If @FT_LOAD_VERTICAL_LAYOUT is set, this is the * If @FT_LOAD_VERTICAL_LAYOUT is set, this is the
@ -155,10 +155,10 @@ FT_BEGIN_HEADER
* @output: * @output:
* padvance :: * padvance ::
* The advance values. This array, to be provided by the * The advance values. This array, to be provided by the
* caller, must contain at least `count' elements. * caller, must contain at least 'count' elements.
* *
* If scaling is performed (based on the value of * If scaling is performed (based on the value of
* `load_flags'), the advance values are in 16.16 format. * `load_flags`), the advance values are in 16.16 format.
* Otherwise, they are in font units. * Otherwise, they are in font units.
* *
* If @FT_LOAD_VERTICAL_LAYOUT is set, these are the * If @FT_LOAD_VERTICAL_LAYOUT is set, these are the

8
include/freetype/ftbdf.h
View File

@ -187,15 +187,15 @@ FT_BEGIN_HEADER
* otherwise. It also returns an error if the property is not in the * otherwise. It also returns an error if the property is not in the
* font. * font.
* *
* A `property' is a either key-value pair within the STARTPROPERTIES * A 'property' is a either key-value pair within the STARTPROPERTIES
* ... ENDPROPERTIES block of a BDF font or a key-value pair from the * ... ENDPROPERTIES block of a BDF font or a key-value pair from the
* `info->props' array within a `FontRec' structure of a PCF font. * `info->props` array within a 'FontRec' structure of a PCF font.
* *
* Integer properties are always stored as `signed' within PCF fonts; * Integer properties are always stored as 'signed' within PCF fonts;
* consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value
* for BDF fonts only. * for BDF fonts only.
* *
* In case of error, `aproperty->type' is always set to * In case of error, `aproperty->type` is always set to
* @BDF_PROPERTY_TYPE_NONE. * @BDF_PROPERTY_TYPE_NONE.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

32
include/freetype/ftbitmap.h
View File

@ -47,8 +47,8 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* This section contains functions for handling @FT_Bitmap objects. * This section contains functions for handling @FT_Bitmap objects.
* Note that none of the functions changes the bitmap's `flow' (as * Note that none of the functions changes the bitmap's 'flow' (as
* indicated by the sign of the `pitch' field in `FT_Bitmap'). * indicated by the sign of the 'pitch' field in `FT_Bitmap`).
* *
*/ */
@ -66,7 +66,7 @@ FT_BEGIN_HEADER
* A pointer to the bitmap structure. * A pointer to the bitmap structure.
* *
* @note: * @note:
* A deprecated name for the same function is `FT_Bitmap_New'. * A deprecated name for the same function is `FT_Bitmap_New`.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )
FT_Bitmap_Init( FT_Bitmap *abitmap ); FT_Bitmap_Init( FT_Bitmap *abitmap );
@ -111,8 +111,8 @@ FT_BEGIN_HEADER
* FT_Bitmap_Embolden * FT_Bitmap_Embolden
* *
* @description: * @description:
* Embolden a bitmap. The new bitmap will be about `xStrength' * Embolden a bitmap. The new bitmap will be about `xStrength`
* pixels wider and `yStrength' pixels higher. The left and bottom * pixels wider and `yStrength` pixels higher. The left and bottom
* borders are kept unchanged. * borders are kept unchanged.
* *
* @input: * @input:
@ -135,7 +135,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The current implementation restricts `xStrength' to be less than * The current implementation restricts `xStrength` to be less than
* or equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO. * or equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO.
* *
* If you want to embolden the bitmap owned by a @FT_GlyphSlotRec, * If you want to embolden the bitmap owned by a @FT_GlyphSlotRec,
@ -159,7 +159,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp * Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp
* to a bitmap object with depth 8bpp, making the number of used * to a bitmap object with depth 8bpp, making the number of used
* bytes per line (a.k.a. the `pitch') a multiple of `alignment'. * bytes per line (a.k.a. the 'pitch') a multiple of 'alignment'.
* *
* @input: * @input:
* library :: * library ::
@ -185,7 +185,7 @@ FT_BEGIN_HEADER
* *
* Use @FT_Bitmap_Done to finally remove the bitmap object. * Use @FT_Bitmap_Done to finally remove the bitmap object.
* *
* The `library' argument is taken to have access to FreeType's * The 'library' argument is taken to have access to FreeType's
* memory handling functions. * memory handling functions.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -215,11 +215,11 @@ FT_BEGIN_HEADER
* 26.6 pixel format. This can be a fractional pixel value. * 26.6 pixel format. This can be a fractional pixel value.
* *
* color :: * color ::
* The color used to draw `source' onto `target'. * The color used to draw 'source' onto 'target'.
* *
* @inout: * @inout:
* target :: * target ::
* A handle to an `FT_Bitmap' object. It should be either initialized * A handle to an `FT_Bitmap` object. It should be either initialized
* as empty with a call to @FT_Bitmap_Init, or it should be of type * as empty with a call to @FT_Bitmap_Init, or it should be of type
* @FT_PIXEL_MODE_BGRA. * @FT_PIXEL_MODE_BGRA.
* *
@ -234,12 +234,12 @@ FT_BEGIN_HEADER
* @note: * @note:
* This function doesn't perform clipping. * This function doesn't perform clipping.
* *
* The bitmap in `target' gets allocated or reallocated as needed; the * The bitmap in 'target' gets allocated or reallocated as needed; the
* vector `atarget_offset' is updated accordingly. * vector `atarget_offset` is updated accordingly.
* *
* In case of allocation or reallocation, the bitmap's pitch is set to * In case of allocation or reallocation, the bitmap's pitch is set to
* `4~*~width'. Both `source' and `target' must have the same bitmap * '4~*~width'. Both 'source' and 'target' must have the same bitmap
* flow (as indicated by the sign of the `pitch' field). * flow (as indicated by the sign of the 'pitch' field).
* *
* @since: * @since:
* 2.10 * 2.10
@ -259,7 +259,7 @@ FT_BEGIN_HEADER
* FT_GlyphSlot_Own_Bitmap * FT_GlyphSlot_Own_Bitmap
* *
* @description: * @description:
* Make sure that a glyph slot owns `slot->bitmap'. * Make sure that a glyph slot owns `slot->bitmap`.
* *
* @input: * @input:
* slot :: * slot ::
@ -295,7 +295,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The `library' argument is taken to have access to FreeType's * The 'library' argument is taken to have access to FreeType's
* memory handling functions. * memory handling functions.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

8
include/freetype/ftbzip2.h
View File

@ -55,7 +55,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Open a new stream to parse bzip2-compressed font files. This is * Open a new stream to parse bzip2-compressed font files. This is
* mainly used to support the compressed `*.pcf.bz2' fonts that come * mainly used to support the compressed `*.pcf.bz2` fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
@ -71,8 +71,8 @@ FT_BEGIN_HEADER
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close` on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
@ -84,7 +84,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a bzip2 compressed stream * compressed file, the library will try to open a bzip2 compressed stream
* from it and re-open the face with it. * from it and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with bzip2 support. * of FreeType was not compiled with bzip2 support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

72
include/freetype/ftcache.h
View File

@ -44,7 +44,7 @@ FT_BEGIN_HEADER
* objects, as well as caching information like character maps and glyph * objects, as well as caching information like character maps and glyph
* images while limiting their maximum memory usage. * images while limiting their maximum memory usage.
* *
* Note that all types and functions begin with the `FTC_' prefix. * Note that all types and functions begin with the 'FTC_' prefix.
* *
* The cache is highly portable and thus doesn't know anything about the * The cache is highly portable and thus doesn't know anything about the
* fonts installed on your system, or how to access them. This implies * fonts installed on your system, or how to access them. This implies
@ -59,7 +59,7 @@ FT_BEGIN_HEADER
* to convert an @FTC_FaceID into a new @FT_Face object. The latter is * to convert an @FTC_FaceID into a new @FT_Face object. The latter is
* then completely managed by the cache, including its termination * then completely managed by the cache, including its termination
* through @FT_Done_Face. To monitor termination of face objects, the * through @FT_Done_Face. To monitor termination of face objects, the
* finalizer callback in the `generic' field of the @FT_Face object can * finalizer callback in the 'generic' field of the @FT_Face object can
* be used, which might also be used to store the @FTC_FaceID of the * be used, which might also be used to store the @FTC_FaceID of the
* face. * face.
* *
@ -69,7 +69,7 @@ FT_BEGIN_HEADER
* possible. * possible.
* *
* Note that for the cache to work correctly, the face ID values must be * Note that for the cache to work correctly, the face ID values must be
* *persistent*, which means that the contents they point to should not * **persistent**, which means that the contents they point to should not
* change at runtime, or that their value should not become invalid. * change at runtime, or that their value should not become invalid.
* *
* If this is unavoidable (e.g., when a font is uninstalled at runtime), * If this is unavoidable (e.g., when a font is uninstalled at runtime),
@ -200,7 +200,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The third parameter `req_data' is the same as the one passed by the * The third parameter `req_data` is the same as the one passed by the
* client when @FTC_Manager_New is called. * client when @FTC_Manager_New is called.
* *
* The face requester should not perform funny things on the returned * The face requester should not perform funny things on the returned
@ -239,9 +239,9 @@ FT_BEGIN_HEADER
* *
* The manager intentionally limits the total number of opened * The manager intentionally limits the total number of opened
* @FT_Face and @FT_Size objects to control memory usage. See the * @FT_Face and @FT_Size objects to control memory usage. See the
* `max_faces' and `max_sizes' parameters of @FTC_Manager_New. * `max_faces` and `max_sizes` parameters of @FTC_Manager_New.
* *
* The manager is also used to cache `nodes' of various types while * The manager is also used to cache 'nodes' of various types while
* limiting their total memory usage. * limiting their total memory usage.
* *
* All limitations are enforced by keeping lists of managed objects * All limitations are enforced by keeping lists of managed objects
@ -261,10 +261,10 @@ FT_BEGIN_HEADER
* reference-counted. A node with a count of~0 might be flushed * reference-counted. A node with a count of~0 might be flushed
* out of a full cache whenever a lookup request is performed. * out of a full cache whenever a lookup request is performed.
* *
* If you look up nodes, you have the ability to `acquire' them, * If you look up nodes, you have the ability to 'acquire' them,
* i.e., to increment their reference count. This will prevent the * i.e., to increment their reference count. This will prevent the
* node from being flushed out of the cache until you explicitly * node from being flushed out of the cache until you explicitly
* `release' it (see @FTC_Node_Unref). * 'release' it (see @FTC_Node_Unref).
* *
* See also @FTC_SBitCache_Lookup and @FTC_ImageCache_Lookup. * See also @FTC_SBitCache_Lookup and @FTC_ImageCache_Lookup.
*/ */
@ -383,7 +383,7 @@ FT_BEGIN_HEADER
* should never try to discard it yourself. * should never try to discard it yourself.
* *
* The @FT_Face object doesn't necessarily have a current size object * The @FT_Face object doesn't necessarily have a current size object
* (i.e., face->size can be~0). If you need a specific `font size', * (i.e., face->size can be~0). If you need a specific 'font size',
* use @FTC_Manager_LookupSize instead. * use @FTC_Manager_LookupSize instead.
* *
* Never change the face's transformation matrix (i.e., never call * Never change the face's transformation matrix (i.e., never call
@ -394,7 +394,7 @@ FT_BEGIN_HEADER
* _within_ the lookup and force incremental flushes of the cache * _within_ the lookup and force incremental flushes of the cache
* until enough memory is released for the lookup to succeed. * until enough memory is released for the lookup to succeed.
* *
* If a lookup fails with `FT_Err_Out_Of_Memory' the cache has * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has
* already been completely flushed, and still no memory was available * already been completely flushed, and still no memory was available
* for the operation. * for the operation.
*/ */
@ -425,16 +425,16 @@ FT_BEGIN_HEADER
* The character height. * The character height.
* *
* pixel :: * pixel ::
* A Boolean. If 1, the `width' and `height' fields are * A Boolean. If 1, the 'width' and 'height' fields are
* interpreted as integer pixel character sizes. * interpreted as integer pixel character sizes.
* Otherwise, they are expressed as 1/64th of points. * Otherwise, they are expressed as 1/64th of points.
* *
* x_res :: * x_res ::
* Only used when `pixel' is value~0 to indicate the * Only used when 'pixel' is value~0 to indicate the
* horizontal resolution in dpi. * horizontal resolution in dpi.
* *
* y_res :: * y_res ::
* Only used when `pixel' is value~0 to indicate the * Only used when 'pixel' is value~0 to indicate the
* vertical resolution in dpi. * vertical resolution in dpi.
* *
* @note: * @note:
@ -491,7 +491,7 @@ FT_BEGIN_HEADER
* The returned @FT_Size object is always owned by the manager. You * The returned @FT_Size object is always owned by the manager. You
* should never try to discard it by yourself. * should never try to discard it by yourself.
* *
* You can access the parent @FT_Face object simply as `size->face' * You can access the parent @FT_Face object simply as `size->face`
* if you need it. Note that this object is also owned by the * if you need it. Note that this object is also owned by the
* manager. * manager.
* *
@ -500,7 +500,7 @@ FT_BEGIN_HEADER
* _within_ the lookup and force incremental flushes of the cache * _within_ the lookup and force incremental flushes of the cache
* until enough memory is released for the lookup to succeed. * until enough memory is released for the lookup to succeed.
* *
* If a lookup fails with `FT_Err_Out_Of_Memory' the cache has * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has
* already been completely flushed, and still no memory is available * already been completely flushed, and still no memory is available
* for the operation. * for the operation.
*/ */
@ -551,11 +551,11 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* This function flushes all nodes from the cache corresponding to this * This function flushes all nodes from the cache corresponding to this
* `face_id', with the exception of nodes with a non-null reference * `face_id`, with the exception of nodes with a non-null reference
* count. * count.
* *
* Such nodes are however modified internally so as to never appear * Such nodes are however modified internally so as to never appear
* in later lookups with the same `face_id' value, and to be immediately * in later lookups with the same `face_id` value, and to be immediately
* destroyed when released by all their users. * destroyed when released by all their users.
* *
*/ */
@ -630,7 +630,7 @@ FT_BEGIN_HEADER
* The character code (in the corresponding charmap). * The character code (in the corresponding charmap).
* *
* @return: * @return:
* Glyph index. 0~means `no glyph'. * Glyph index. 0~means 'no glyph'.
* *
*/ */
FT_EXPORT( FT_UInt ) FT_EXPORT( FT_UInt )
@ -777,13 +777,13 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however * Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one. * create a copy with @FT_Glyph_Copy and modify the new one.
* *
* If `anode' is _not_ NULL, it receives the address of the cache * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the glyph image, after increasing its reference * node containing the glyph image, after increasing its reference
* count. This ensures that the node (as well as the @FT_Glyph) will * count. This ensures that the node (as well as the @FT_Glyph) will
* always be kept in the cache until you call @FTC_Node_Unref to * always be kept in the cache until you call @FTC_Node_Unref to
* `release' it. * 'release' it.
* *
* If `anode' is NULL, the cache node is left unchanged, which means * If 'anode' is NULL, the cache node is left unchanged, which means
* that the @FT_Glyph could be flushed out of the cache on the next * that the @FT_Glyph could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it * call to one of the caching sub-system APIs. Don't assume that it
* is persistent! * is persistent!
@ -836,13 +836,13 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however * Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one. * create a copy with @FT_Glyph_Copy and modify the new one.
* *
* If `anode' is _not_ NULL, it receives the address of the cache * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the glyph image, after increasing its reference * node containing the glyph image, after increasing its reference
* count. This ensures that the node (as well as the @FT_Glyph) will * count. This ensures that the node (as well as the @FT_Glyph) will
* always be kept in the cache until you call @FTC_Node_Unref to * always be kept in the cache until you call @FTC_Node_Unref to
* `release' it. * 'release' it.
* *
* If `anode' is NULL, the cache node is left unchanged, which means * If 'anode' is NULL, the cache node is left unchanged, which means
* that the @FT_Glyph could be flushed out of the cache on the next * that the @FT_Glyph could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it * call to one of the caching sub-system APIs. Don't assume that it
* is persistent! * is persistent!
@ -888,12 +888,12 @@ FT_BEGIN_HEADER
* *
* left :: * left ::
* The horizontal distance from the pen position to the * The horizontal distance from the pen position to the
* left bitmap border (a.k.a. `left side bearing', or * left bitmap border (a.k.a. 'left side bearing', or
* `lsb'). * 'lsb').
* *
* top :: * top ::
* The vertical distance from the pen position (on the * The vertical distance from the pen position (on the
* baseline) to the upper bitmap border (a.k.a. `top * baseline) to the upper bitmap border (a.k.a. 'top
* side bearing'). The distance is positive for upwards * side bearing'). The distance is positive for upwards
* y~coordinates. * y~coordinates.
* *
@ -979,7 +979,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Look up a given small glyph bitmap in a given sbit cache and * Look up a given small glyph bitmap in a given sbit cache and
* `lock' it to prevent its flushing from the cache until needed. * 'lock' it to prevent its flushing from the cache until needed.
* *
* @input: * @input:
* cache :: * cache ::
@ -1009,15 +1009,15 @@ FT_BEGIN_HEADER
* as well disappear from memory on the next cache lookup, so don't * as well disappear from memory on the next cache lookup, so don't
* treat them as persistent data. * treat them as persistent data.
* *
* The descriptor's `buffer' field is set to~0 to indicate a missing * The descriptor's 'buffer' field is set to~0 to indicate a missing
* glyph bitmap. * glyph bitmap.
* *
* If `anode' is _not_ NULL, it receives the address of the cache * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the bitmap, after increasing its reference count. * node containing the bitmap, after increasing its reference count.
* This ensures that the node (as well as the image) will always be * This ensures that the node (as well as the image) will always be
* kept in the cache until you call @FTC_Node_Unref to `release' it. * kept in the cache until you call @FTC_Node_Unref to 'release' it.
* *
* If `anode' is NULL, the cache node is left unchanged, which means * If 'anode' is NULL, the cache node is left unchanged, which means
* that the bitmap could be flushed out of the cache on the next * that the bitmap could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it * call to one of the caching sub-system APIs. Don't assume that it
* is persistent! * is persistent!
@ -1070,15 +1070,15 @@ FT_BEGIN_HEADER
* as well disappear from memory on the next cache lookup, so don't * as well disappear from memory on the next cache lookup, so don't
* treat them as persistent data. * treat them as persistent data.
* *
* The descriptor's `buffer' field is set to~0 to indicate a missing * The descriptor's 'buffer' field is set to~0 to indicate a missing
* glyph bitmap. * glyph bitmap.
* *
* If `anode' is _not_ NULL, it receives the address of the cache * If 'anode' is _not_ NULL, it receives the address of the cache
* node containing the bitmap, after increasing its reference count. * node containing the bitmap, after increasing its reference count.
* This ensures that the node (as well as the image) will always be * This ensures that the node (as well as the image) will always be
* kept in the cache until you call @FTC_Node_Unref to `release' it. * kept in the cache until you call @FTC_Node_Unref to 'release' it.
* *
* If `anode' is NULL, the cache node is left unchanged, which means * If 'anode' is NULL, the cache node is left unchanged, which means
* that the bitmap could be flushed out of the cache on the next * that the bitmap could be flushed out of the cache on the next
* call to one of the caching sub-system APIs. Don't assume that it * call to one of the caching sub-system APIs. Don't assume that it
* is persistent! * is persistent!

56
include/freetype/ftcolor.h
View File

@ -41,11 +41,11 @@ FT_BEGIN_HEADER
* Glyph Color Management * Glyph Color Management
* *
* @abstract: * @abstract:
* Retrieving and manipulating OpenType's `CPAL' table data. * Retrieving and manipulating OpenType's 'CPAL' table data.
* *
* @description: * @description:
* The functions described here allow access and manipulation of color * The functions described here allow access and manipulation of color
* palette entries in OpenType's `CPAL' tables. * palette entries in OpenType's 'CPAL' tables.
*/ */
@ -55,7 +55,7 @@ FT_BEGIN_HEADER
* FT_Color * FT_Color
* *
* @description: * @description:
* This structure models a BGRA color value of a `CPAL' palette entry. * This structure models a BGRA color value of a 'CPAL' palette entry.
* *
* The used color space is sRGB; the colors are not pre-multiplied, and * The used color space is sRGB; the colors are not pre-multiplied, and
* alpha values must be explicitly set. * alpha values must be explicitly set.
@ -92,7 +92,7 @@ FT_BEGIN_HEADER
* FT_PALETTE_XXX * FT_PALETTE_XXX
* *
* @description: * @description:
* A list of bit field constants used in the `palette_flags' array of * A list of bit field constants used in the `palette_flags` array of
* the @FT_Palette_Data structure to indicate for which background a * the @FT_Palette_Data structure to indicate for which background a
* palette with a given index is usable. * palette with a given index is usable.
* *
@ -118,29 +118,29 @@ FT_BEGIN_HEADER
* FT_Palette_Data * FT_Palette_Data
* *
* @description: * @description:
* This structure holds the data of the `CPAL' table. * This structure holds the data of the 'CPAL' table.
* *
* @fields: * @fields:
* num_palettes :: * num_palettes ::
* The number of palettes. * The number of palettes.
* *
* palette_name_ids :: * palette_name_ids ::
* A read-only array of palette name IDs with `num_palettes' elements, * A read-only array of palette name IDs with `num_palettes` elements,
* corresponding to entries like `dark' or `light' in the font's * corresponding to entries like 'dark' or 'light' in the font's
* `name' table. * 'name' table.
* *
* An empty name ID in the `CPAL' table gets represented as value * An empty name ID in the 'CPAL' table gets represented as value
* 0xFFFF. * 0xFFFF.
* *
* NULL if the font's `CPAL' table doesn't contain appropriate data. * NULL if the font's 'CPAL' table doesn't contain appropriate data.
* *
* palette_flags :: * palette_flags ::
* A read-only array of palette flags with `num_palettes' elements. * A read-only array of palette flags with `num_palettes` elements.
* Possible values are an ORed combination of * Possible values are an ORed combination of
* @FT_PALETTE_FOR_LIGHT_BACKGROUND and * @FT_PALETTE_FOR_LIGHT_BACKGROUND and
* @FT_PALETTE_FOR_DARK_BACKGROUND. * @FT_PALETTE_FOR_DARK_BACKGROUND.
* *
* NULL if the font's `CPAL' table doesn't contain appropriate data. * NULL if the font's 'CPAL' table doesn't contain appropriate data.
* *
* num_palette_entries :: * num_palette_entries ::
* The number of entries in a single palette. All palettes have the * The number of entries in a single palette. All palettes have the
@ -148,17 +148,17 @@ FT_BEGIN_HEADER
* *
* palette_entry_name_ids :: * palette_entry_name_ids ::
* A read-only array of palette entry name IDs with * A read-only array of palette entry name IDs with
* `num_palette_entries'. In each palette, entries with the same * `num_palette_entries`. In each palette, entries with the same
* index have the same function. For example, index~0 might * index have the same function. For example, index~0 might
* correspond to string `outline' in the font's `name' table to * correspond to string 'outline' in the font's 'name' table to
* indicate that this palette entry is used for outlines, index~1 * indicate that this palette entry is used for outlines, index~1
* might correspond to `fill' to indicate the filling color palette * might correspond to 'fill' to indicate the filling color palette
* entry, etc. * entry, etc.
* *
* An empty entry name ID in the `CPAL' table gets represented as * An empty entry name ID in the 'CPAL' table gets represented as
* value 0xFFFF. * value 0xFFFF.
* *
* NULL if the font's `CPAL' table doesn't contain appropriate data. * NULL if the font's 'CPAL' table doesn't contain appropriate data.
* *
* @note: * @note:
* Use function @FT_Get_Sfnt_Name to map name IDs and entry name IDs to * Use function @FT_Get_Sfnt_Name to map name IDs and entry name IDs to
@ -201,7 +201,7 @@ FT_BEGIN_HEADER
* All arrays in the returned @FT_Palette_Data structure are read-only. * All arrays in the returned @FT_Palette_Data structure are read-only.
* *
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_COLOR_LAYERS' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
* *
* @since: * @since:
* 2.10 * 2.10
@ -227,7 +227,7 @@ FT_BEGIN_HEADER
* *
* A corollary of (2) is that calling the function, then modifying some * A corollary of (2) is that calling the function, then modifying some
* values, then calling the function again with the same arguments resets * values, then calling the function again with the same arguments resets
* all color entries to the original `CPAL' values; all user modifications * all color entries to the original 'CPAL' values; all user modifications
* are lost. * are lost.
* *
* @input: * @input:
@ -239,8 +239,8 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* apalette :: * apalette ::
* An array of color entries for a palette with index `palette_index'. * An array of color entries for a palette with index `palette_index`.
* If `apalette' is set to NULL, no array gets returned (and no color * If 'apalette' is set to NULL, no array gets returned (and no color
* entries can be modified). * entries can be modified).
* *
* In case the font doesn't support color palettes, NULL is returned. * In case the font doesn't support color palettes, NULL is returned.
@ -249,14 +249,14 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The number of color entries is given by the `num_palette_entries' * The number of color entries is given by the `num_palette_entries`
* field in the @FT_Palette_Data structure. * field in the @FT_Palette_Data structure.
* *
* The array pointed to by `apalette_entries' is owned and managed by * The array pointed to by `apalette_entries` is owned and managed by
* FreeType. * FreeType.
* *
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_COLOR_LAYERS' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
* *
* @since: * @since:
* 2.10 * 2.10
@ -273,7 +273,7 @@ FT_BEGIN_HEADER
* FT_Palette_Set_Foreground_Color * FT_Palette_Set_Foreground_Color
* *
* @description: * @description:
* `COLR' uses palette index 0xFFFF to indicate a `text foreground * 'COLR' uses palette index 0xFFFF to indicate a 'text foreground
* color'. This function sets this value. * color'. This function sets this value.
* *
* @input: * @input:
@ -281,7 +281,7 @@ FT_BEGIN_HEADER
* The source face handle. * The source face handle.
* *
* foreground_color :: * foreground_color ::
* An `FT_Color' structure to define the text foreground color. * An `FT_Color` structure to define the text foreground color.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -291,11 +291,11 @@ FT_BEGIN_HEADER
* white opaque (BGRA value 0xFFFFFFFF) if * white opaque (BGRA value 0xFFFFFFFF) if
* @FT_PALETTE_FOR_DARK_BACKGROUND is present for the current * @FT_PALETTE_FOR_DARK_BACKGROUND is present for the current
* palette, and black opaque (BGRA value 0x000000FF) otherwise, * palette, and black opaque (BGRA value 0x000000FF) otherwise,
* including the case that no palette types are available in the `CPAL' * including the case that no palette types are available in the 'CPAL'
* table. * table.
* *
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_COLOR_LAYERS' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`.
* *
* @since: * @since:
* 2.10 * 2.10

298
include/freetype/ftdriver.h
View File

@ -50,7 +50,7 @@ FT_BEGIN_HEADER
* @FT_Property_Get. The following lists the available properties * @FT_Property_Get. The following lists the available properties
* together with the necessary macros and structures. * together with the necessary macros and structures.
* *
* Note that the auto-hinter's module name is `autofitter' for * Note that the auto-hinter's module name is 'autofitter' for
* historical reasons. * historical reasons.
* *
* Available properties are @increase-x-height, @no-stem-darkening * Available properties are @increase-x-height, @no-stem-darkening
@ -78,14 +78,14 @@ FT_BEGIN_HEADER
* it is possible to control its behaviour with @FT_Property_Set and * it is possible to control its behaviour with @FT_Property_Set and
* @FT_Property_Get. * @FT_Property_Get.
* *
* The CFF driver's module name is `cff'. * The CFF driver's module name is 'cff'.
* *
* Available properties are @hinting-engine, @no-stem-darkening, * Available properties are @hinting-engine, @no-stem-darkening,
* @darkening-parameters, and @random-seed, as documented in the * @darkening-parameters, and @random-seed, as documented in the
* @properties section. * @properties section.
* *
* *
* *Hinting* *and* *antialiasing* *principles* *of* *the* *new* *engine* * **Hinting and antialiasing principles of the new engine**
* *
* The rasterizer is positioning horizontal features (e.g., ascender * The rasterizer is positioning horizontal features (e.g., ascender
* height & x-height, or crossbars) on the pixel grid and minimizing the * height & x-height, or crossbars) on the pixel grid and minimizing the
@ -93,14 +93,14 @@ FT_BEGIN_HEADER
* features (vertical stems) on the pixel grid without hinting, thus * features (vertical stems) on the pixel grid without hinting, thus
* representing the stem position and weight accurately. Sometimes the * representing the stem position and weight accurately. Sometimes the
* vertical stems may be only partially black. In this context, * vertical stems may be only partially black. In this context,
* `antialiasing' means that stems are not positioned exactly on pixel * 'antialiasing' means that stems are not positioned exactly on pixel
* borders, causing a fuzzy appearance. * borders, causing a fuzzy appearance.
* *
* There are two principles behind this approach. * There are two principles behind this approach.
* *
* 1) No hinting in the horizontal direction: Unlike `superhinted' * 1) No hinting in the horizontal direction: Unlike 'superhinted'
* TrueType, which changes glyph widths to accommodate regular * TrueType, which changes glyph widths to accommodate regular
* inter-glyph spacing, Adobe's approach is `faithful to the design' in * inter-glyph spacing, Adobe's approach is 'faithful to the design' in
* representing both the glyph width and the inter-glyph spacing * representing both the glyph width and the inter-glyph spacing
* designed for the font. This makes the screen display as close as it * designed for the font. This makes the screen display as close as it
* can be to the result one would get with infinite resolution, while * can be to the result one would get with infinite resolution, while
@ -132,13 +132,13 @@ FT_BEGIN_HEADER
* *
* On the technical side, horizontal alignment zones for ascender, * On the technical side, horizontal alignment zones for ascender,
* x-height, and other important height values (traditionally called * x-height, and other important height values (traditionally called
* `blue zones') as defined in the font are positioned independently, * 'blue zones') as defined in the font are positioned independently,
* each being rounded to the nearest pixel edge, taking care of * each being rounded to the nearest pixel edge, taking care of
* overshoot suppression at small sizes, stem darkening, and scaling. * overshoot suppression at small sizes, stem darkening, and scaling.
* *
* Hstems (this is, hint values defined in the font to help align * Hstems (this is, hint values defined in the font to help align
* horizontal features) that fall within a blue zone are said to be * horizontal features) that fall within a blue zone are said to be
* `captured' and are aligned to that zone. Uncaptured stems are moved * 'captured' and are aligned to that zone. Uncaptured stems are moved
* in one of four ways, top edge up or down, bottom edge up or down. * in one of four ways, top edge up or down, bottom edge up or down.
* Unless there are conflicting hstems, the smallest movement is taken * Unless there are conflicting hstems, the smallest movement is taken
* to minimize distortion. * to minimize distortion.
@ -164,7 +164,7 @@ FT_BEGIN_HEADER
* @no-long-family-names available if FreeType is compiled with * @no-long-family-names available if FreeType is compiled with
* PCF_CONFIG_OPTION_LONG_FAMILY_NAMES. * PCF_CONFIG_OPTION_LONG_FAMILY_NAMES.
* *
* The PCF driver's module name is `pcf'. * The PCF driver's module name is 'pcf'.
* *
*/ */
@ -187,8 +187,8 @@ FT_BEGIN_HEADER
* Behind the scenes, both drivers use the Adobe CFF engine for hinting; * Behind the scenes, both drivers use the Adobe CFF engine for hinting;
* however, the used properties must be specified separately. * however, the used properties must be specified separately.
* *
* The Type~1 driver's module name is `type1'; the CID driver's module * The Type~1 driver's module name is 'type1'; the CID driver's module
* name is `t1cid'. * name is 't1cid'.
* *
* Available properties are @hinting-engine, @no-stem-darkening, * Available properties are @hinting-engine, @no-stem-darkening,
* @darkening-parameters, and @random-seed, as documented in the * @darkening-parameters, and @random-seed, as documented in the
@ -217,7 +217,7 @@ FT_BEGIN_HEADER
* and @FT_Property_Get. The following lists the available properties * and @FT_Property_Get. The following lists the available properties
* together with the necessary macros and structures. * together with the necessary macros and structures.
* *
* The TrueType driver's module name is `truetype'. * The TrueType driver's module name is 'truetype'.
* *
* A single property @interpreter-version is available, as documented in * A single property @interpreter-version is available, as documented in
* the @properties section. * the @properties section.
@ -225,7 +225,7 @@ FT_BEGIN_HEADER
* We start with a list of definitions, kindly provided by Greg * We start with a list of definitions, kindly provided by Greg
* Hitchcock. * Hitchcock.
* *
* _Bi-Level_ _Rendering_ * _Bi-Level Rendering_
* *
* Monochromatic rendering, exclusively used in the early days of * Monochromatic rendering, exclusively used in the early days of
* TrueType by both Apple and Microsoft. Microsoft's GDI interface * TrueType by both Apple and Microsoft. Microsoft's GDI interface
@ -234,27 +234,27 @@ FT_BEGIN_HEADER
* achieve some level of glyph symmetry. To enable reasonable * achieve some level of glyph symmetry. To enable reasonable
* performance (e.g., not having to run hinting on all glyphs just to * performance (e.g., not having to run hinting on all glyphs just to
* get the widths) there was a bit in the head table indicating if the * get the widths) there was a bit in the head table indicating if the
* side bearing was hinted, and additional tables, `hdmx' and `LTSH', to * side bearing was hinted, and additional tables, 'hdmx' and 'LTSH', to
* cache hinting widths across multiple sizes and device aspect ratios. * cache hinting widths across multiple sizes and device aspect ratios.
* *
* _Font_ _Smoothing_ * _Font Smoothing_
* *
* Microsoft's GDI implementation of anti-aliasing. Not traditional * Microsoft's GDI implementation of anti-aliasing. Not traditional
* anti-aliasing as the outlines were hinted before the sampling. The * anti-aliasing as the outlines were hinted before the sampling. The
* widths matched the bi-level rendering. * widths matched the bi-level rendering.
* *
* _ClearType_ _Rendering_ * _ClearType Rendering_
* *
* Technique that uses physical subpixels to improve rendering on LCD * Technique that uses physical subpixels to improve rendering on LCD
* (and other) displays. Because of the higher resolution, many methods * (and other) displays. Because of the higher resolution, many methods
* of improving symmetry in glyphs through hinting the right-side * of improving symmetry in glyphs through hinting the right-side
* bearing were no longer necessary. This lead to what GDI calls * bearing were no longer necessary. This lead to what GDI calls
* `natural widths' ClearType, see * 'natural widths' ClearType, see
* http://www.beatstamm.com/typography/RTRCh4.htm#Sec21. Since hinting * http://www.beatstamm.com/typography/RTRCh4.htm#Sec21. Since hinting
* has extra resolution, most non-linearity went away, but it is still * has extra resolution, most non-linearity went away, but it is still
* possible for hints to change the advance widths in this mode. * possible for hints to change the advance widths in this mode.
* *
* _ClearType_ _Compatible_ _Widths_ * _ClearType Compatible Widths_
* *
* One of the earliest challenges with ClearType was allowing the * One of the earliest challenges with ClearType was allowing the
* implementation in GDI to be selected without requiring all UI and * implementation in GDI to be selected without requiring all UI and
@ -267,20 +267,20 @@ FT_BEGIN_HEADER
* definition, compatible width ClearType allows for non-linear widths, * definition, compatible width ClearType allows for non-linear widths,
* but only when the bi-level version has non-linear widths. * but only when the bi-level version has non-linear widths.
* *
* _ClearType_ _Subpixel_ _Positioning_ * _ClearType Subpixel Positioning_
* *
* One of the nice benefits of ClearType is the ability to more crisply * One of the nice benefits of ClearType is the ability to more crisply
* display fractional widths; unfortunately, the GDI model of integer * display fractional widths; unfortunately, the GDI model of integer
* bitmaps did not support this. However, the WPF and Direct Write * bitmaps did not support this. However, the WPF and Direct Write
* frameworks do support fractional widths. DWrite calls this `natural * frameworks do support fractional widths. DWrite calls this 'natural
* mode', not to be confused with GDI's `natural widths'. Subpixel * mode', not to be confused with GDI's 'natural widths'. Subpixel
* positioning, in the current implementation of Direct Write, * positioning, in the current implementation of Direct Write,
* unfortunately does not support hinted advance widths, see * unfortunately does not support hinted advance widths, see
* http://www.beatstamm.com/typography/RTRCh4.htm#Sec22. Note that the * http://www.beatstamm.com/typography/RTRCh4.htm#Sec22. Note that the
* TrueType interpreter fully allows the advance width to be adjusted in * TrueType interpreter fully allows the advance width to be adjusted in
* this mode, just the DWrite client will ignore those changes. * this mode, just the DWrite client will ignore those changes.
* *
* _ClearType_ _Backward_ _Compatibility_ * _ClearType Backward Compatibility_
* *
* This is a set of exceptions made in the TrueType interpreter to * This is a set of exceptions made in the TrueType interpreter to
* minimize hinting techniques that were problematic with the extra * minimize hinting techniques that were problematic with the extra
@ -293,9 +293,9 @@ FT_BEGIN_HEADER
* disabling some deltas. This could be worked around in backward * disabling some deltas. This could be worked around in backward
* compatibility mode. * compatibility mode.
* *
* _Native_ _ClearType_ _Mode_ * _Native ClearType Mode_
* *
* (Not to be confused with `natural widths'.) This mode removes all * (Not to be confused with 'natural widths'.) This mode removes all
* the exceptions in the TrueType interpreter when running with * the exceptions in the TrueType interpreter when running with
* ClearType. Any issues on widths would still apply, though. * ClearType. Any issues on widths would still apply, though.
* *
@ -357,31 +357,31 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Thanks to Adobe, which contributed a new hinting (and parsing) * Thanks to Adobe, which contributed a new hinting (and parsing)
* engine, an application can select between `freetype' and `adobe' if * engine, an application can select between 'freetype' and 'adobe' if
* compiled with CFF_CONFIG_OPTION_OLD_ENGINE. If this configuration * compiled with CFF_CONFIG_OPTION_OLD_ENGINE. If this configuration
* macro isn't defined, `hinting-engine' does nothing. * macro isn't defined, 'hinting-engine' does nothing.
* *
* The same holds for the Type~1 and CID modules if compiled with * The same holds for the Type~1 and CID modules if compiled with
* T1_CONFIG_OPTION_OLD_ENGINE. * T1_CONFIG_OPTION_OLD_ENGINE.
* *
* For the `cff' module, the default engine is `freetype' if * For the 'cff' module, the default engine is 'freetype' if
* CFF_CONFIG_OPTION_OLD_ENGINE is defined, and `adobe' otherwise. * CFF_CONFIG_OPTION_OLD_ENGINE is defined, and 'adobe' otherwise.
* *
* For both the `type1' and `t1cid' modules, the default engine is * For both the 'type1' and 't1cid' modules, the default engine is
* `freetype' if T1_CONFIG_OPTION_OLD_ENGINE is defined, and `adobe' * 'freetype' if T1_CONFIG_OPTION_OLD_ENGINE is defined, and 'adobe'
* otherwise. * otherwise.
* *
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable (using values `adobe' or `freetype'). * variable (using values 'adobe' or 'freetype').
* *
* @example: * @example:
* The following example code demonstrates how to select Adobe's hinting * The following example code demonstrates how to select Adobe's hinting
* engine for the `cff' module (omitting the error handling). * engine for the 'cff' module (omitting the error handling).
* *
* { * ```
* FT_Library library; * FT_Library library;
* FT_UInt hinting_engine = FT_CFF_HINTING_ADOBE; * FT_UInt hinting_engine = FT_CFF_HINTING_ADOBE;
* *
@ -390,12 +390,12 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "cff", * FT_Property_Set( library, "cff",
* "hinting-engine", &hinting_engine ); * "hinting-engine", &hinting_engine );
* } * ```
* *
* @since: * @since:
* 2.4.12 (for `cff' module) * 2.4.12 (for 'cff' module)
* *
* 2.9 (for `type1' and `t1cid' modules) * 2.9 (for 'type1' and 't1cid' modules)
* *
*/ */
@ -408,7 +408,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* All glyphs that pass through the auto-hinter will be emboldened * All glyphs that pass through the auto-hinter will be emboldened
* unless this property is set to TRUE. The same is true for the CFF, * unless this property is set to TRUE. The same is true for the CFF,
* Type~1, and CID font modules if the `Adobe' engine is selected (which * Type~1, and CID font modules if the 'Adobe' engine is selected (which
* is the default). * is the default).
* *
* Stem darkening emboldens glyphs at smaller sizes to make them more * Stem darkening emboldens glyphs at smaller sizes to make them more
@ -420,12 +420,12 @@ FT_BEGIN_HEADER
* Gamma correction essentially lightens fonts since shades of grey are * Gamma correction essentially lightens fonts since shades of grey are
* shifted to higher pixel values (=~higher brightness) to match the * shifted to higher pixel values (=~higher brightness) to match the
* original intention to the reality of our screens. The side-effect is * original intention to the reality of our screens. The side-effect is
* that glyphs `thin out'. Mac OS~X and Adobe's proprietary font * that glyphs 'thin out'. Mac OS~X and Adobe's proprietary font
* rendering library implement a counter-measure: stem darkening at * rendering library implement a counter-measure: stem darkening at
* smaller sizes where shades of gray dominate. By emboldening a glyph * smaller sizes where shades of gray dominate. By emboldening a glyph
* slightly in relation to its pixel size, individual pixels get higher * slightly in relation to its pixel size, individual pixels get higher
* coverage of filled-in outlines and are therefore `blacker'. This * coverage of filled-in outlines and are therefore 'blacker'. This
* counteracts the `thinning out' of glyphs, making text remain readable * counteracts the 'thinning out' of glyphs, making text remain readable
* at smaller sizes. * at smaller sizes.
* *
* By default, the Adobe engines for CFF, Type~1, and CID fonts darken * By default, the Adobe engines for CFF, Type~1, and CID fonts darken
@ -433,7 +433,7 @@ FT_BEGIN_HEADER
* Setting this property, stem darkening gets switched off. * Setting this property, stem darkening gets switched off.
* *
* For the auto-hinter, stem-darkening is experimental currently and * For the auto-hinter, stem-darkening is experimental currently and
* thus switched off by default (this is, `no-stem-darkening' is set to * thus switched off by default (this is, 'no-stem-darkening' is set to
* TRUE by default). Total consistency with the CFF driver is not * TRUE by default). Total consistency with the CFF driver is not
* achieved right now because the emboldening method differs and glyphs * achieved right now because the emboldening method differs and glyphs
* must be scaled down on the Y-axis to keep outline points inside their * must be scaled down on the Y-axis to keep outline points inside their
@ -446,13 +446,13 @@ FT_BEGIN_HEADER
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable (using values 1 and 0 for `on' and `off', respectively). * variable (using values 1 and 0 for 'on' and 'off', respectively).
* It can also be set per face using @FT_Face_Properties with * It can also be set per face using @FT_Face_Properties with
* @FT_PARAM_TAG_STEM_DARKENING. * @FT_PARAM_TAG_STEM_DARKENING.
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_Bool no_stem_darkening = TRUE; * FT_Bool no_stem_darkening = TRUE;
* *
@ -461,14 +461,14 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "cff", * FT_Property_Set( library, "cff",
* "no-stem-darkening", &no_stem_darkening ); * "no-stem-darkening", &no_stem_darkening );
* } * ```
* *
* @since: * @since:
* 2.4.12 (for `cff' module) * 2.4.12 (for 'cff' module)
* *
* 2.6.2 (for `autofitter' module) * 2.6.2 (for 'autofitter' module)
* *
* 2.9 (for `type1' and `t1cid' modules) * 2.9 (for 'type1' and 't1cid' modules)
* *
*/ */
@ -481,20 +481,20 @@ FT_BEGIN_HEADER
* @description: * @description:
* By default, the Adobe hinting engine, as used by the CFF, Type~1, and * By default, the Adobe hinting engine, as used by the CFF, Type~1, and
* CID font drivers, darkens stems as follows (if the * CID font drivers, darkens stems as follows (if the
* `no-stem-darkening' property isn't set): * 'no-stem-darkening' property isn't set):
* *
* { * ```
* stem width <= 0.5px: darkening amount = 0.4px * stem width <= 0.5px: darkening amount = 0.4px
* stem width = 1px: darkening amount = 0.275px * stem width = 1px: darkening amount = 0.275px
* stem width = 1.667px: darkening amount = 0.275px * stem width = 1.667px: darkening amount = 0.275px
* stem width >= 2.333px: darkening amount = 0px * stem width >= 2.333px: darkening amount = 0px
* } * ```
* *
* and piecewise linear in-between. At configuration time, these four * and piecewise linear in-between. At configuration time, these four
* control points can be set with the macro * control points can be set with the macro
* `CFF_CONFIG_OPTION_DARKENING_PARAMETERS'; the CFF, Type~1, and CID * `CFF_CONFIG_OPTION_DARKENING_PARAMETERS`; the CFF, Type~1, and CID
* drivers share these values. At runtime, the control points can be * drivers share these values. At runtime, the control points can be
* changed using the `darkening-parameters' property (see the example * changed using the 'darkening-parameters' property (see the example
* below that demonstrates this for the Type~1 driver). * below that demonstrates this for the Type~1 driver).
* *
* The x~values give the stem width, and the y~values the darkening * The x~values give the stem width, and the y~values the darkening
@ -510,17 +510,17 @@ FT_BEGIN_HEADER
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable, using eight comma-separated integers without spaces. Here * variable, using eight comma-separated integers without spaces. Here
* the above example, using `\' to break the line for readability. * the above example, using '\' to break the line for readability.
* *
* { * ```
* FREETYPE_PROPERTIES=\ * FREETYPE_PROPERTIES=\
* type1:darkening-parameters=500,300,1000,200,1500,100,2000,0 * type1:darkening-parameters=500,300,1000,200,1500,100,2000,0
* } * ```
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_Int darken_params[8] = { 500, 300, // x1, y1 * FT_Int darken_params[8] = { 500, 300, // x1, y1
* 1000, 200, // x2, y2 * 1000, 200, // x2, y2
@ -532,14 +532,14 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "type1", * FT_Property_Set( library, "type1",
* "darkening-parameters", darken_params ); * "darkening-parameters", darken_params );
* } * ```
* *
* @since: * @since:
* 2.5.1 (for `cff' module) * 2.5.1 (for 'cff' module)
* *
* 2.6.2 (for `autofitter' module) * 2.6.2 (for 'autofitter' module)
* *
* 2.9 (for `type1' and `t1cid' modules) * 2.9 (for 'type1' and 't1cid' modules)
* *
*/ */
@ -550,29 +550,29 @@ FT_BEGIN_HEADER
* random-seed * random-seed
* *
* @description: * @description:
* By default, the seed value for the CFF `random' operator and the * By default, the seed value for the CFF 'random' operator and the
* similar `0 28 callothersubr pop' command for the Type~1 and CID * similar '0 28 callothersubr pop' command for the Type~1 and CID
* drivers is set to a random value. However, mainly for debugging * drivers is set to a random value. However, mainly for debugging
* purposes, it is often necessary to use a known value as a seed so * purposes, it is often necessary to use a known value as a seed so
* that the pseudo-random number sequences generated by `random' are * that the pseudo-random number sequences generated by 'random' are
* repeatable. * repeatable.
* *
* The `random-seed' property does that. Its argument is a signed 32bit * The 'random-seed' property does that. Its argument is a signed 32bit
* integer; if the value is zero or negative, the seed given by the * integer; if the value is zero or negative, the seed given by the
* `intitialRandomSeed' private DICT operator in a CFF file gets used * `intitialRandomSeed` private DICT operator in a CFF file gets used
* (or a default value if there is no such operator). If the value is * (or a default value if there is no such operator). If the value is
* positive, use it instead of `initialRandomSeed', which is * positive, use it instead of `initialRandomSeed`, which is
* consequently ignored. * consequently ignored.
* *
* @note: * @note:
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable. It can also be set per face using @FT_Face_Properties with * variable. It can also be set per face using @FT_Face_Properties with
* @FT_PARAM_TAG_RANDOM_SEED. * @FT_PARAM_TAG_RANDOM_SEED.
* *
* @since: * @since:
* 2.8 (for `cff' module) * 2.8 (for 'cff' module)
* *
* 2.9 (for `type1' and `t1cid' modules) * 2.9 (for 'type1' and 't1cid' modules)
* *
*/ */
@ -586,25 +586,25 @@ FT_BEGIN_HEADER
* If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling * If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling
* FreeType, the PCF driver constructs long family names. * FreeType, the PCF driver constructs long family names.
* *
* There are many PCF fonts just called `Fixed' which look completely * There are many PCF fonts just called 'Fixed' which look completely
* different, and which have nothing to do with each other. When * different, and which have nothing to do with each other. When
* selecting `Fixed' in KDE or Gnome one gets results that appear rather * selecting 'Fixed' in KDE or Gnome one gets results that appear rather
* random, the style changes often if one changes the size and one * random, the style changes often if one changes the size and one
* cannot select some fonts at all. The improve this situation, the PCF * cannot select some fonts at all. The improve this situation, the PCF
* module prepends the foundry name (plus a space) to the family name. * module prepends the foundry name (plus a space) to the family name.
* It also checks whether there are `wide' characters; all put together, * It also checks whether there are 'wide' characters; all put together,
* family names like `Sony Fixed' or `Misc Fixed Wide' are constructed. * family names like 'Sony Fixed' or 'Misc Fixed Wide' are constructed.
* *
* If `no-long-family-names' is set, this feature gets switched off. * If 'no-long-family-names' is set, this feature gets switched off.
* *
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable (using values 1 and 0 for `on' and `off', respectively). * variable (using values 1 and 0 for 'on' and 'off', respectively).
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_Bool no_long_family_names = TRUE; * FT_Bool no_long_family_names = TRUE;
* *
@ -614,7 +614,7 @@ FT_BEGIN_HEADER
* FT_Property_Set( library, "pcf", * FT_Property_Set( library, "pcf",
* "no-long-family-names", * "no-long-family-names",
* &no_long_family_names ); * &no_long_family_names );
* } * ```
* *
* @since: * @since:
* 2.8 * 2.8
@ -631,7 +631,7 @@ FT_BEGIN_HEADER
* select the hinting engine for Truetype fonts. * select the hinting engine for Truetype fonts.
* *
* The numeric value in the constant names represents the version * The numeric value in the constant names represents the version
* number as returned by the `GETINFO' bytecode instruction. * number as returned by the 'GETINFO' bytecode instruction.
* *
* @values: * @values:
* TT_INTERPRETER_VERSION_35 :: * TT_INTERPRETER_VERSION_35 ::
@ -642,7 +642,7 @@ FT_BEGIN_HEADER
* Version~38 corresponds to MS rasterizer v.1.9; it is roughly * Version~38 corresponds to MS rasterizer v.1.9; it is roughly
* equivalent to the hinting provided by DirectWrite ClearType (as can * equivalent to the hinting provided by DirectWrite ClearType (as can
* be found, for example, in the Internet Explorer~9 running on * be found, for example, in the Internet Explorer~9 running on
* Windows~7). It is used in FreeType to select the `Infinality' * Windows~7). It is used in FreeType to select the 'Infinality'
* subpixel hinting code. The code may be removed in a future * subpixel hinting code. The code may be removed in a future
* version. * version.
* *
@ -650,30 +650,30 @@ FT_BEGIN_HEADER
* Version~40 corresponds to MS rasterizer v.2.1; it is roughly * Version~40 corresponds to MS rasterizer v.2.1; it is roughly
* equivalent to the hinting provided by DirectWrite ClearType (as can * equivalent to the hinting provided by DirectWrite ClearType (as can
* be found, for example, in Microsoft's Edge Browser on Windows~10). * be found, for example, in Microsoft's Edge Browser on Windows~10).
* It is used in FreeType to select the `minimal' subpixel hinting * It is used in FreeType to select the 'minimal' subpixel hinting
* code, a stripped-down and higher performance version of the * code, a stripped-down and higher performance version of the
* `Infinality' code. * 'Infinality' code.
* *
* @note: * @note:
* This property controls the behaviour of the bytecode interpreter * This property controls the behaviour of the bytecode interpreter
* and thus how outlines get hinted. It does *not* control how glyph * and thus how outlines get hinted. It does **not** control how glyph
* get rasterized! In particular, it does not control subpixel color * get rasterized! In particular, it does not control subpixel color
* filtering. * filtering.
* *
* If FreeType has not been compiled with the configuration option * If FreeType has not been compiled with the configuration option
* TT_CONFIG_OPTION_SUBPIXEL_HINTING, selecting version~38 or~40 causes * TT_CONFIG_OPTION_SUBPIXEL_HINTING, selecting version~38 or~40 causes
* an `FT_Err_Unimplemented_Feature' error. * an `FT_Err_Unimplemented_Feature` error.
* *
* Depending on the graphics framework, Microsoft uses different * Depending on the graphics framework, Microsoft uses different
* bytecode and rendering engines. As a consequence, the version * bytecode and rendering engines. As a consequence, the version
* numbers returned by a call to the `GETINFO' bytecode instruction are * numbers returned by a call to the 'GETINFO' bytecode instruction are
* more convoluted than desired. * more convoluted than desired.
* *
* Here are two tables that try to shed some light on the possible * Here are two tables that try to shed some light on the possible
* values for the MS rasterizer engine, together with the additional * values for the MS rasterizer engine, together with the additional
* features introduced by it. * features introduced by it.
* *
* { * ```
* GETINFO framework version feature * GETINFO framework version feature
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* 3 GDI (Win 3.1), v1.0 16-bit, first version * 3 GDI (Win 3.1), v1.0 16-bit, first version
@ -696,15 +696,15 @@ FT_BEGIN_HEADER
* 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag * 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag
* DWrite (Win 8) in GETINFO opcode, * DWrite (Win 8) in GETINFO opcode,
* Gray ClearType * Gray ClearType
* } * ```
* *
* The `version' field gives a rough orientation only, since some * The 'version' field gives a rough orientation only, since some
* applications provided certain features much earlier (as an example, * applications provided certain features much earlier (as an example,
* Microsoft Reader used subpixel and Y-direction ClearType already in * Microsoft Reader used subpixel and Y-direction ClearType already in
* Windows 2000). Similarly, updates to a given framework might include * Windows 2000). Similarly, updates to a given framework might include
* improved hinting support. * improved hinting support.
* *
* { * ```
* version sampling rendering comment * version sampling rendering comment
* x y x y * x y x y
* -------------------------------------------------------------- * --------------------------------------------------------------
@ -714,28 +714,28 @@ FT_BEGIN_HEADER
* v1.9 high high color-filter gray Color ClearType * v1.9 high high color-filter gray Color ClearType
* v2.1 high normal gray B/W Gray ClearType * v2.1 high normal gray B/W Gray ClearType
* v2.1 high high gray gray Gray ClearType * v2.1 high high gray gray Gray ClearType
* } * ```
* *
* Color and Gray ClearType are the two available variants of * Color and Gray ClearType are the two available variants of
* `Y-direction ClearType', meaning grayscale rasterization along the * 'Y-direction ClearType', meaning grayscale rasterization along the
* Y-direction; the name used in the TrueType specification for this * Y-direction; the name used in the TrueType specification for this
* feature is `symmetric smoothing'. `Classic ClearType' is the * feature is 'symmetric smoothing'. 'Classic ClearType' is the
* original algorithm used before introducing a modified version in * original algorithm used before introducing a modified version in
* Win~XP. Another name for v1.6's grayscale rendering is `font * Win~XP. Another name for v1.6's grayscale rendering is 'font
* smoothing', and `Color ClearType' is sometimes also called `DWrite * smoothing', and 'Color ClearType' is sometimes also called 'DWrite
* ClearType'. To differentiate between today's Color ClearType and the * ClearType'. To differentiate between today's Color ClearType and the
* earlier ClearType variant with B/W rendering along the vertical axis, * earlier ClearType variant with B/W rendering along the vertical axis,
* the latter is sometimes called `GDI ClearType'. * the latter is sometimes called 'GDI ClearType'.
* *
* `Normal' and `high' sampling describe the (virtual) resolution to * 'Normal' and 'high' sampling describe the (virtual) resolution to
* access the rasterized outline after the hinting process. `Normal' * access the rasterized outline after the hinting process. 'Normal'
* means 1 sample per grid line (i.e., B/W). In the current Microsoft * means 1 sample per grid line (i.e., B/W). In the current Microsoft
* implementation, `high' means an extra virtual resolution of 16x16 (or * implementation, 'high' means an extra virtual resolution of 16x16 (or
* 16x1) grid lines per pixel for bytecode instructions like `MIRP'. * 16x1) grid lines per pixel for bytecode instructions like 'MIRP'.
* After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid * After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid
* lines for color filtering if Color ClearType is activated. * lines for color filtering if Color ClearType is activated.
* *
* Note that `Gray ClearType' is essentially the same as v1.6's * Note that 'Gray ClearType' is essentially the same as v1.6's
* grayscale rendering. However, the GETINFO instruction handles it * grayscale rendering. However, the GETINFO instruction handles it
* differently: v1.6 returns bit~12 (hinting for grayscale), while v2.1 * differently: v1.6 returns bit~12 (hinting for grayscale), while v2.1
* returns bits~13 (hinting for ClearType), 18 (symmetrical smoothing), * returns bits~13 (hinting for ClearType), 18 (symmetrical smoothing),
@ -760,14 +760,14 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Currently, three versions are available, two representing the * Currently, three versions are available, two representing the
* bytecode interpreter with subpixel hinting support (old `Infinality' * bytecode interpreter with subpixel hinting support (old 'Infinality'
* code and new stripped-down and higher performance `minimal' code) and * code and new stripped-down and higher performance 'minimal' code) and
* one without, respectively. The default is subpixel support if * one without, respectively. The default is subpixel support if
* TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel support * TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel support
* otherwise (since it isn't available then). * otherwise (since it isn't available then).
* *
* If subpixel hinting is on, many TrueType bytecode instructions behave * If subpixel hinting is on, many TrueType bytecode instructions behave
* differently compared to B/W or grayscale rendering (except if `native * differently compared to B/W or grayscale rendering (except if 'native
* ClearType' is selected by the font). Microsoft's main idea is to * ClearType' is selected by the font). Microsoft's main idea is to
* render at a much increased horizontal resolution, then sampling down * render at a much increased horizontal resolution, then sampling down
* the created output to subpixel precision. However, many older fonts * the created output to subpixel precision. However, many older fonts
@ -776,8 +776,8 @@ FT_BEGIN_HEADER
* *
* Details on subpixel hinting and some of the necessary tweaks can be * Details on subpixel hinting and some of the necessary tweaks can be
* found in Greg Hitchcock's whitepaper at * found in Greg Hitchcock's whitepaper at
* `https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'. * 'https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'.
* Note that FreeType currently doesn't really `subpixel hint' (6x1, 6x2, * Note that FreeType currently doesn't really 'subpixel hint' (6x1, 6x2,
* or 6x5 supersampling) like discussed in the paper. Depending on the * or 6x5 supersampling) like discussed in the paper. Depending on the
* chosen interpreter, it simply ignores instructions on vertical stems * chosen interpreter, it simply ignores instructions on vertical stems
* to arrive at very similar results. * to arrive at very similar results.
@ -785,14 +785,14 @@ FT_BEGIN_HEADER
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable (using values `35', `38', or `40'). * variable (using values '35', '38', or '40').
* *
* @example: * @example:
* The following example code demonstrates how to deactivate subpixel * The following example code demonstrates how to deactivate subpixel
* hinting (omitting the error handling). * hinting (omitting the error handling).
* *
* { * ```
* FT_Library library; * FT_Library library;
* FT_Face face; * FT_Face face;
* FT_UInt interpreter_version = TT_INTERPRETER_VERSION_35; * FT_UInt interpreter_version = TT_INTERPRETER_VERSION_35;
@ -803,7 +803,7 @@ FT_BEGIN_HEADER
* FT_Property_Set( library, "truetype", * FT_Property_Set( library, "truetype",
* "interpreter-version", * "interpreter-version",
* &interpreter_version ); * &interpreter_version );
* } * ```
* *
* @since: * @since:
* 2.5 * 2.5
@ -816,7 +816,7 @@ FT_BEGIN_HEADER
* glyph-to-script-map * glyph-to-script-map
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* The auto-hinter provides various script modules to hint glyphs. * The auto-hinter provides various script modules to hint glyphs.
* Examples of supported scripts are Latin or CJK. Before a glyph is * Examples of supported scripts are Latin or CJK. Before a glyph is
@ -826,14 +826,14 @@ FT_BEGIN_HEADER
* *
* OpenType fonts, however, often provide much more glyphs than * OpenType fonts, however, often provide much more glyphs than
* character codes (small caps, superscripts, ligatures, swashes, etc.), * character codes (small caps, superscripts, ligatures, swashes, etc.),
* to be controlled by so-called `features'. Handling OpenType features * to be controlled by so-called 'features'. Handling OpenType features
* can be quite complicated and thus needs a separate library on top of * can be quite complicated and thus needs a separate library on top of
* FreeType. * FreeType.
* *
* The mapping between glyph indices and scripts (in the auto-hinter * The mapping between glyph indices and scripts (in the auto-hinter
* sense, see the @FT_AUTOHINTER_SCRIPT_XXX values) is stored as an * sense, see the @FT_AUTOHINTER_SCRIPT_XXX values) is stored as an
* array with `num_glyphs' elements, as found in the font's @FT_Face * array with `num_glyphs` elements, as found in the font's @FT_Face
* structure. The `glyph-to-script-map' property returns a pointer to * structure. The 'glyph-to-script-map' property returns a pointer to
* this array, which can be modified as needed. Note that the * this array, which can be modified as needed. Note that the
* modification should happen before the first glyph gets processed by * modification should happen before the first glyph gets processed by
* the auto-hinter so that the global analysis of the font shapes * the auto-hinter so that the global analysis of the font shapes
@ -843,7 +843,7 @@ FT_BEGIN_HEADER
* The following example code demonstrates how to access it (omitting * The following example code demonstrates how to access it (omitting
* the error handling). * the error handling).
* *
* { * ```
* FT_Library library; * FT_Library library;
* FT_Face face; * FT_Face face;
* FT_Prop_GlyphToScriptMap prop; * FT_Prop_GlyphToScriptMap prop;
@ -860,7 +860,7 @@ FT_BEGIN_HEADER
* // adjust `prop.map' as needed right here * // adjust `prop.map' as needed right here
* *
* FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); * FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT );
* } * ```
* *
* @since: * @since:
* 2.4.11 * 2.4.11
@ -874,7 +874,7 @@ FT_BEGIN_HEADER
* FT_AUTOHINTER_SCRIPT_XXX * FT_AUTOHINTER_SCRIPT_XXX
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* A list of constants used for the @glyph-to-script-map property to * A list of constants used for the @glyph-to-script-map property to
* specify the script submodule the auto-hinter should use for hinting a * specify the script submodule the auto-hinter should use for hinting a
@ -885,14 +885,14 @@ FT_BEGIN_HEADER
* Don't auto-hint this glyph. * Don't auto-hint this glyph.
* *
* FT_AUTOHINTER_SCRIPT_LATIN :: * FT_AUTOHINTER_SCRIPT_LATIN ::
* Apply the latin auto-hinter. For the auto-hinter, `latin' is a * Apply the latin auto-hinter. For the auto-hinter, 'latin' is a
* very broad term, including Cyrillic and Greek also since characters * very broad term, including Cyrillic and Greek also since characters
* from those scripts share the same design constraints. * from those scripts share the same design constraints.
* *
* By default, characters from the following Unicode ranges are * By default, characters from the following Unicode ranges are
* assigned to this submodule. * assigned to this submodule.
* *
* { * ```
* U+0020 - U+007F // Basic Latin (no control characters) * U+0020 - U+007F // Basic Latin (no control characters)
* U+00A0 - U+00FF // Latin-1 Supplement (no control characters) * U+00A0 - U+00FF // Latin-1 Supplement (no control characters)
* U+0100 - U+017F // Latin Extended-A * U+0100 - U+017F // Latin Extended-A
@ -921,7 +921,7 @@ FT_BEGIN_HEADER
* U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures) * U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures)
* U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols * U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols
* U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement * U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement
* } * ```
* *
* FT_AUTOHINTER_SCRIPT_CJK :: * FT_AUTOHINTER_SCRIPT_CJK ::
* Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old * Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old
@ -930,7 +930,7 @@ FT_BEGIN_HEADER
* By default, characters from the following Unicode ranges are * By default, characters from the following Unicode ranges are
* assigned to this submodule. * assigned to this submodule.
* *
* { * ```
* U+1100 - U+11FF // Hangul Jamo * U+1100 - U+11FF // Hangul Jamo
* U+2E80 - U+2EFF // CJK Radicals Supplement * U+2E80 - U+2EFF // CJK Radicals Supplement
* U+2F00 - U+2FDF // Kangxi Radicals * U+2F00 - U+2FDF // Kangxi Radicals
@ -963,7 +963,7 @@ FT_BEGIN_HEADER
* U+2A700 - U+2B73F // CJK Unified Ideographs Extension C * U+2A700 - U+2B73F // CJK Unified Ideographs Extension C
* U+2B740 - U+2B81F // CJK Unified Ideographs Extension D * U+2B740 - U+2B81F // CJK Unified Ideographs Extension D
* U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement * U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement
* } * ```
* *
* FT_AUTOHINTER_SCRIPT_INDIC :: * FT_AUTOHINTER_SCRIPT_INDIC ::
* Apply the indic auto-hinter, covering all major scripts from the * Apply the indic auto-hinter, covering all major scripts from the
@ -973,7 +973,7 @@ FT_BEGIN_HEADER
* By default, characters from the following Unicode ranges are * By default, characters from the following Unicode ranges are
* assigned to this submodule. * assigned to this submodule.
* *
* { * ```
* U+0900 - U+0DFF // Indic Range * U+0900 - U+0DFF // Indic Range
* U+0F00 - U+0FFF // Tibetan * U+0F00 - U+0FFF // Tibetan
* U+1900 - U+194F // Limbu * U+1900 - U+194F // Limbu
@ -981,7 +981,7 @@ FT_BEGIN_HEADER
* U+A800 - U+A82F // Syloti Nagri * U+A800 - U+A82F // Syloti Nagri
* U+ABC0 - U+ABFF // Meetei Mayek * U+ABC0 - U+ABFF // Meetei Mayek
* U+11800 - U+118DF // Sharada * U+11800 - U+118DF // Sharada
* } * ```
* *
* Note that currently Indic support is rudimentary only, missing blue * Note that currently Indic support is rudimentary only, missing blue
* zone support. * zone support.
@ -1002,7 +1002,7 @@ FT_BEGIN_HEADER
* FT_Prop_GlyphToScriptMap * FT_Prop_GlyphToScriptMap
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* The data exchange structure for the @glyph-to-script-map property. * The data exchange structure for the @glyph-to-script-map property.
* *
@ -1024,12 +1024,12 @@ FT_BEGIN_HEADER
* fallback-script * fallback-script
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* If no auto-hinter script module can be assigned to a glyph, a * If no auto-hinter script module can be assigned to a glyph, a
* fallback script gets assigned to it (see also the * fallback script gets assigned to it (see also the
* @glyph-to-script-map property). By default, this is * @glyph-to-script-map property). By default, this is
* @FT_AUTOHINTER_SCRIPT_CJK. Using the `fallback-script' property, * @FT_AUTOHINTER_SCRIPT_CJK. Using the 'fallback-script' property,
* this fallback value can be changed. * this fallback value can be changed.
* *
* @note: * @note:
@ -1044,7 +1044,7 @@ FT_BEGIN_HEADER
* auto-hinter), a change of the fallback script will affect this face. * auto-hinter), a change of the fallback script will affect this face.
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE; * FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE;
* *
@ -1053,7 +1053,7 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "autofitter", * FT_Property_Set( library, "autofitter",
* "fallback-script", &fallback_script ); * "fallback-script", &fallback_script );
* } * ```
* *
* @since: * @since:
* 2.4.11 * 2.4.11
@ -1067,19 +1067,19 @@ FT_BEGIN_HEADER
* default-script * default-script
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make * If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make
* the HarfBuzz library access OpenType features for getting better * the HarfBuzz library access OpenType features for getting better
* glyph coverages, this property sets the (auto-fitter) script to be * glyph coverages, this property sets the (auto-fitter) script to be
* used for the default (OpenType) script data of a font's GSUB table. * used for the default (OpenType) script data of a font's GSUB table.
* Features for the default script are intended for all scripts not * Features for the default script are intended for all scripts not
* explicitly handled in GSUB; an example is a `dlig' feature, * explicitly handled in GSUB; an example is a 'dlig' feature,
* containing the combination of the characters `T', `E', and `L' to * containing the combination of the characters 'T', 'E', and 'L' to
* form a `TEL' ligature. * form a 'TEL' ligature.
* *
* By default, this is @FT_AUTOHINTER_SCRIPT_LATIN. Using the * By default, this is @FT_AUTOHINTER_SCRIPT_LATIN. Using the
* `default-script' property, this default value can be changed. * 'default-script' property, this default value can be changed.
* *
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
@ -1093,7 +1093,7 @@ FT_BEGIN_HEADER
* auto-hinter), a change of the default script will affect this face. * auto-hinter), a change of the default script will affect this face.
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE; * FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE;
* *
@ -1102,7 +1102,7 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "autofitter", * FT_Property_Set( library, "autofitter",
* "default-script", &default_script ); * "default-script", &default_script );
* } * ```
* *
* @since: * @since:
* 2.5.3 * 2.5.3
@ -1116,7 +1116,7 @@ FT_BEGIN_HEADER
* increase-x-height * increase-x-height
* *
* @description: * @description:
* For ppem values in the range 6~<= ppem <= `increase-x-height', round * For ppem values in the range 6~<= ppem <= 'increase-x-height', round
* up the font's x~height much more often than normally. If the value * up the font's x~height much more often than normally. If the value
* is set to~0, which is the default, this feature is switched off. Use * is set to~0, which is the default, this feature is switched off. Use
* this property to improve the legibility of small font sizes if * this property to improve the legibility of small font sizes if
@ -1129,7 +1129,7 @@ FT_BEGIN_HEADER
* loading any glyph (using the auto-hinter). * loading any glyph (using the auto-hinter).
* *
* @example: * @example:
* { * ```
* FT_Library library; * FT_Library library;
* FT_Face face; * FT_Face face;
* FT_Prop_IncreaseXHeight prop; * FT_Prop_IncreaseXHeight prop;
@ -1144,7 +1144,7 @@ FT_BEGIN_HEADER
* *
* FT_Property_Set( library, "autofitter", * FT_Property_Set( library, "autofitter",
* "increase-x-height", &prop ); * "increase-x-height", &prop );
* } * ```
* *
* @since: * @since:
* 2.4.11 * 2.4.11
@ -1175,13 +1175,13 @@ FT_BEGIN_HEADER
* warping * warping
* *
* @description: * @description:
* *Experimental* *only* * **Experimental only**
* *
* If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to * If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to
* activate the warp hinting code in the auto-hinter, this property * activate the warp hinting code in the auto-hinter, this property
* switches warping on and off. * switches warping on and off.
* *
* Warping only works in `normal' auto-hinting mode replacing it. * Warping only works in 'normal' auto-hinting mode replacing it.
* The idea of the code is to slightly scale and shift a glyph along * The idea of the code is to slightly scale and shift a glyph along
* the non-hinted dimension (which is usually the horizontal axis) so * the non-hinted dimension (which is usually the horizontal axis) so
* that as much of its segments are aligned (more or less) to the grid. * that as much of its segments are aligned (more or less) to the grid.
@ -1192,22 +1192,22 @@ FT_BEGIN_HEADER
* @note: * @note:
* This property can be used with @FT_Property_Get also. * This property can be used with @FT_Property_Get also.
* *
* This property can be set via the `FREETYPE_PROPERTIES' environment * This property can be set via the `FREETYPE_PROPERTIES` environment
* variable (using values 1 and 0 for `on' and `off', respectively). * variable (using values 1 and 0 for 'on' and 'off', respectively).
* *
* The warping code can also change advance widths. Have a look at the * The warping code can also change advance widths. Have a look at the
* `lsb_delta' and `rsb_delta' fields in the @FT_GlyphSlotRec structure * `lsb_delta` and `rsb_delta` fields in the @FT_GlyphSlotRec structure
* for details on improving inter-glyph distances while rendering. * for details on improving inter-glyph distances while rendering.
* *
* Since warping is a global property of the auto-hinter it is best to * Since warping is a global property of the auto-hinter it is best to
* change its value before rendering any face. Otherwise, you should * change its value before rendering any face. Otherwise, you should
* reload all faces that get auto-hinted in `normal' hinting mode. * reload all faces that get auto-hinted in 'normal' hinting mode.
* *
* @example: * @example:
* This example shows how to switch on warping (omitting the error * This example shows how to switch on warping (omitting the error
* handling). * handling).
* *
* { * ```
* FT_Library library; * FT_Library library;
* FT_Bool warping = 1; * FT_Bool warping = 1;
* *
@ -1215,7 +1215,7 @@ FT_BEGIN_HEADER
* FT_Init_FreeType( &library ); * FT_Init_FreeType( &library );
* *
* FT_Property_Set( library, "autofitter", "warping", &warping ); * FT_Property_Set( library, "autofitter", "warping", &warping );
* } * ```
* *
* @since: * @since:
* 2.6 * 2.6

18
include/freetype/fterrdef.h
View File

@ -28,20 +28,20 @@
* All possible error codes returned by FreeType functions. * All possible error codes returned by FreeType functions.
* *
* @description: * @description:
* The list below is taken verbatim from the file `fterrdef.h' * The list below is taken verbatim from the file `fterrdef.h`
* (loaded automatically by including `FT_FREETYPE_H'). The first * (loaded automatically by including `FT_FREETYPE_H`). The first
* argument of the `FT_ERROR_DEF_' macro is the error label; by * argument of the `FT_ERROR_DEF_` macro is the error label; by
* default, the prefix `FT_Err_' gets added so that you get error * default, the prefix `FT_Err_` gets added so that you get error
* names like `FT_Err_Cannot_Open_Resource'. The second argument is * names like `FT_Err_Cannot_Open_Resource`. The second argument is
* the error code, and the last argument an error string, which is not * the error code, and the last argument an error string, which is not
* used by FreeType. * used by FreeType.
* *
* Within your application you should *only* use error names and * Within your application you should **only** use error names and
* *never* its numeric values! The latter might (and actually do) * **never** its numeric values! The latter might (and actually do)
* change in forthcoming FreeType versions. * change in forthcoming FreeType versions.
* *
* Macro `FT_NOERRORDEF_' defines `FT_Err_Ok', which is always zero. * Macro `FT_NOERRORDEF_` defines `FT_Err_Ok`, which is always zero.
* See the `Error Enumerations' subsection how to automatically * See the 'Error Enumerations' subsection how to automatically
* generate a list of error strings. * generate a list of error strings.
* *
*/ */

40
include/freetype/fterrors.h
View File

@ -28,20 +28,20 @@
* How to handle errors and error strings. * How to handle errors and error strings.
* *
* @description: * @description:
* The header file `fterrors.h' (which is automatically included by * The header file `fterrors.h` (which is automatically included by
* `freetype.h' defines the handling of FreeType's enumeration * `freetype.h` defines the handling of FreeType's enumeration
* constants. It can also be used to generate error message strings * constants. It can also be used to generate error message strings
* with a small macro trick explained below. * with a small macro trick explained below.
* *
* *Error* *Formats* * **Error Formats**
* *
* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be * The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be
* defined in `ftoption.h' in order to make the higher byte indicate * defined in `ftoption.h` in order to make the higher byte indicate
* the module where the error has happened (this is not compatible * the module where the error has happened (this is not compatible
* with standard builds of FreeType~2, however). See the file * with standard builds of FreeType~2, however). See the file
* `ftmoderr.h' for more details. * `ftmoderr.h` for more details.
* *
* *Error* *Message* *Strings* * **Error Message Strings**
* *
* Error definitions are set up with special macros that allow client * Error definitions are set up with special macros that allow client
* applications to build a table of error message strings. The * applications to build a table of error message strings. The
@ -51,33 +51,33 @@
* To do so, you have to define the following macros before including * To do so, you have to define the following macros before including
* this file. * this file.
* *
* { * ```
* FT_ERROR_START_LIST * FT_ERROR_START_LIST
* } * ```
* *
* This macro is called before anything else to define the start of * This macro is called before anything else to define the start of
* the error list. It is followed by several FT_ERROR_DEF calls. * the error list. It is followed by several FT_ERROR_DEF calls.
* *
* { * ```
* FT_ERROR_DEF( e, v, s ) * FT_ERROR_DEF( e, v, s )
* } * ```
* *
* This macro is called to define one single error. `e' is the error * This macro is called to define one single error. 'e' is the error
* code identifier (e.g., `Invalid_Argument'), `v' is the error's * code identifier (e.g., `Invalid_Argument`), 'v' is the error's
* numerical value, and `s' is the corresponding error string. * numerical value, and 's' is the corresponding error string.
* *
* { * ```
* FT_ERROR_END_LIST * FT_ERROR_END_LIST
* } * ```
* *
* This macro ends the list. * This macro ends the list.
* *
* Additionally, you have to undefine `FTERRORS_H_' before #including * Additionally, you have to undefine `FTERRORS_H_` before #including
* this file. * this file.
* *
* Here is a simple example. * Here is a simple example.
* *
* { * ```
* #undef FTERRORS_H_ * #undef FTERRORS_H_
* #define FT_ERRORDEF( e, v, s ) { e, s }, * #define FT_ERRORDEF( e, v, s ) { e, s },
* #define FT_ERROR_START_LIST { * #define FT_ERROR_START_LIST {
@ -90,10 +90,10 @@
* } ft_errors[] = * } ft_errors[] =
* *
* #include FT_ERRORS_H * #include FT_ERRORS_H
* } * ```
* *
* Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with * Note that `FT_Err_Ok` is _not_ defined with `FT_ERRORDEF` but with
* `FT_NOERRORDEF'; it is always zero. * `FT_NOERRORDEF`; it is always zero.
* *
*/ */

6
include/freetype/ftfntfmt.h
View File

@ -59,8 +59,8 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Return a string describing the format of a given face. Possible * Return a string describing the format of a given face. Possible
* values are `TrueType', `Type~1', `BDF', `PCF', `Type~42', * values are 'TrueType', 'Type~1', 'BDF', 'PCF', 'Type~42',
* `CID~Type~1', `CFF', `PFR', and `Windows~FNT'. * 'CID~Type~1', 'CFF', 'PFR', and 'Windows~FNT'.
* *
* The return value is suitable to be used as an X11 FONT_PROPERTY. * The return value is suitable to be used as an X11 FONT_PROPERTY.
* *
@ -73,7 +73,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* A deprecated name for the same function is * A deprecated name for the same function is
* `FT_Get_X11_Font_Format'. * `FT_Get_X11_Font_Format`.
*/ */
FT_EXPORT( const char* ) FT_EXPORT( const char* )
FT_Get_Font_Format( FT_Face face ); FT_Get_Font_Format( FT_Face face );

22
include/freetype/ftgasp.h
View File

@ -41,11 +41,11 @@ FT_BEGIN_HEADER
* Gasp Table * Gasp Table
* *
* @abstract: * @abstract:
* Retrieving TrueType `gasp' table entries. * Retrieving TrueType 'gasp' table entries.
* *
* @description: * @description:
* The function @FT_Get_Gasp can be used to query a TrueType or OpenType * The function @FT_Get_Gasp can be used to query a TrueType or OpenType
* font for specific entries in its `gasp' table, if any. This is * font for specific entries in its 'gasp' table, if any. This is
* mainly useful when implementing native TrueType hinting with the * mainly useful when implementing native TrueType hinting with the
* bytecode interpreter to duplicate the Windows text rendering results. * bytecode interpreter to duplicate the Windows text rendering results.
*/ */
@ -66,7 +66,7 @@ FT_BEGIN_HEADER
* *
* FT_GASP_DO_GRIDFIT :: * FT_GASP_DO_GRIDFIT ::
* Grid-fitting and hinting should be performed at the specified ppem. * Grid-fitting and hinting should be performed at the specified ppem.
* This *really* means TrueType bytecode interpretation. If this bit * This **really** means TrueType bytecode interpretation. If this bit
* is not set, no hinting gets applied. * is not set, no hinting gets applied.
* *
* FT_GASP_DO_GRAY :: * FT_GASP_DO_GRAY ::
@ -80,13 +80,13 @@ FT_BEGIN_HEADER
* Grid-fitting must be used with ClearType's symmetric smoothing. * Grid-fitting must be used with ClearType's symmetric smoothing.
* *
* @note: * @note:
* The bit-flags `FT_GASP_DO_GRIDFIT' and `FT_GASP_DO_GRAY' are to be * The bit-flags `FT_GASP_DO_GRIDFIT` and `FT_GASP_DO_GRAY` are to be
* used for standard font rasterization only. Independently of that, * used for standard font rasterization only. Independently of that,
* `FT_GASP_SYMMETRIC_SMOOTHING' and `FT_GASP_SYMMETRIC_GRIDFIT' are to * `FT_GASP_SYMMETRIC_SMOOTHING` and `FT_GASP_SYMMETRIC_GRIDFIT` are to
* be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT' and * be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT` and
* `FT_GASP_DO_GRAY' are consequently ignored). * `FT_GASP_DO_GRAY` are consequently ignored).
* *
* `ClearType' is Microsoft's implementation of LCD rendering, partly * 'ClearType' is Microsoft's implementation of LCD rendering, partly
* protected by patents. * protected by patents.
* *
* @since: * @since:
@ -106,7 +106,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* For a TrueType or OpenType font file, return the rasterizer behaviour * For a TrueType or OpenType font file, return the rasterizer behaviour
* flags from the font's `gasp' table corresponding to a given * flags from the font's 'gasp' table corresponding to a given
* character pixel size. * character pixel size.
* *
* @input: * @input:
@ -118,12 +118,12 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no * Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no
* `gasp' table in the face. * 'gasp' table in the face.
* *
* @note: * @note:
* If you want to use the MM functionality of OpenType variation fonts * If you want to use the MM functionality of OpenType variation fonts
* (i.e., using @FT_Set_Var_Design_Coordinates and friends), call this * (i.e., using @FT_Set_Var_Design_Coordinates and friends), call this
* function *after* setting an instance since the return values can * function **after** setting an instance since the return values can
* change. * change.
* *
* @since: * @since:

50
include/freetype/ftglyph.h
View File

@ -138,7 +138,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A structure used for bitmap glyph images. This really is a * A structure used for bitmap glyph images. This really is a
* `sub-class' of @FT_GlyphRec. * 'sub-class' of @FT_GlyphRec.
* *
* @fields: * @fields:
* root :: * root ::
@ -159,7 +159,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have * You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have
* `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access * `glyph->format == FT_GLYPH_FORMAT_BITMAP`. This lets you access
* the bitmap's contents easily. * the bitmap's contents easily.
* *
* The corresponding pixel buffer is always owned by @FT_BitmapGlyph * The corresponding pixel buffer is always owned by @FT_BitmapGlyph
@ -194,7 +194,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A structure used for outline (vectorial) glyph images. This * A structure used for outline (vectorial) glyph images. This
* really is a `sub-class' of @FT_GlyphRec. * really is a 'sub-class' of @FT_GlyphRec.
* *
* @fields: * @fields:
* root :: * root ::
@ -205,7 +205,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have * You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have
* `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access * `glyph->format == FT_GLYPH_FORMAT_OUTLINE`. This lets you access
* the outline's content easily. * the outline's content easily.
* *
* As the outline is extracted from a glyph slot, its coordinates are * As the outline is extracted from a glyph slot, its coordinates are
@ -276,8 +276,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* Because `*aglyph->advance.x' and `*aglyph->advance.y' are 16.16 * Because `*aglyph->advance.x` and `*aglyph->advance.y` are 16.16
* fixed-point numbers, `slot->advance.x' and `slot->advance.y' * fixed-point numbers, `slot->advance.x` and `slot->advance.y`
* (which are in 26.6 fixed-point format) must be in the range * (which are in 26.6 fixed-point format) must be in the range
* ]-32768;32768[. * ]-32768;32768[.
*/ */
@ -395,7 +395,7 @@ FT_BEGIN_HEADER
* FT_Glyph_Get_CBox * FT_Glyph_Get_CBox
* *
* @description: * @description:
* Return a glyph's `control box'. The control box encloses all the * Return a glyph's 'control box'. The control box encloses all the
* outline's points, including Bezier control points. Though it * outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be * coincides with the exact bounding box for most glyphs, it can be
* slightly larger in some situations (like when rotating an outline * slightly larger in some situations (like when rotating an outline
@ -404,7 +404,7 @@ FT_BEGIN_HEADER
* Computing the control box is very fast, while getting the bounding * Computing the control box is very fast, while getting the bounding
* box can take much more time as it needs to walk over all segments * box can take much more time as it needs to walk over all segments
* and arcs in the outline. To get the latter, you can use the * and arcs in the outline. To get the latter, you can use the
* `ftbbox' component, which is dedicated to this single task. * 'ftbbox' component, which is dedicated to this single task.
* *
* @input: * @input:
* glyph :: * glyph ::
@ -423,7 +423,7 @@ FT_BEGIN_HEADER
* Coordinates are relative to the glyph origin, using the y~upwards * Coordinates are relative to the glyph origin, using the y~upwards
* convention. * convention.
* *
* If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode' * If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode`
* must be set to @FT_GLYPH_BBOX_UNSCALED to get unscaled font * must be set to @FT_GLYPH_BBOX_UNSCALED to get unscaled font
* units in 26.6 pixel format. The value @FT_GLYPH_BBOX_SUBPIXELS * units in 26.6 pixel format. The value @FT_GLYPH_BBOX_SUBPIXELS
* is another name for this constant. * is another name for this constant.
@ -439,26 +439,26 @@ FT_BEGIN_HEADER
* one can compute the width and height of the glyph image (be it in * one can compute the width and height of the glyph image (be it in
* integer or 26.6 pixels) as: * integer or 26.6 pixels) as:
* *
* { * ```
* width = bbox.xMax - bbox.xMin; * width = bbox.xMax - bbox.xMin;
* height = bbox.yMax - bbox.yMin; * height = bbox.yMax - bbox.yMin;
* } * ```
* *
* Note also that for 26.6 coordinates, if `bbox_mode' is set to * Note also that for 26.6 coordinates, if `bbox_mode` is set to
* @FT_GLYPH_BBOX_GRIDFIT, the coordinates will also be grid-fitted, * @FT_GLYPH_BBOX_GRIDFIT, the coordinates will also be grid-fitted,
* which corresponds to: * which corresponds to:
* *
* { * ```
* bbox.xMin = FLOOR(bbox.xMin); * bbox.xMin = FLOOR(bbox.xMin);
* bbox.yMin = FLOOR(bbox.yMin); * bbox.yMin = FLOOR(bbox.yMin);
* bbox.xMax = CEILING(bbox.xMax); * bbox.xMax = CEILING(bbox.xMax);
* bbox.yMax = CEILING(bbox.yMax); * bbox.yMax = CEILING(bbox.yMax);
* } * ```
* *
* To get the bbox in pixel coordinates, set `bbox_mode' to * To get the bbox in pixel coordinates, set `bbox_mode` to
* @FT_GLYPH_BBOX_TRUNCATE. * @FT_GLYPH_BBOX_TRUNCATE.
* *
* To get the bbox in grid-fitted pixel coordinates, set `bbox_mode' * To get the bbox in grid-fitted pixel coordinates, set `bbox_mode`
* to @FT_GLYPH_BBOX_PIXELS. * to @FT_GLYPH_BBOX_PIXELS.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )
@ -501,7 +501,7 @@ FT_BEGIN_HEADER
* @note: * @note:
* This function does nothing if the glyph format isn't scalable. * This function does nothing if the glyph format isn't scalable.
* *
* The glyph image is translated with the `origin' vector before * The glyph image is translated with the 'origin' vector before
* rendering. * rendering.
* *
* The first parameter is a pointer to an @FT_Glyph handle, that will * The first parameter is a pointer to an @FT_Glyph handle, that will
@ -509,7 +509,7 @@ FT_BEGIN_HEADER
* Typically, you would use (omitting error handling): * Typically, you would use (omitting error handling):
* *
* *
* { * ```
* FT_Glyph glyph; * FT_Glyph glyph;
* FT_BitmapGlyph glyph_bitmap; * FT_BitmapGlyph glyph_bitmap;
* *
@ -537,13 +537,13 @@ FT_BEGIN_HEADER
* *
* // discard glyph image (bitmap or not) * // discard glyph image (bitmap or not)
* FT_Done_Glyph( glyph ); * FT_Done_Glyph( glyph );
* } * ```
* *
* *
* Here another example, again without error handling: * Here another example, again without error handling:
* *
* *
* { * ```
* FT_Glyph glyphs[MAX_GLYPHS] * FT_Glyph glyphs[MAX_GLYPHS]
* *
* *
@ -575,7 +575,7 @@ FT_BEGIN_HEADER
* *
* for ( idx = 0; i < MAX_GLYPHS; i++ ) * for ( idx = 0; i < MAX_GLYPHS; i++ )
* FT_Done_Glyph( glyphs[idx] ); * FT_Done_Glyph( glyphs[idx] );
* } * ```
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Glyph_To_Bitmap( FT_Glyph* the_glyph, FT_Glyph_To_Bitmap( FT_Glyph* the_glyph,
@ -618,18 +618,18 @@ FT_BEGIN_HEADER
* FT_Matrix_Multiply * FT_Matrix_Multiply
* *
* @description: * @description:
* Perform the matrix operation `b = a*b'. * Perform the matrix operation 'b = a*b'.
* *
* @input: * @input:
* a :: * a ::
* A pointer to matrix `a'. * A pointer to matrix 'a'.
* *
* @inout: * @inout:
* b :: * b ::
* A pointer to matrix `b'. * A pointer to matrix 'b'.
* *
* @note: * @note:
* The result is undefined if either `a' or `b' is zero. * The result is undefined if either 'a' or 'b' is zero.
* *
* Since the function uses wrap-around arithmetic, results become * Since the function uses wrap-around arithmetic, results become
* meaningless if the arguments are very large. * meaningless if the arguments are very large.

36
include/freetype/ftgxval.h
View File

@ -99,7 +99,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* The number of tables checked in this module. Use it as a parameter * The number of tables checked in this module. Use it as a parameter
* for the `table-length' argument of function @FT_TrueTypeGX_Validate. * for the 'table-length' argument of function @FT_TrueTypeGX_Validate.
*/ */
#define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 ) #define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 )
@ -123,34 +123,34 @@ FT_BEGIN_HEADER
* *
* @values: * @values:
* FT_VALIDATE_feat :: * FT_VALIDATE_feat ::
* Validate `feat' table. * Validate 'feat' table.
* *
* FT_VALIDATE_mort :: * FT_VALIDATE_mort ::
* Validate `mort' table. * Validate 'mort' table.
* *
* FT_VALIDATE_morx :: * FT_VALIDATE_morx ::
* Validate `morx' table. * Validate 'morx' table.
* *
* FT_VALIDATE_bsln :: * FT_VALIDATE_bsln ::
* Validate `bsln' table. * Validate 'bsln' table.
* *
* FT_VALIDATE_just :: * FT_VALIDATE_just ::
* Validate `just' table. * Validate 'just' table.
* *
* FT_VALIDATE_kern :: * FT_VALIDATE_kern ::
* Validate `kern' table. * Validate 'kern' table.
* *
* FT_VALIDATE_opbd :: * FT_VALIDATE_opbd ::
* Validate `opbd' table. * Validate 'opbd' table.
* *
* FT_VALIDATE_trak :: * FT_VALIDATE_trak ::
* Validate `trak' table. * Validate 'trak' table.
* *
* FT_VALIDATE_prop :: * FT_VALIDATE_prop ::
* Validate `prop' table. * Validate 'prop' table.
* *
* FT_VALIDATE_lcar :: * FT_VALIDATE_lcar ::
* Validate `lcar' table. * Validate 'lcar' table.
* *
* FT_VALIDATE_GX :: * FT_VALIDATE_GX ::
* Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern, * Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern,
@ -201,7 +201,7 @@ FT_BEGIN_HEADER
* @FT_VALIDATE_GXXXX for possible values. * @FT_VALIDATE_GXXXX for possible values.
* *
* table_length :: * table_length ::
* The size of the `tables' array. Normally, @FT_VALIDATE_GX_LENGTH * The size of the 'tables' array. Normally, @FT_VALIDATE_GX_LENGTH
* should be passed. * should be passed.
* *
* @output: * @output:
@ -217,7 +217,7 @@ FT_BEGIN_HEADER
* otherwise. * otherwise.
* *
* After use, the application should deallocate the buffers pointed to by * After use, the application should deallocate the buffers pointed to by
* each `tables' element, by calling @FT_TrueTypeGX_Free. A NULL value * each 'tables' element, by calling @FT_TrueTypeGX_Free. A NULL value
* indicates that the table either doesn't exist in the font, the * indicates that the table either doesn't exist in the font, the
* application hasn't asked for validation, or the validator doesn't have * application hasn't asked for validation, or the validator doesn't have
* the ability to validate the sfnt table. * the ability to validate the sfnt table.
@ -267,13 +267,13 @@ FT_BEGIN_HEADER
* *
* @values: * @values:
* FT_VALIDATE_MS :: * FT_VALIDATE_MS ::
* Handle the `kern' table as a classic Microsoft kern table. * Handle the 'kern' table as a classic Microsoft kern table.
* *
* FT_VALIDATE_APPLE :: * FT_VALIDATE_APPLE ::
* Handle the `kern' table as a classic Apple kern table. * Handle the 'kern' table as a classic Apple kern table.
* *
* FT_VALIDATE_CKERN :: * FT_VALIDATE_CKERN ::
* Handle the `kern' as either classic Apple or Microsoft kern table. * Handle the 'kern' as either classic Apple or Microsoft kern table.
*/ */
#define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 ) #define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 )
#define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) #define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 )
@ -292,7 +292,7 @@ FT_BEGIN_HEADER
* actually does the text layout can access those tables without error * actually does the text layout can access those tables without error
* checking (which can be quite time consuming). * checking (which can be quite time consuming).
* *
* The `kern' table validator in @FT_TrueTypeGX_Validate deals with both * The 'kern' table validator in @FT_TrueTypeGX_Validate deals with both
* the new 32-bit format and the classic 16-bit format, while * the new 32-bit format and the classic 16-bit format, while
* FT_ClassicKern_Validate only supports the classic 16-bit format. * FT_ClassicKern_Validate only supports the classic 16-bit format.
* *
@ -313,7 +313,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* After use, the application should deallocate the buffers pointed to by * After use, the application should deallocate the buffers pointed to by
* `ckern_table', by calling @FT_ClassicKern_Free. A NULL value * `ckern_table`, by calling @FT_ClassicKern_Free. A NULL value
* indicates that the table doesn't exist in the font. * indicates that the table doesn't exist in the font.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

16
include/freetype/ftgzip.h
View File

@ -55,7 +55,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Open a new stream to parse gzip-compressed font files. This is * Open a new stream to parse gzip-compressed font files. This is
* mainly used to support the compressed `*.pcf.gz' fonts that come * mainly used to support the compressed `*.pcf.gz` fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
@ -71,8 +71,8 @@ FT_BEGIN_HEADER
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close` on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
@ -84,7 +84,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a gzipped stream from * compressed file, the library will try to open a gzipped stream from
* it and re-open the face with it. * it and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with zlib support. * of FreeType was not compiled with zlib support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -99,7 +99,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Decompress a zipped input buffer into an output buffer. This function * Decompress a zipped input buffer into an output buffer. This function
* is modeled after zlib's `uncompress' function. * is modeled after zlib's 'uncompress' function.
* *
* @input: * @input:
* memory :: * memory ::
@ -120,14 +120,14 @@ FT_BEGIN_HEADER
* Before calling the function, this is the total size of the output * Before calling the function, this is the total size of the output
* buffer, which must be large enough to hold the entire uncompressed * buffer, which must be large enough to hold the entire uncompressed
* data (so the size of the uncompressed data must be known in * data (so the size of the uncompressed data must be known in
* advance). After calling the function, `output_len' is the size of * advance). After calling the function, `output_len` is the size of
* the used data in `output'. * the used data in 'output'.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with zlib support. * of FreeType was not compiled with zlib support.
* *
* @since: * @since:

114
include/freetype/ftimage.h
View File

@ -109,13 +109,13 @@ FT_BEGIN_HEADER
* left and the upper right corner. In PostScript, those values are * left and the upper right corner. In PostScript, those values are
* often called (llx,lly) and (urx,ury), respectively. * often called (llx,lly) and (urx,ury), respectively.
* *
* If `yMin' is negative, this value gives the glyph's descender. * If `yMin` is negative, this value gives the glyph's descender.
* Otherwise, the glyph doesn't descend below the baseline. * Otherwise, the glyph doesn't descend below the baseline.
* Similarly, if `ymax' is positive, this value gives the glyph's * Similarly, if 'ymax' is positive, this value gives the glyph's
* ascender. * ascender.
* *
* `xMin' gives the horizontal distance from the glyph's origin to * `xMin` gives the horizontal distance from the glyph's origin to
* the left edge of the glyph's bounding box. If `xMin' is negative, * the left edge of the glyph's bounding box. If `xMin` is negative,
* the glyph extends to the left of the origin. * the glyph extends to the left of the origin.
*/ */
typedef struct FT_BBox_ typedef struct FT_BBox_
@ -148,7 +148,7 @@ FT_BEGIN_HEADER
* FT_PIXEL_MODE_GRAY :: * FT_PIXEL_MODE_GRAY ::
* An 8-bit bitmap, generally used to represent anti-aliased glyph * An 8-bit bitmap, generally used to represent anti-aliased glyph
* images. Each pixel is stored in one byte. Note that the number * images. Each pixel is stored in one byte. Note that the number
* of `gray' levels is stored in the `num_grays' field of the * of 'gray' levels is stored in the `num_grays` field of the
* @FT_Bitmap structure (it generally is 256). * @FT_Bitmap structure (it generally is 256).
* *
* FT_PIXEL_MODE_GRAY2 :: * FT_PIXEL_MODE_GRAY2 ::
@ -181,7 +181,7 @@ FT_BEGIN_HEADER
* blue channel comes first in memory. The color channels are * blue channel comes first in memory. The color channels are
* pre-multiplied and in the sRGB colorspace. For example, full * pre-multiplied and in the sRGB colorspace. For example, full
* red at half-translucent opacity will be represented as * red at half-translucent opacity will be represented as
* `00,00,80,80', not `00,00,FF,80'. See also @FT_LOAD_COLOR. * '00,00,80,80', not '00,00,FF,80'. See also @FT_LOAD_COLOR.
*/ */
typedef enum FT_Pixel_Mode_ typedef enum FT_Pixel_Mode_
{ {
@ -216,7 +216,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* A structure used to describe a bitmap or pixmap to the raster. * A structure used to describe a bitmap or pixmap to the raster.
* Note that we now manage pixmaps of various depths through the * Note that we now manage pixmaps of various depths through the
* `pixel_mode' field. * `pixel_mode` field.
* *
* @fields: * @fields:
* rows :: * rows ::
@ -229,23 +229,23 @@ FT_BEGIN_HEADER
* The pitch's absolute value is the number of bytes * The pitch's absolute value is the number of bytes
* taken by one bitmap row, including padding. * taken by one bitmap row, including padding.
* However, the pitch is positive when the bitmap has * However, the pitch is positive when the bitmap has
* a `down' flow, and negative when it has an `up' * a 'down' flow, and negative when it has an 'up'
* flow. In all cases, the pitch is an offset to add * flow. In all cases, the pitch is an offset to add
* to a bitmap pointer in order to go down one row. * to a bitmap pointer in order to go down one row.
* *
* Note that `padding' means the alignment of a * Note that 'padding' means the alignment of a
* bitmap to a byte border, and FreeType functions * bitmap to a byte border, and FreeType functions
* normally align to the smallest possible integer * normally align to the smallest possible integer
* value. * value.
* *
* For the B/W rasterizer, `pitch' is always an even * For the B/W rasterizer, 'pitch' is always an even
* number. * number.
* *
* To change the pitch of a bitmap (say, to make it a * To change the pitch of a bitmap (say, to make it a
* multiple of 4), use @FT_Bitmap_Convert. * multiple of 4), use @FT_Bitmap_Convert.
* Alternatively, you might use callback functions to * Alternatively, you might use callback functions to
* directly render to the application's surface; see * directly render to the application's surface; see
* the file `example2.cpp' in the tutorial for a * the file `example2.cpp` in the tutorial for a
* demonstration. * demonstration.
* *
* buffer :: * buffer ::
@ -311,18 +311,18 @@ FT_BEGIN_HEADER
* The number of points in the outline. * The number of points in the outline.
* *
* points :: * points ::
* A pointer to an array of `n_points' @FT_Vector * A pointer to an array of `n_points` @FT_Vector
* elements, giving the outline's point coordinates. * elements, giving the outline's point coordinates.
* *
* tags :: * tags ::
* A pointer to an array of `n_points' chars, giving * A pointer to an array of `n_points` chars, giving
* each outline point's type. * each outline point's type.
* *
* If bit~0 is unset, the point is `off' the curve, * If bit~0 is unset, the point is 'off' the curve,
* i.e., a Bezier control point, while it is `on' if * i.e., a Bezier control point, while it is 'on' if
* set. * set.
* *
* Bit~1 is meaningful for `off' points only. If set, * Bit~1 is meaningful for 'off' points only. If set,
* it indicates a third-order Bezier arc control point; * it indicates a third-order Bezier arc control point;
* and a second-order control point if unset. * and a second-order control point if unset.
* *
@ -334,11 +334,11 @@ FT_BEGIN_HEADER
* Bits 3 and~4 are reserved for internal purposes. * Bits 3 and~4 are reserved for internal purposes.
* *
* contours :: * contours ::
* An array of `n_contours' shorts, giving the end * An array of `n_contours` shorts, giving the end
* point of each contour within the outline. For * point of each contour within the outline. For
* example, the first contour is defined by the points * example, the first contour is defined by the points
* `0' to `contours[0]', the second one is defined by * '0' to 'contours[0]', the second one is defined by
* the points `contours[0]+1' to `contours[1]', etc. * the points 'contours[0]+1' to 'contours[1]', etc.
* *
* flags :: * flags ::
* A set of bit flags used to characterize the outline * A set of bit flags used to characterize the outline
@ -346,10 +346,10 @@ FT_BEGIN_HEADER
* how to convert/grid-fit it. See @FT_OUTLINE_XXX. * how to convert/grid-fit it. See @FT_OUTLINE_XXX.
* *
* @note: * @note:
* The B/W rasterizer only checks bit~2 in the `tags' array for the * The B/W rasterizer only checks bit~2 in the 'tags' array for the
* first point of each contour. The drop-out mode as given with * first point of each contour. The drop-out mode as given with
* @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and * @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and
* @FT_OUTLINE_INCLUDE_STUBS in `flags' is then overridden. * @FT_OUTLINE_INCLUDE_STUBS in 'flags' is then overridden.
*/ */
typedef struct FT_Outline_ typedef struct FT_Outline_
{ {
@ -379,7 +379,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A list of bit-field constants use for the flags in an outline's * A list of bit-field constants use for the flags in an outline's
* `flags' field. * 'flags' field.
* *
* @values: * @values:
* FT_OUTLINE_NONE :: * FT_OUTLINE_NONE ::
@ -387,7 +387,7 @@ FT_BEGIN_HEADER
* *
* FT_OUTLINE_OWNER :: * FT_OUTLINE_OWNER ::
* If set, this flag indicates that the outline's field arrays * If set, this flag indicates that the outline's field arrays
* (i.e., `points', `flags', and `contours') are `owned' by the * (i.e., 'points', 'flags', and 'contours') are 'owned' by the
* outline object, and should thus be freed when it is destroyed. * outline object, and should thus be freed when it is destroyed.
* *
* FT_OUTLINE_EVEN_ODD_FILL :: * FT_OUTLINE_EVEN_ODD_FILL ::
@ -414,7 +414,7 @@ FT_BEGIN_HEADER
* below for more information. * below for more information.
* *
* FT_OUTLINE_INCLUDE_STUBS :: * FT_OUTLINE_INCLUDE_STUBS ::
* If set, turn pixels on for `stubs', otherwise exclude them. * If set, turn pixels on for 'stubs', otherwise exclude them.
* Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for * Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for
* more information. * more information.
* *
@ -438,10 +438,10 @@ FT_BEGIN_HEADER
* rasterizer. * rasterizer.
* *
* There exists a second mechanism to pass the drop-out mode to the * There exists a second mechanism to pass the drop-out mode to the
* B/W rasterizer; see the `tags' field in @FT_Outline. * B/W rasterizer; see the 'tags' field in @FT_Outline.
* *
* Please refer to the description of the `SCANTYPE' instruction in * Please refer to the description of the 'SCANTYPE' instruction in
* the OpenType specification (in file `ttinst1.doc') how simple * the OpenType specification (in file `ttinst1.doc`) how simple
* drop-outs, smart drop-outs, and stubs are defined. * drop-outs, smart drop-outs, and stubs are defined.
*/ */
#define FT_OUTLINE_NONE 0x0 #define FT_OUTLINE_NONE 0x0
@ -495,14 +495,14 @@ FT_BEGIN_HEADER
* FT_Outline_MoveToFunc * FT_Outline_MoveToFunc
* *
* @description: * @description:
* A function pointer type used to describe the signature of a `move * A function pointer type used to describe the signature of a 'move
* to' function during outline walking/decomposition. * to' function during outline walking/decomposition.
* *
* A `move to' is emitted to start a new contour in an outline. * A 'move to' is emitted to start a new contour in an outline.
* *
* @input: * @input:
* to :: * to ::
* A pointer to the target point of the `move to'. * A pointer to the target point of the 'move to'.
* *
* user :: * user ::
* A typeless pointer, which is passed from the caller of the * A typeless pointer, which is passed from the caller of the
@ -524,14 +524,14 @@ FT_BEGIN_HEADER
* FT_Outline_LineToFunc * FT_Outline_LineToFunc
* *
* @description: * @description:
* A function pointer type used to describe the signature of a `line * A function pointer type used to describe the signature of a 'line
* to' function during outline walking/decomposition. * to' function during outline walking/decomposition.
* *
* A `line to' is emitted to indicate a segment in the outline. * A 'line to' is emitted to indicate a segment in the outline.
* *
* @input: * @input:
* to :: * to ::
* A pointer to the target point of the `line to'. * A pointer to the target point of the 'line to'.
* *
* user :: * user ::
* A typeless pointer, which is passed from the caller of the * A typeless pointer, which is passed from the caller of the
@ -553,16 +553,16 @@ FT_BEGIN_HEADER
* FT_Outline_ConicToFunc * FT_Outline_ConicToFunc
* *
* @description: * @description:
* A function pointer type used to describe the signature of a `conic * A function pointer type used to describe the signature of a 'conic
* to' function during outline walking or decomposition. * to' function during outline walking or decomposition.
* *
* A `conic to' is emitted to indicate a second-order Bezier arc in * A 'conic to' is emitted to indicate a second-order Bezier arc in
* the outline. * the outline.
* *
* @input: * @input:
* control :: * control ::
* An intermediate control point between the last position * An intermediate control point between the last position
* and the new target in `to'. * and the new target in 'to'.
* *
* to :: * to ::
* A pointer to the target end point of the conic arc. * A pointer to the target end point of the conic arc.
@ -588,10 +588,10 @@ FT_BEGIN_HEADER
* FT_Outline_CubicToFunc * FT_Outline_CubicToFunc
* *
* @description: * @description:
* A function pointer type used to describe the signature of a `cubic * A function pointer type used to describe the signature of a 'cubic
* to' function during outline walking or decomposition. * to' function during outline walking or decomposition.
* *
* A `cubic to' is emitted to indicate a third-order Bezier arc. * A 'cubic to' is emitted to indicate a third-order Bezier arc.
* *
* @input: * @input:
* control1 :: * control1 ::
@ -630,7 +630,7 @@ FT_BEGIN_HEADER
* *
* @fields: * @fields:
* move_to :: * move_to ::
* The `move to' emitter. * The 'move to' emitter.
* *
* line_to :: * line_to ::
* The segment emitter. * The segment emitter.
@ -654,12 +654,12 @@ FT_BEGIN_HEADER
* version of the original coordinates (this is important for high * version of the original coordinates (this is important for high
* accuracy during scan-conversion). The transformation is simple: * accuracy during scan-conversion). The transformation is simple:
* *
* { * ```
* x' = (x << shift) - delta * x' = (x << shift) - delta
* y' = (y << shift) - delta * y' = (y << shift) - delta
* } * ```
* *
* Set the values of `shift' and `delta' to~0 to get the original * Set the values of 'shift' and 'delta' to~0 to get the original
* point coordinates. * point coordinates.
*/ */
typedef struct FT_Outline_Funcs_ typedef struct FT_Outline_Funcs_
@ -696,9 +696,9 @@ FT_BEGIN_HEADER
* should redefine this macro in case of problems to something like * should redefine this macro in case of problems to something like
* this: * this:
* *
* { * ```
* #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value * #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value
* } * ```
* *
* to get a simple enumeration without assigning special numbers. * to get a simple enumeration without assigning special numbers.
*/ */
@ -733,13 +733,13 @@ FT_BEGIN_HEADER
* *
* FT_GLYPH_FORMAT_BITMAP :: * FT_GLYPH_FORMAT_BITMAP ::
* The glyph image is a bitmap, and can be described as an * The glyph image is a bitmap, and can be described as an
* @FT_Bitmap. You generally need to access the `bitmap' field of * @FT_Bitmap. You generally need to access the 'bitmap' field of
* the @FT_GlyphSlotRec structure to read it. * the @FT_GlyphSlotRec structure to read it.
* *
* FT_GLYPH_FORMAT_OUTLINE :: * FT_GLYPH_FORMAT_OUTLINE ::
* The glyph image is a vectorial outline made of line segments * The glyph image is a vectorial outline made of line segments
* and Bezier arcs; it can be described as an @FT_Outline; you * and Bezier arcs; it can be described as an @FT_Outline; you
* generally want to access the `outline' field of the * generally want to access the 'outline' field of the
* @FT_GlyphSlotRec structure to read it. * @FT_GlyphSlotRec structure to read it.
* *
* FT_GLYPH_FORMAT_PLOTTER :: * FT_GLYPH_FORMAT_PLOTTER ::
@ -892,7 +892,7 @@ FT_BEGIN_HEADER
* The number of spans to draw on this scanline. * The number of spans to draw on this scanline.
* *
* spans :: * spans ::
* A table of `count' spans to draw on the scanline. * A table of 'count' spans to draw on the scanline.
* *
* user :: * user ::
* User-supplied data that is passed to the callback. * User-supplied data that is passed to the callback.
@ -947,7 +947,7 @@ FT_BEGIN_HEADER
* FT_RASTER_FLAG_XXX * FT_RASTER_FLAG_XXX
* *
* @description: * @description:
* A list of bit flag constants as used in the `flags' field of a * A list of bit flag constants as used in the 'flags' field of a
* @FT_Raster_Params structure. * @FT_Raster_Params structure.
* *
* @values: * @values:
@ -977,7 +977,7 @@ FT_BEGIN_HEADER
* This flag is only used in direct * This flag is only used in direct
* rendering mode. If set, the output will * rendering mode. If set, the output will
* be clipped to a box specified in the * be clipped to a box specified in the
* `clip_box' field of the * `clip_box` field of the
* @FT_Raster_Params structure. * @FT_Raster_Params structure.
* *
* Note that by default, the glyph bitmap * Note that by default, the glyph bitmap
@ -1042,11 +1042,11 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA * An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA
* bit flag is set in the `flags' field, otherwise a monochrome * bit flag is set in the 'flags' field, otherwise a monochrome
* bitmap is generated. * bitmap is generated.
* *
* If the @FT_RASTER_FLAG_DIRECT bit flag is set in `flags', the * If the @FT_RASTER_FLAG_DIRECT bit flag is set in 'flags', the
* raster will call the `gray_spans' callback to draw gray pixel * raster will call the `gray_spans` callback to draw gray pixel
* spans. This allows direct composition over a pre-existing bitmap * spans. This allows direct composition over a pre-existing bitmap
* through user-provided callbacks to perform the span drawing and * through user-provided callbacks to perform the span drawing and
* composition. Not supported by the monochrome rasterizer. * composition. Not supported by the monochrome rasterizer.
@ -1086,7 +1086,7 @@ FT_BEGIN_HEADER
* Error code. 0~means success. * Error code. 0~means success.
* *
* @note: * @note:
* The `memory' parameter is a typeless pointer in order to avoid * The 'memory' parameter is a typeless pointer in order to avoid
* un-wanted dependencies on the rest of the FreeType code. In * un-wanted dependencies on the rest of the FreeType code. In
* practice, it is an @FT_Memory object, i.e., a handle to the * practice, it is an @FT_Memory object, i.e., a handle to the
* standard FreeType memory allocator. However, this field can be * standard FreeType memory allocator. However, this field can be
@ -1123,7 +1123,7 @@ FT_BEGIN_HEADER
* FT_Raster_ResetFunc * FT_Raster_ResetFunc
* *
* @description: * @description:
* FreeType used to provide an area of memory called the `render * FreeType used to provide an area of memory called the 'render
* pool' available to all registered rasterizers. This was not * pool' available to all registered rasterizers. This was not
* thread safe, however, and now FreeType never allocates this pool. * thread safe, however, and now FreeType never allocates this pool.
* *
@ -1162,7 +1162,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* This function is a generic facility to change modes or attributes * This function is a generic facility to change modes or attributes
* in a given raster. This can be used for debugging purposes, or * in a given raster. This can be used for debugging purposes, or
* simply to allow implementation-specific `features' in a given * simply to allow implementation-specific 'features' in a given
* raster module. * raster module.
* *
* @input: * @input:
@ -1210,12 +1210,12 @@ FT_BEGIN_HEADER
* glyph formats. * glyph formats.
* *
* Note also that the render function can fail and return a * Note also that the render function can fail and return a
* `FT_Err_Unimplemented_Feature' error code if the raster used does * `FT_Err_Unimplemented_Feature` error code if the raster used does
* not support direct composition. * not support direct composition.
* *
* XXX: For now, the standard raster doesn't support direct * XXX: For now, the standard raster doesn't support direct
* composition but this should change for the final release (see * composition but this should change for the final release (see
* the files `demos/src/ftgrays.c' and `demos/src/ftgrays2.c' * the files 'demos/src/ftgrays.c' and 'demos/src/ftgrays2.c'
* for examples of distinct implementations that support direct * for examples of distinct implementations that support direct
* composition). * composition).
*/ */

14
include/freetype/ftincrem.h
View File

@ -45,7 +45,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* This section contains various functions used to perform so-called * This section contains various functions used to perform so-called
* `incremental' glyph loading. This is a mode where all glyphs loaded * 'incremental' glyph loading. This is a mode where all glyphs loaded
* from a given @FT_Face are provided by the client application. * from a given @FT_Face are provided by the client application.
* *
* Apart from that, all other tables are loaded normally from the font * Apart from that, all other tables are loaded normally from the font
@ -67,7 +67,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* An opaque type describing a user-provided object used to implement * An opaque type describing a user-provided object used to implement
* `incremental' glyph loading within FreeType. This is used to support * 'incremental' glyph loading within FreeType. This is used to support
* embedded fonts in certain environments (e.g., PostScript interpreters), * embedded fonts in certain environments (e.g., PostScript interpreters),
* where the glyph data isn't in the font file, or must be overridden by * where the glyph data isn't in the font file, or must be overridden by
* different values. * different values.
@ -109,7 +109,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* These correspond to horizontal or vertical metrics depending on the * These correspond to horizontal or vertical metrics depending on the
* value of the `vertical' argument to the function * value of the 'vertical' argument to the function
* @FT_Incremental_GetGlyphMetricsFunc. * @FT_Incremental_GetGlyphMetricsFunc.
* *
*/ */
@ -147,8 +147,8 @@ FT_BEGIN_HEADER
* *
* Note that the format of the glyph's data bytes depends on the font * Note that the format of the glyph's data bytes depends on the font
* file format. For TrueType, it must correspond to the raw bytes within * file format. For TrueType, it must correspond to the raw bytes within
* the `glyf' table. For PostScript formats, it must correspond to the * the 'glyf' table. For PostScript formats, it must correspond to the
* *unencrypted* charstring bytes, without any `lenIV' header. It is * **unencrypted** charstring bytes, without any `lenIV` header. It is
* undefined for any other format. * undefined for any other format.
* *
* @input: * @input:
@ -286,7 +286,7 @@ FT_BEGIN_HEADER
* wants to support incremental glyph loading. You should use it with * wants to support incremental glyph loading. You should use it with
* @FT_PARAM_TAG_INCREMENTAL as in the following example: * @FT_PARAM_TAG_INCREMENTAL as in the following example:
* *
* { * ```
* FT_Incremental_InterfaceRec inc_int; * FT_Incremental_InterfaceRec inc_int;
* FT_Parameter parameter; * FT_Parameter parameter;
* FT_Open_Args open_args; * FT_Open_Args open_args;
@ -309,7 +309,7 @@ FT_BEGIN_HEADER
* // open the font * // open the font
* error = FT_Open_Face( library, &open_args, index, &face ); * error = FT_Open_Face( library, &open_args, index, &face );
* ... * ...
* } * ```
* *
*/ */
typedef struct FT_Incremental_InterfaceRec_ typedef struct FT_Incremental_InterfaceRec_

16
include/freetype/ftlcdfil.h
View File

@ -47,7 +47,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* FreeType provides two alternative subpixel rendering technologies. * FreeType provides two alternative subpixel rendering technologies.
* Should you #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your * Should you #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your
* `ftoption.h', this enables patented ClearType-style rendering. * `ftoption.h`, this enables patented ClearType-style rendering.
* Otherwise, Harmony LCD rendering is enabled. These technologies are * Otherwise, Harmony LCD rendering is enabled. These technologies are
* controlled differently and API described below, although always * controlled differently and API described below, although always
* available, performs its function when appropriate method is enabled * available, performs its function when appropriate method is enabled
@ -156,7 +156,7 @@ FT_BEGIN_HEADER
* FreeType. * FreeType.
* *
* @since: * @since:
* 2.3.0 (`FT_LCD_FILTER_LEGACY1' since 2.6.2) * 2.3.0 (`FT_LCD_FILTER_LEGACY1` since 2.6.2)
*/ */
typedef enum FT_LcdFilter_ typedef enum FT_LcdFilter_
{ {
@ -197,11 +197,11 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* This feature is always disabled by default. Clients must make an * This feature is always disabled by default. Clients must make an
* explicit call to this function with a `filter' value other than * explicit call to this function with a 'filter' value other than
* @FT_LCD_FILTER_NONE in order to enable it. * @FT_LCD_FILTER_NONE in order to enable it.
* *
* Due to *PATENTS* covering subpixel rendering, this function doesn't * Due to **PATENTS** covering subpixel rendering, this function doesn't
* do anything except returning `FT_Err_Unimplemented_Feature' if the * do anything except returning `FT_Err_Unimplemented_Feature` if the
* configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
* defined in your build of the library, which should correspond to all * defined in your build of the library, which should correspond to all
* default builds of FreeType. * default builds of FreeType.
@ -235,8 +235,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* Due to *PATENTS* covering subpixel rendering, this function doesn't * Due to **PATENTS** covering subpixel rendering, this function doesn't
* do anything except returning `FT_Err_Unimplemented_Feature' if the * do anything except returning `FT_Err_Unimplemented_Feature` if the
* configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
* defined in your build of the library, which should correspond to all * defined in your build of the library, which should correspond to all
* default builds of FreeType. * default builds of FreeType.
@ -305,7 +305,7 @@ FT_BEGIN_HEADER
* *
* - {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement. * - {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement.
* *
* This function does nothing and returns `FT_Err_Unimplemented_Feature' * This function does nothing and returns `FT_Err_Unimplemented_Feature`
* in the context of ClearType-style subpixel rendering when * in the context of ClearType-style subpixel rendering when
* FT_CONFIG_OPTION_SUBPIXEL_RENDERING is defined in your build of the * FT_CONFIG_OPTION_SUBPIXEL_RENDERING is defined in your build of the
* library. * library.

8
include/freetype/ftlzw.h
View File

@ -54,7 +54,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Open a new stream to parse LZW-compressed font files. This is * Open a new stream to parse LZW-compressed font files. This is
* mainly used to support the compressed `*.pcf.Z' fonts that come * mainly used to support the compressed `*.pcf.Z` fonts that come
* with XFree86. * with XFree86.
* *
* @input: * @input:
@ -70,8 +70,8 @@ FT_BEGIN_HEADER
* @note: * @note:
* The source stream must be opened _before_ calling this function. * The source stream must be opened _before_ calling this function.
* *
* Calling the internal function `FT_Stream_Close' on the new stream will * Calling the internal function `FT_Stream_Close` on the new stream will
* *not* call `FT_Stream_Close' on the source stream. None of the stream * **not** call `FT_Stream_Close` on the source stream. None of the stream
* objects will be released to the heap. * objects will be released to the heap.
* *
* The stream implementation is very basic and resets the decompression * The stream implementation is very basic and resets the decompression
@ -83,7 +83,7 @@ FT_BEGIN_HEADER
* compressed file, the library will try to open a LZW stream from it * compressed file, the library will try to open a LZW stream from it
* and re-open the face with it. * and re-open the face with it.
* *
* This function may return `FT_Err_Unimplemented_Feature' if your build * This function may return `FT_Err_Unimplemented_Feature` if your build
* of FreeType was not compiled with LZW support. * of FreeType was not compiled with LZW support.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

8
include/freetype/ftmac.h
View File

@ -82,7 +82,7 @@ FT_BEGIN_HEADER
* A FOND resource. * A FOND resource.
* *
* face_index :: * face_index ::
* Only supported for the -1 `sanity check' special * Only supported for the -1 'sanity check' special
* case. * case.
* *
* @output: * @output:
@ -96,10 +96,10 @@ FT_BEGIN_HEADER
* This function can be used to create @FT_Face objects from fonts * This function can be used to create @FT_Face objects from fonts
* that are installed in the system as follows. * that are installed in the system as follows.
* *
* { * ```
* fond = GetResource( 'FOND', fontName ); * fond = GetResource( 'FOND', fontName );
* error = FT_New_Face_From_FOND( library, fond, 0, &face ); * error = FT_New_Face_From_FOND( library, fond, 0, &face );
* } * ```
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_New_Face_From_FOND( FT_Library library, FT_New_Face_From_FOND( FT_Library library,
@ -192,7 +192,7 @@ FT_BEGIN_HEADER
* buffer before calling this function. * buffer before calling this function.
* *
* maxPathSize :: * maxPathSize ::
* Lengths of the buffer `path' that client allocated. * Lengths of the buffer 'path' that client allocated.
* *
* face_index :: * face_index ::
* Index of the face. For passing to @FT_New_Face. * Index of the face. For passing to @FT_New_Face.

62
include/freetype/ftmm.h
View File

@ -143,18 +143,18 @@ FT_BEGIN_HEADER
* The axis's maximum design coordinate. * The axis's maximum design coordinate.
* *
* tag :: * tag ::
* The axis's tag (the equivalent to `name' for TrueType * The axis's tag (the equivalent to 'name' for TrueType
* GX and OpenType variation fonts). FreeType provides * GX and OpenType variation fonts). FreeType provides
* default values for Adobe MM fonts if possible. * default values for Adobe MM fonts if possible.
* *
* strid :: * strid ::
* The axis name entry in the font's `name' table. This * The axis name entry in the font's 'name' table. This
* is another (and often better) version of the `name' * is another (and often better) version of the 'name'
* field for TrueType GX or OpenType variation fonts. Not * field for TrueType GX or OpenType variation fonts. Not
* meaningful for Adobe MM fonts. * meaningful for Adobe MM fonts.
* *
* @note: * @note:
* The fields `minimum', `def', and `maximum' are 16.16 fractional * The fields 'minimum', 'def', and 'maximum' are 16.16 fractional
* values for TrueType GX and OpenType variation fonts. For Adobe MM * values for TrueType GX and OpenType variation fonts. For Adobe MM
* fonts, the values are integers. * fonts, the values are integers.
*/ */
@ -189,10 +189,10 @@ FT_BEGIN_HEADER
* This is an array with one entry for each axis. * This is an array with one entry for each axis.
* *
* strid :: * strid ::
* The entry in `name' table identifying this instance. * The entry in 'name' table identifying this instance.
* *
* psid :: * psid ::
* The entry in `name' table identifying a PostScript name * The entry in 'name' table identifying a PostScript name
* for this instance. Value 0xFFFF indicates a missing * for this instance. Value 0xFFFF indicates a missing
* entry. * entry.
*/ */
@ -230,12 +230,12 @@ FT_BEGIN_HEADER
* number of designs). * number of designs).
* *
* num_namedstyles :: * num_namedstyles ::
* The number of named styles; a `named style' is * The number of named styles; a 'named style' is
* a tuple of design coordinates that has a string * a tuple of design coordinates that has a string
* ID (in the `name' table) associated with it. * ID (in the 'name' table) associated with it.
* The font can tell the user that, for example, * The font can tell the user that, for example,
* [Weight=1.5,Width=1.1] is `Bold'. Another name * [Weight=1.5,Width=1.1] is 'Bold'. Another name
* for `named style' is `named instance'. * for 'named style' is 'named instance'.
* *
* For Adobe Multiple Masters fonts, this value is * For Adobe Multiple Masters fonts, this value is
* always zero because the format does not support * always zero because the format does not support
@ -331,7 +331,7 @@ FT_BEGIN_HEADER
* @input: * @input:
* library :: * library ::
* A handle of the face's parent library object that was * A handle of the face's parent library object that was
* used in the call to @FT_Get_MM_Var to create `amaster'. * used in the call to @FT_Get_MM_Var to create 'amaster'.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -372,11 +372,11 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* [Since 2.8.1] To reset all axes to the default values, call the * [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL. * function with `num_coords` set to zero and 'coords' set to NULL.
* *
* [Since 2.9] If `num_coords' is larger than zero, this function * [Since 2.9] If `num_coords` is larger than zero, this function
* sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags' * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
* field (i.e., @FT_IS_VARIATION will return true). If `num_coords' * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset. * is zero, this bit flag gets unset.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -414,13 +414,13 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* [Since 2.8.1] To reset all axes to the default values, call the * [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL. * function with `num_coords` set to zero and 'coords' set to NULL.
* [Since 2.9] `Default values' means the currently selected named * [Since 2.9] 'Default values' means the currently selected named
* instance (or the base font if no named instance is selected). * instance (or the base font if no named instance is selected).
* *
* [Since 2.9] If `num_coords' is larger than zero, this function * [Since 2.9] If `num_coords` is larger than zero, this function
* sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags' * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
* field (i.e., @FT_IS_VARIATION will return true). If `num_coords' * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset. * is zero, this bit flag gets unset.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -498,13 +498,13 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* [Since 2.8.1] To reset all axes to the default values, call the * [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL. * function with `num_coords` set to zero and 'coords' set to NULL.
* [Since 2.9] `Default values' means the currently selected named * [Since 2.9] 'Default values' means the currently selected named
* instance (or the base font if no named instance is selected). * instance (or the base font if no named instance is selected).
* *
* [Since 2.9] If `num_coords' is larger than zero, this function * [Since 2.9] If `num_coords` is larger than zero, this function
* sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags' * sets the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags`
* field (i.e., @FT_IS_VARIATION will return true). If `num_coords' * field (i.e., @FT_IS_VARIATION will return true). If `num_coords`
* is zero, this bit flag gets unset. * is zero, this bit flag gets unset.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -606,9 +606,9 @@ FT_BEGIN_HEADER
* FT_Get_Var_Axis_Flags * FT_Get_Var_Axis_Flags
* *
* @description: * @description:
* Get the `flags' field of an OpenType Variation Axis Record. * Get the 'flags' field of an OpenType Variation Axis Record.
* *
* Not meaningful for Adobe MM fonts (`*flags' is always zero). * Not meaningful for Adobe MM fonts ('*flags' is always zero).
* *
* @input: * @input:
* master :: * master ::
@ -619,7 +619,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* flags :: * flags ::
* The `flags' field. See @FT_VAR_AXIS_FLAG_XXX for * The 'flags' field. See @FT_VAR_AXIS_FLAG_XXX for
* possible values. * possible values.
* *
* @return: * @return:
@ -656,10 +656,10 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The function uses the value of `instance_index' to set bits 16-30 * The function uses the value of `instance_index` to set bits 16-30
* of the face's `face_index' field. It also resets any variation * of the face's `face_index` field. It also resets any variation
* applied to the font, and the @FT_FACE_FLAG_VARIATION bit of the * applied to the font, and the @FT_FACE_FLAG_VARIATION bit of the
* face's `face_flags' field gets reset to zero (i.e., * face's `face_flags` field gets reset to zero (i.e.,
* @FT_IS_VARIATION will return false). * @FT_IS_VARIATION will return false).
* *
* For Adobe MM fonts (which don't have named instances) this * For Adobe MM fonts (which don't have named instances) this

52
include/freetype/ftmodapi.h
View File

@ -49,10 +49,10 @@ FT_BEGIN_HEADER
* Modules can be added, upgraded, and removed at runtime. * Modules can be added, upgraded, and removed at runtime.
* Additionally, some module properties can be controlled also. * Additionally, some module properties can be controlled also.
* *
* Here is a list of possible values of the `module_name' field in * Here is a list of possible values of the `module_name` field in
* the @FT_Module_Class structure. * the @FT_Module_Class structure.
* *
* { * ```
* autofitter * autofitter
* bdf * bdf
* cff * cff
@ -71,7 +71,7 @@ FT_BEGIN_HEADER
* type42 * type42
* t1cid * t1cid
* winfonts * winfonts
* } * ```
* *
* Note that the FreeType Cache sub-system is not a FreeType module. * Note that the FreeType Cache sub-system is not a FreeType module.
* *
@ -219,7 +219,7 @@ FT_BEGIN_HEADER
* module_interface :: * module_interface ::
* A typeless pointer to a structure (which varies between different * A typeless pointer to a structure (which varies between different
* modules) that holds the module's interface functions. This is * modules) that holds the module's interface functions. This is
* essentially what `get_interface' returns. * essentially what `get_interface` returns.
* *
* module_init :: * module_init ::
* The initializing function. * The initializing function.
@ -352,27 +352,27 @@ FT_BEGIN_HEADER
* *
* value :: * value ::
* A generic pointer to a variable or structure that gives the new * A generic pointer to a variable or structure that gives the new
* value of the property. The exact definition of `value' is * value of the property. The exact definition of 'value' is
* dependent on the property; see section @properties. * dependent on the property; see section @properties.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If `module_name' isn't a valid module name, or `property_name' * If `module_name` isn't a valid module name, or `property_name`
* doesn't specify a valid property, or if `value' doesn't represent a * doesn't specify a valid property, or if 'value' doesn't represent a
* valid value for the given property, an error is returned. * valid value for the given property, an error is returned.
* *
* The following example sets property `bar' (a simple integer) in * The following example sets property 'bar' (a simple integer) in
* module `foo' to value~1. * module 'foo' to value~1.
* *
* { * ```
* FT_UInt bar; * FT_UInt bar;
* *
* *
* bar = 1; * bar = 1;
* FT_Property_Set( library, "foo", "bar", &bar ); * FT_Property_Set( library, "foo", "bar", &bar );
* } * ```
* *
* Note that the FreeType Cache sub-system doesn't recognize module * Note that the FreeType Cache sub-system doesn't recognize module
* property changes. To avoid glyph lookup confusion within the cache * property changes. To avoid glyph lookup confusion within the cache
@ -417,20 +417,20 @@ FT_BEGIN_HEADER
* @inout: * @inout:
* value :: * value ::
* A generic pointer to a variable or structure that gives the * A generic pointer to a variable or structure that gives the
* value of the property. The exact definition of `value' is * value of the property. The exact definition of 'value' is
* dependent on the property; see section @properties. * dependent on the property; see section @properties.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If `module_name' isn't a valid module name, or `property_name' * If `module_name` isn't a valid module name, or `property_name`
* doesn't specify a valid property, or if `value' doesn't represent a * doesn't specify a valid property, or if 'value' doesn't represent a
* valid value for the given property, an error is returned. * valid value for the given property, an error is returned.
* *
* The following example gets property `baz' (a range) in module `foo'. * The following example gets property 'baz' (a range) in module 'foo'.
* *
* { * ```
* typedef range_ * typedef range_
* { * {
* FT_Int32 min; * FT_Int32 min;
@ -442,7 +442,7 @@ FT_BEGIN_HEADER
* *
* *
* FT_Property_Get( library, "foo", "baz", &baz ); * FT_Property_Get( library, "foo", "baz", &baz );
* } * ```
* *
* It is not possible to retrieve properties of the FreeType Cache * It is not possible to retrieve properties of the FreeType Cache
* sub-system with FT_Property_Get; use @FTC_Property_Get instead. * sub-system with FT_Property_Get; use @FTC_Property_Get instead.
@ -465,16 +465,16 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is * If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is
* set, this function reads the `FREETYPE_PROPERTIES' environment * set, this function reads the `FREETYPE_PROPERTIES` environment
* variable to control driver properties. See section @properties * variable to control driver properties. See section @properties
* for more. * for more.
* *
* If the compilation option is not set, this function does nothing. * If the compilation option is not set, this function does nothing.
* *
* `FREETYPE_PROPERTIES' has the following syntax form (broken here * `FREETYPE_PROPERTIES` has the following syntax form (broken here
* into multiple lines for better readability). * into multiple lines for better readability).
* *
* { * ```
* <optional whitespace> * <optional whitespace>
* <module-name1> ':' * <module-name1> ':'
* <property-name1> '=' <property-value1> * <property-name1> '=' <property-value1>
@ -482,15 +482,15 @@ FT_BEGIN_HEADER
* <module-name2> ':' * <module-name2> ':'
* <property-name2> '=' <property-value2> * <property-name2> '=' <property-value2>
* ... * ...
* } * ```
* *
* Example: * Example:
* *
* { * ```
* FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ * FREETYPE_PROPERTIES=truetype:interpreter-version=35 \
* cff:no-stem-darkening=1 \ * cff:no-stem-darkening=1 \
* autofitter:warping=1 * autofitter:warping=1
* } * ```
* *
* @inout: * @inout:
* library :: * library ::
@ -616,8 +616,8 @@ FT_BEGIN_HEADER
* @input: * @input:
* hook_index :: * hook_index ::
* The index of the debug hook. You should use the * The index of the debug hook. You should use the
* values defined in `ftobjs.h', e.g., * values defined in `ftobjs.h`, e.g.,
* `FT_DEBUG_HOOK_TRUETYPE'. * `FT_DEBUG_HOOK_TRUETYPE`.
* *
* debug_hook :: * debug_hook ::
* The function used to debug the interpreter. * The function used to debug the interpreter.
@ -627,7 +627,7 @@ FT_BEGIN_HEADER
* the TrueType and the Type~1 interpreter) are defined. * the TrueType and the Type~1 interpreter) are defined.
* *
* Since the internal headers of FreeType are no longer installed, * Since the internal headers of FreeType are no longer installed,
* the symbol `FT_DEBUG_HOOK_TRUETYPE' isn't available publicly. * the symbol `FT_DEBUG_HOOK_TRUETYPE` isn't available publicly.
* This is a bug and will be fixed in a forthcoming release. * This is a bug and will be fixed in a forthcoming release.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )

44
include/freetype/ftoutln.h
View File

@ -47,7 +47,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* This section contains routines used to create and destroy scalable * This section contains routines used to create and destroy scalable
* glyph images known as `outlines'. These can also be measured, * glyph images known as 'outlines'. These can also be measured,
* transformed, and converted into bitmaps and pixmaps. * transformed, and converted into bitmaps and pixmaps.
* *
* @order: * @order:
@ -89,7 +89,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Walk over an outline's structure to decompose it into individual * Walk over an outline's structure to decompose it into individual
* segments and Bezier arcs. This function also emits `move to' * segments and Bezier arcs. This function also emits 'move to'
* operations to indicate the start of new contours in the outline. * operations to indicate the start of new contours in the outline.
* *
* @input: * @input:
@ -97,7 +97,7 @@ FT_BEGIN_HEADER
* A pointer to the source target. * A pointer to the source target.
* *
* func_interface :: * func_interface ::
* A table of `emitters', i.e., function pointers * A table of 'emitters', i.e., function pointers
* called during decomposition to indicate path * called during decomposition to indicate path
* operations. * operations.
* *
@ -113,7 +113,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* A contour that contains a single point only is represented by a * A contour that contains a single point only is represented by a
* `move to' operation followed by `line to' to the same point. In * 'move to' operation followed by 'line to' to the same point. In
* most cases, it is best to filter this out before using the * most cases, it is best to filter this out before using the
* outline for stroking purposes (otherwise it would result in a * outline for stroking purposes (otherwise it would result in a
* visible dot when round caps are used). * visible dot when round caps are used).
@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* library :: * library ::
* A handle to the library object from where the * A handle to the library object from where the
* outline is allocated. Note however that the new * outline is allocated. Note however that the new
* outline will *not* necessarily be *freed*, when * outline will **not** necessarily be **freed**, when
* destroying the library, by @FT_Done_FreeType. * destroying the library, by @FT_Done_FreeType.
* *
* numPoints :: * numPoints ::
@ -149,7 +149,7 @@ FT_BEGIN_HEADER
* *
* numContours :: * numContours ::
* The maximum number of contours within the outline. * The maximum number of contours within the outline.
* This value must be in the range 0 to `numPoints'. * This value must be in the range 0 to `numPoints`.
* *
* @output: * @output:
* anoutline :: * anoutline ::
@ -159,7 +159,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The reason why this function takes a `library' parameter is simply * The reason why this function takes a 'library' parameter is simply
* to use the library's memory allocator. * to use the library's memory allocator.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -196,7 +196,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If the outline's `owner' field is not set, only the outline * If the outline's 'owner' field is not set, only the outline
* descriptor will be released. * descriptor will be released.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -238,7 +238,7 @@ FT_BEGIN_HEADER
* FT_Outline_Get_CBox * FT_Outline_Get_CBox
* *
* @description: * @description:
* Return an outline's `control box'. The control box encloses all * Return an outline's 'control box'. The control box encloses all
* the outline's points, including Bezier control points. Though it * the outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be * coincides with the exact bounding box for most glyphs, it can be
* slightly larger in some situations (like when rotating an outline * slightly larger in some situations (like when rotating an outline
@ -247,7 +247,7 @@ FT_BEGIN_HEADER
* Computing the control box is very fast, while getting the bounding * Computing the control box is very fast, while getting the bounding
* box can take much more time as it needs to walk over all segments * box can take much more time as it needs to walk over all segments
* and arcs in the outline. To get the latter, you can use the * and arcs in the outline. To get the latter, you can use the
* `ftbbox' component, which is dedicated to this single task. * 'ftbbox' component, which is dedicated to this single task.
* *
* @input: * @input:
* outline :: * outline ::
@ -349,10 +349,10 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Embolden an outline. The new outline will be at most 4~times * Embolden an outline. The new outline will be at most 4~times
* `strength' pixels wider and higher. You may think of the left and * 'strength' pixels wider and higher. You may think of the left and
* bottom borders as unchanged. * bottom borders as unchanged.
* *
* Negative `strength' values to reduce the outline thickness are * Negative 'strength' values to reduce the outline thickness are
* possible also. * possible also.
* *
* @inout: * @inout:
@ -373,19 +373,19 @@ FT_BEGIN_HEADER
* situations like acute angles or intersections are sometimes * situations like acute angles or intersections are sometimes
* handled incorrectly. * handled incorrectly.
* *
* If you need `better' metrics values you should call * If you need 'better' metrics values you should call
* @FT_Outline_Get_CBox or @FT_Outline_Get_BBox. * @FT_Outline_Get_CBox or @FT_Outline_Get_BBox.
* *
* To get meaningful results, font scaling values must be set with * To get meaningful results, font scaling values must be set with
* functions like @FT_Set_Char_Size before calling FT_Render_Glyph. * functions like @FT_Set_Char_Size before calling FT_Render_Glyph.
* *
* @example: * @example:
* { * ```
* FT_Load_Glyph( face, index, FT_LOAD_DEFAULT ); * FT_Load_Glyph( face, index, FT_LOAD_DEFAULT );
* *
* if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE ) * if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE )
* FT_Outline_Embolden( &face->glyph->outline, strength ); * FT_Outline_Embolden( &face->glyph->outline, strength );
* } * ```
* *
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -399,8 +399,8 @@ FT_BEGIN_HEADER
* FT_Outline_EmboldenXY * FT_Outline_EmboldenXY
* *
* @description: * @description:
* Embolden an outline. The new outline will be `xstrength' pixels * Embolden an outline. The new outline will be 'xstrength' pixels
* wider and `ystrength' pixels higher. Otherwise, it is similar to * wider and 'ystrength' pixels higher. Otherwise, it is similar to
* @FT_Outline_Embolden, which uses the same strength in both * @FT_Outline_Embolden, which uses the same strength in both
* directions. * directions.
* *
@ -428,7 +428,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in * This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in
* the outline's `flags' field. * the outline's 'flags' field.
* *
* It shouldn't be used by a normal client application, unless it * It shouldn't be used by a normal client application, unless it
* knows what it is doing. * knows what it is doing.
@ -463,11 +463,11 @@ FT_BEGIN_HEADER
* @note: * @note:
* This function does NOT CREATE the bitmap, it only renders an * This function does NOT CREATE the bitmap, it only renders an
* outline image within the one you pass to it! Consequently, the * outline image within the one you pass to it! Consequently, the
* various fields in `abitmap' should be set accordingly. * various fields in 'abitmap' should be set accordingly.
* *
* It will use the raster corresponding to the default glyph format. * It will use the raster corresponding to the default glyph format.
* *
* The value of the `num_grays' field in `abitmap' is ignored. If * The value of the `num_grays` field in 'abitmap' is ignored. If
* you select the gray-level rasterizer, and you want less than 256 * you select the gray-level rasterizer, and you want less than 256
* gray levels, you have to use @FT_Outline_Render directly. * gray levels, you have to use @FT_Outline_Render directly.
*/ */
@ -507,13 +507,13 @@ FT_BEGIN_HEADER
* You should know what you are doing and how @FT_Raster_Params works * You should know what you are doing and how @FT_Raster_Params works
* to use this function. * to use this function.
* *
* The field `params.source' will be set to `outline' before the scan * 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 * converter is called, which means that the value you give to it is
* actually ignored. * actually ignored.
* *
* The gray-level rasterizer always uses 256 gray levels. If you * The gray-level rasterizer always uses 256 gray levels. If you
* want less gray levels, you have to provide your own span callback. * want less gray levels, you have to provide your own span callback.
* See the @FT_RASTER_FLAG_DIRECT value of the `flags' field in the * See the @FT_RASTER_FLAG_DIRECT value of the 'flags' field in the
* @FT_Raster_Params structure for more details. * @FT_Raster_Params structure for more details.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

6
include/freetype/ftparams.h
View File

@ -58,7 +58,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic * A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
* family names in the `name' table (introduced in OpenType version * family names in the 'name' table (introduced in OpenType version
* 1.4). Use this for backward compatibility with legacy systems that * 1.4). Use this for backward compatibility with legacy systems that
* have a four-faces-per-family restriction. * have a four-faces-per-family restriction.
* *
@ -82,7 +82,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic * A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
* subfamily names in the `name' table (introduced in OpenType version * subfamily names in the 'name' table (introduced in OpenType version
* 1.4). Use this for backward compatibility with legacy systems that * 1.4). Use this for backward compatibility with legacy systems that
* have a four-faces-per-family restriction. * have a four-faces-per-family restriction.
* *
@ -165,7 +165,7 @@ FT_BEGIN_HEADER
* *
* This is a passive setting that only takes effect if the font driver * This is a passive setting that only takes effect if the font driver
* or autohinter honors it, which the CFF, Type~1, and CID drivers * or autohinter honors it, which the CFF, Type~1, and CID drivers
* always do, but the autohinter only in `light' hinting mode (as of * always do, but the autohinter only in 'light' hinting mode (as of
* version 2.9). * version 2.9).
* *
* @since: * @since:

12
include/freetype/ftpfr.h
View File

@ -63,21 +63,21 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* aoutline_resolution :: * aoutline_resolution ::
* Outline resolution. This is equivalent to `face->units_per_EM' * Outline resolution. This is equivalent to `face->units_per_EM`
* for non-PFR fonts. Optional (parameter can be NULL). * for non-PFR fonts. Optional (parameter can be NULL).
* *
* ametrics_resolution :: * ametrics_resolution ::
* Metrics resolution. This is equivalent to `outline_resolution' * Metrics resolution. This is equivalent to `outline_resolution`
* for non-PFR fonts. Optional (parameter can be NULL). * for non-PFR fonts. Optional (parameter can be NULL).
* *
* ametrics_x_scale :: * ametrics_x_scale ::
* A 16.16 fixed-point number used to scale distance expressed * A 16.16 fixed-point number used to scale distance expressed
* in metrics units to device subpixels. This is equivalent to * in metrics units to device subpixels. This is equivalent to
* `face->size->x_scale', but for metrics only. Optional (parameter * `face->size->x_scale`, but for metrics only. Optional (parameter
* can be NULL). * can be NULL).
* *
* ametrics_y_scale :: * ametrics_y_scale ::
* Same as `ametrics_x_scale' but for the vertical direction. * Same as `ametrics_x_scale` but for the vertical direction.
* optional (parameter can be NULL). * optional (parameter can be NULL).
* *
* @return: * @return:
@ -127,7 +127,7 @@ FT_BEGIN_HEADER
* units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED * units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED
* mode, which always returns distances converted to outline units. * mode, which always returns distances converted to outline units.
* *
* You can use the value of the `x_scale' and `y_scale' parameters * You can use the value of the `x_scale` and `y_scale` parameters
* returned by @FT_Get_PFR_Metrics to scale these to device subpixels. * returned by @FT_Get_PFR_Metrics to scale these to device subpixels.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -161,7 +161,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics * You can use the `x_scale` or `y_scale` results of @FT_Get_PFR_Metrics
* to convert the advance to device subpixels (i.e., 1/64th of pixels). * to convert the advance to device subpixels (i.e., 1/64th of pixels).
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

2
include/freetype/ftrender.h
View File

@ -226,7 +226,7 @@ FT_BEGIN_HEADER
* *
* This doesn't change the current renderer for other formats. * This doesn't change the current renderer for other formats.
* *
* Currently, no FreeType renderer module uses `parameters'; you * Currently, no FreeType renderer module uses 'parameters'; you
* should thus always pass NULL as the value. * should thus always pass NULL as the value.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )

12
include/freetype/ftsizes.h
View File

@ -56,7 +56,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* When creating a new face object (e.g., with @FT_New_Face), an * When creating a new face object (e.g., with @FT_New_Face), an
* @FT_Size object is automatically created and used to store all * @FT_Size object is automatically created and used to store all
* pixel-size dependent information, available in the `face->size' * pixel-size dependent information, available in the `face->size`
* field. * field.
* *
* It is however possible to create more sizes for a given face, * It is however possible to create more sizes for a given face,
@ -64,7 +64,7 @@ FT_BEGIN_HEADER
* same font family and style. See @FT_New_Size and @FT_Done_Size. * same font family and style. See @FT_New_Size and @FT_Done_Size.
* *
* Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only * Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only
* modify the contents of the current `active' size; you thus need * modify the contents of the current 'active' size; you thus need
* to use @FT_Activate_Size to change it. * to use @FT_Activate_Size to change it.
* *
* 99% of applications won't need the functions provided here, * 99% of applications won't need the functions provided here,
@ -133,9 +133,9 @@ FT_BEGIN_HEADER
* Even though it is possible to create several size objects for a * Even though it is possible to create several size objects for a
* given face (see @FT_New_Size for details), functions like * given face (see @FT_New_Size for details), functions like
* @FT_Load_Glyph or @FT_Load_Char only use the one that has been * @FT_Load_Glyph or @FT_Load_Char only use the one that has been
* activated last to determine the `current character pixel size'. * activated last to determine the 'current character pixel size'.
* *
* This function can be used to `activate' a previously created size * This function can be used to 'activate' a previously created size
* object. * object.
* *
* @input: * @input:
@ -146,8 +146,8 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If `face' is the size's parent face object, this function changes * If 'face' is the size's parent face object, this function changes
* the value of `face->size' to the input size handle. * the value of `face->size` to the input size handle.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Activate_Size( FT_Size size ); FT_Activate_Size( FT_Size size );

56
include/freetype/ftsnames.h
View File

@ -50,7 +50,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* The TrueType and OpenType specifications allow the inclusion of * The TrueType and OpenType specifications allow the inclusion of
* a special names table (`name') in font files. This table contains * a special names table ('name') in font files. This table contains
* textual (and internationalized) information regarding the font, * textual (and internationalized) information regarding the font,
* like family name, copyright, version, etc. * like family name, copyright, version, etc.
* *
@ -67,43 +67,43 @@ FT_BEGIN_HEADER
* FT_SfntName * FT_SfntName
* *
* @description: * @description:
* A structure used to model an SFNT `name' table entry. * A structure used to model an SFNT 'name' table entry.
* *
* @fields: * @fields:
* platform_id :: * platform_id ::
* The platform ID for `string'. * The platform ID for 'string'.
* See @TT_PLATFORM_XXX for possible values. * See @TT_PLATFORM_XXX for possible values.
* *
* encoding_id :: * encoding_id ::
* The encoding ID for `string'. * The encoding ID for 'string'.
* See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, * See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX,
* @TT_ISO_ID_XXX, @TT_MS_ID_XXX, and @TT_ADOBE_ID_XXX * @TT_ISO_ID_XXX, @TT_MS_ID_XXX, and @TT_ADOBE_ID_XXX
* for possible values. * for possible values.
* *
* language_id :: * language_id ::
* The language ID for `string'. * The language ID for 'string'.
* See @TT_MAC_LANGID_XXX and @TT_MS_LANGID_XXX for * See @TT_MAC_LANGID_XXX and @TT_MS_LANGID_XXX for
* possible values. * possible values.
* *
* Registered OpenType values for `language_id' are * Registered OpenType values for `language_id` are
* always smaller than 0x8000; values equal or larger * always smaller than 0x8000; values equal or larger
* than 0x8000 usually indicate a language tag string * than 0x8000 usually indicate a language tag string
* (introduced in OpenType version 1.6). Use function * (introduced in OpenType version 1.6). Use function
* @FT_Get_Sfnt_LangTag with `language_id' as its * @FT_Get_Sfnt_LangTag with `language_id` as its
* argument to retrieve the associated language tag. * argument to retrieve the associated language tag.
* *
* name_id :: * name_id ::
* An identifier for `string'. * An identifier for 'string'.
* See @TT_NAME_ID_XXX for possible values. * See @TT_NAME_ID_XXX for possible values.
* *
* string :: * string ::
* The `name' string. Note that its format differs * The 'name' string. Note that its format differs
* depending on the (platform,encoding) pair, being * depending on the (platform,encoding) pair, being
* either a string of bytes (without a terminating * either a string of bytes (without a terminating
* NULL byte) or containing UTF-16BE entities. * NULL byte) or containing UTF-16BE entities.
* *
* string_len :: * string_len ::
* The length of `string' in bytes. * The length of 'string' in bytes.
* *
* @note: * @note:
* Please refer to the TrueType or OpenType specification for more * Please refer to the TrueType or OpenType specification for more
@ -128,18 +128,18 @@ FT_BEGIN_HEADER
* FT_Get_Sfnt_Name_Count * FT_Get_Sfnt_Name_Count
* *
* @description: * @description:
* Retrieve the number of name strings in the SFNT `name' table. * Retrieve the number of name strings in the SFNT 'name' table.
* *
* @input: * @input:
* face :: * face ::
* A handle to the source face. * A handle to the source face.
* *
* @return: * @return:
* The number of strings in the `name' table. * The number of strings in the 'name' table.
* *
* @note: * @note:
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
*/ */
FT_EXPORT( FT_UInt ) FT_EXPORT( FT_UInt )
FT_Get_Sfnt_Name_Count( FT_Face face ); FT_Get_Sfnt_Name_Count( FT_Face face );
@ -151,14 +151,14 @@ FT_BEGIN_HEADER
* FT_Get_Sfnt_Name * FT_Get_Sfnt_Name
* *
* @description: * @description:
* Retrieve a string of the SFNT `name' table for a given index. * Retrieve a string of the SFNT 'name' table for a given index.
* *
* @input: * @input:
* face :: * face ::
* A handle to the source face. * A handle to the source face.
* *
* idx :: * idx ::
* The index of the `name' string. * The index of the 'name' string.
* *
* @output: * @output:
* aname :: * aname ::
@ -168,19 +168,19 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The `string' array returned in the `aname' structure is not * The 'string' array returned in the 'aname' structure is not
* null-terminated. Note that you don't have to deallocate `string' * null-terminated. Note that you don't have to deallocate 'string'
* by yourself; FreeType takes care of it if you call @FT_Done_Face. * by yourself; FreeType takes care of it if you call @FT_Done_Face.
* *
* Use @FT_Get_Sfnt_Name_Count to get the total number of available * Use @FT_Get_Sfnt_Name_Count to get the total number of available
* `name' table entries, then do a loop until you get the right * 'name' table entries, then do a loop until you get the right
* platform, encoding, and name ID. * platform, encoding, and name ID.
* *
* `name' table format~1 entries can use language tags also, see * 'name' table format~1 entries can use language tags also, see
* @FT_Get_Sfnt_LangTag. * @FT_Get_Sfnt_LangTag.
* *
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Get_Sfnt_Name( FT_Face face, FT_Get_Sfnt_Name( FT_Face face,
@ -194,7 +194,7 @@ FT_BEGIN_HEADER
* FT_SfntLangTag * FT_SfntLangTag
* *
* @description: * @description:
* A structure to model a language tag entry from an SFNT `name' * A structure to model a language tag entry from an SFNT 'name'
* table. * table.
* *
* @fields: * @fields:
@ -203,7 +203,7 @@ FT_BEGIN_HEADER
* (without trailing NULL bytes). * (without trailing NULL bytes).
* *
* string_len :: * string_len ::
* The length of `string' in *bytes*. * The length of 'string' in **bytes**.
* *
* @note: * @note:
* Please refer to the TrueType or OpenType specification for more * Please refer to the TrueType or OpenType specification for more
@ -227,7 +227,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Retrieve the language tag associated with a language ID of an SFNT * Retrieve the language tag associated with a language ID of an SFNT
* `name' table entry. * 'name' table entry.
* *
* @input: * @input:
* face :: * face ::
@ -239,24 +239,24 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* alangTag :: * alangTag ::
* The language tag associated with the `name' table * The language tag associated with the 'name' table
* entry's language ID. * entry's language ID.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* The `string' array returned in the `alangTag' structure is not * The 'string' array returned in the `alangTag` structure is not
* null-terminated. Note that you don't have to deallocate `string' * null-terminated. Note that you don't have to deallocate 'string'
* by yourself; FreeType takes care of it if you call @FT_Done_Face. * by yourself; FreeType takes care of it if you call @FT_Done_Face.
* *
* Only `name' table format~1 supports language tags. For format~0 * Only 'name' table format~1 supports language tags. For format~0
* tables, this function always returns FT_Err_Invalid_Table. For * tables, this function always returns FT_Err_Invalid_Table. For
* invalid format~1 language ID values, FT_Err_Invalid_Argument is * invalid format~1 language ID values, FT_Err_Invalid_Argument is
* returned. * returned.
* *
* This function always returns an error if the config macro * This function always returns an error if the config macro
* `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'. * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`.
* *
* @since: * @since:
* 2.8 * 2.8

52
include/freetype/ftstroke.h
View File

@ -40,10 +40,10 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* This component generates stroked outlines of a given vectorial * This component generates stroked outlines of a given vectorial
* glyph. It also allows you to retrieve the `outside' and/or the * glyph. It also allows you to retrieve the 'outside' and/or the
* `inside' borders of the stroke. * 'inside' borders of the stroke.
* *
* This can be useful to generate `bordered' glyph, i.e., glyphs * This can be useful to generate 'bordered' glyph, i.e., glyphs
* displayed with a coloured (and anti-aliased) border around their * displayed with a coloured (and anti-aliased) border around their
* shape. * shape.
* *
@ -197,9 +197,9 @@ FT_BEGIN_HEADER
* Select the right border, relative to the drawing direction. * Select the right border, relative to the drawing direction.
* *
* @note: * @note:
* Applications are generally interested in the `inside' and `outside' * Applications are generally interested in the 'inside' and 'outside'
* borders. However, there is no direct mapping between these and the * borders. However, there is no direct mapping between these and the
* `left' and `right' ones, since this really depends on the glyph's * 'left' and 'right' ones, since this really depends on the glyph's
* drawing orientation, which varies between font formats. * drawing orientation, which varies between font formats.
* *
* You can however use @FT_Outline_GetInsideBorder and * You can however use @FT_Outline_GetInsideBorder and
@ -220,7 +220,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Retrieve the @FT_StrokerBorder value corresponding to the * Retrieve the @FT_StrokerBorder value corresponding to the
* `inside' borders of a given outline. * 'inside' borders of a given outline.
* *
* @input: * @input:
* outline :: * outline ::
@ -241,7 +241,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Retrieve the @FT_StrokerBorder value corresponding to the * Retrieve the @FT_StrokerBorder value corresponding to the
* `outside' borders of a given outline. * 'outside' borders of a given outline.
* *
* @input: * @input:
* outline :: * outline ::
@ -363,11 +363,11 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* If `opened' is~0 (the default), the outline is treated as a closed * If 'opened' is~0 (the default), the outline is treated as a closed
* path, and the stroker generates two distinct `border' outlines. * path, and the stroker generates two distinct 'border' outlines.
* *
* If `opened' is~1, the outline is processed as an open path, and the * If 'opened' is~1, the outline is processed as an open path, and the
* stroker generates a single `stroke' outline. * stroker generates a single 'stroke' outline.
* *
* This function calls @FT_Stroker_Rewind automatically. * This function calls @FT_Stroker_Rewind automatically.
*/ */
@ -425,7 +425,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* You should call this function after @FT_Stroker_BeginSubPath. * You should call this function after @FT_Stroker_BeginSubPath.
* If the subpath was not `opened', this function `draws' a * If the subpath was not 'opened', this function 'draws' a
* single line segment to the start position when needed. * single line segment to the start position when needed.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -438,7 +438,7 @@ FT_BEGIN_HEADER
* FT_Stroker_LineTo * FT_Stroker_LineTo
* *
* @description: * @description:
* `Draw' a single line segment in the stroker's current sub-path, * 'Draw' a single line segment in the stroker's current sub-path,
* from the last position. * from the last position.
* *
* @input: * @input:
@ -466,7 +466,7 @@ FT_BEGIN_HEADER
* FT_Stroker_ConicTo * FT_Stroker_ConicTo
* *
* @description: * @description:
* `Draw' a single quadratic Bezier in the stroker's current sub-path, * 'Draw' a single quadratic Bezier in the stroker's current sub-path,
* from the last position. * from the last position.
* *
* @input: * @input:
@ -498,7 +498,7 @@ FT_BEGIN_HEADER
* FT_Stroker_CubicTo * FT_Stroker_CubicTo
* *
* @description: * @description:
* `Draw' a single cubic Bezier in the stroker's current sub-path, * 'Draw' a single cubic Bezier in the stroker's current sub-path,
* from the last position. * from the last position.
* *
* @input: * @input:
@ -536,7 +536,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* Call this function once you have finished parsing your paths * Call this function once you have finished parsing your paths
* with the stroker. It returns the number of points and * with the stroker. It returns the number of points and
* contours necessary to export one of the `border' or `stroke' * contours necessary to export one of the 'border' or 'stroke'
* outlines generated by the stroker. * outlines generated by the stroker.
* *
* @input: * @input:
@ -557,12 +557,12 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @note:
* When an outline, or a sub-path, is `closed', the stroker generates * When an outline, or a sub-path, is 'closed', the stroker generates
* two independent `border' outlines, named `left' and `right'. * two independent 'border' outlines, named 'left' and 'right'.
* *
* When the outline, or a sub-path, is `opened', the stroker merges * When the outline, or a sub-path, is 'opened', the stroker merges
* the `border' outlines with caps. The `left' border receives all * the 'border' outlines with caps. The 'left' border receives all
* points, while the `right' border becomes empty. * points, while the 'right' border becomes empty.
* *
* Use the function @FT_Stroker_GetCounts instead if you want to * Use the function @FT_Stroker_GetCounts instead if you want to
* retrieve the counts associated to both borders. * retrieve the counts associated to both borders.
@ -603,12 +603,12 @@ FT_BEGIN_HEADER
* get sure that there is enough room in your @FT_Outline object to * get sure that there is enough room in your @FT_Outline object to
* receive all new data. * receive all new data.
* *
* When an outline, or a sub-path, is `closed', the stroker generates * When an outline, or a sub-path, is 'closed', the stroker generates
* two independent `border' outlines, named `left' and `right'. * two independent 'border' outlines, named 'left' and 'right'.
* *
* When the outline, or a sub-path, is `opened', the stroker merges * When the outline, or a sub-path, is 'opened', the stroker merges
* the `border' outlines with caps. The `left' border receives all * the 'border' outlines with caps. The 'left' border receives all
* points, while the `right' border becomes empty. * points, while the 'right' border becomes empty.
* *
* Use the function @FT_Stroker_Export instead if you want to * Use the function @FT_Stroker_Export instead if you want to
* retrieve all borders at once. * retrieve all borders at once.

12
include/freetype/ftsystem.h
View File

@ -72,7 +72,7 @@ FT_BEGIN_HEADER
* FT_Alloc_Func * FT_Alloc_Func
* *
* @description: * @description:
* A function used to allocate `size' bytes from `memory'. * A function used to allocate 'size' bytes from 'memory'.
* *
* @input: * @input:
* memory :: * memory ::
@ -207,7 +207,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A union type used to store either a long or a pointer. This is used * A union type used to store either a long or a pointer. This is used
* to store a file descriptor or a `FILE*' in an input stream. * to store a file descriptor or a 'FILE*' in an input stream.
* *
*/ */
typedef union FT_StreamDesc_ typedef union FT_StreamDesc_
@ -244,7 +244,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* This function might be called to perform a seek or skip operation * This function might be called to perform a seek or skip operation
* with a `count' of~0. A non-zero return value then indicates an * with a 'count' of~0. A non-zero return value then indicates an
* error. * error.
* *
*/ */
@ -299,7 +299,7 @@ FT_BEGIN_HEADER
* *
* descriptor :: * descriptor ::
* This field is a union that can hold an integer or a pointer. It is * This field is a union that can hold an integer or a pointer. It is
* used by stream implementations to store file descriptors or `FILE*' * used by stream implementations to store file descriptors or 'FILE*'
* pointers. * pointers.
* *
* pathname :: * pathname ::
@ -320,8 +320,8 @@ FT_BEGIN_HEADER
* *
* cursor :: * cursor ::
* This field is set and used internally by FreeType when parsing * This field is set and used internally by FreeType when parsing
* frames. In particular, the `FT_GET_XXX' macros use this instead * frames. In particular, the `FT_GET_XXX` macros use this instead
* of the `pos' field. * of the 'pos' field.
* *
* limit :: * limit ::
* This field is set and used internally by FreeType when parsing * This field is set and used internally by FreeType when parsing

6
include/freetype/fttrigon.h
View File

@ -210,7 +210,7 @@ FT_BEGIN_HEADER
* Second angle. * Second angle.
* *
* @return: * @return:
* Constrained value of `value2-value1'. * Constrained value of 'value2-value1'.
* *
*/ */
FT_EXPORT( FT_Angle ) FT_EXPORT( FT_Angle )
@ -225,8 +225,8 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Return the unit vector corresponding to a given angle. After the * Return the unit vector corresponding to a given angle. After the
* call, the value of `vec.x' will be `cos(angle)', and the value of * call, the value of `vec.x` will be 'cos(angle)', and the value of
* `vec.y' will be `sin(angle)'. * `vec.y` will be 'sin(angle)'.
* *
* This function is useful to retrieve both the sinus and cosinus of a * This function is useful to retrieve both the sinus and cosinus of a
* given angle quickly. * given angle quickly.

22
include/freetype/fttypes.h
View File

@ -317,7 +317,7 @@ FT_BEGIN_HEADER
* FT_Offset * FT_Offset
* *
* @description: * @description:
* This is equivalent to the ANSI~C `size_t' type, i.e., the largest * This is equivalent to the ANSI~C `size_t` type, i.e., the largest
* _unsigned_ integer type used to express a file size or position, * _unsigned_ integer type used to express a file size or position,
* or a memory block size. * or a memory block size.
*/ */
@ -330,7 +330,7 @@ FT_BEGIN_HEADER
* FT_PtrDist * FT_PtrDist
* *
* @description: * @description:
* This is equivalent to the ANSI~C `ptrdiff_t' type, i.e., the * This is equivalent to the ANSI~C `ptrdiff_t` type, i.e., the
* largest _signed_ integer type used to express the distance * largest _signed_ integer type used to express the distance
* between two pointers. * between two pointers.
*/ */
@ -370,10 +370,10 @@ FT_BEGIN_HEADER
* A simple structure used to store a 2x2 matrix. Coefficients are * A simple structure used to store a 2x2 matrix. Coefficients are
* in 16.16 fixed-point format. The computation performed is: * in 16.16 fixed-point format. The computation performed is:
* *
* { * ```
* x' = x*xx + y*xy * x' = x*xx + y*xy
* y' = x*yx + y*yy * y' = x*yx + y*yy
* } * ```
* *
* @fields: * @fields:
* xx :: * xx ::
@ -425,13 +425,13 @@ FT_BEGIN_HEADER
* FT_Generic_Finalizer * FT_Generic_Finalizer
* *
* @description: * @description:
* Describe a function used to destroy the `client' data of any * Describe a function used to destroy the 'client' data of any
* FreeType object. See the description of the @FT_Generic type for * FreeType object. See the description of the @FT_Generic type for
* details of usage. * details of usage.
* *
* @input: * @input:
* The address of the FreeType object that is under finalization. * The address of the FreeType object that is under finalization.
* Its client data is accessed through its `generic' field. * Its client data is accessed through its 'generic' field.
*/ */
typedef void (*FT_Generic_Finalizer)( void* object ); typedef void (*FT_Generic_Finalizer)( void* object );
@ -446,15 +446,15 @@ FT_BEGIN_HEADER
* variety of FreeType core objects. For example, a text layout API * variety of FreeType core objects. For example, a text layout API
* might want to associate a glyph cache to a given size object. * might want to associate a glyph cache to a given size object.
* *
* Some FreeType object contains a `generic' field, of type * Some FreeType object contains a 'generic' field, of type
* FT_Generic, which usage is left to client applications and font * FT_Generic, which usage is left to client applications and font
* servers. * servers.
* *
* It can be used to store a pointer to client-specific data, as well * It can be used to store a pointer to client-specific data, as well
* as the address of a `finalizer' function, which will be called by * as the address of a 'finalizer' function, which will be called by
* FreeType when the object is destroyed (for example, the previous * FreeType when the object is destroyed (for example, the previous
* client example would put the address of the glyph cache destructor * client example would put the address of the glyph cache destructor
* in the `finalizer' field). * in the 'finalizer' field).
* *
* @fields: * @fields:
* data :: * data ::
@ -462,7 +462,7 @@ FT_BEGIN_HEADER
* field is completely ignored by the FreeType library. * field is completely ignored by the FreeType library.
* *
* finalizer :: * finalizer ::
* A pointer to a `generic finalizer' function, which * A pointer to a 'generic finalizer' function, which
* will be called when the object is destroyed. If this * will be called when the object is destroyed. If this
* field is set to NULL, no code will be called. * field is set to NULL, no code will be called.
*/ */
@ -484,7 +484,7 @@ FT_BEGIN_HEADER
* TrueType tables into an unsigned long, to be used within FreeType. * TrueType tables into an unsigned long, to be used within FreeType.
* *
* @note: * @note:
* The produced values *must* be 32-bit integers. Don't redefine * The produced values **must** be 32-bit integers. Don't redefine
* this macro. * this macro.
*/ */
#define FT_MAKE_TAG( _x1, _x2, _x3, _x4 ) \ #define FT_MAKE_TAG( _x1, _x2, _x3, _x4 ) \

16
include/freetype/ftwinfnt.h
View File

@ -56,7 +56,7 @@ FT_BEGIN_HEADER
* FT_WinFNT_ID_XXX * FT_WinFNT_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `charset' byte in * A list of valid values for the 'charset' byte in
* @FT_WinFNT_HeaderRec. Exact mapping tables for the various cpXXXX * @FT_WinFNT_HeaderRec. Exact mapping tables for the various cpXXXX
* encodings (except for cp1361) can be found at * encodings (except for cp1361) can be found at
* ftp://ftp.unicode.org/Public in the MAPPINGS/VENDORS/MICSFT/WINDOWS * ftp://ftp.unicode.org/Public in the MAPPINGS/VENDORS/MICSFT/WINDOWS
@ -66,7 +66,7 @@ FT_BEGIN_HEADER
* @values: * @values:
* FT_WinFNT_ID_DEFAULT :: * FT_WinFNT_ID_DEFAULT ::
* This is used for font enumeration and font creation as a * This is used for font enumeration and font creation as a
* `don't care' value. Valid font files don't contain this value. * 'don't care' value. Valid font files don't contain this value.
* When querying for information about the character set of the font * When querying for information about the character set of the font
* that is currently selected into a specified device context, this * that is currently selected into a specified device context, this
* return value (of the related Windows API) simply denotes failure. * return value (of the related Windows API) simply denotes failure.
@ -80,14 +80,14 @@ FT_BEGIN_HEADER
* FT_WinFNT_ID_OEM :: * FT_WinFNT_ID_OEM ::
* From Michael Poettgen <michael@poettgen.de>: * From Michael Poettgen <michael@poettgen.de>:
* *
* The `Windows Font Mapping' article says that FT_WinFNT_ID_OEM * The 'Windows Font Mapping' article says that FT_WinFNT_ID_OEM
* is used for the charset of vector fonts, like `modern.fon', * is used for the charset of vector fonts, like `modern.fon`,
* `roman.fon', and `script.fon' on Windows. * `roman.fon`, and `script.fon` on Windows.
* *
* The `CreateFont' documentation says: The FT_WinFNT_ID_OEM value * The 'CreateFont' documentation says: The FT_WinFNT_ID_OEM value
* specifies a character set that is operating-system dependent. * specifies a character set that is operating-system dependent.
* *
* The `IFIMETRICS' documentation from the `Windows Driver * The 'IFIMETRICS' documentation from the 'Windows Driver
* Development Kit' says: This font supports an OEM-specific * Development Kit' says: This font supports an OEM-specific
* character set. The OEM character set is system dependent. * character set. The OEM character set is system dependent.
* *
@ -97,7 +97,7 @@ FT_BEGIN_HEADER
* *
* https://docs.microsoft.com/en-us/windows/desktop/intl/code-page-identifiers , * https://docs.microsoft.com/en-us/windows/desktop/intl/code-page-identifiers ,
* *
* and is used for the `DOS boxes', to support legacy applications. * and is used for the 'DOS boxes', to support legacy applications.
* A German Windows version for example usually uses ANSI codepage * A German Windows version for example usually uses ANSI codepage
* 1252 and OEM codepage 850. * 1252 and OEM codepage 850.
* *

2
include/freetype/internal/cffotypes.h
View File

@ -76,7 +76,7 @@ FT_BEGIN_HEADER
* CFF_Internal * CFF_Internal
* *
* @description: * @description:
* The interface to the `internal' field of `FT_Size'. * The interface to the 'internal' field of `FT_Size`.
*/ */
typedef struct CFF_InternalRec_ typedef struct CFF_InternalRec_
{ {

10
include/freetype/internal/ftcalc.h
View File

@ -252,7 +252,7 @@ FT_BEGIN_HEADER
* FT_MulDiv_No_Round * FT_MulDiv_No_Round
* *
* @description: * @description:
* A very simple function used to perform the computation `(a*b)/c' * A very simple function used to perform the computation '(a*b)/c'
* (without rounding) with maximum accuracy (it uses a 64-bit * (without rounding) with maximum accuracy (it uses a 64-bit
* intermediate integer whenever necessary). * intermediate integer whenever necessary).
* *
@ -268,9 +268,9 @@ FT_BEGIN_HEADER
* The divisor. * The divisor.
* *
* @return: * @return:
* The result of `(a*b)/c'. This function never traps when trying to * The result of '(a*b)/c'. This function never traps when trying to
* divide by zero; it simply returns `MaxInt' or `MinInt' depending * divide by zero; it simply returns 'MaxInt' or 'MinInt' depending
* on the signs of `a' and `b'. * on the signs of 'a' and 'b'.
*/ */
FT_BASE( FT_Long ) FT_BASE( FT_Long )
FT_MulDiv_No_Round( FT_Long a, FT_MulDiv_No_Round( FT_Long a,
@ -433,7 +433,7 @@ FT_BEGIN_HEADER
* The value to compute the root for. * The value to compute the root for.
* *
* @return: * @return:
* The result of `sqrt(x)'. * The result of 'sqrt(x)'.
* *
* @note: * @note:
* This function is not very fast. * This function is not very fast.

2
include/freetype/internal/ftdebug.h
View File

@ -111,7 +111,7 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* This function may be useful if you want to access elements of * This function may be useful if you want to access elements of
* the internal `ft_trace_levels' array by an index. * the internal `ft_trace_levels` array by an index.
*/ */
FT_BASE( FT_Int ) FT_BASE( FT_Int )
FT_Trace_Get_Count( void ); FT_Trace_Get_Count( void );

12
include/freetype/internal/ftdrv.h
View File

@ -147,10 +147,10 @@ FT_BEGIN_HEADER
* *
* get_advances :: * get_advances ::
* A function handle used to return advance * A function handle used to return advance
* widths of `count' glyphs (in font units), * widths of 'count' glyphs (in font units),
* starting at `first'. The `vertical' flag must * starting at 'first'. The 'vertical' flag must
* be set to get vertical advance heights. The * be set to get vertical advance heights. The
* `advances' buffer is caller-allocated. * 'advances' buffer is caller-allocated.
* The idea of this function is to be able to * The idea of this function is to be able to
* perform device-independent text layout without * perform device-independent text layout without
* loading a single glyph image. * loading a single glyph image.
@ -167,7 +167,7 @@ FT_BEGIN_HEADER
* to 0 if the scaling done in the base layer * to 0 if the scaling done in the base layer
* suffices. * suffices.
* @note: * @note:
* Most function pointers, with the exception of `load_glyph', can be * Most function pointers, with the exception of `load_glyph`, can be
* set to 0 to indicate a default behaviour. * set to 0 to indicate a default behaviour.
*/ */
typedef struct FT_Driver_ClassRec_ typedef struct FT_Driver_ClassRec_
@ -215,9 +215,9 @@ FT_BEGIN_HEADER
* @description: * @description:
* Used to initialize an instance of FT_Driver_ClassRec struct. * Used to initialize an instance of FT_Driver_ClassRec struct.
* *
* `ftinit.c' (ft_create_default_module_classes) already contains a * `ftinit.c` (ft_create_default_module_classes) already contains a
* mechanism to call these functions for the default modules * mechanism to call these functions for the default modules
* described in `ftmodule.h'. * described in `ftmodule.h`.
* *
* The struct will be allocated in the global scope (or the scope * The struct will be allocated in the global scope (or the scope
* where the macro is used). * where the macro is used).

2
include/freetype/internal/ftmemory.h
View File

@ -34,7 +34,7 @@ FT_BEGIN_HEADER
* FT_SET_ERROR * FT_SET_ERROR
* *
* @description: * @description:
* This macro is used to set an implicit `error' variable to a given * This macro is used to set an implicit 'error' variable to a given
* expression's value (usually a function call), and convert it to a * expression's value (usually a function call), and convert it to a
* boolean which is set whenever the value is != 0. * boolean which is set whenever the value is != 0.
*/ */

6
include/freetype/internal/ftobjs.h
View File

@ -330,7 +330,7 @@ FT_BEGIN_HEADER
* *
* services :: * services ::
* A cache for frequently used services. It should be only * A cache for frequently used services. It should be only
* accessed with the macro `FT_FACE_LOOKUP_SERVICE'. * accessed with the macro `FT_FACE_LOOKUP_SERVICE`.
* *
* incremental_interface :: * incremental_interface ::
* If non-null, the interface through which glyph data and metrics * If non-null, the interface through which glyph data and metrics
@ -344,7 +344,7 @@ FT_BEGIN_HEADER
* respectively, value~-1 means to use the module/driver default. * respectively, value~-1 means to use the module/driver default.
* *
* random_seed :: * random_seed ::
* If positive, override the seed value for the CFF `random' * If positive, override the seed value for the CFF 'random'
* operator. Value~0 means to use the font's value. Value~-1 * operator. Value~0 means to use the font's value. Value~-1
* means to use the CFF driver's default. * means to use the CFF driver's default.
* *
@ -798,7 +798,7 @@ FT_BEGIN_HEADER
* *
* clazz :: * clazz ::
* A pointer to the font driver's class. Note that * A pointer to the font driver's class. Note that
* this is NOT root.clazz. `class' wasn't used * this is NOT root.clazz. 'class' wasn't used
* as it is a reserved word in C++. * as it is a reserved word in C++.
* *
* faces_list :: * faces_list ::

26
include/freetype/internal/ftrfork.h
View File

@ -118,18 +118,18 @@ FT_BEGIN_HEADER
* @output: * @output:
* new_names :: * new_names ::
* An array of guessed file names in which the resource forks may * An array of guessed file names in which the resource forks may
* exist. If `new_names[N]' is NULL, the guessed file name is * exist. If 'new_names[N]' is NULL, the guessed file name is
* equal to `base_name'. * equal to `base_name`.
* *
* offsets :: * offsets ::
* An array of guessed file offsets. `offsets[N]' holds the file * An array of guessed file offsets. 'offsets[N]' holds the file
* offset of the possible start of the resource fork in file * offset of the possible start of the resource fork in file
* `new_names[N]'. * 'new_names[N]'.
* *
* errors :: * errors ::
* An array of FreeType error codes. `errors[N]' is the error * An array of FreeType error codes. 'errors[N]' is the error
* code of Nth guessing rule function. If `errors[N]' is not * code of Nth guessing rule function. If 'errors[N]' is not
* FT_Err_Ok, `new_names[N]' and `offsets[N]' are meaningless. * FT_Err_Ok, 'new_names[N]' and 'offsets[N]' are meaningless.
*/ */
FT_BASE( void ) FT_BASE( void )
FT_Raccess_Guess( FT_Library library, FT_Raccess_Guess( FT_Library library,
@ -149,7 +149,7 @@ FT_BEGIN_HEADER
* Get the information from the header of resource fork. The * Get the information from the header of resource fork. The
* information includes the file offset where the resource map * information includes the file offset where the resource map
* starts, and the file offset where the resource data starts. * starts, and the file offset where the resource data starts.
* `FT_Raccess_Get_DataOffsets' requires these two data. * `FT_Raccess_Get_DataOffsets` requires these two data.
* *
* @input: * @input:
* library :: * library ::
@ -207,14 +207,14 @@ FT_BEGIN_HEADER
* *
* sort_by_res_id :: * sort_by_res_id ::
* A Boolean to sort the fragmented resource by their ids. * A Boolean to sort the fragmented resource by their ids.
* The fragmented resources for `POST' resource should be sorted * The fragmented resources for 'POST' resource should be sorted
* to restore Type1 font properly. For `sfnt' resources, sorting * to restore Type1 font properly. For 'sfnt' resources, sorting
* may induce a different order of the faces in comparison to that * may induce a different order of the faces in comparison to that
* by QuickDraw API. * by QuickDraw API.
* *
* @output: * @output:
* offsets :: * offsets ::
* The stream offsets for the resource data specified by `tag'. * The stream offsets for the resource data specified by 'tag'.
* This array is allocated by the function, so you have to call * This array is allocated by the function, so you have to call
* @ft_mem_free after use. * @ft_mem_free after use.
* *
@ -225,8 +225,8 @@ FT_BEGIN_HEADER
* FreeType error code. FT_Err_Ok means success. * FreeType error code. FT_Err_Ok means success.
* *
* @note: * @note:
* Normally you should use `FT_Raccess_Get_HeaderInfo' to get the * Normally you should use `FT_Raccess_Get_HeaderInfo` to get the
* value for `map_offset' and `rdata_pos'. * value for `map_offset` and `rdata_pos`.
*/ */
FT_BASE( FT_Error ) FT_BASE( FT_Error )
FT_Raccess_Get_DataOffsets( FT_Library library, FT_Raccess_Get_DataOffsets( FT_Library library,

8
include/freetype/internal/ftserv.h
View File

@ -49,8 +49,8 @@ FT_BEGIN_HEADER
* id :: * id ::
* A string describing the service as defined in the service's * A string describing the service as defined in the service's
* header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to * header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to
* `multi-masters'). It is automatically prefixed with * 'multi-masters'). It is automatically prefixed with
* `FT_SERVICE_ID_'. * `FT_SERVICE_ID_`.
* *
* @output: * @output:
* ptr :: * ptr ::
@ -101,8 +101,8 @@ FT_BEGIN_HEADER
* id :: * id ::
* A string describing the service as defined in the service's * A string describing the service as defined in the service's
* header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to * header files (e.g. FT_SERVICE_ID_MULTI_MASTERS which expands to
* `multi-masters'). It is automatically prefixed with * 'multi-masters'). It is automatically prefixed with
* `FT_SERVICE_ID_'. * `FT_SERVICE_ID_`.
* *
* @output: * @output:
* ptr :: * ptr ::

2
include/freetype/internal/psaux.h
View File

@ -130,7 +130,7 @@ FT_BEGIN_HEADER
* 1kByte chunks. * 1kByte chunks.
* *
* init :: * init ::
* Set to 0xDEADBEEF if `elements' and `lengths' have * Set to 0xDEADBEEF if 'elements' and 'lengths' have
* been allocated. * been allocated.
* *
* max_elems :: * max_elems ::

52
include/freetype/internal/pshints.h
View File

@ -86,14 +86,14 @@ FT_BEGIN_HEADER
* @T1_Hints_FuncsRec structure. Recording glyph hints is normally * @T1_Hints_FuncsRec structure. Recording glyph hints is normally
* achieved through the following scheme: * achieved through the following scheme:
* *
* - Open a new hint recording session by calling the `open' method. * - Open a new hint recording session by calling the 'open' method.
* This rewinds the recorder and prepare it for new input. * This rewinds the recorder and prepare it for new input.
* *
* - For each hint found in the glyph charstring, call the corresponding * - For each hint found in the glyph charstring, call the corresponding
* method (`stem', `stem3', or `reset'). Note that these functions do * method ('stem', 'stem3', or 'reset'). Note that these functions do
* not return an error code. * not return an error code.
* *
* - Close the recording session by calling the `close' method. It * - Close the recording session by calling the 'close' method. It
* returns an error code if the hints were invalid or something * returns an error code if the hints were invalid or something
* strange happened (e.g., memory shortage). * strange happened (e.g., memory shortage).
* *
@ -146,7 +146,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A method of the @T1_Hints class used to record a new horizontal or * A method of the @T1_Hints class used to record a new horizontal or
* vertical stem. This corresponds to the Type 1 `hstem' and `vstem' * vertical stem. This corresponds to the Type 1 'hstem' and 'vstem'
* operators. * operators.
* *
* @input: * @input:
@ -164,15 +164,15 @@ FT_BEGIN_HEADER
* Use vertical coordinates (y) for horizontal stems (dim=0). Use * Use vertical coordinates (y) for horizontal stems (dim=0). Use
* horizontal coordinates (x) for vertical stems (dim=1). * horizontal coordinates (x) for vertical stems (dim=1).
* *
* `coords[0]' is the absolute stem position (lowest coordinate); * 'coords[0]' is the absolute stem position (lowest coordinate);
* `coords[1]' is the length. * 'coords[1]' is the length.
* *
* The length can be negative, in which case it must be either -20 or * The length can be negative, in which case it must be either -20 or
* -21. It is interpreted as a `ghost' stem, according to the Type 1 * -21. It is interpreted as a 'ghost' stem, according to the Type 1
* specification. * specification.
* *
* If the length is -21 (corresponding to a bottom ghost stem), then * If the length is -21 (corresponding to a bottom ghost stem), then
* the real stem position is `coords[0]+coords[1]'. * the real stem position is 'coords[0]+coords[1]'.
* *
*/ */
typedef void typedef void
@ -297,7 +297,7 @@ FT_BEGIN_HEADER
* On input, all points within the outline are in font coordinates. On * On input, all points within the outline are in font coordinates. On
* output, they are in 1/64th of pixels. * output, they are in 1/64th of pixels.
* *
* The scaling transformation is taken from the `globals' object which * The scaling transformation is taken from the 'globals' object which
* must correspond to the same font as the glyph. * must correspond to the same font as the glyph.
* *
*/ */
@ -373,14 +373,14 @@ FT_BEGIN_HEADER
* @T2_Hints_FuncsRec structure. Recording glyph hints is normally * @T2_Hints_FuncsRec structure. Recording glyph hints is normally
* achieved through the following scheme: * achieved through the following scheme:
* *
* - Open a new hint recording session by calling the `open' method. * - Open a new hint recording session by calling the 'open' method.
* This rewinds the recorder and prepare it for new input. * This rewinds the recorder and prepare it for new input.
* *
* - For each hint found in the glyph charstring, call the corresponding * - For each hint found in the glyph charstring, call the corresponding
* method (`stems', `hintmask', `counters'). Note that these * method ('stems', 'hintmask', 'counters'). Note that these
* functions do not return an error code. * functions do not return an error code.
* *
* - Close the recording session by calling the `close' method. It * - Close the recording session by calling the 'close' method. It
* returns an error code if the hints were invalid or something * returns an error code if the hints were invalid or something
* strange happened (e.g., memory shortage). * strange happened (e.g., memory shortage).
* *
@ -434,7 +434,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* A method of the @T2_Hints class used to set the table of stems in * A method of the @T2_Hints class used to set the table of stems in
* either the vertical or horizontal dimension. Equivalent to the * either the vertical or horizontal dimension. Equivalent to the
* `hstem', `vstem', `hstemhm', and `vstemhm' Type 2 operators. * 'hstem', 'vstem', 'hstemhm', and 'vstemhm' Type 2 operators.
* *
* @input: * @input:
* hints :: * hints ::
@ -447,18 +447,18 @@ FT_BEGIN_HEADER
* The number of stems. * The number of stems.
* *
* coords :: * coords ::
* An array of `count' (position,length) pairs in 16.16 format. * An array of 'count' (position,length) pairs in 16.16 format.
* *
* @note: * @note:
* Use vertical coordinates (y) for horizontal stems (dim=0). Use * Use vertical coordinates (y) for horizontal stems (dim=0). Use
* horizontal coordinates (x) for vertical stems (dim=1). * horizontal coordinates (x) for vertical stems (dim=1).
* *
* There are `2*count' elements in the `coords' array. Each even * There are '2*count' elements in the 'coords' array. Each even
* element is an absolute position in font units, each odd element is a * element is an absolute position in font units, each odd element is a
* length in font units. * length in font units.
* *
* A length can be negative, in which case it must be either -20 or * A length can be negative, in which case it must be either -20 or
* -21. It is interpreted as a `ghost' stem, according to the Type 1 * -21. It is interpreted as a 'ghost' stem, according to the Type 1
* specification. * specification.
* *
*/ */
@ -476,7 +476,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A method of the @T2_Hints class used to set a given hintmask (this * A method of the @T2_Hints class used to set a given hintmask (this
* corresponds to the `hintmask' Type 2 operator). * corresponds to the 'hintmask' Type 2 operator).
* *
* @input: * @input:
* hints :: * hints ::
@ -494,13 +494,13 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* If the hintmask starts the charstring (before any glyph point * If the hintmask starts the charstring (before any glyph point
* definition), the value of `end_point' should be 0. * definition), the value of `end_point` should be 0.
* *
* `bit_count' is the number of meaningful bits in the `bytes' array; it * `bit_count` is the number of meaningful bits in the 'bytes' array; it
* must be equal to the total number of hints defined so far (i.e., * must be equal to the total number of hints defined so far (i.e.,
* horizontal+verticals). * horizontal+verticals).
* *
* The `bytes' array can come directly from the Type 2 charstring and * The 'bytes' array can come directly from the Type 2 charstring and
* respects the same format. * respects the same format.
* *
*/ */
@ -518,7 +518,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A method of the @T2_Hints class used to set a given counter mask * A method of the @T2_Hints class used to set a given counter mask
* (this corresponds to the `hintmask' Type 2 operator). * (this corresponds to the 'hintmask' Type 2 operator).
* *
* @input: * @input:
* hints :: * hints ::
@ -536,13 +536,13 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* If the hintmask starts the charstring (before any glyph point * If the hintmask starts the charstring (before any glyph point
* definition), the value of `end_point' should be 0. * definition), the value of `end_point` should be 0.
* *
* `bit_count' is the number of meaningful bits in the `bytes' array; it * `bit_count` is the number of meaningful bits in the 'bytes' array; it
* must be equal to the total number of hints defined so far (i.e., * must be equal to the total number of hints defined so far (i.e.,
* horizontal+verticals). * horizontal+verticals).
* *
* The `bytes' array can come directly from the Type 2 charstring and * The 'bytes' array can come directly from the Type 2 charstring and
* respects the same format. * respects the same format.
* *
*/ */
@ -588,7 +588,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A method of the @T2_Hints class used to apply hints to the * A method of the @T2_Hints class used to apply hints to the
* corresponding glyph outline. Must be called after the `close' * corresponding glyph outline. Must be called after the 'close'
* method. * method.
* *
* @input: * @input:
@ -611,7 +611,7 @@ FT_BEGIN_HEADER
* On input, all points within the outline are in font coordinates. On * On input, all points within the outline are in font coordinates. On
* output, they are in 1/64th of pixels. * output, they are in 1/64th of pixels.
* *
* The scaling transformation is taken from the `globals' object which * The scaling transformation is taken from the 'globals' object which
* must correspond to the same font than the glyph. * must correspond to the same font than the glyph.
* *
*/ */

2
include/freetype/internal/services/svttcmap.h
View File

@ -45,7 +45,7 @@ FT_BEGIN_HEADER
* @fields: * @fields:
* language :: * language ::
* The language ID used in Mac fonts. Definitions of values are in * The language ID used in Mac fonts. Definitions of values are in
* `ttnameid.h'. * `ttnameid.h`.
* *
* format :: * format ::
* The cmap format. OpenType 1.6 defines the formats 0 (byte * The cmap format. OpenType 1.6 defines the formats 0 (byte

46
include/freetype/internal/sfnt.h
View File

@ -63,7 +63,7 @@ FT_BEGIN_HEADER
* @note: * @note:
* The stream cursor must be at the font file's origin. * The stream cursor must be at the font file's origin.
* *
* This function recognizes fonts embedded in a `TrueType * This function recognizes fonts embedded in a 'TrueType
* collection'. * collection'.
* *
* Once the format tag has been validated by the font driver, it * Once the format tag has been validated by the font driver, it
@ -167,16 +167,16 @@ FT_BEGIN_HEADER
* *
* If length == NULL: * If length == NULL:
* Loads the whole table. Returns an error if * Loads the whole table. Returns an error if
* `offset' == 0! * 'offset' == 0!
* *
* If *length == 0: * If *length == 0:
* Exits immediately; returning the length of the given * Exits immediately; returning the length of the given
* table or of the font file, depending on the value of * table or of the font file, depending on the value of
* `tag'. * 'tag'.
* *
* If *length != 0: * If *length != 0:
* Loads the next `length' bytes of table or font, * Loads the next 'length' bytes of table or font,
* starting at offset `offset' (in table or font too). * starting at offset 'offset' (in table or font too).
* *
* @output: * @output:
* buffer :: * buffer ::
@ -199,7 +199,7 @@ FT_BEGIN_HEADER
* TT_Find_SBit_Image_Func * TT_Find_SBit_Image_Func
* *
* @description: * @description:
* Check whether an embedded bitmap (an `sbit') exists for a given * Check whether an embedded bitmap (an 'sbit') exists for a given
* glyph, at a given strike. * glyph, at a given strike.
* *
* @input: * @input:
@ -220,7 +220,7 @@ FT_BEGIN_HEADER
* The SBit strike containing the glyph index. * The SBit strike containing the glyph index.
* *
* aglyph_offset :: * aglyph_offset ::
* The offset of the glyph data in `EBDT' table. * The offset of the glyph data in 'EBDT' table.
* *
* @return: * @return:
* FreeType error code. 0 means success. Returns * FreeType error code. 0 means success. Returns
@ -260,10 +260,10 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* The stream cursor must be positioned at the glyph's offset within * The stream cursor must be positioned at the glyph's offset within
* the `EBDT' table before the call. * the 'EBDT' table before the call.
* *
* If the image format uses variable metrics, the stream cursor is * If the image format uses variable metrics, the stream cursor is
* positioned just after the metrics header in the `EBDT' table on * positioned just after the metrics header in the 'EBDT' table on
* function exit. * function exit.
*/ */
typedef FT_Error typedef FT_Error
@ -309,7 +309,7 @@ FT_BEGIN_HEADER
* glyph sbit exists for the index. * glyph sbit exists for the index.
* *
* @note: * @note:
* The `map.buffer' field is always freed before the glyph is loaded. * The `map.buffer` field is always freed before the glyph is loaded.
*/ */
typedef FT_Error typedef FT_Error
(*TT_Load_SBit_Image_Func)( TT_Face face, (*TT_Load_SBit_Image_Func)( TT_Face face,
@ -475,7 +475,7 @@ FT_BEGIN_HEADER
* TT_Set_Palette_Func * TT_Set_Palette_Func
* *
* @description: * @description:
* Load the colors into `face->palette' for a given palette index. * Load the colors into `face->palette` for a given palette index.
* *
* @input: * @input:
* face :: * face ::
@ -510,7 +510,7 @@ FT_BEGIN_HEADER
* @inout: * @inout:
* iterator :: * iterator ::
* An @FT_LayerIterator object. For the first call you should set * An @FT_LayerIterator object. For the first call you should set
* `iterator->p' to NULL. For all following calls, simply use the * `iterator->p` to NULL. For all following calls, simply use the
* same object again. * same object again.
* *
* @output: * @output:
@ -542,10 +542,10 @@ FT_BEGIN_HEADER
* TT_Blend_Colr_Func * TT_Blend_Colr_Func
* *
* @description: * @description:
* Blend the bitmap in `new_glyph' into `base_glyph' using the color * Blend the bitmap in `new_glyph` into `base_glyph` using the color
* specified by `color_index'. If `color_index' is 0xFFFF, use * specified by `color_index`. If `color_index` is 0xFFFF, use
* `face->foreground_color' if `face->have_foreground_color' is set. * `face->foreground_color` if `face->have_foreground_color` is set.
* Otherwise check `face->palette_data.palette_flags': If present and * Otherwise check `face->palette_data.palette_flags`: If present and
* @FT_PALETTE_FOR_DARK_BACKGROUND is set, use BGRA value 0xFFFFFFFF * @FT_PALETTE_FOR_DARK_BACKGROUND is set, use BGRA value 0xFFFFFFFF
* (white opaque). Otherwise use BGRA value 0x000000FF (black opaque). * (white opaque). Otherwise use BGRA value 0x000000FF (black opaque).
* *
@ -561,7 +561,7 @@ FT_BEGIN_HEADER
* bitmap may get reallocated. * bitmap may get reallocated.
* *
* new_glyph :: * new_glyph ::
* Slot to be incooperated into `base_glyph'. * Slot to be incooperated into `base_glyph`.
* *
* @return: * @return:
* FreeType error code. 0 means success. Returns an error if * FreeType error code. 0 means success. Returns an error if
@ -580,7 +580,7 @@ FT_BEGIN_HEADER
* TT_Get_Name_Func * TT_Get_Name_Func
* *
* @description: * @description:
* From the `name' table, return a given ENGLISH name record in * From the 'name' table, return a given ENGLISH name record in
* ASCII. * ASCII.
* *
* @input: * @input:
@ -611,7 +611,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Search whether an ENGLISH version for a given name ID is in the * Search whether an ENGLISH version for a given name ID is in the
* `name' table. * 'name' table.
* *
* @input: * @input:
* face :: * face ::
@ -622,11 +622,11 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* win :: * win ::
* If non-negative, an index into the `name' table with * If non-negative, an index into the 'name' table with
* the corresponding (3,1) or (3,0) Windows entry. * the corresponding (3,1) or (3,0) Windows entry.
* *
* apple :: * apple ::
* If non-negative, an index into the `name' table with * If non-negative, an index into the 'name' table with
* the corresponding (1,0) Apple entry. * the corresponding (1,0) Apple entry.
* *
* @return: * @return:
@ -658,7 +658,7 @@ FT_BEGIN_HEADER
* FreeType error code. 0 means success. * FreeType error code. 0 means success.
* *
* @note: * @note:
* The function uses `face->goto_table' to seek the stream to the * The function uses `face->goto_table` to seek the stream to the
* start of the table, except while loading the font directory. * start of the table, except while loading the font directory.
*/ */
typedef FT_Error typedef FT_Error
@ -710,7 +710,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* This structure holds pointers to the functions used to load and * This structure holds pointers to the functions used to load and
* free the basic tables that are required in a `sfnt' font file. * free the basic tables that are required in a 'sfnt' font file.
* *
* @fields: * @fields:
* Check the various xxx_Func() descriptions for details. * Check the various xxx_Func() descriptions for details.

148
include/freetype/internal/tttypes.h
View File

@ -58,7 +58,7 @@ FT_BEGIN_HEADER
* *
* @fields: * @fields:
* tag :: * tag ::
* Must be `ttc ' to indicate a TrueType collection. * Must be 'ttc ' to indicate a TrueType collection.
* *
* version :: * version ::
* The version number. * The version number.
@ -98,13 +98,13 @@ FT_BEGIN_HEADER
* The number of tables in file. * The number of tables in file.
* *
* search_range :: * search_range ::
* Must be `16 * (max power of 2 <= num_tables)'. * Must be '16 * (max power of 2 <= num_tables)'.
* *
* entry_selector :: * entry_selector ::
* Must be log2 of `search_range / 16'. * Must be log2 of 'search_range / 16'.
* *
* range_shift :: * range_shift ::
* Must be `num_tables * 16 - search_range'. * Must be 'num_tables * 16 - search_range'.
*/ */
typedef struct SFNT_HeaderRec_ typedef struct SFNT_HeaderRec_
{ {
@ -232,7 +232,7 @@ FT_BEGIN_HEADER
* TT_LongMetricsRec * TT_LongMetricsRec
* *
* @description: * @description:
* A structure modeling the long metrics of the `hmtx' and `vmtx' * A structure modeling the long metrics of the 'hmtx' and 'vmtx'
* TrueType tables. The values are expressed in font units. * TrueType tables. The values are expressed in font units.
* *
* @fields: * @fields:
@ -256,7 +256,7 @@ FT_BEGIN_HEADER
* TT_ShortMetrics * TT_ShortMetrics
* *
* @description: * @description:
* A simple type to model the short metrics of the `hmtx' and `vmtx' * A simple type to model the short metrics of the 'hmtx' and 'vmtx'
* tables. * tables.
*/ */
typedef FT_Short TT_ShortMetrics; typedef FT_Short TT_ShortMetrics;
@ -290,7 +290,7 @@ FT_BEGIN_HEADER
* The length of the string in bytes. * The length of the string in bytes.
* *
* stringOffset :: * stringOffset ::
* The offset to the string in the `name' table. * The offset to the string in the 'name' table.
* *
* string :: * string ::
* A pointer to the string's bytes. Note that these * A pointer to the string's bytes. Note that these
@ -319,7 +319,7 @@ FT_BEGIN_HEADER
* TT_LangTagRec * TT_LangTagRec
* *
* @description: * @description:
* A structure modeling language tag records in SFNT `name' tables, * A structure modeling language tag records in SFNT 'name' tables,
* introduced in OpenType version 1.6. * introduced in OpenType version 1.6.
* *
* @fields: * @fields:
@ -327,7 +327,7 @@ FT_BEGIN_HEADER
* The length of the string in bytes. * The length of the string in bytes.
* *
* stringOffset :: * stringOffset ::
* The offset to the string in the `name' table. * The offset to the string in the 'name' table.
* *
* string :: * string ::
* A pointer to the string's bytes. Note that these * A pointer to the string's bytes. Note that these
@ -362,7 +362,7 @@ FT_BEGIN_HEADER
* The number of names in table. * The number of names in table.
* *
* storageOffset :: * storageOffset ::
* The offset of the name table in the `name' * The offset of the name table in the 'name'
* TrueType table. * TrueType table.
* *
* names :: * names ::
@ -414,7 +414,7 @@ FT_BEGIN_HEADER
* *
* @fields: * @fields:
* maxPPEM :: * maxPPEM ::
* The maximum ppem value to which `gaspFlag' applies. * The maximum ppem value to which `gaspFlag` applies.
* *
* gaspFlag :: * gaspFlag ::
* A flag describing the grid-fitting and anti-aliasing * A flag describing the grid-fitting and anti-aliasing
@ -438,7 +438,7 @@ FT_BEGIN_HEADER
* TT_GaspRec * TT_GaspRec
* *
* @description: * @description:
* A structure modeling the TrueType `gasp' table used to specify * A structure modeling the TrueType 'gasp' table used to specify
* grid-fitting and anti-aliasing behaviour. * grid-fitting and anti-aliasing behaviour.
* *
* @fields: * @fields:
@ -481,7 +481,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* A structure used to hold the big metrics of a given glyph bitmap * A structure used to hold the big metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the * in a TrueType or OpenType font. These are usually found in the
* `EBDT' (Microsoft) or `bloc' (Apple) table. * 'EBDT' (Microsoft) or 'bloc' (Apple) table.
* *
* @fields: * @fields:
* height :: * height ::
@ -532,7 +532,7 @@ FT_BEGIN_HEADER
* @description: * @description:
* A structure used to hold the small metrics of a given glyph bitmap * A structure used to hold the small metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the * in a TrueType or OpenType font. These are usually found in the
* `EBDT' (Microsoft) or the `bdat' (Apple) table. * 'EBDT' (Microsoft) or the 'bdat' (Apple) table.
* *
* @fields: * @fields:
* height :: * height ::
@ -647,8 +647,8 @@ FT_BEGIN_HEADER
* TT_SBit_RangeRec * TT_SBit_RangeRec
* *
* @description: * @description:
* A TrueType/OpenType subIndexTable as defined in the `EBLC' * A TrueType/OpenType subIndexTable as defined in the 'EBLC'
* (Microsoft) or `bloc' (Apple) tables. * (Microsoft) or 'bloc' (Apple) tables.
* *
* @fields: * @fields:
* first_glyph :: * first_glyph ::
@ -662,10 +662,10 @@ FT_BEGIN_HEADER
* to 5. * to 5.
* *
* image_format :: * image_format ::
* The format of `EBDT' image data. * The format of 'EBDT' image data.
* *
* image_offset :: * image_offset ::
* The offset to image data in `EBDT'. * The offset to image data in 'EBDT'.
* *
* image_size :: * image_size ::
* For index formats 2 and 5. This is the size in * For index formats 2 and 5. This is the size in
@ -686,7 +686,7 @@ FT_BEGIN_HEADER
* For index formats 4 and 5. * For index formats 4 and 5.
* *
* table_offset :: * table_offset ::
* The offset of the index table in the `EBLC' * The offset of the index table in the 'EBLC'
* table. Only used during strike loading. * table. Only used during strike loading.
*/ */
typedef struct TT_SBit_RangeRec_ typedef struct TT_SBit_RangeRec_
@ -716,8 +716,8 @@ FT_BEGIN_HEADER
* TT_SBit_StrikeRec * TT_SBit_StrikeRec
* *
* @description: * @description:
* A structure used describe a given bitmap strike in the `EBLC' * A structure used describe a given bitmap strike in the 'EBLC'
* (Microsoft) or `bloc' (Apple) tables. * (Microsoft) or 'bloc' (Apple) tables.
* *
* @fields: * @fields:
* num_index_ranges :: * num_index_ranges ::
@ -727,7 +727,7 @@ FT_BEGIN_HEADER
* An array of glyph index ranges. * An array of glyph index ranges.
* *
* color_ref :: * color_ref ::
* Unused. `color_ref' is put in for future * Unused. `color_ref` is put in for future
* enhancements, but these fields are already * enhancements, but these fields are already
* in use by other platforms (e.g. Newton). * in use by other platforms (e.g. Newton).
* For details, please see * For details, please see
@ -819,7 +819,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* A structure used describe a given bitmap scaling table, as defined * A structure used describe a given bitmap scaling table, as defined
* in the `EBSC' table. * in the 'EBSC' table.
* *
* @fields: * @fields:
* hori :: * hori ::
@ -1075,7 +1075,7 @@ FT_BEGIN_HEADER
* resource. * resource.
* *
* @note: * @note:
* The TT_Face structure is also used as a `parent class' for the * The TT_Face structure is also used as a 'parent class' for the
* OpenType-CFF class (T2_Face). * OpenType-CFF class (T2_Face).
*/ */
typedef struct TT_FaceRec_* TT_Face; typedef struct TT_FaceRec_* TT_Face;
@ -1142,7 +1142,7 @@ FT_BEGIN_HEADER
* *
* offset :: * offset ::
* The offset of the glyph according to the * The offset of the glyph according to the
* `locations' table. * 'locations' table.
* *
* byte_count :: * byte_count ::
* The size of the frame in bytes. * The size of the frame in bytes.
@ -1259,9 +1259,9 @@ FT_BEGIN_HEADER
* *
* ttc_header :: * ttc_header ::
* The TrueType collection header, used when * The TrueType collection header, used when
* the file is a `ttc' rather than a `ttf'. * the file is a 'ttc' rather than a 'ttf'.
* For ordinary font files, the field * For ordinary font files, the field
* `ttc_header.count' is set to 0. * `ttc_header.count` is set to 0.
* *
* format_tag :: * format_tag ::
* The font format tag. * The font format tag.
@ -1275,14 +1275,14 @@ FT_BEGIN_HEADER
* font file. * font file.
* *
* header :: * header ::
* The font's font header (`head' table). * The font's font header ('head' table).
* Read on font opening. * Read on font opening.
* *
* horizontal :: * horizontal ::
* The font's horizontal header (`hhea' * The font's horizontal header ('hhea'
* table). This field also contains the * table). This field also contains the
* associated horizontal metrics table * associated horizontal metrics table
* (`hmtx'). * ('hmtx').
* *
* max_profile :: * max_profile ::
* The font's maximum profile table. Read on * The font's maximum profile table. Read on
@ -1294,15 +1294,15 @@ FT_BEGIN_HEADER
* vertical_info :: * vertical_info ::
* A boolean which is set when the font file * A boolean which is set when the font file
* contains vertical metrics. If not, the * contains vertical metrics. If not, the
* value of the `vertical' field is * value of the 'vertical' field is
* undefined. * undefined.
* *
* vertical :: * vertical ::
* The font's vertical header (`vhea' table). * The font's vertical header ('vhea' table).
* This field also contains the associated * This field also contains the associated
* vertical metrics table (`vmtx'), if found. * vertical metrics table ('vmtx'), if found.
* IMPORTANT: The contents of this field is * IMPORTANT: The contents of this field is
* undefined if the `vertical_info' field is * undefined if the `vertical_info` field is
* unset. * unset.
* *
* num_names :: * num_names ::
@ -1310,23 +1310,23 @@ FT_BEGIN_HEADER
* TrueType font. * TrueType font.
* *
* name_table :: * name_table ::
* The table of name records (`name'). * The table of name records ('name').
* *
* os2 :: * os2 ::
* The font's OS/2 table (`OS/2'). * The font's OS/2 table ('OS/2').
* *
* postscript :: * postscript ::
* The font's PostScript table (`post' * The font's PostScript table ('post'
* table). The PostScript glyph names are * table). The PostScript glyph names are
* not loaded by the driver on face opening. * not loaded by the driver on face opening.
* See the `ttpost' module for more details. * See the 'ttpost' module for more details.
* *
* cmap_table :: * cmap_table ::
* Address of the face's `cmap' SFNT table * Address of the face's 'cmap' SFNT table
* in memory (it's an extracted frame). * in memory (it's an extracted frame).
* *
* cmap_size :: * cmap_size ::
* The size in bytes of the `cmap_table' * The size in bytes of the `cmap_table`
* described above. * described above.
* *
* goto_table :: * goto_table ::
@ -1347,18 +1347,18 @@ FT_BEGIN_HEADER
* *
* read_glyph_header :: * read_glyph_header ::
* A function used to read a glyph header. * A function used to read a glyph header.
* It must be called between an `access' and * It must be called between an 'access' and
* `forget'. * 'forget'.
* *
* read_simple_glyph :: * read_simple_glyph ::
* A function used to read a simple glyph. * A function used to read a simple glyph.
* It must be called after the header was * It must be called after the header was
* read, and before the `forget'. * read, and before the 'forget'.
* *
* read_composite_glyph :: * read_composite_glyph ::
* A function used to read a composite glyph. * A function used to read a composite glyph.
* It must be called after the header was * It must be called after the header was
* read, and before the `forget'. * read, and before the 'forget'.
* *
* sfnt :: * sfnt ::
* A pointer to the SFNT service. * A pointer to the SFNT service.
@ -1375,16 +1375,16 @@ FT_BEGIN_HEADER
* *
* hdmx :: * hdmx ::
* The face's horizontal device metrics * The face's horizontal device metrics
* (`hdmx' table). This table is optional in * ('hdmx' table). This table is optional in
* TrueType/OpenType fonts. * TrueType/OpenType fonts.
* *
* gasp :: * gasp ::
* The grid-fitting and scaling properties * The grid-fitting and scaling properties
* table (`gasp'). This table is optional in * table ('gasp'). This table is optional in
* TrueType/OpenType fonts. * TrueType/OpenType fonts.
* *
* pclt :: * pclt ::
* The `pclt' SFNT table. * The 'pclt' SFNT table.
* *
* num_sbit_scales :: * num_sbit_scales ::
* The number of sbit scales for this font. * The number of sbit scales for this font.
@ -1397,11 +1397,11 @@ FT_BEGIN_HEADER
* postscript_names :: * postscript_names ::
* A table used to store the Postscript names * A table used to store the Postscript names
* of the glyphs for this font. See the * of the glyphs for this font. See the
* file `ttconfig.h' for comments on the * file `ttconfig.h` for comments on the
* TT_CONFIG_OPTION_POSTSCRIPT_NAMES option. * TT_CONFIG_OPTION_POSTSCRIPT_NAMES option.
* *
* palette_data :: * palette_data ::
* Some fields from the `CPAL' table that are directly indexed. * Some fields from the 'CPAL' table that are directly indexed.
* *
* palette_index :: * palette_index ::
* The current palette index, as set by @FT_Palette_Select. * The current palette index, as set by @FT_Palette_Select.
@ -1413,8 +1413,8 @@ FT_BEGIN_HEADER
* There was a call to @FT_Palette_Set_Foreground_Color. * There was a call to @FT_Palette_Set_Foreground_Color.
* *
* foreground_color :: * foreground_color ::
* The current foreground color corresponding to `CPAL' color index * The current foreground color corresponding to 'CPAL' color index
* 0xFFFF. Only valid if `have_foreground_color' is set. * 0xFFFF. Only valid if `have_foreground_color` is set.
* *
* font_program_size :: * font_program_size ::
* Size in bytecodes of the face's font * Size in bytecodes of the face's font
@ -1424,7 +1424,7 @@ FT_BEGIN_HEADER
* font_program :: * font_program ::
* The face's font program (bytecode stream) * The face's font program (bytecode stream)
* executed at load time, also used during * executed at load time, also used during
* glyph rendering. Comes from the `fpgm' * glyph rendering. Comes from the 'fpgm'
* table. Ignored for Type 2 font fonts. * table. Ignored for Type 2 font fonts.
* *
* cvt_program_size :: * cvt_program_size ::
@ -1434,7 +1434,7 @@ FT_BEGIN_HEADER
* cvt_program :: * cvt_program ::
* The face's cvt program (bytecode stream) * The face's cvt program (bytecode stream)
* executed each time an instance/size is * executed each time an instance/size is
* changed/reset. Comes from the `prep' * changed/reset. Comes from the 'prep'
* table. Ignored for Type 2 fonts. * table. Ignored for Type 2 fonts.
* *
* cvt_size :: * cvt_size ::
@ -1444,13 +1444,13 @@ FT_BEGIN_HEADER
* cvt :: * cvt ::
* The face's original control value table. * The face's original control value table.
* Coordinates are expressed in unscaled font * Coordinates are expressed in unscaled font
* units. Comes from the `cvt ' table. * units. Comes from the 'cvt ' table.
* Ignored for Type 2 fonts. * Ignored for Type 2 fonts.
* *
* interpreter :: * interpreter ::
* A pointer to the TrueType bytecode * A pointer to the TrueType bytecode
* interpreters field is also used to hook * interpreters field is also used to hook
* the debugger in `ttdebug'. * the debugger in 'ttdebug'.
* *
* extra :: * extra ::
* Reserved for third-party font drivers. * Reserved for third-party font drivers.
@ -1460,11 +1460,11 @@ FT_BEGIN_HEADER
* postscript name service. * postscript name service.
* *
* glyf_len :: * glyf_len ::
* The length of the `glyf' table. Needed * The length of the 'glyf' table. Needed
* for malformed `loca' tables. * for malformed 'loca' tables.
* *
* glyf_offset :: * glyf_offset ::
* The file offset of the `glyf' table. * The file offset of the 'glyf' table.
* *
* is_cff2 :: * is_cff2 ::
* Set if the font format is CFF2. * Set if the font format is CFF2.
@ -1491,14 +1491,14 @@ FT_BEGIN_HEADER
* PS name . * PS name .
* *
* var_postscript_prefix_len :: * var_postscript_prefix_len ::
* The length of the `var_postscript_prefix' * The length of the `var_postscript_prefix`
* string. * string.
* *
* horz_metrics_size :: * horz_metrics_size ::
* The size of the `hmtx' table. * The size of the 'hmtx' table.
* *
* vert_metrics_size :: * vert_metrics_size ::
* The size of the `vmtx' table. * The size of the 'vmtx' table.
* *
* num_locations :: * num_locations ::
* The number of glyph locations in this * The number of glyph locations in this
@ -1508,14 +1508,14 @@ FT_BEGIN_HEADER
* *
* glyph_locations :: * glyph_locations ::
* An array of longs. These are offsets to * An array of longs. These are offsets to
* glyph data within the `glyf' table. * glyph data within the 'glyf' table.
* Ignored for Type 2 font faces. * Ignored for Type 2 font faces.
* *
* hdmx_table :: * hdmx_table ::
* A pointer to the `hdmx' table. * A pointer to the 'hdmx' table.
* *
* hdmx_table_size :: * hdmx_table_size ::
* The size of the `hdmx' table. * The size of the 'hdmx' table.
* *
* hdmx_record_count :: * hdmx_record_count ::
* The number of hdmx records. * The number of hdmx records.
@ -1525,14 +1525,14 @@ FT_BEGIN_HEADER
* *
* hdmx_record_sizes :: * hdmx_record_sizes ::
* An array holding the ppem sizes available * An array holding the ppem sizes available
* in the `hdmx' table. * in the 'hdmx' table.
* *
* sbit_table :: * sbit_table ::
* A pointer to the font's embedded bitmap * A pointer to the font's embedded bitmap
* location table. * location table.
* *
* sbit_table_size :: * sbit_table_size ::
* The size of `sbit_table'. * The size of `sbit_table`.
* *
* sbit_table_type :: * sbit_table_type ::
* The sbit table type (CBLC, sbix, etc.). * The sbit table type (CBLC, sbix, etc.).
@ -1547,18 +1547,18 @@ FT_BEGIN_HEADER
* the font's sbit table. * the font's sbit table.
* *
* cpal :: * cpal ::
* A pointer to data related to the `CPAL' table. NULL if the table * A pointer to data related to the 'CPAL' table. NULL if the table
* is not available. * is not available.
* *
* colr :: * colr ::
* A pointer to data related to the `COLR' table. NULL if the table * A pointer to data related to the 'COLR' table. NULL if the table
* is not available. * is not available.
* *
* kern_table :: * kern_table ::
* A pointer to the `kern' table. * A pointer to the 'kern' table.
* *
* kern_table_size :: * kern_table_size ::
* The size of the `kern' table. * The size of the 'kern' table.
* *
* num_kern_tables :: * num_kern_tables ::
* The number of supported kern subtables * The number of supported kern subtables
@ -1574,14 +1574,14 @@ FT_BEGIN_HEADER
* if bit n is set, table n is sorted. * if bit n is set, table n is sorted.
* *
* bdf :: * bdf ::
* Data related to an SFNT font's `bdf' * Data related to an SFNT font's 'bdf'
* table; see `tttypes.h'. * table; see `tttypes.h`.
* *
* horz_metrics_offset :: * horz_metrics_offset ::
* The file offset of the `hmtx' table. * The file offset of the 'hmtx' table.
* *
* vert_metrics_offset :: * vert_metrics_offset ::
* The file offset of the `vmtx' table. * The file offset of the 'vmtx' table.
* *
* sph_found_func_flags :: * sph_found_func_flags ::
* Flags identifying special bytecode * Flags identifying special bytecode

18
include/freetype/t1tables.h
View File

@ -497,7 +497,7 @@ FT_BEGIN_HEADER
* in the font's FontInfo dictionary are represented by NULL pointers. * in the font's FontInfo dictionary are represented by NULL pointers.
* *
* If the font's format is not PostScript-based, this function will * If the font's format is not PostScript-based, this function will
* return the `FT_Err_Invalid_Argument' error code. * return the `FT_Err_Invalid_Argument` error code.
* *
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -530,7 +530,7 @@ FT_BEGIN_HEADER
* the face and don't need to be freed by the caller. * the face and don't need to be freed by the caller.
* *
* If the font's format is not PostScript-based, this function returns * If the font's format is not PostScript-based, this function returns
* the `FT_Err_Invalid_Argument' error code. * the `FT_Err_Invalid_Argument` error code.
* *
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -544,7 +544,7 @@ FT_BEGIN_HEADER
* T1_EncodingType * T1_EncodingType
* *
* @description: * @description:
* An enumeration describing the `Encoding' entry in a Type 1 * An enumeration describing the 'Encoding' entry in a Type 1
* dictionary. * dictionary.
* *
* @values: * @values:
@ -721,18 +721,18 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* The values returned are not pointers into the internal structures of * The values returned are not pointers into the internal structures of
* the face, but are `fresh' copies, so that the memory containing them * the face, but are 'fresh' copies, so that the memory containing them
* belongs to the calling application. This also enforces the * belongs to the calling application. This also enforces the
* `read-only' nature of these values, i.e., this function cannot be * 'read-only' nature of these values, i.e., this function cannot be
* used to manipulate the face. * used to manipulate the face.
* *
* `value' is a void pointer because the values returned can be of * 'value' is a void pointer because the values returned can be of
* various types. * various types.
* *
* If either `value' is NULL or `value_len' is too small, just the * If either 'value' is NULL or `value_len` is too small, just the
* required memory size for the requested entry is returned. * required memory size for the requested entry is returned.
* *
* The `idx' parameter is used, not only to retrieve elements of, for * The 'idx' parameter is used, not only to retrieve elements of, for
* example, the FontMatrix or FontBBox, but also to retrieve name keys * example, the FontMatrix or FontBBox, but also to retrieve name keys
* from the CharStrings dictionary, and the charstrings themselves. It * from the CharStrings dictionary, and the charstrings themselves. It
* is ignored for atomic values. * is ignored for atomic values.
@ -747,7 +747,7 @@ FT_BEGIN_HEADER
* available either. * available either.
* *
* If the font's format is not PostScript-based, this function returns * If the font's format is not PostScript-based, this function returns
* the `FT_Err_Invalid_Argument' error code. * the `FT_Err_Invalid_Argument` error code.
* *
* @since: * @since:
* 2.4.8 * 2.4.8

34
include/freetype/ttnameid.h
View File

@ -47,30 +47,30 @@ FT_BEGIN_HEADER
* TT_PLATFORM_XXX * TT_PLATFORM_XXX
* *
* @description: * @description:
* A list of valid values for the `platform_id' identifier code in * A list of valid values for the `platform_id` identifier code in
* @FT_CharMapRec and @FT_SfntName structures. * @FT_CharMapRec and @FT_SfntName structures.
* *
* @values: * @values:
* TT_PLATFORM_APPLE_UNICODE :: * TT_PLATFORM_APPLE_UNICODE ::
* Used by Apple to indicate a Unicode character map and/or name entry. * Used by Apple to indicate a Unicode character map and/or name entry.
* See @TT_APPLE_ID_XXX for corresponding `encoding_id' values. Note * See @TT_APPLE_ID_XXX for corresponding `encoding_id` values. Note
* that name entries in this format are coded as big-endian UCS-2 * that name entries in this format are coded as big-endian UCS-2
* character codes _only_. * character codes _only_.
* *
* TT_PLATFORM_MACINTOSH :: * TT_PLATFORM_MACINTOSH ::
* Used by Apple to indicate a MacOS-specific charmap and/or name entry. * Used by Apple to indicate a MacOS-specific charmap and/or name entry.
* See @TT_MAC_ID_XXX for corresponding `encoding_id' values. Note that * See @TT_MAC_ID_XXX for corresponding `encoding_id` values. Note that
* most TrueType fonts contain an Apple roman charmap to be usable on * most TrueType fonts contain an Apple roman charmap to be usable on
* MacOS systems (even if they contain a Microsoft charmap as well). * MacOS systems (even if they contain a Microsoft charmap as well).
* *
* TT_PLATFORM_ISO :: * TT_PLATFORM_ISO ::
* This value was used to specify ISO/IEC 10646 charmaps. It is however * This value was used to specify ISO/IEC 10646 charmaps. It is however
* now deprecated. See @TT_ISO_ID_XXX for a list of corresponding * now deprecated. See @TT_ISO_ID_XXX for a list of corresponding
* `encoding_id' values. * `encoding_id` values.
* *
* TT_PLATFORM_MICROSOFT :: * TT_PLATFORM_MICROSOFT ::
* Used by Microsoft to indicate Windows-specific charmaps. See * Used by Microsoft to indicate Windows-specific charmaps. See
* @TT_MS_ID_XXX for a list of corresponding `encoding_id' values. * @TT_MS_ID_XXX for a list of corresponding `encoding_id` values.
* Note that most fonts contain a Unicode charmap using * Note that most fonts contain a Unicode charmap using
* (TT_PLATFORM_MICROSOFT, @TT_MS_ID_UNICODE_CS). * (TT_PLATFORM_MICROSOFT, @TT_MS_ID_UNICODE_CS).
* *
@ -97,7 +97,7 @@ FT_BEGIN_HEADER
* TT_APPLE_ID_XXX * TT_APPLE_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `encoding_id' for * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_APPLE_UNICODE charmaps and name entries. * @TT_PLATFORM_APPLE_UNICODE charmaps and name entries.
* *
* @values: * @values:
@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* TT_MAC_ID_XXX * TT_MAC_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `encoding_id' for * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_MACINTOSH charmaps and name entries. * @TT_PLATFORM_MACINTOSH charmaps and name entries.
*/ */
@ -186,7 +186,7 @@ FT_BEGIN_HEADER
* TT_ISO_ID_XXX * TT_ISO_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `encoding_id' for * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_ISO charmaps and name entries. * @TT_PLATFORM_ISO charmaps and name entries.
* *
* Their use is now deprecated. * Their use is now deprecated.
@ -211,7 +211,7 @@ FT_BEGIN_HEADER
* TT_MS_ID_XXX * TT_MS_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `encoding_id' for * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_MICROSOFT charmaps and name entries. * @TT_PLATFORM_MICROSOFT charmaps and name entries.
* *
* @values: * @values:
@ -264,7 +264,7 @@ FT_BEGIN_HEADER
* TT_ADOBE_ID_XXX * TT_ADOBE_ID_XXX
* *
* @description: * @description:
* A list of valid values for the `encoding_id' for * A list of valid values for the `encoding_id` for
* @TT_PLATFORM_ADOBE charmaps. This is a FreeType-specific extension! * @TT_PLATFORM_ADOBE charmaps. This is a FreeType-specific extension!
* *
* @values: * @values:
@ -291,7 +291,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Possible values of the language identifier field in the name records * Possible values of the language identifier field in the name records
* of the SFNT `name' table if the `platform' identifier code is * of the SFNT 'name' table if the 'platform' identifier code is
* @TT_PLATFORM_MACINTOSH. These values are also used as return values * @TT_PLATFORM_MACINTOSH. These values are also used as return values
* for function @FT_Get_CMap_Language_ID. * for function @FT_Get_CMap_Language_ID.
* *
@ -431,7 +431,7 @@ FT_BEGIN_HEADER
* *
* @description: * @description:
* Possible values of the language identifier field in the name records * Possible values of the language identifier field in the name records
* of the SFNT `name' table if the `platform' identifier code is * of the SFNT 'name' table if the 'platform' identifier code is
* @TT_PLATFORM_MICROSOFT. These values are also used as return values * @TT_PLATFORM_MICROSOFT. These values are also used as return values
* for function @FT_Get_CMap_Language_ID. * for function @FT_Get_CMap_Language_ID.
* *
@ -441,7 +441,7 @@ FT_BEGIN_HEADER
* *
* however, we only provide macros for language identifiers present in * however, we only provide macros for language identifiers present in
* the OpenType specification: Microsoft has abandoned the concept of * the OpenType specification: Microsoft has abandoned the concept of
* LCIDs (language code identifiers), and format~1 of the `name' table * LCIDs (language code identifiers), and format~1 of the 'name' table
* provides a better mechanism for languages not covered here. * provides a better mechanism for languages not covered here.
* *
* More legacy values not listed in the reference can be found in the * More legacy values not listed in the reference can be found in the
@ -786,8 +786,8 @@ FT_BEGIN_HEADER
* TT_NAME_ID_XXX * TT_NAME_ID_XXX
* *
* @description: * @description:
* Possible values of the `name' identifier field in the name records of * Possible values of the 'name' identifier field in the name records of
* an SFNT `name' table. These values are platform independent. * an SFNT 'name' table. These values are platform independent.
*/ */
#define TT_NAME_ID_COPYRIGHT 0 #define TT_NAME_ID_COPYRIGHT 0
@ -840,8 +840,8 @@ FT_BEGIN_HEADER
* TT_UCR_XXX * TT_UCR_XXX
* *
* @description: * @description:
* Possible bit mask values for the `ulUnicodeRangeX' fields in an SFNT * Possible bit mask values for the `ulUnicodeRangeX` fields in an SFNT
* `OS/2' table. * 'OS/2' table.
*/ */
/* ulUnicodeRange1 */ /* ulUnicodeRange1 */

120
include/freetype/tttables.h
View File

@ -115,9 +115,9 @@ FT_BEGIN_HEADER
* TT_HoriHeader * TT_HoriHeader
* *
* @description: * @description:
* A structure to model a TrueType horizontal header, the `hhea' * A structure to model a TrueType horizontal header, the 'hhea'
* table, as well as the corresponding horizontal metrics table, * table, as well as the corresponding horizontal metrics table,
* `hmtx'. * 'hmtx'.
* *
* @fields: * @fields:
* Version :: * Version ::
@ -133,8 +133,8 @@ FT_BEGIN_HEADER
* and often reflects only a portion of the * and often reflects only a portion of the
* glyphs found in the font (maybe ASCII). * glyphs found in the font (maybe ASCII).
* *
* You should use the `sTypoAscender' field * You should use the `sTypoAscender` field
* of the `OS/2' table instead if you want * of the 'OS/2' table instead if you want
* the correct one. * the correct one.
* *
* Descender :: * Descender ::
@ -148,8 +148,8 @@ FT_BEGIN_HEADER
* and often reflects only a portion of the * and often reflects only a portion of the
* glyphs found in the font (maybe ASCII). * glyphs found in the font (maybe ASCII).
* *
* You should use the `sTypoDescender' * You should use the `sTypoDescender`
* field of the `OS/2' table instead if you * field of the 'OS/2' table instead if you
* want the correct one. * want the correct one.
* *
* Line_Gap :: * Line_Gap ::
@ -175,7 +175,7 @@ FT_BEGIN_HEADER
* *
* xMax_Extent :: * xMax_Extent ::
* The maximum horizontal extent (i.e., the * The maximum horizontal extent (i.e., the
* `width' of a glyph's bounding box) for * 'width' of a glyph's bounding box) for
* all glyphs in the font. * all glyphs in the font.
* *
* caret_Slope_Rise :: * caret_Slope_Rise ::
@ -196,21 +196,21 @@ FT_BEGIN_HEADER
* Always~0. * Always~0.
* *
* number_Of_HMetrics :: * number_Of_HMetrics ::
* Number of HMetrics entries in the `hmtx' * Number of HMetrics entries in the 'hmtx'
* table -- this value can be smaller than * table -- this value can be smaller than
* the total number of glyphs in the font. * the total number of glyphs in the font.
* *
* long_metrics :: * long_metrics ::
* A pointer into the `hmtx' table. * A pointer into the 'hmtx' table.
* *
* short_metrics :: * short_metrics ::
* A pointer into the `hmtx' table. * A pointer into the 'hmtx' table.
* *
* @note: * @note:
* For an OpenType variation font, the values of the following fields * For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and * can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `caret_Slope_Rise', * friends) if the font contains an 'MVAR' table: `caret_Slope_Rise`,
* `caret_Slope_Run', and `caret_Offset'. * `caret_Slope_Run`, and `caret_Offset`.
*/ */
typedef struct TT_HoriHeader_ typedef struct TT_HoriHeader_
{ {
@ -249,9 +249,9 @@ FT_BEGIN_HEADER
* TT_VertHeader * TT_VertHeader
* *
* @description: * @description:
* A structure used to model a TrueType vertical header, the `vhea' * A structure used to model a TrueType vertical header, the 'vhea'
* table, as well as the corresponding vertical metrics table, * table, as well as the corresponding vertical metrics table,
* `vmtx'. * 'vmtx'.
* *
* @fields: * @fields:
* Version :: * Version ::
@ -268,8 +268,8 @@ FT_BEGIN_HEADER
* the glyphs found in the font (maybe * the glyphs found in the font (maybe
* ASCII). * ASCII).
* *
* You should use the `sTypoAscender' * You should use the `sTypoAscender`
* field of the `OS/2' table instead if * field of the 'OS/2' table instead if
* you want the correct one. * you want the correct one.
* *
* Descender :: * Descender ::
@ -284,8 +284,8 @@ FT_BEGIN_HEADER
* the glyphs found in the font (maybe * the glyphs found in the font (maybe
* ASCII). * ASCII).
* *
* You should use the `sTypoDescender' * You should use the `sTypoDescender`
* field of the `OS/2' table instead if * field of the 'OS/2' table instead if
* you want the correct one. * you want the correct one.
* *
* Line_Gap :: * Line_Gap ::
@ -311,7 +311,7 @@ FT_BEGIN_HEADER
* *
* yMax_Extent :: * yMax_Extent ::
* The maximum vertical extent (i.e., the * The maximum vertical extent (i.e., the
* `height' of a glyph's bounding box) for * 'height' of a glyph's bounding box) for
* all glyphs in the font. * all glyphs in the font.
* *
* caret_Slope_Rise :: * caret_Slope_Rise ::
@ -333,22 +333,22 @@ FT_BEGIN_HEADER
* *
* number_Of_VMetrics :: * number_Of_VMetrics ::
* Number of VMetrics entries in the * Number of VMetrics entries in the
* `vmtx' table -- this value can be * 'vmtx' table -- this value can be
* smaller than the total number of glyphs * smaller than the total number of glyphs
* in the font. * in the font.
* *
* long_metrics :: * long_metrics ::
* A pointer into the `vmtx' table. * A pointer into the 'vmtx' table.
* *
* short_metrics :: * short_metrics ::
* A pointer into the `vmtx' table. * A pointer into the 'vmtx' table.
* *
* @note: * @note:
* For an OpenType variation font, the values of the following fields * For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and * can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `Ascender', * friends) if the font contains an 'MVAR' table: 'Ascender',
* `Descender', `Line_Gap', `caret_Slope_Rise', `caret_Slope_Run', * 'Descender', `Line_Gap`, `caret_Slope_Rise`, `caret_Slope_Run`,
* and `caret_Offset'. * and `caret_Offset`.
*/ */
typedef struct TT_VertHeader_ typedef struct TT_VertHeader_
{ {
@ -387,25 +387,25 @@ FT_BEGIN_HEADER
* TT_OS2 * TT_OS2
* *
* @description: * @description:
* A structure to model a TrueType `OS/2' table. All fields comply * A structure to model a TrueType 'OS/2' table. All fields comply
* to the OpenType specification. * to the OpenType specification.
* *
* Note that we now support old Mac fonts that do not include an * Note that we now support old Mac fonts that do not include an
* `OS/2' table. In this case, the `version' field is always set to * 'OS/2' table. In this case, the 'version' field is always set to
* 0xFFFF. * 0xFFFF.
* *
* @note: * @note:
* For an OpenType variation font, the values of the following fields * For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and * can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `sCapHeight', * friends) if the font contains an 'MVAR' table: `sCapHeight`,
* `sTypoAscender', `sTypoDescender', `sTypoLineGap', `sxHeight', * `sTypoAscender`, `sTypoDescender`, `sTypoLineGap`, `sxHeight`,
* `usWinAscent', `usWinDescent', `yStrikeoutPosition', * `usWinAscent`, `usWinDescent`, `yStrikeoutPosition`,
* `yStrikeoutSize', `ySubscriptXOffset', `ySubScriptXSize', * `yStrikeoutSize`, `ySubscriptXOffset`, `ySubScriptXSize`,
* `ySubscriptYOffset', `ySubscriptYSize', `ySuperscriptXOffset', * `ySubscriptYOffset`, `ySubscriptYSize`, `ySuperscriptXOffset`,
* `ySuperscriptXSize', `ySuperscriptYOffset', and * `ySuperscriptXSize`, `ySuperscriptYOffset`, and
* `ySuperscriptYSize'. * `ySuperscriptYSize`.
* *
* Possible values for bits in the `ulUnicodeRangeX' fields are given * Possible values for bits in the `ulUnicodeRangeX` fields are given
* by the @TT_UCR_XXX macros. * by the @TT_UCR_XXX macros.
*/ */
@ -473,7 +473,7 @@ FT_BEGIN_HEADER
* TT_Postscript * TT_Postscript
* *
* @description: * @description:
* A structure to model a TrueType `post' table. All fields comply * A structure to model a TrueType 'post' table. All fields comply
* to the OpenType specification. This structure does not reference * to the OpenType specification. This structure does not reference
* a font's PostScript glyph names; use @FT_Get_Glyph_Name to * a font's PostScript glyph names; use @FT_Get_Glyph_Name to
* retrieve them. * retrieve them.
@ -481,8 +481,8 @@ FT_BEGIN_HEADER
* @note: * @note:
* For an OpenType variation font, the values of the following fields * For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and * can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `underlinePosition' * friends) if the font contains an 'MVAR' table: `underlinePosition`
* and `underlineThickness'. * and `underlineThickness`.
*/ */
typedef struct TT_Postscript_ typedef struct TT_Postscript_
{ {
@ -508,7 +508,7 @@ FT_BEGIN_HEADER
* TT_PCLT * TT_PCLT
* *
* @description: * @description:
* A structure to model a TrueType `PCLT' table. All fields comply * A structure to model a TrueType 'PCLT' table. All fields comply
* to the OpenType specification. * to the OpenType specification.
*/ */
typedef struct TT_PCLT_ typedef struct TT_PCLT_
@ -538,7 +538,7 @@ FT_BEGIN_HEADER
* TT_MaxProfile * TT_MaxProfile
* *
* @description: * @description:
* The maximum profile (`maxp') table contains many max values, which * The maximum profile ('maxp') table contains many max values, which
* can be used to pre-allocate arrays for speeding up glyph loading * can be used to pre-allocate arrays for speeding up glyph loading
* and hinting. * and hinting.
* *
@ -553,22 +553,22 @@ FT_BEGIN_HEADER
* maxPoints :: * maxPoints ::
* The maximum number of points in a * The maximum number of points in a
* non-composite TrueType glyph. See also * non-composite TrueType glyph. See also
* `maxCompositePoints'. * `maxCompositePoints`.
* *
* maxContours :: * maxContours ::
* The maximum number of contours in a * The maximum number of contours in a
* non-composite TrueType glyph. See also * non-composite TrueType glyph. See also
* `maxCompositeContours'. * `maxCompositeContours`.
* *
* maxCompositePoints :: * maxCompositePoints ::
* The maximum number of points in a * The maximum number of points in a
* composite TrueType glyph. See also * composite TrueType glyph. See also
* `maxPoints'. * `maxPoints`.
* *
* maxCompositeContours :: * maxCompositeContours ::
* The maximum number of contours in a * The maximum number of contours in a
* composite TrueType glyph. See also * composite TrueType glyph. See also
* `maxContours'. * `maxContours`.
* *
* maxZones :: * maxZones ::
* The maximum number of zones used for * The maximum number of zones used for
@ -706,10 +706,10 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* A type-less pointer to the table. This will be NULL in case of * A type-less pointer to the table. This will be NULL in case of
* error, or if the corresponding table was not found *OR* loaded * error, or if the corresponding table was not found **OR** loaded
* from the file. * from the file.
* *
* Use a typecast according to `tag' to access the structure * Use a typecast according to 'tag' to access the structure
* elements. * elements.
* *
* @note: * @note:
@ -720,15 +720,15 @@ FT_BEGIN_HEADER
* a list. * a list.
* *
* @example: * @example:
* Here an example how to access the `vhea' table. * Here an example how to access the 'vhea' table.
* *
* { * ```
* TT_VertHeader* vert_header; * TT_VertHeader* vert_header;
* *
* *
* vert_header = * vert_header =
* (TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA ); * (TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA );
* } * ```
*/ */
FT_EXPORT( void* ) FT_EXPORT( void* )
FT_Get_Sfnt_Table( FT_Face face, FT_Get_Sfnt_Table( FT_Face face,
@ -763,10 +763,10 @@ FT_BEGIN_HEADER
* *
* @inout: * @inout:
* length :: * length ::
* If the `length' parameter is NULL, try to load the whole table. * If the 'length' parameter is NULL, try to load the whole table.
* Return an error code if it fails. * Return an error code if it fails.
* *
* Else, if `*length' is~0, exit immediately while returning the * Else, if '*length' is~0, exit immediately while returning the
* table's (or file) full size in it. * table's (or file) full size in it.
* *
* Else the number of bytes to read from the table or file, from the * Else the number of bytes to read from the table or file, from the
@ -777,9 +777,9 @@ FT_BEGIN_HEADER
* *
* @note: * @note:
* If you need to determine the table's length you should first call this * If you need to determine the table's length you should first call this
* function with `*length' set to~0, as in the following example: * function with '*length' set to~0, as in the following example:
* *
* { * ```
* FT_ULong length = 0; * FT_ULong length = 0;
* *
* *
@ -791,7 +791,7 @@ FT_BEGIN_HEADER
* *
* error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length ); * error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
* if ( error ) { ... could not load table ... } * if ( error ) { ... could not load table ... }
* } * ```
* *
* Note that structures like @TT_Header or @TT_OS2 can't be used with * Note that structures like @TT_Header or @TT_OS2 can't be used with
* this function; they are limited to @FT_Get_Sfnt_Table. Reason is that * this function; they are limited to @FT_Get_Sfnt_Table. Reason is that
@ -825,14 +825,14 @@ FT_BEGIN_HEADER
* *
* @inout: * @inout:
* tag :: * tag ::
* The name tag of the SFNT table. If the value is NULL, `table_index' * The name tag of the SFNT table. If the value is NULL, `table_index`
* is ignored, and `length' returns the number of SFNT tables in the * is ignored, and 'length' returns the number of SFNT tables in the
* font. * font.
* *
* @output: * @output:
* length :: * length ::
* The length of the SFNT table (or the number of SFNT tables, depending * The length of the SFNT table (or the number of SFNT tables, depending
* on `tag'). * on 'tag').
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -863,7 +863,7 @@ FT_BEGIN_HEADER
* The target charmap. * The target charmap.
* *
* @return: * @return:
* The language ID of `charmap'. If `charmap' doesn't belong to an * The language ID of 'charmap'. If 'charmap' doesn't belong to an
* SFNT face, just return~0 as the default value. * SFNT face, just return~0 as the default value.
* *
* For a format~14 cmap (to access Unicode IVS), the return value is * For a format~14 cmap (to access Unicode IVS), the return value is
@ -879,14 +879,14 @@ FT_BEGIN_HEADER
* FT_Get_CMap_Format * FT_Get_CMap_Format
* *
* @description: * @description:
* Return the format of an SFNT `cmap' table. * Return the format of an SFNT 'cmap' table.
* *
* @input: * @input:
* charmap :: * charmap ::
* The target charmap. * The target charmap.
* *
* @return: * @return:
* The format of `charmap'. If `charmap' doesn't belong to an SFNT * The format of 'charmap'. If 'charmap' doesn't belong to an SFNT
* face, return -1. * face, return -1.
*/ */
FT_EXPORT( FT_Long ) FT_EXPORT( FT_Long )