From 2047e40e6e3e1e887085b92f4f3d8cadc048f030 Mon Sep 17 00:00:00 2001
From: Diego Biurrun <diego@biurrun.de>
Date: Tue, 3 Jul 2012 22:42:42 +0200
Subject: Clarify Doxygen comment for FF_API_* #defines.

---
 libavcodec/version.h    | 6 ++++--
 libavdevice/version.h   | 6 ++++++
 libavfilter/version.h   | 6 ++++--
 libavformat/version.h   | 6 ++++--
 libavresample/version.h | 5 +++--
 libavutil/version.h     | 9 ++++-----
 libswscale/version.h    | 6 ++++--
 7 files changed, 29 insertions(+), 15 deletions(-)

diff --git a/libavcodec/version.h b/libavcodec/version.h
index 1e189f6390..cb2373848e 100644
--- a/libavcodec/version.h
+++ b/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.
- * 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_REQUEST_CHANNELS
 #define FF_API_REQUEST_CHANNELS (LIBAVCODEC_VERSION_MAJOR < 55)
 #endif
diff --git a/libavdevice/version.h b/libavdevice/version.h
index 6ed3817cf5..52b47db546 100644
--- a/libavdevice/version.h
+++ b/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 */
diff --git a/libavfilter/version.h b/libavfilter/version.h
index 88bdd4a821..c1292bb70d 100644
--- a/libavfilter/version.h
+++ b/libavfilter/version.h
@@ -41,9 +41,11 @@
 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
 
 /**
- * These FF_API_* defines are not part of the 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_AVFILTERPAD_PUBLIC
 #define FF_API_AVFILTERPAD_PUBLIC           (LIBAVFILTER_VERSION_MAJOR < 4)
 #endif
diff --git a/libavformat/version.h b/libavformat/version.h
index 26bb2c596e..0017698cce 100644
--- a/libavformat/version.h
+++ b/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.
- * 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_CLOSE_INPUT_FILE
 #define FF_API_CLOSE_INPUT_FILE        (LIBAVFORMAT_VERSION_MAJOR < 55)
 #endif
diff --git a/libavresample/version.h b/libavresample/version.h
index 63f07f5e84..c4741e420e 100644
--- a/libavresample/version.h
+++ b/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.
- * 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.
  */
 
 #endif /* AVRESAMPLE_VERSION_H */
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
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