Clarify Doxygen comment for FF_API_* #defines.

2012-07-03 22:42:42 +02:00
parent 112971af26
commit 2047e40e6e
7 changed files with 29 additions and 15 deletions
--- 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 */