1. ffmpeg
  2. Commit 2047e40e6e3e1e887085b92f4f3d8cadc048f030
Browse code

Clarify Doxygen comment for FF_API_* #defines.

Diego Biurrun authored on 2012/07/04 05:42:42
Showing 7 changed files
libavcodec/version.h
History View file @ 2047e40
... ... 
@@ -41,9 +41,11 @@
41 41 
 #define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
42 42
43 43 
 /**
44 
- * These FF_API_* defines are not part of the public API.
45 
- * They may change, break or disappear at any time.
44 
+ * FF_API_* defines may be placed below to indicate public API that will be
45 
+ * dropped at a future version bump. The defines themselves are not part of
46 
+ * the public API and may change, break or disappear at any time.
46 47 
  */
48 
+
47 49 
 #ifndef FF_API_REQUEST_CHANNELS
48 50 
 #define FF_API_REQUEST_CHANNELS (LIBAVCODEC_VERSION_MAJOR < 55)
49 51 
 #endif
libavdevice/version.h
History View file @ 2047e40
... ... 
@@ -39,4 +39,10 @@
39 39 
                                            LIBAVDEVICE_VERSION_MICRO)
40 40 
 #define LIBAVDEVICE_BUILD       LIBAVDEVICE_VERSION_INT
41 41
42 
+/**
43 
+ * FF_API_* defines may be placed below to indicate public API that will be
44 
+ * dropped at a future version bump. The defines themselves are not part of
45 
+ * the public API and may change, break or disappear at any time.
46 
+ */
47 
+
42 48 
 #endif /* AVDEVICE_VERSION_H */
libavfilter/version.h
History View file @ 2047e40
... ... 
@@ -41,9 +41,11 @@
41 41 
 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
42 42
43 43 
 /**
44 
- * These FF_API_* defines are not part of the public API.
45 
- * They may change, break or disappear at any time.
44 
+ * FF_API_* defines may be placed below to indicate public API that will be
45 
+ * dropped at a future version bump. The defines themselves are not part of
46 
+ * the public API and may change, break or disappear at any time.
46 47 
  */
48 
+
47 49 
 #ifndef FF_API_AVFILTERPAD_PUBLIC
48 50 
 #define FF_API_AVFILTERPAD_PUBLIC           (LIBAVFILTER_VERSION_MAJOR < 4)
49 51 
 #endif
libavformat/version.h
History View file @ 2047e40
... ... 
@@ -44,9 +44,11 @@
44 44 
 #define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
45 45
46 46 
 /**
47 
- * These FF_API_* defines are not part of the public API.
48 
- * They may change, break or disappear at any time.
47 
+ * FF_API_* defines may be placed below to indicate public API that will be
48 
+ * dropped at a future version bump. The defines themselves are not part of
49 
+ * the public API and may change, break or disappear at any time.
49 50 
  */
51 
+
50 52 
 #ifndef FF_API_CLOSE_INPUT_FILE
51 53 
 #define FF_API_CLOSE_INPUT_FILE        (LIBAVFORMAT_VERSION_MAJOR < 55)
52 54 
 #endif
libavresample/version.h
History View file @ 2047e40
... ... 
@@ -34,8 +34,9 @@
34 34 
 #define LIBAVRESAMPLE_IDENT        "Lavr" AV_STRINGIFY(LIBAVRESAMPLE_VERSION)
35 35
36 36 
 /**
37 
- * These FF_API_* defines are not part of public API.
38 
- * They may change, break or disappear at any time.
37 
+ * FF_API_* defines may be placed below to indicate public API that will be
38 
+ * dropped at a future version bump. The defines themselves are not part of
39 
+ * the public API and may change, break or disappear at any time.
39 40 
  */
40 41
41 42 
 #endif /* AVRESAMPLE_VERSION_H */
libavutil/version.h
History View file @ 2047e40
... ... 
@@ -54,14 +54,13 @@
54 54 
  * @}
55 55 
  *
56 56 
  * @defgroup depr_guards Deprecation guards
57 
- * These FF_API_* defines are not part of the public API.
58 
- * They may change, break or disappear at any time.
59 
- *
60 
- * They are used mostly internally to mark code that will be removed
61 
- * on the next major version.
57 
+ * FF_API_* defines may be placed below to indicate public API that will be
58 
+ * dropped at a future version bump. The defines themselves are not part of
59 
+ * the public API and may change, break or disappear at any time.
62 60 
  *
63 61 
  * @{
64 62 
  */
63 
+
65 64 
 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
66 65 
 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
67 66 
 #endif
libswscale/version.h
History View file @ 2047e40
... ... 
@@ -41,9 +41,11 @@
41 41 
 #define LIBSWSCALE_IDENT        "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
42 42
43 43 
 /**
44 
- * Those FF_API_* defines are not part of public API.
45 
- * They may change, break or disappear at any time.
44 
+ * FF_API_* defines may be placed below to indicate public API that will be
45 
+ * dropped at a future version bump. The defines themselves are not part of
46 
+ * the public API and may change, break or disappear at any time.
46 47 
  */
48 
+
47 49 
 #ifndef FF_API_SWS_GETCONTEXT
48 50 
 #define FF_API_SWS_GETCONTEXT  (LIBSWSCALE_VERSION_MAJOR < 3)
49 51 
 #endif