AuroraMiddleware/freetype
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[documentation] Add section how to include FreeType header files.

Browse Source 
Problem reported by David Kastrup <dak@gnu.org>.

Surprisingly, a description how to do that was completely missing in
the API reference.

* include/freetype.h, include/ftchapters.h: New documentation
section `header_inclusion'.
This commit is contained in:
Werner Lemberg 2013-12-11 07:48:51 +01:00
parent 9193259cf2
commit e9d95aa06b
3 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ChangeLog
View File

@ -1,3 +1,14 @@
2013-12-11 Werner Lemberg <wl@gnu.org>
[documentation] Add section how to include FreeType header files.
Problem reported by David Kastrup <dak@gnu.org>.
Surprisingly, a description how to do that was completely missing in
the API reference.
* include/freetype.h, include/ftchapters.h: New documentation
section `header_inclusion'.
2013-12-10 Werner Lemberg <wl@gnu.org>
[autofit] s/DFLT/NONE/, s/dflt/none/.

32
include/freetype.h
View File

@ -39,6 +39,38 @@ FT_BEGIN_HEADER
/*************************************************************************/
/* */
/* <Section> */
/* header_inclusion */
/* */
/* <Title> */
/* FreeType's header inclusion scheme */
/* */
/* <Abstract> */
/* How client applications should include FreeType header files. */
/* */
/* <Description> */
/* To be as flexible as possible (and for historical reasons), */
/* FreeType uses a very special inclusion scheme to load header */
/* files, for example */
/* */
/* { */
/* #include <ft2build.h> */
/* */
/* #include FT_FREETYPE_H */
/* #include FT_OUTLINE_H */
/* } */
/* */
/* A compiler and its preprocessor only needs an include path to find */
/* the file `ft2build.h'; the exact locations and names of the other */
/* FreeType header files are hidden by preprocessor macro names, */
/* loaded by `ft2build.h'. The API documentation always gives the */
/* header macro name needed for a particular function. */
/* */
/*************************************************************************/
/*************************************************************************/
/* */
/* <Section> */

1
include/ftchapters.h
View File

@ -15,6 +15,7 @@
/* General Remarks */
/* */
/* <Sections> */
/* header_inclusion */
/* user_allocation */
/* */
/***************************************************************************/