Document hb_ot_name_t values

Add a short blurb for each value and refer
to the OpenType spec for more information.

Fixes: #3181
This commit is contained in:
Matthias Clasen 2021-10-28 07:42:07 -04:00 committed by Behdad Esfahbod
parent 85deddb16e
commit 8cb2f969d9
1 changed files with 29 additions and 0 deletions

View File

@ -36,12 +36,41 @@ HB_BEGIN_DECLS
/**
* hb_ot_name_id_t:
* @HB_OT_NAME_ID_COPYRIGHT: Copyright notice
* @HB_OT_NAME_ID_FONT_FAMILY: Font Family name
* @HB_OT_NAME_ID_FONT_SUBFAMILY: Font Subfamily name
* @HB_OT_NAME_ID_UNIQUE_ID: Unique font identifier
* @HB_OT_NAME_ID_FULL_NAME: Full font name that reflects
* all family and relevant subfamily descriptors
* @HB_OT_NAME_ID_VERSION_STRING: Version string
* @HB_OT_NAME_ID_POSTSCRIPT_NAME: PostScript name for the font
* @HB_OT_NAME_ID_TRADEMARK: Trademark
* @HB_OT_NAME_ID_MANUFACTURER: Manufacturer Name
* @HB_OT_NAME_ID_DESIGNER: Designer
* @HB_OT_NAME_ID_DESCRIPTION: Description
* @HB_OT_NAME_ID_VENDOR_URL: URL of font vendor
* @HB_OT_NAME_ID_DESIGNER_URL: URL of typeface designer
* @HB_OT_NAME_ID_LICENSE: License Description
* @HB_OT_NAME_ID_LICENSE_URL: URL where additional licensing
* information can be found
* @HB_OT_NAME_ID_TYPOGRAPHIC_FAMILY: Typographic Family name
* @HB_OT_NAME_ID_TYPOGRAPHIC_SUBFAMILY: Typographic Subfamily name
* @HB_OT_NAME_ID_MAC_FULL_NAME: Compatible Full Name for MacOS
* @HB_OT_NAME_ID_SAMPLE_TEXT: Sample text
* @HB_OT_NAME_ID_CID_FINDFONT_NAME: PostScript CID findfont name
* @HB_OT_NAME_ID_WWS_FAMILY: WWS Family Name
* @HB_OT_NAME_ID_WWS_SUBFAMILY: WWS Subfamily Name
* @HB_OT_NAME_ID_LIGHT_BACKGROUND: Light Background Palette
* @HB_OT_NAME_ID_DARK_BACKGROUND: Dark Background Palette
* @HB_OT_NAME_ID_VARIATIONS_PS_PREFIX: Variations PostScript Name Prefix
* @HB_OT_NAME_ID_INVALID: Value to represent a nonexistent name ID.
*
* An integral type representing an OpenType 'name' table name identifier.
* There are predefined name IDs, as well as name IDs return from other
* API. These can be used to fetch name strings from a font face.
*
* For more information on these fields, see the OpenType spec.
*
* Since: 2.0.0
**/
enum