summaryrefslogtreecommitdiff
path: root/libswscale/version.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2012-07-03 22:42:42 +0200
committerDiego Biurrun <diego@biurrun.de>2012-07-04 15:10:10 +0200
commit2047e40e6e3e1e887085b92f4f3d8cadc048f030 (patch)
tree9ebad7eb2ddef2345ff11854c6045581cb31d5d2 /libswscale/version.h
parent112971af2667b11e8bd3d3d7e6629a0fa8b8151c (diff)
Clarify Doxygen comment for FF_API_* #defines.
Diffstat (limited to 'libswscale/version.h')
-rw-r--r--libswscale/version.h6
1 files changed, 4 insertions, 2 deletions
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