From 2047e40e6e3e1e887085b92f4f3d8cadc048f030 Mon Sep 17 00:00:00 2001 From: Diego Biurrun Date: Tue, 3 Jul 2012 22:42:42 +0200 Subject: Clarify Doxygen comment for FF_API_* #defines. --- libswscale/version.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'libswscale/version.h') diff --git a/libswscale/version.h b/libswscale/version.h index f1d95bc691..32bb2f5887 100644 --- a/libswscale/version.h +++ b/libswscale/version.h @@ -41,9 +41,11 @@ #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION) /** - * Those FF_API_* defines are not part of public API. - * They may change, break or disappear at any time. + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. */ + #ifndef FF_API_SWS_GETCONTEXT #define FF_API_SWS_GETCONTEXT (LIBSWSCALE_VERSION_MAJOR < 3) #endif -- cgit v1.2.3