ref: 5a53e51b5cabd17d6220f389c0266f52d2e5b362
parent: c67ecb8c3a0441d2abb1da1e1e332bd929a7af65
author: Werner Lemberg <[email protected]>
date: Sat Feb 12 02:58:43 EST 2022
t1tables.h: Documentation improvements.
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -490,7 +490,7 @@
*
* @output:
* afont_info ::
- * Output font info structure pointer.
+ * A pointer to a @PS_FontInfoRec object.
*
* @return:
* FreeType error code. 0~means success.
@@ -497,12 +497,22 @@
*
* @note:
* 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
- * the font's FontInfo dictionary are represented by `NULL` pointers.
+ * face and don't need to be freed by the caller. Missing entries in the
+ * font's FontInfo dictionary are represented by `NULL` pointers.
*
- * If the font's format is not PostScript-based, this function will
- * return the `FT_Err_Invalid_Argument` error code.
+ * The following font formats support this feature: 'Type~1', 'Type~42',
+ * 'CFF', 'CID~Type~1'. For other font formats this function returns the
+ * `FT_Err_Invalid_Argument` error code.
*
+ * @example:
+ * ```
+ * PS_FontInfoRec font_info;
+ *
+ *
+ * error = FT_Get_PS_Font_Info( face, &font_info );
+ * ...
+ * ```
+ *
*/
FT_EXPORT( FT_Error )
FT_Get_PS_Font_Info( FT_Face face,
@@ -524,7 +534,7 @@
*
* @output:
* afont_private ::
- * Output private dictionary structure pointer.
+ * A pointer to a @PS_PrivateRec object.
*
* @return:
* FreeType error code. 0~means success.
@@ -533,8 +543,18 @@
* The string pointers within the @PS_PrivateRec structure are owned by
* the face and don't need to be freed by the caller.
*
- * If the font's format is not PostScript-based, this function returns
- * the `FT_Err_Invalid_Argument` error code.
+ * Only the 'Type~1' font format supports this feature. For other font
+ * formats this function returns the `FT_Err_Invalid_Argument` error
+ * code.
+ *
+ * @example:
+ * ```
+ * PS_PrivateRec font_private;
+ *
+ *
+ * error = FT_Get_PS_Font_Private( face, &font_private );
+ * ...
+ * ```
*
*/
FT_EXPORT( FT_Error )