[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'.
This commit is contained in:
parent
9193259cf2
commit
e9d95aa06b
11
ChangeLog
11
ChangeLog
|
@ -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>
|
2013-12-10 Werner Lemberg <wl@gnu.org>
|
||||||
|
|
||||||
[autofit] s/DFLT/NONE/, s/dflt/none/.
|
[autofit] s/DFLT/NONE/, s/dflt/none/.
|
||||||
|
|
|
@ -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> */
|
/* <Section> */
|
||||||
|
|
|
@ -15,6 +15,7 @@
|
||||||
/* General Remarks */
|
/* General Remarks */
|
||||||
/* */
|
/* */
|
||||||
/* <Sections> */
|
/* <Sections> */
|
||||||
|
/* header_inclusion */
|
||||||
/* user_allocation */
|
/* user_allocation */
|
||||||
/* */
|
/* */
|
||||||
/***************************************************************************/
|
/***************************************************************************/
|
||||||
|
|
Loading…
Reference in New Issue