From 81dea493212077fb8b869940cc1582900917ac32 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Fri, 8 Dec 2017 20:32:23 +0100 Subject: [PATCH] Documentation fixes for the last few commits. --- include/freetype/config/ftoption.h | 13 ++++++------- include/freetype/ftcache.h | 15 --------------- include/freetype/ftchapters.h | 4 +++- include/freetype/ftdriver.h | 2 +- include/freetype/ftmodapi.h | 18 ++++++++---------- 5 files changed, 18 insertions(+), 34 deletions(-) diff --git a/include/freetype/config/ftoption.h b/include/freetype/config/ftoption.h index 6f1d93fd8..06f3d50bb 100644 --- a/include/freetype/config/ftoption.h +++ b/include/freetype/config/ftoption.h @@ -80,14 +80,12 @@ FT_BEGIN_HEADER /* If you enable this configuration option, FreeType recognizes an */ /* environment variable called `FREETYPE_PROPERTIES', which can be used */ /* to control the various font drivers and modules. The controllable */ - /* properties are listed in the section `Controlling FreeType Modules' */ - /* 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'). */ + /* properties are listed in the section @properties. */ /* */ /* `FREETYPE_PROPERTIES' has the following syntax form (broken here into */ /* multiple lines for better readability). */ /* */ + /* { */ /* */ /* ':' */ /* '=' */ @@ -95,6 +93,7 @@ FT_BEGIN_HEADER /* ':' */ /* '=' */ /* ... */ + /* } */ /* */ /* Example: */ /* */ @@ -794,8 +793,8 @@ FT_BEGIN_HEADER /* possible to set up the default values of the four control points that */ /* define the stem darkening behaviour of the (new) CFF engine. For */ /* more details please read the documentation of the */ - /* `darkening-parameters' property of the cff driver module (file */ - /* `ftcffdrv.h'), which allows the control at run-time. */ + /* `darkening-parameters' property (file `ftdriver.h'), which allows the */ + /* control at run-time. */ /* */ /* Do *not* undefine these macros! */ /* */ @@ -883,7 +882,7 @@ FT_BEGIN_HEADER /* */ /* This experimental option is active only if the rendering mode is */ /* 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). */ /* */ #define AF_CONFIG_OPTION_USE_WARPER diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h index 5ff3ccf40..0fd6118b2 100644 --- a/include/freetype/ftcache.h +++ b/include/freetype/ftcache.h @@ -540,13 +540,6 @@ FT_BEGIN_HEADER FTC_FaceID face_id ); - /*************************************************************************/ - /* */ - /*
*/ - /* cache_subsystem */ - /* */ - /*************************************************************************/ - /************************************************************************* * * @type: @@ -623,14 +616,6 @@ FT_BEGIN_HEADER FT_UInt32 char_code ); - /*************************************************************************/ - /* */ - /*
*/ - /* cache_subsystem */ - /* */ - /*************************************************************************/ - - /*************************************************************************/ /*************************************************************************/ /*************************************************************************/ diff --git a/include/freetype/ftchapters.h b/include/freetype/ftchapters.h index 75747cd23..51257bb7c 100644 --- a/include/freetype/ftchapters.h +++ b/include/freetype/ftchapters.h @@ -60,7 +60,6 @@ /* pfr_fonts */ /* winfnt_fonts */ /* font_formats */ -/* parameter_tags */ /* gasp_table */ /* */ /***************************************************************************/ @@ -77,8 +76,11 @@ /* */ /* auto_hinter */ /* cff_driver */ +/* t1_cid_driver */ /* tt_driver */ /* pcf_driver */ +/* properties */ +/* parameter_tags */ /* */ /***************************************************************************/ diff --git a/include/freetype/ftdriver.h b/include/freetype/ftdriver.h index 4d8854d63..063ceec31 100644 --- a/include/freetype/ftdriver.h +++ b/include/freetype/ftdriver.h @@ -175,7 +175,7 @@ FT_BEGIN_HEADER * t1_cid_driver * * @title: - * The Type~1 and CID drivers + * The Type 1 and CID drivers * * @abstract: * Controlling the Type~1 and CID driver modules. diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h index 9c901329a..d62fafbee 100644 --- a/include/freetype/ftmodapi.h +++ b/include/freetype/ftmodapi.h @@ -323,16 +323,15 @@ FT_BEGIN_HEADER * The module name. * * property_name :: - * The property name. Properties are described in the `Synopsis' - * subsection of the module's documentation. + * The property name. Properties are described in section + * @properties. * * Note that only a few modules have properties. * * value :: * A generic pointer to a variable or structure that gives the new * value of the property. The exact definition of `value' is - * dependent on the property; see the `Synopsis' subsection of the - * module's documentation. + * dependent on the property; see section @properties. * * @return: * FreeType error code. 0~means success. @@ -390,15 +389,14 @@ FT_BEGIN_HEADER * The module name. * * property_name :: - * The property name. Properties are described in the `Synopsis' - * subsection of the module's documentation. + * The property name. Properties are described in section + * @properties. * * @inout: * value :: * A generic pointer to a variable or structure that gives the * value of the property. The exact definition of `value' is - * dependent on the property; see the `Synopsis' subsection of the - * module's documentation. + * dependent on the property; see section @properties. * * @return: * FreeType error code. 0~means success. @@ -446,8 +444,8 @@ FT_BEGIN_HEADER /* */ /* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is */ /* set, this function reads the `FREETYPE_PROPERTIES' environment */ - /* variable to control driver properties. See sections @auto_hinter, */ - /* @cff_driver, @pcf_driver, and @tt_driver for more. */ + /* variable to control driver properties. See section @properties */ + /* for more. */ /* */ /* If the compilation option is not set, this function does nothing. */ /* */