From eeec2b8fc63718fbe401b62f7ce523548159f698 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Thu, 25 Jun 2009 16:47:10 +0200 Subject: [PATCH] Documentation improvements. --- include/freetype/freetype.h | 5 +++++ include/freetype/ftmodapi.h | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h index dd316dd31..2e6f6b087 100644 --- a/include/freetype/freetype.h +++ b/include/freetype/freetype.h @@ -1652,6 +1652,11 @@ FT_BEGIN_HEADER /* */ /* FreeType error code. 0~means success. */ /* */ + /* */ + /* In case you want to provide your own memory allocating routines, */ + /* use @FT_New_Library instead, followed by a call to */ + /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */ + /* */ FT_EXPORT( FT_Error ) FT_Init_FreeType( FT_Library *alibrary ); diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h index b051d34a8..3c9b876df 100644 --- a/include/freetype/ftmodapi.h +++ b/include/freetype/ftmodapi.h @@ -4,7 +4,7 @@ /* */ /* FreeType modules public interface (specification). */ /* */ -/* Copyright 1996-2001, 2002, 2003, 2006, 2008 by */ +/* Copyright 1996-2001, 2002, 2003, 2006, 2008, 2009 by */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* */ /* This file is part of the FreeType project, and may only be used, */ @@ -259,6 +259,10 @@ FT_BEGIN_HEADER /* from a given memory object. It is thus possible to use libraries */ /* with distinct memory allocators within the same program. */ /* */ + /* Normally, you would call this function (followed by a call to */ + /* @FT_Add_Default_Modules or a series of calls to @FT_Add_Module) */ + /* instead of @FT_Init_FreeType to initialize the FreeType library. */ + /* */ /* */ /* memory :: A handle to the original memory object. */ /* */