lavu/common: add warning to GET_UTF8 doxy

Should prevent wrong uses, or at least decrease their chance.
This commit is contained in:
Stefano Sabatini 2013-10-03 00:32:26 +02:00
parent 9d8e8495c9
commit 719b4eef5d
1 changed files with 5 additions and 0 deletions

View File

@ -295,6 +295,11 @@ static av_always_inline av_const int av_popcount64_c(uint64_t x)
* input, this could be *ptr++. * input, this could be *ptr++.
* @param ERROR Expression to be evaluated on invalid input, * @param ERROR Expression to be evaluated on invalid input,
* typically a goto statement. * typically a goto statement.
*
* @warning ERROR should not contain a loop control statement which
* could interact with the internal while loop, and should force an
* exit from the macro code (e.g. through a goto or a return) in order
* to prevent undefined results.
*/ */
#define GET_UTF8(val, GET_BYTE, ERROR)\ #define GET_UTF8(val, GET_BYTE, ERROR)\
val= GET_BYTE;\ val= GET_BYTE;\