diff options
author | Werner Lemberg <wl@gnu.org> | 2003-04-22 07:49:24 +0000 |
---|---|---|
committer | Werner Lemberg <wl@gnu.org> | 2003-04-22 07:49:24 +0000 |
commit | 3ae7cc997a270e9cbdf193e27d47168cd8da6276 (patch) | |
tree | b1bab1026259e6d6f302fc69f78cdbda2f31f149 /include/freetype/ftbdf.h | |
parent | 90e979e7beda71325b155cbebf23f44b4bf243cc (diff) | |
download | freetype2-3ae7cc997a270e9cbdf193e27d47168cd8da6276.tar.gz |
Cleanups.
Diffstat (limited to 'include/freetype/ftbdf.h')
-rw-r--r-- | include/freetype/ftbdf.h | 71 |
1 files changed, 39 insertions, 32 deletions
diff --git a/include/freetype/ftbdf.h b/include/freetype/ftbdf.h index 71735e3c6..b3bfcb50e 100644 --- a/include/freetype/ftbdf.h +++ b/include/freetype/ftbdf.h @@ -4,7 +4,7 @@ /* */ /* FreeType API for accessing BDF-specific strings (specification). */ /* */ -/* Copyright 2002 by */ +/* Copyright 2002, 2003 by */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* */ /* This file is part of the FreeType project, and may only be used, */ @@ -49,20 +49,20 @@ FT_BEGIN_HEADER * FT_PropertyType * * @description: - * list of BDF property types + * A list of BDF property types. * * @values: * BDF_PROPERTY_TYPE_NONE :: - * value 0 is used to indicate a missing property + * Value 0 is used to indicate a missing property. * * BDF_PROPERTY_TYPE_ATOM :: - * property is a string atom + * Property is a string atom. * * BDF_PROPERTY_TYPE_INTEGER :: - * property is a 32-bit signed integer + * Property is a 32-bit signed integer. * * BDF_PROPERTY_TYPE_CARDINAL :: - * property is a 32-bit unsigned integer + * Property is a 32-bit unsigned integer. */ typedef enum { @@ -76,34 +76,39 @@ FT_BEGIN_HEADER /********************************************************************** * - * @type: BDF_Property + * @type: + * BDF_Property * * @description: - * handle to a @BDF_PropertyRec structure used to model a given - * BDF/PCF property + * A handle to a @BDF_PropertyRec structure to model a given + * BDF/PCF property. */ - typedef struct BDF_PropertyRec_* BDF_Property; + typedef struct BDF_PropertyRec_* BDF_Property; + /********************************************************************** * - * @struct: BDF_PropertyRec + * @struct: + * BDF_PropertyRec * * @description: - * models a given BDF/PCF property + * This structure models a given BDF/PCF property. * - * @note: - * type :: property type - * u.atom :: atom string, when type is @BDF_PROPERTY_TYPE_ATOM - * u.integer :: signed integer, when type is @BDF_PROPERTY_TYPE_INTEGER - * u.cardinal :: unsigned integer, when type is @BDF_PROPERTY_TYPE_CARDINAL + * @fields: + * type :: The property type. + * + * u.atom :: The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. + * u.integer :: A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. + * u.cardinal :: An unsigned integer, if type is + * @BDF_PROPERTY_TYPE_CARDINAL. */ - typedef struct BDF_PropertyRec_ + typedef struct BDF_PropertyRec_ { - BDF_PropertyType type; + BDF_PropertyType type; union { - const char* atom; - FT_Int32 integer; - FT_UInt32 cardinal; + const char* atom; + FT_Int32 integer; + FT_UInt32 cardinal; } u; @@ -121,7 +126,7 @@ FT_BEGIN_HEADER * * @input: * face :: - * handle to input face + * A handle to the input face. * * @output: * acharset_encoding :: @@ -131,7 +136,7 @@ FT_BEGIN_HEADER * Charset registry, as a C string, owned by the face. * * @return: - * FreeType rror code. 0 means success. + * FreeType error code. 0 means success. * * @note: * This function only works with BDF faces, returning an error otherwise. @@ -141,31 +146,33 @@ FT_BEGIN_HEADER const char* *acharset_encoding, const char* *acharset_registry ); + /********************************************************************** * * @function: * FT_Get_BDF_Property * * @description: - * Retrieves a BDF property from a BDF or PCF font file + * Retrieves a BDF property from a BDF or PCF font file. * * @input: - * face :: handle to input face - * name :: property name + * face :: A handle to the input face. + * + * name :: The property name. * * @output: - * aproperty :: the property + * aproperty :: The property. * * @return: * FreeType error code. 0 means success. * * @note: - * This function works with BDF _and_ PCF fonts. It returns an error - * otherwise. it also returns an error when the property is not in the + * This function works with BDF _and_ PCF fonts. It returns an error + * otherwise. It also returns an error if the property is not in the * font. * - * in case of error, "aproperty->type" is always set to - * @BDF_PROPERTY_TYPE_NONE + * In case of error, "aproperty->type" is always set to + * @BDF_PROPERTY_TYPE_NONE. */ FT_EXPORT( FT_Error ) FT_Get_BDF_Property( FT_Face face, |