ReceiveTempSMS
/
Al-Qurtas-Islamic-bank-The-Best-Bank-in-Iraq
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

s/NULL/`NULL`/ in documentation.

This commit is contained in:
Werner Lemberg 2019-02-20 16:18:40 +01:00
parent f92fa39341
commit 8de11f3def
25 changed files with 107 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
include/freetype/freetype.h
View File

@ -927,7 +927,7 @@ FT_BEGIN_HEADER
* denominator used to list fonts. Some formats (TrueType & OpenType) * denominator used to list fonts. Some formats (TrueType & OpenType)
* provide localized and Unicode versions of this string. Applications * provide localized and Unicode versions of this string. Applications
* should use the format-specific interface to access them. Can be * should use the format-specific interface to access them. Can be
* NULL (e.g., in fonts embedded in a PDF file). * `NULL` (e.g., in fonts embedded in a PDF file).
* *
* In case the font doesn't provide a specific family name entry, * In case the font doesn't provide a specific family name entry,
* FreeType tries to synthesize one, deriving it from other name * FreeType tries to synthesize one, deriving it from other name
@ -937,7 +937,7 @@ FT_BEGIN_HEADER
* The face's style name. This is an ASCII string, usually in English, * The face's style name. This is an ASCII string, usually in English,
* that describes the typeface's style (like 'Italic', 'Bold', * that describes the typeface's style (like 'Italic', 'Bold',
* 'Condensed', etc). Not all font formats provide a style name, so * 'Condensed', etc). Not all font formats provide a style name, so
* this field is optional, and can be set to NULL. As for * this field is optional, and can be set to `NULL`. As for
* `family_name`, some formats provide localized and Unicode versions * `family_name`, some formats provide localized and Unicode versions
* of this string. Applications should use the format-specific * of this string. Applications should use the format-specific
* interface to access them. * interface to access them.
@ -949,7 +949,7 @@ FT_BEGIN_HEADER
* *
* available_sizes :: * available_sizes ::
* An array of @FT_Bitmap_Size for all bitmap strikes in the face. It * An array of @FT_Bitmap_Size for all bitmap strikes in the face. It
* is set to NULL if there is no bitmap strike. * is set to `NULL` if there is no bitmap strike.
* *
* Note that FreeType tries to sanitize the strike data since they are * Note that FreeType tries to sanitize the strike data since they are
* sometimes sloppy or incorrect, but this can easily fail. * sometimes sloppy or incorrect, but this can easily fail.
@ -2078,7 +2078,7 @@ FT_BEGIN_HEADER
* *
* driver :: * driver ::
* This field is exclusively used by @FT_Open_Face; it simply specifies * This field is exclusively used by @FT_Open_Face; it simply specifies
* the font driver to use for opening the face. If set to NULL, * the font driver to use for opening the face. If set to `NULL`,
* FreeType tries to load the face with each one of the drivers in its * FreeType tries to load the face with each one of the drivers in its
* list. * list.
* *
@ -2149,7 +2149,7 @@ FT_BEGIN_HEADER
* @output: * @output:
* aface :: * aface ::
* A handle to a new face object. If `face_index` is greater than or * A handle to a new face object. If `face_index` is greater than or
* equal to zero, it must be non-NULL. * equal to zero, it must be non-`NULL`.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -2190,7 +2190,7 @@ FT_BEGIN_HEADER
* @output: * @output:
* aface :: * aface ::
* A handle to a new face object. If `face_index` is greater than or * A handle to a new face object. If `face_index` is greater than or
* equal to zero, it must be non-NULL. * equal to zero, it must be non-`NULL`.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -2242,7 +2242,7 @@ FT_BEGIN_HEADER
* In general, if the `face_index` argument is negative, the function's * In general, if the `face_index` argument is negative, the function's
* return value is~0 if the font format is recognized, or non-zero * return value is~0 if the font format is recognized, or non-zero
* otherwise. The function allocates a more or less empty face handle * otherwise. The function allocates a more or less empty face handle
* in `*aface` (if `aface` isn't NULL); the only two useful fields in * in `*aface` (if `aface` isn't `NULL`); the only two useful fields in
* this special case are `face->num_faces` and `face->style_flags`. * this special case are `face->num_faces` and `face->style_flags`.
* For any negative value of `face_index`, `face->num_faces` gives the * For any negative value of `face_index`, `face->num_faces` gives the
* number of faces within the font file. For the negative value * number of faces within the font file. For the negative value
@ -2255,7 +2255,7 @@ FT_BEGIN_HEADER
* @output: * @output:
* aface :: * aface ::
* A handle to a new face object. If `face_index` is greater than or * A handle to a new face object. If `face_index` is greater than or
* equal to zero, it must be non-NULL. * equal to zero, it must be non-`NULL`.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -3174,10 +3174,10 @@ FT_BEGIN_HEADER
* *
* @input: * @input:
* matrix :: * matrix ::
* A pointer to the transformation's 2x2 matrix. Use NULL for the * A pointer to the transformation's 2x2 matrix. Use `NULL` for the
* identity matrix. * identity matrix.
* delta :: * delta ::
* A pointer to the translation vector. Use NULL for the null vector. * A pointer to the translation vector. Use `NULL` for the null vector.
* *
* @note: * @note:
* The transformation is only applied to scalable image formats after the * The transformation is only applied to scalable image formats after the
@ -3576,7 +3576,7 @@ FT_BEGIN_HEADER
* A handle to the source face object. * A handle to the source face object.
* *
* @return: * @return:
* A pointer to the face's PostScript name. NULL if unavailable. * A pointer to the face's PostScript name. `NULL` if unavailable.
* *
* @note: * @note:
* The returned pointer is owned by the face and is destroyed with it. * The returned pointer is owned by the face and is destroyed with it.
@ -3841,7 +3841,7 @@ FT_BEGIN_HEADER
* provided by the 'cff', 'type1', and 't1cid' modules; see * provided by the 'cff', 'type1', and 't1cid' modules; see
* @random-seed). * @random-seed).
* *
* Pass NULL as `data` in @FT_Parameter for a given tag to reset the * Pass `NULL` as `data` in @FT_Parameter for a given tag to reset the
* option and use the library or module default again. * option and use the library or module default again.
* *
* @input: * @input:
@ -4056,7 +4056,7 @@ FT_BEGIN_HEADER
* *
* p :: * p ::
* An opaque pointer into `COLR` table data. The caller must set this * An opaque pointer into `COLR` table data. The caller must set this
* to NULL before the first call of @FT_Get_Color_Glyph_Layer. * to `NULL` before the first call of @FT_Get_Color_Glyph_Layer.
*/ */
typedef struct FT_LayerIterator_ typedef struct FT_LayerIterator_
{ {
@ -4100,8 +4100,8 @@ 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 same * `iterator->p` to `NULL`. For all following calls, simply use the
* object again. * same object again.
* *
* @output: * @output:
* aglyph_index :: * aglyph_index ::
@ -4422,8 +4422,8 @@ FT_BEGIN_HEADER
* A handle to the source face object. * A handle to the source face object.
* *
* @return: * @return:
* A pointer to an array of selector code points, or NULL if there is no * A pointer to an array of selector code points, or `NULL` if there is
* valid variation selector cmap subtable. * no valid variation selector cmap subtable.
* *
* @note: * @note:
* The last item in the array is~0; the array is owned by the @FT_Face * The last item in the array is~0; the array is owned by the @FT_Face
@ -4455,7 +4455,7 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* A pointer to an array of variation selector code points that are * A pointer to an array of variation selector code points that are
* active for the given character, or NULL if the corresponding list is * active for the given character, or `NULL` if the corresponding list is
* empty. * empty.
* *
* @note: * @note:
@ -4489,8 +4489,8 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* A list of all the code points that are specified by this selector * A list of all the code points that are specified by this selector
* (both default and non-default codes are returned) or NULL if there is * (both default and non-default codes are returned) or `NULL` if there
* no valid cmap or the variation selector is invalid. * is no valid cmap or the variation selector is invalid.
* *
* @note: * @note:
* The last item in the array is~0; the array is owned by the @FT_Face * The last item in the array is~0; the array is owned by the @FT_Face

4
include/freetype/ftbdf.h
View File

@ -106,8 +106,8 @@ FT_BEGIN_HEADER
* The property type. * The property type.
* *
* u.atom :: * u.atom ::
* The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be NULL, * The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be
* indicating an empty string. * `NULL`, indicating an empty string.
* *
* u.integer :: * u.integer ::
* A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. * A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER.

40
include/freetype/ftcache.h
View File

@ -155,7 +155,7 @@ FT_BEGIN_HEADER
* containing a font file path, and face index. * containing a font file path, and face index.
* *
* @note: * @note:
* Never use NULL as a valid @FTC_FaceID. * Never use `NULL` as a valid @FTC_FaceID.
* *
* Face IDs are passed by the client to the cache manager that calls, * Face IDs are passed by the client to the cache manager that calls,
* when needed, the @FTC_Face_Requester to translate them into new * when needed, the @FTC_Face_Requester to translate them into new
@ -588,7 +588,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* acache :: * acache ::
* A new cache handle. NULL in case of error. * A new cache handle. `NULL` in case of error.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -772,14 +772,14 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however create * Never try to transform or discard it manually! You can however create
* a copy with @FT_Glyph_Copy and modify the new one. * a copy with @FT_Glyph_Copy and modify the new one.
* *
* If `anode` is _not_ NULL, it receives the address of the cache node * If `anode` is _not_ `NULL`, it receives the address of the cache node
* containing the glyph image, after increasing its reference count. * containing the glyph image, after increasing its reference count.
* This ensures that the node (as well as the @FT_Glyph) will always be * 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 '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 that * If `anode` is `NULL`, the cache node is left unchanged, which means
* the @FT_Glyph could be flushed out of the cache on the next call to * that the @FT_Glyph could be flushed out of the cache on the next call
* one of the caching sub-system APIs. Don't assume that it is * to one of the caching sub-system APIs. Don't assume that it is
* persistent! * persistent!
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
@ -828,14 +828,14 @@ FT_BEGIN_HEADER
* Never try to transform or discard it manually! You can however create * Never try to transform or discard it manually! You can however create
* a copy with @FT_Glyph_Copy and modify the new one. * a copy with @FT_Glyph_Copy and modify the new one.
* *
* If `anode` is _not_ NULL, it receives the address of the cache node * If `anode` is _not_ `NULL`, it receives the address of the cache node
* containing the glyph image, after increasing its reference count. * containing the glyph image, after increasing its reference count.
* This ensures that the node (as well as the @FT_Glyph) will always be * 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 '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 that * If `anode` is `NULL`, the cache node is left unchanged, which means
* the @FT_Glyph could be flushed out of the cache on the next call to * that the @FT_Glyph could be flushed out of the cache on the next call
* one of the caching sub-system APIs. Don't assume that it is * to one of the caching sub-system APIs. Don't assume that it is
* persistent! * persistent!
* *
* Calls to @FT_Set_Char_Size and friends have no effect on cached * Calls to @FT_Set_Char_Size and friends have no effect on cached
@ -950,7 +950,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* acache :: * acache ::
* A handle to the new sbit cache. NULL in case of error. * A handle to the new sbit cache. `NULL` in case of error.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -999,14 +999,15 @@ FT_BEGIN_HEADER
* 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 node * If `anode` is _not_ `NULL`, it receives the address of the cache node
* containing the bitmap, after increasing its reference count. This * containing the bitmap, after increasing its reference count. This
* ensures that the node (as well as the image) will always be kept in * 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. * the cache until you call @FTC_Node_Unref to 'release' it.
* *
* If `anode` is NULL, the cache node is left unchanged, which means that * If `anode` is `NULL`, the cache node is left unchanged, which means
* the bitmap could be flushed out of the cache on the next call to one * that the bitmap could be flushed out of the cache on the next call to
* of the caching sub-system APIs. Don't assume that it is persistent! * one of the caching sub-system APIs. Don't assume that it is
* persistent!
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FTC_SBitCache_Lookup( FTC_SBitCache cache, FTC_SBitCache_Lookup( FTC_SBitCache cache,
@ -1058,14 +1059,15 @@ FT_BEGIN_HEADER
* 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 node * If `anode` is _not_ `NULL`, it receives the address of the cache node
* containing the bitmap, after increasing its reference count. This * containing the bitmap, after increasing its reference count. This
* ensures that the node (as well as the image) will always be kept in * 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. * the cache until you call @FTC_Node_Unref to 'release' it.
* *
* If `anode` is NULL, the cache node is left unchanged, which means that * If `anode` is `NULL`, the cache node is left unchanged, which means
* the bitmap could be flushed out of the cache on the next call to one * that the bitmap could be flushed out of the cache on the next call to
* of the caching sub-system APIs. Don't assume that it is persistent! * one of the caching sub-system APIs. Don't assume that it is
* persistent!
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FTC_SBitCache_LookupScaler( FTC_SBitCache cache, FTC_SBitCache_LookupScaler( FTC_SBitCache cache,

10
include/freetype/ftcolor.h
View File

@ -132,7 +132,7 @@ FT_BEGIN_HEADER
* 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.
@ -140,7 +140,7 @@ FT_BEGIN_HEADER
* @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
@ -157,7 +157,7 @@ FT_BEGIN_HEADER
* An empty entry name ID in the `CPAL` table gets represented as value * An empty entry 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.
* *
* @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
@ -240,10 +240,10 @@ FT_BEGIN_HEADER
* 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`,
* having `num_palette_entries` elements (as found in the * having `num_palette_entries` elements (as found in the
* `FT_Palette_Data` structure). If `apalette` is set to NULL, no * `FT_Palette_Data` structure). If `apalette` is set to `NULL`, no
* array gets returned (and no color entries can be modified). * array gets returned (and no color 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.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.

2
include/freetype/ftfntfmt.h
View File

@ -69,7 +69,7 @@ FT_BEGIN_HEADER
* Input face handle. * Input face handle.
* *
* @return: * @return:
* Font format string. NULL in case of error. * Font format string. `NULL` in case of error.
* *
* @note: * @note:
* A deprecated name for the same function is `FT_Get_X11_Font_Format`. * A deprecated name for the same function is `FT_Get_X11_Font_Format`.

4
include/freetype/ftgxval.h
View File

@ -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.
@ -311,7 +311,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 )

2
include/freetype/ftimage.h
View File

@ -1105,7 +1105,7 @@ FT_BEGIN_HEADER
* *
* pool_base :: * pool_base ::
* Previously, the address in memory of the render pool. Set this to * Previously, the address in memory of the render pool. Set this to
* NULL. * `NULL`.
* *
* pool_size :: * pool_size ::
* Previously, the size in bytes of the render pool. Set this to 0. * Previously, the size in bytes of the render pool. Set this to 0.

4
include/freetype/ftlist.h
View File

@ -90,7 +90,7 @@ FT_BEGIN_HEADER
* The address of the listed object. * The address of the listed object.
* *
* @return: * @return:
* List node. NULL if it wasn't found. * List node. `NULL` if it wasn't found.
*/ */
FT_EXPORT( FT_ListNode ) FT_EXPORT( FT_ListNode )
FT_List_Find( FT_List list, FT_List_Find( FT_List list,
@ -267,7 +267,7 @@ FT_BEGIN_HEADER
* *
* destroy :: * destroy ::
* A list destructor that will be applied to each element of the list. * A list destructor that will be applied to each element of the list.
* Set this to NULL if not needed. * Set this to `NULL` if not needed.
* *
* memory :: * memory ::
* The current memory object that handles deallocation. * The current memory object that handles deallocation.

8
include/freetype/ftmm.h
View File

@ -356,7 +356,7 @@ 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 sets * [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` field * the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags` field
@ -397,7 +397,7 @@ 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).
* *
@ -478,7 +478,7 @@ 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).
* *
@ -593,7 +593,7 @@ FT_BEGIN_HEADER
* Adobe Multiple Master fonts limit the number of designs, and thus the * Adobe Multiple Master fonts limit the number of designs, and thus the
* length of the weight vector to~16. * length of the weight vector to~16.
* *
* If `len` is zero and `weightvector` is NULL, the weight vector array * If `len` is zero and `weightvector` is `NULL`, the weight vector array
* is reset to the default values. * is reset to the default values.
* *
* The Adobe documentation also states that the values in the * The Adobe documentation also states that the values in the

2
include/freetype/ftotval.h
View File

@ -157,7 +157,7 @@ FT_BEGIN_HEADER
* otherwise. * otherwise.
* *
* After use, the application should deallocate the five tables with * After use, the application should deallocate the five tables with
* @FT_OpenType_Free. A NULL value indicates that the table either * @FT_OpenType_Free. A `NULL` value indicates that the table either
* doesn't exist in the font, or the application hasn't asked for * doesn't exist in the font, or the application hasn't asked for
* validation. * validation.
*/ */

8
include/freetype/ftpfr.h
View File

@ -64,21 +64,21 @@ FT_BEGIN_HEADER
* @output: * @output:
* aoutline_resolution :: * aoutline_resolution ::
* Outline resolution. This is equivalent to `face->units_per_EM` for * Outline resolution. This is equivalent to `face->units_per_EM` for
* non-PFR fonts. Optional (parameter can be NULL). * non-PFR fonts. Optional (parameter can be `NULL`).
* *
* ametrics_resolution :: * ametrics_resolution ::
* Metrics resolution. This is equivalent to `outline_resolution` for * Metrics resolution. This is equivalent to `outline_resolution` for
* non-PFR fonts. Optional (parameter can be NULL). * 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 in * A 16.16 fixed-point number used to scale distance expressed in
* metrics units to device subpixels. This is equivalent to * 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:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.

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 should * Currently, no FreeType renderer module uses `parameters`; you should
* thus always pass NULL as the value. * thus always pass `NULL` as the value.
*/ */
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Set_Renderer( FT_Library library, FT_Set_Renderer( FT_Library library,

6
include/freetype/ftsnames.h
View File

@ -96,7 +96,7 @@ FT_BEGIN_HEADER
* string :: * string ::
* The 'name' string. Note that its format differs depending on the * The 'name' string. Note that its format differs depending on the
* (platform,encoding) pair, being either a string of bytes (without a * (platform,encoding) pair, being either a string of bytes (without a
* terminating NULL byte) or containing UTF-16BE entities. * terminating `NULL` byte) or containing UTF-16BE entities.
* *
* string_len :: * string_len ::
* The length of `string` in bytes. * The length of `string` in bytes.
@ -194,8 +194,8 @@ FT_BEGIN_HEADER
* *
* @fields: * @fields:
* string :: * string ::
* The language tag string, encoded in UTF-16BE (without trailing NULL * The language tag string, encoded in UTF-16BE (without trailing
* bytes). * `NULL` bytes).
* *
* string_len :: * string_len ::
* The length of `string` in **bytes**. * The length of `string` in **bytes**.

4
include/freetype/ftstroke.h
View File

@ -264,7 +264,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* astroker :: * astroker ::
* A new stroker object handle. NULL in case of error. * A new stroker object handle. `NULL` in case of error.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -674,7 +674,7 @@ FT_BEGIN_HEADER
* *
* @input: * @input:
* stroker :: * stroker ::
* A stroker handle. Can be NULL. * A stroker handle. Can be `NULL`.
*/ */
FT_EXPORT( void ) FT_EXPORT( void )
FT_Stroker_Done( FT_Stroker stroker ); FT_Stroker_Done( FT_Stroker stroker );

2
include/freetype/ftsystem.h
View File

@ -281,7 +281,7 @@ FT_BEGIN_HEADER
* @input: * @input:
* base :: * base ::
* For memory-based streams, this is the address of the first stream * For memory-based streams, this is the address of the first stream
* byte in memory. This field should always be set to NULL for * byte in memory. This field should always be set to `NULL` for
* disk-based streams. * disk-based streams.
* *
* size :: * size ::

8
include/freetype/fttypes.h
View File

@ -461,8 +461,8 @@ FT_BEGIN_HEADER
* *
* finalizer :: * finalizer ::
* A pointer to a 'generic finalizer' function, which will be called * A pointer to a 'generic finalizer' function, which will be called
* when the object is destroyed. If this field is set to NULL, no code * when the object is destroyed. If this field is set to `NULL`, no
* will be called. * code will be called.
*/ */
typedef struct FT_Generic_ typedef struct FT_Generic_
{ {
@ -544,10 +544,10 @@ FT_BEGIN_HEADER
* *
* @fields: * @fields:
* prev :: * prev ::
* The previous element in the list. NULL if first. * The previous element in the list. `NULL` if first.
* *
* next :: * next ::
* The next element in the list. NULL if last. * The next element in the list. `NULL` if last.
* *
* data :: * data ::
* A typeless pointer to the listed object. * A typeless pointer to the listed object.

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

@ -135,8 +135,8 @@ FT_BEGIN_HEADER
* *
* @return: * @return:
* The name of the trace component. This is a statically allocated * The name of the trace component. This is a statically allocated
* C~string, so do not free it after use. NULL if FreeType is not built * C~string, so do not free it after use. `NULL` if FreeType is not
* with FT_DEBUG_LEVEL_TRACE definition. * built with FT_DEBUG_LEVEL_TRACE definition.
* *
* @note: * @note:
* Use @FT_Trace_Get_Count to get the number of available trace * Use @FT_Trace_Get_Count to get the number of available trace

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

@ -118,8 +118,8 @@ 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 equal to * exist. If 'new_names[N]' is `NULL`, the guessed file name is equal
* `base_name`. * 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

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

@ -54,7 +54,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* ptr :: * ptr ::
* A variable that receives the service pointer. Will be NULL if not * A variable that receives the service pointer. Will be `NULL` if not
* found. * found.
*/ */
#ifdef __cplusplus #ifdef __cplusplus
@ -106,7 +106,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* ptr :: * ptr ::
* A variable that receives the service pointer. Will be NULL if not * A variable that receives the service pointer. Will be `NULL` if not
* found. * found.
*/ */
#ifdef __cplusplus #ifdef __cplusplus
@ -426,7 +426,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* ptr :: * ptr ::
* A variable receiving the service data. NULL if not available. * A variable receiving the service data. `NULL` if not available.
*/ */
#ifdef __cplusplus #ifdef __cplusplus

4
include/freetype/internal/services/svpostnm.h
View File

@ -26,9 +26,9 @@ FT_BEGIN_HEADER
/* /*
* A trivial service used to retrieve the PostScript name of a given font * A trivial service used to retrieve the PostScript name of a given font
* when available. The `get_name' field should never be NULL. * when available. The `get_name' field should never be `NULL`.
* *
* The corresponding function can return NULL to indicate that the * The corresponding function can return `NULL` to indicate that the
* PostScript name is not available. * PostScript name is not available.
* *
* The name is owned by the face and will be destroyed with it. * The name is owned by the face and will be destroyed with it.

8
include/freetype/internal/services/svpscmap.h
View File

@ -35,13 +35,13 @@ FT_BEGIN_HEADER
(*PS_Unicode_ValueFunc)( const char* glyph_name ); (*PS_Unicode_ValueFunc)( const char* glyph_name );
/* /*
* Macintosh name id to glyph name. NULL if invalid index. * Macintosh name id to glyph name. `NULL` if invalid index.
*/ */
typedef const char* typedef const char*
(*PS_Macintosh_NameFunc)( FT_UInt name_index ); (*PS_Macintosh_NameFunc)( FT_UInt name_index );
/* /*
* Adobe standard string ID to glyph name. NULL if invalid index. * Adobe standard string ID to glyph name. `NULL` if invalid index.
*/ */
typedef const char* typedef const char*
(*PS_Adobe_Std_StringsFunc)( FT_UInt string_index ); (*PS_Adobe_Std_StringsFunc)( FT_UInt string_index );
@ -70,8 +70,8 @@ FT_BEGIN_HEADER
/* /*
* A function which returns a glyph name for a given index. Returns NULL * A function which returns a glyph name for a given index. Returns
* if invalid index. * `NULL` if invalid index.
*/ */
typedef const char* typedef const char*
(*PS_GetGlyphNameFunc)( FT_Pointer data, (*PS_GetGlyphNameFunc)( FT_Pointer data,

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

@ -160,13 +160,13 @@ FT_BEGIN_HEADER
* length :: * length ::
* The address of the decision variable: * The address of the decision variable:
* *
* If length == NULL: Loads the whole table. Returns an error if * If `length == NULL`: Loads the whole table. Returns an error if
* 'offset' == 0! * 'offset' == 0!
* *
* If *length == 0: Exits immediately; returning the length of the * If `*length == 0`: Exits immediately; returning the length of the
* given table or of the font file, depending on the value of 'tag'. * given table or of the font file, depending on the value of 'tag'.
* *
* If *length != 0: Loads the next 'length' bytes of table or font, * If `*length != 0`: 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:
@ -382,7 +382,7 @@ FT_BEGIN_HEADER
* The glyph index. * The glyph index.
* *
* PSname :: * PSname ::
* The address of a string pointer. Will be NULL in case of error, * The address of a string pointer. Will be `NULL` in case of error,
* otherwise it is a pointer to the glyph name. * otherwise it is a pointer to the glyph name.
* *
* You must not modify the returned string! * You must not modify the returned string!
@ -498,8 +498,8 @@ 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 same * `iterator->p` to `NULL`. For all following calls, simply use the
* object again. * same object again.
* *
* @output: * @output:
* aglyph_index :: * aglyph_index ::
@ -579,7 +579,7 @@ FT_BEGIN_HEADER
* *
* @inout: * @inout:
* name :: * name ::
* The address of an allocated string pointer. NULL if no name is * The address of an allocated string pointer. `NULL` if no name is
* present. * present.
* *
* @return: * @return:

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

@ -1485,12 +1485,12 @@ FT_BEGIN_HEADER
* indices used in the font's sbit table. * indices used in the font's sbit table.
* *
* cpal :: * cpal ::
* A pointer to data related to the 'CPAL' table. NULL if the table is * A pointer to data related to the 'CPAL' table. `NULL` if the table
* not available. * is not available.
* *
* colr :: * colr ::
* A pointer to data related to the 'COLR' table. NULL if the table is * A pointer to data related to the 'COLR' table. `NULL` if the table
* not available. * is not available.
* *
* kern_table :: * kern_table ::
* A pointer to the 'kern' table. * A pointer to the 'kern' table.

4
include/freetype/t1tables.h
View File

@ -499,7 +499,7 @@ FT_BEGIN_HEADER
* @note: * @note:
* String pointers within the @PS_FontInfoRec structure are owned by the * String pointers within the @PS_FontInfoRec structure are owned by the
* face and don't need to be freed by the caller. Missing entries in * face and don't need to be freed by the caller. Missing entries in
* the font's FontInfo dictionary are represented by NULL pointers. * 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.
@ -733,7 +733,7 @@ FT_BEGIN_HEADER
* `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

14
include/freetype/tttables.h
View File

@ -659,9 +659,9 @@ FT_BEGIN_HEADER
* The index of the SFNT table. * The index of the SFNT table.
* *
* @return: * @return:
* A type-less pointer to the table. This will be NULL in case of error, * A type-less pointer to the table. This will be `NULL` in case of
* or if the corresponding table was not found **OR** loaded from the * error, or if the corresponding table was not found **OR** loaded from
* file. * the file.
* *
* Use a typecast according to `tag` to access the structure elements. * Use a typecast according to `tag` to access the structure elements.
* *
@ -716,7 +716,7 @@ 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
@ -778,9 +778,9 @@ 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`,
* is ignored, and `length` returns the number of SFNT tables in the * `table_index` is ignored, and `length` returns the number of SFNT
* font. * tables in the font.
* *
* @output: * @output:
* length :: * length ::