rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation fixes for the last few commits.

This commit is contained in:
Werner Lemberg 2017-12-08 20:32:23 +01:00
parent ea68f1c8d3
commit 81dea49321
5 changed files with 18 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/freetype/config/ftoption.h
View File

@ -80,14 +80,12 @@ FT_BEGIN_HEADER
/* If you enable this configuration option, FreeType recognizes an */ /* If you enable this configuration option, FreeType recognizes an */
/* environment variable called `FREETYPE_PROPERTIES', which can be used */ /* environment variable called `FREETYPE_PROPERTIES', which can be used */
/* to control the various font drivers and modules. The controllable */ /* to control the various font drivers and modules. The controllable */
/* properties are listed in the section `Controlling FreeType Modules' */ /* properties are listed in the section @properties. */
/* in the reference's table of contents; currently there are properties */
/* for the auto-hinter (file `ftautoh.h'), CFF (file `ftcffdrv.h'), */
/* TrueType (file `ftttdrv.h'), and PCF (file `ftpcfdrv.h'). */
/* */ /* */
/* `FREETYPE_PROPERTIES' has the following syntax form (broken here into */ /* `FREETYPE_PROPERTIES' has the following syntax form (broken here into */
/* multiple lines for better readability). */ /* multiple lines for better readability). */
/* */ /* */
/* { */
/* <optional whitespace> */ /* <optional whitespace> */
/* <module-name1> ':' */ /* <module-name1> ':' */
/* <property-name1> '=' <property-value1> */ /* <property-name1> '=' <property-value1> */
@ -95,6 +93,7 @@ FT_BEGIN_HEADER
/* <module-name2> ':' */ /* <module-name2> ':' */
/* <property-name2> '=' <property-value2> */ /* <property-name2> '=' <property-value2> */
/* ... */ /* ... */
/* } */
/* */ /* */
/* Example: */ /* Example: */
/* */ /* */
@ -794,8 +793,8 @@ FT_BEGIN_HEADER
/* possible to set up the default values of the four control points that */ /* possible to set up the default values of the four control points that */
/* define the stem darkening behaviour of the (new) CFF engine. For */ /* define the stem darkening behaviour of the (new) CFF engine. For */
/* more details please read the documentation of the */ /* more details please read the documentation of the */
/* `darkening-parameters' property of the cff driver module (file */ /* `darkening-parameters' property (file `ftdriver.h'), which allows the */
/* `ftcffdrv.h'), which allows the control at run-time. */ /* control at run-time. */
/* */ /* */
/* Do *not* undefine these macros! */ /* Do *not* undefine these macros! */
/* */ /* */
@ -883,7 +882,7 @@ FT_BEGIN_HEADER
/* */ /* */
/* This experimental option is active only if the rendering mode is */ /* This experimental option is active only if the rendering mode is */
/* FT_RENDER_MODE_LIGHT; you can switch warping on and off with the */ /* FT_RENDER_MODE_LIGHT; you can switch warping on and off with the */
/* `warping' property of the auto-hinter (see file `ftautoh.h' for more */ /* `warping' property of the auto-hinter (see file `ftdriver.h' for more */
/* information; by default it is switched off). */ /* information; by default it is switched off). */
/* */ /* */
#define AF_CONFIG_OPTION_USE_WARPER #define AF_CONFIG_OPTION_USE_WARPER

15
include/freetype/ftcache.h
View File

@ -540,13 +540,6 @@ FT_BEGIN_HEADER
FTC_FaceID face_id ); FTC_FaceID face_id );
/*************************************************************************/
/* */
/* <Section> */
/* cache_subsystem */
/* */
/*************************************************************************/
/************************************************************************* /*************************************************************************
* *
* @type: * @type:
@ -623,14 +616,6 @@ FT_BEGIN_HEADER
FT_UInt32 char_code ); FT_UInt32 char_code );
/*************************************************************************/
/* */
/* <Section> */
/* cache_subsystem */
/* */
/*************************************************************************/
/*************************************************************************/ /*************************************************************************/
/*************************************************************************/ /*************************************************************************/
/*************************************************************************/ /*************************************************************************/

4
include/freetype/ftchapters.h
View File

@ -60,7 +60,6 @@
/* pfr_fonts */ /* pfr_fonts */
/* winfnt_fonts */ /* winfnt_fonts */
/* font_formats */ /* font_formats */
/* parameter_tags */
/* gasp_table */ /* gasp_table */
/* */ /* */
/***************************************************************************/ /***************************************************************************/
@ -77,8 +76,11 @@
/* <Sections> */ /* <Sections> */
/* auto_hinter */ /* auto_hinter */
/* cff_driver */ /* cff_driver */
/* t1_cid_driver */
/* tt_driver */ /* tt_driver */
/* pcf_driver */ /* pcf_driver */
/* properties */
/* parameter_tags */
/* */ /* */
/***************************************************************************/ /***************************************************************************/

2
include/freetype/ftdriver.h
View File

@ -175,7 +175,7 @@ FT_BEGIN_HEADER
* t1_cid_driver * t1_cid_driver
* *
* @title: * @title:
* The Type~1 and CID drivers * The Type 1 and CID drivers
* *
* @abstract: * @abstract:
* Controlling the Type~1 and CID driver modules. * Controlling the Type~1 and CID driver modules.

18
include/freetype/ftmodapi.h
View File

@ -323,16 +323,15 @@ FT_BEGIN_HEADER
* The module name. * The module name.
* *
* property_name :: * property_name ::
* The property name. Properties are described in the `Synopsis' * The property name. Properties are described in section
* subsection of the module's documentation. * @properties.
* *
* Note that only a few modules have properties. * Note that only a few modules have properties.
* *
* value :: * value ::
* A generic pointer to a variable or structure that gives the new * A generic pointer to a variable or structure that gives the new
* value of the property. The exact definition of `value' is * value of the property. The exact definition of `value' is
* dependent on the property; see the `Synopsis' subsection of the * dependent on the property; see section @properties.
* module's documentation.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -390,15 +389,14 @@ FT_BEGIN_HEADER
* The module name. * The module name.
* *
* property_name :: * property_name ::
* The property name. Properties are described in the `Synopsis' * The property name. Properties are described in section
* subsection of the module's documentation. * @properties.
* *
* @inout: * @inout:
* value :: * value ::
* A generic pointer to a variable or structure that gives the * A generic pointer to a variable or structure that gives the
* value of the property. The exact definition of `value' is * value of the property. The exact definition of `value' is
* dependent on the property; see the `Synopsis' subsection of the * dependent on the property; see section @properties.
* module's documentation.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -446,8 +444,8 @@ FT_BEGIN_HEADER
/* <Description> */ /* <Description> */
/* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is */ /* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is */
/* set, this function reads the `FREETYPE_PROPERTIES' environment */ /* set, this function reads the `FREETYPE_PROPERTIES' environment */
/* variable to control driver properties. See sections @auto_hinter, */ /* variable to control driver properties. See section @properties */
/* @cff_driver, @pcf_driver, and @tt_driver for more. */ /* for more. */
/* */ /* */
/* If the compilation option is not set, this function does nothing. */ /* If the compilation option is not set, this function does nothing. */
/* */ /* */