diff options
author | Werner Lemberg <wl@gnu.org> | 2018-06-03 22:00:42 +0200 |
---|---|---|
committer | Werner Lemberg <wl@gnu.org> | 2018-06-03 22:00:42 +0200 |
commit | f999375a9a834666f82928f9ad6293d9b25213a5 (patch) | |
tree | 2416528a574600ee96ea0ce9709143f5fc9d1d64 /include/freetype/fterrors.h | |
parent | dc170dea33545dbbbf18bb59b316117e73275889 (diff) | |
download | freetype2-f999375a9a834666f82928f9ad6293d9b25213a5.tar.gz |
[GSoC] include/*.*, devel/*.*: Convert block comments to `light' style.
This second and final monster commit was created by applying Nikhil's
scripts `docconverter.py' and `markify.py' to all C header and source files,
followed up by minor manual clean-up.
No change in functionality, of course.
I used commit f7419907bc6044b9b7057f9789866426c804ba82 from
https://github.com/nikramakrishnan/freetype-docs.git.
Diffstat (limited to 'include/freetype/fterrors.h')
-rw-r--r-- | include/freetype/fterrors.h | 196 |
1 files changed, 98 insertions, 98 deletions
diff --git a/include/freetype/fterrors.h b/include/freetype/fterrors.h index f6ee5c24e..e9bcf4d31 100644 --- a/include/freetype/fterrors.h +++ b/include/freetype/fterrors.h @@ -1,101 +1,101 @@ -/***************************************************************************/ -/* */ -/* fterrors.h */ -/* */ -/* FreeType error code handling (specification). */ -/* */ -/* Copyright 1996-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. */ -/* */ -/***************************************************************************/ - - - /*************************************************************************/ - /* */ - /* <Section> */ - /* error_enumerations */ - /* */ - /* <Title> */ - /* Error Enumerations */ - /* */ - /* <Abstract> */ - /* How to handle errors and error strings. */ - /* */ - /* <Description> */ - /* The header file `fterrors.h' (which is automatically included by */ - /* `freetype.h' defines the handling of FreeType's enumeration */ - /* constants. It can also be used to generate error message strings */ - /* with a small macro trick explained below. */ - /* */ - /* *Error* *Formats* */ - /* */ - /* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be */ - /* defined in `ftoption.h' in order to make the higher byte indicate */ - /* the module where the error has happened (this is not compatible */ - /* with standard builds of FreeType~2, however). See the file */ - /* `ftmoderr.h' for more details. */ - /* */ - /* *Error* *Message* *Strings* */ - /* */ - /* Error definitions are set up with special macros that allow client */ - /* applications to build a table of error message strings. The */ - /* strings are not included in a normal build of FreeType~2 to save */ - /* space (most client applications do not use them). */ - /* */ - /* To do so, you have to define the following macros before including */ - /* this file. */ - /* */ - /* { */ - /* FT_ERROR_START_LIST */ - /* } */ - /* */ - /* This macro is called before anything else to define the start of */ - /* the error list. It is followed by several FT_ERROR_DEF calls. */ - /* */ - /* { */ - /* FT_ERROR_DEF( e, v, s ) */ - /* } */ - /* */ - /* This macro is called to define one single error. `e' is the error */ - /* code identifier (e.g., `Invalid_Argument'), `v' is the error's */ - /* numerical value, and `s' is the corresponding error string. */ - /* */ - /* { */ - /* FT_ERROR_END_LIST */ - /* } */ - /* */ - /* This macro ends the list. */ - /* */ - /* Additionally, you have to undefine `FTERRORS_H_' before #including */ - /* this file. */ - /* */ - /* Here is a simple example. */ - /* */ - /* { */ - /* #undef FTERRORS_H_ */ - /* #define FT_ERRORDEF( e, v, s ) { e, s }, */ - /* #define FT_ERROR_START_LIST { */ - /* #define FT_ERROR_END_LIST { 0, NULL } }; */ - /* */ - /* const struct */ - /* { */ - /* int err_code; */ - /* const char* err_msg; */ - /* } ft_errors[] = */ - /* */ - /* #include FT_ERRORS_H */ - /* } */ - /* */ - /* Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with */ - /* `FT_NOERRORDEF'; it is always zero. */ - /* */ - /*************************************************************************/ +/**************************************************************************** + * + * fterrors.h + * + * FreeType error code handling (specification). + * + * Copyright 1996-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. + * + */ + + + /************************************************************************** + * + * @Section: + * error_enumerations + * + * @Title: + * Error Enumerations + * + * @Abstract: + * How to handle errors and error strings. + * + * @Description: + * The header file `fterrors.h' (which is automatically included by + * `freetype.h' defines the handling of FreeType's enumeration + * constants. It can also be used to generate error message strings + * with a small macro trick explained below. + * + * *Error* *Formats* + * + * The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be + * defined in `ftoption.h' in order to make the higher byte indicate + * the module where the error has happened (this is not compatible + * with standard builds of FreeType~2, however). See the file + * `ftmoderr.h' for more details. + * + * *Error* *Message* *Strings* + * + * Error definitions are set up with special macros that allow client + * applications to build a table of error message strings. The + * strings are not included in a normal build of FreeType~2 to save + * space (most client applications do not use them). + * + * To do so, you have to define the following macros before including + * this file. + * + * { + * FT_ERROR_START_LIST + * } + * + * This macro is called before anything else to define the start of + * the error list. It is followed by several FT_ERROR_DEF calls. + * + * { + * FT_ERROR_DEF( e, v, s ) + * } + * + * This macro is called to define one single error. `e' is the error + * code identifier (e.g., `Invalid_Argument'), `v' is the error's + * numerical value, and `s' is the corresponding error string. + * + * { + * FT_ERROR_END_LIST + * } + * + * This macro ends the list. + * + * Additionally, you have to undefine `FTERRORS_H_' before #including + * this file. + * + * Here is a simple example. + * + * { + * #undef FTERRORS_H_ + * #define FT_ERRORDEF( e, v, s ) { e, s }, + * #define FT_ERROR_START_LIST { + * #define FT_ERROR_END_LIST { 0, NULL } }; + * + * const struct + * { + * int err_code; + * const char* err_msg; + * } ft_errors[] = + * + * #include FT_ERRORS_H + * } + * + * Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with + * `FT_NOERRORDEF'; it is always zero. + * + */ /* */ |