From e2d73df77dc36556b0ff3a6b9a96eec4f6fbc20a Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Sun, 9 Jun 2013 08:48:01 +0200 Subject: [PATCH] Documentation improvements. --- docs/CHANGES | 10 ++++++++-- include/freetype/ftmodapi.h | 11 +++++++++-- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/CHANGES b/docs/CHANGES index 4b6d5236a..e94963def 100644 --- a/docs/CHANGES +++ b/docs/CHANGES @@ -1,7 +1,13 @@ CHANGES BETWEEN 2.4.12 and 2.5 - I. IMPORTANT CHANGES + I. IMPORTANT BUG FIXES + + - The cache manager function `FTC_Manager_Reset' didn't flush the + cache. + + + II. IMPORTANT CHANGES - Behdad Esfahbod (on behalf of Google) contributed support for color embedded bitmaps (eg. color emoji). @@ -31,7 +37,7 @@ CHANGES BETWEEN 2.4.12 and 2.5 obsolete. - II. MISCELLANEOUS + III. MISCELLANEOUS - The property API (`FT_Property_Get' and `FT_Property_Set') is now declared as stable. diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h index da61fb7ab..8abffb558 100644 --- a/include/freetype/ftmodapi.h +++ b/include/freetype/ftmodapi.h @@ -4,7 +4,7 @@ /* */ /* FreeType modules public interface (specification). */ /* */ -/* Copyright 1996-2003, 2006, 2008-2010, 2012 by */ +/* Copyright 1996-2003, 2006, 2008-2010, 2012, 2013 by */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* */ /* This file is part of the FreeType project, and may only be used, */ @@ -322,8 +322,15 @@ FT_BEGIN_HEADER * FT_Property_Set( library, "foo", "bar", &bar ); * } * + * Note that the FreeType Cache sub-system doesn't recognize module + * property changes. To avoid glyph lookup confusion within the cache + * you should call @FTC_Manager_Reset to completely flush the cache if + * a module property gets changed after @FTC_Manager_New has been + * called. + * * It is not possible to set properties of the FreeType Cache - * sub-system with FT_Property_Set; use @FTC_Property_Set instead. + * sub-system itself with FT_Property_Set; use @FTC_Property_Set + * instead. * * @since: * 2.4.11