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

Minor documentation fixes and improvements.

This commit is contained in:
Werner Lemberg 2021-09-23 08:46:01 +02:00
parent 3b573e4527
commit 6d19b29fbc
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/freetype/freetype.h
View File

@ -2099,7 +2099,8 @@ FT_BEGIN_HEADER
* The size in bytes of the file in memory.
*
* pathname ::
* A pointer to an 8-bit file pathname. The pointer is not owned by
* A pointer to an 8-bit file pathname, which must be a C~string (i.e.,
* no NULL bytes except at the very end). The pointer is not owned by
* FreeType.
*
* stream ::
@ -2186,9 +2187,12 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
* The `pathname` string should be reconizable as such by a standard
* `fopen()` call on your system. If that is not sufficient to address
* all file name possiblities, you can use @FT_Open_Face.
* The `pathname` string should be recognizable as such by a standard
* `fopen` call on your system; in particular, this means that `pathname`
* must not contain NULL bytes. If that is not sufficient to address all
* file name possibilities (for example, to handle wide character file
* names on Windows in UTF-16 encoding) you might use @FT_Open_Face to
* pass a memory array or a stream object instead.
*
* Use @FT_Done_Face to destroy the created @FT_Face object (along with
* its slot and sizes).