summaryrefslogtreecommitdiff
path: root/include/freetype/freetype.h
diff options
context:
space:
mode:
authorDavid Turner <david@freetype.org>2020-06-08 13:31:55 +0200
committerWerner Lemberg <wl@gnu.org>2020-06-08 13:31:55 +0200
commite13391333f501967db8823025ce8c63259b5d57e (patch)
tree64cddc61043a9db91168f734bdba8211357168ce /include/freetype/freetype.h
parent9e6e903cc4f6f2de86356d551e74eace75927c31 (diff)
downloadfreetype2-e13391333f501967db8823025ce8c63259b5d57e.tar.gz
Make macros for header file names optional.
We no longer have to take care of the 8.3 file name limit; this allows us (a) to introduce longer, meaningful file names, and (b) to avoid macro names in `#include' lines altogether since some compilers (most notably Visual C++) doesn't support this properly. */*: Replace #include FOO_H with #include <freetype/foo.h> or something similar. Also update the documentation.
Diffstat (limited to 'include/freetype/freetype.h')
-rw-r--r--include/freetype/freetype.h23
1 files changed, 6 insertions, 17 deletions
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 6af7557d9..93cc9ab55 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -22,17 +22,13 @@
#ifndef FT_FREETYPE_H
#error "`ft2build.h' hasn't been included yet!"
-#error "Please always use macros to include FreeType header files."
-#error "Example:"
-#error " #include <ft2build.h>"
-#error " #include FT_FREETYPE_H"
#endif
#include <ft2build.h>
#include FT_CONFIG_CONFIG_H
-#include FT_TYPES_H
-#include FT_ERRORS_H
+#include <freetype/fttypes.h>
+#include <freetype/fterrors.h>
FT_BEGIN_HEADER
@@ -51,22 +47,15 @@ FT_BEGIN_HEADER
* 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
+ * To be as flexible as possible (and for historical reasons), you must
+ * load file `ft2build.h` first before other header files, for example
*
* ```
* #include <ft2build.h>
*
- * #include FT_FREETYPE_H
- * #include FT_OUTLINE_H
+ * #include <freetype/freetype.h>
+ * #include <freetype/ftoutln.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 @header_file_macros, loaded by
- * `ft2build.h`. The API documentation always gives the header macro
- * name needed for a particular function.
- *
*/