diff options
Diffstat (limited to 'include/freetype/ftfntfmt.h')
| -rw-r--r-- | include/freetype/ftfntfmt.h | 118 |
1 files changed, 59 insertions, 59 deletions
diff --git a/include/freetype/ftfntfmt.h b/include/freetype/ftfntfmt.h index cc86efac2..c073e3708 100644 --- a/include/freetype/ftfntfmt.h +++ b/include/freetype/ftfntfmt.h @@ -1,19 +1,19 @@ -/***************************************************************************/ -/* */ -/* ftfntfmt.h */ -/* */ -/* Support functions for font formats. */ -/* */ -/* Copyright 2002-2018 by */ -/* David Turner, Robert Wilhelm, and Werner Lemberg. */ -/* */ -/* This file is part of the FreeType project, and may only be used, */ -/* modified, and distributed under the terms of the FreeType project */ -/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ -/* this file you indicate that you have read the license and */ -/* understand and accept it fully. */ -/* */ -/***************************************************************************/ +/**************************************************************************** + * + * ftfntfmt.h + * + * Support functions for font formats. + * + * Copyright 2002-2018 by + * David Turner, Robert Wilhelm, and Werner Lemberg. + * + * This file is part of the FreeType project, and may only be used, + * modified, and distributed under the terms of the FreeType project + * license, LICENSE.TXT. By continuing to use, modify, or distribute + * this file you indicate that you have read the license and + * understand and accept it fully. + * + */ #ifndef FTFNTFMT_H_ @@ -32,49 +32,49 @@ FT_BEGIN_HEADER - /*************************************************************************/ - /* */ - /* <Section> */ - /* font_formats */ - /* */ - /* <Title> */ - /* Font Formats */ - /* */ - /* <Abstract> */ - /* Getting the font format. */ - /* */ - /* <Description> */ - /* The single function in this section can be used to get the font */ - /* format. Note that this information is not needed normally; */ - /* however, there are special cases (like in PDF devices) where it is */ - /* important to differentiate, in spite of FreeType's uniform API. */ - /* */ - /*************************************************************************/ - - - /*************************************************************************/ - /* */ - /* <Function> */ - /* FT_Get_Font_Format */ - /* */ - /* <Description> */ - /* Return a string describing the format of a given face. Possible */ - /* values are `TrueType', `Type~1', `BDF', `PCF', `Type~42', */ - /* `CID~Type~1', `CFF', `PFR', and `Windows~FNT'. */ - /* */ - /* The return value is suitable to be used as an X11 FONT_PROPERTY. */ - /* */ - /* <Input> */ - /* face :: */ - /* Input face handle. */ - /* */ - /* <Return> */ - /* Font format string. NULL in case of error. */ - /* */ - /* <Note> */ - /* A deprecated name for the same function is */ - /* `FT_Get_X11_Font_Format'. */ - /* */ + /************************************************************************** + * + * @Section: + * font_formats + * + * @Title: + * Font Formats + * + * @Abstract: + * Getting the font format. + * + * @Description: + * The single function in this section can be used to get the font + * format. Note that this information is not needed normally; + * however, there are special cases (like in PDF devices) where it is + * important to differentiate, in spite of FreeType's uniform API. + * + */ + + + /************************************************************************** + * + * @Function: + * FT_Get_Font_Format + * + * @Description: + * Return a string describing the format of a given face. Possible + * values are `TrueType', `Type~1', `BDF', `PCF', `Type~42', + * `CID~Type~1', `CFF', `PFR', and `Windows~FNT'. + * + * The return value is suitable to be used as an X11 FONT_PROPERTY. + * + * @Input: + * face :: + * Input face handle. + * + * @Return: + * Font format string. NULL in case of error. + * + * @Note: + * A deprecated name for the same function is + * `FT_Get_X11_Font_Format'. + */ FT_EXPORT( const char* ) FT_Get_Font_Format( FT_Face face ); |