Clarify Doxygen comment for FF_API_* #defines.

libavcodec/version.h

@@ -41,9 +41,11 @@
 #define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
 
 /**
- * These FF_API_* defines are not part of the public API.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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_REQUEST_CHANNELS
 #define FF_API_REQUEST_CHANNELS (LIBAVCODEC_VERSION_MAJOR < 55)
 #endif

libavdevice/version.h

@@ -39,4 +39,10 @@
                                            LIBAVDEVICE_VERSION_MICRO)
 #define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
 
+/**
+ * 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.
+ */
+
 #endif /* AVDEVICE_VERSION_H */

libavfilter/version.h

@@ -41,9 +41,11 @@
 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
 
 /**
- * These FF_API_* defines are not part of the public API.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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_AVFILTERPAD_PUBLIC
 #define FF_API_AVFILTERPAD_PUBLIC           (LIBAVFILTER_VERSION_MAJOR < 4)
 #endif

libavformat/version.h

@@ -44,9 +44,11 @@
 #define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
 
 /**
- * These FF_API_* defines are not part of the public API.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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_CLOSE_INPUT_FILE
 #define FF_API_CLOSE_INPUT_FILE        (LIBAVFORMAT_VERSION_MAJOR < 55)
 #endif

libavresample/version.h

@@ -34,8 +34,9 @@
 #define LIBAVRESAMPLE_IDENT        "Lavr" AV_STRINGIFY(LIBAVRESAMPLE_VERSION)
 
 /**
- * These FF_API_* defines are not part of public API.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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.
  */
 
 #endif /* AVRESAMPLE_VERSION_H */

libavutil/version.h

@@ -54,14 +54,13 @@
  * @}
  *
  * @defgroup depr_guards Deprecation guards
- * These FF_API_* defines are not part of the public API.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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.
- * They are used mostly internally to mark code that will be removed
- * on the next major version.
  *
  * @{
  */
+
 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
 #endif

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.
+ * FF_API_* defines may be placed below to indicate public API that will be
- * They may change, break or disappear at any time.
+ * 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