aboutsummaryrefslogtreecommitdiffstats
path: root/libavutil/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 /libavutil/version.h
parent112971af2667b11e8bd3d3d7e6629a0fa8b8151c (diff)
downloadffmpeg-2047e40e6e3e1e887085b92f4f3d8cadc048f030.tar.gz
Clarify Doxygen comment for FF_API_* #defines.
Diffstat (limited to 'libavutil/version.h')
-rw-r--r--libavutil/version.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/libavutil/version.h b/libavutil/version.h
index 426146562e..c42c6b0bc4 100644
--- a/libavutil/version.h
+++ b/libavutil/version.h
@@ -54,14 +54,13 @@
* @}
*
* @defgroup depr_guards Deprecation guards
- * These FF_API_* defines are not part of the public API.
- * They may change, break or disappear at any time.
- *
- * They are used mostly internally to mark code that will be removed
- * on the next major version.
+ * 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_GET_BITS_PER_SAMPLE_FMT
#define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
#endif