changeset 9893:1d10ec092b64 libavcodec

Add doxy to av_log_missing_feature() etc. stating that the function is primarily intended for internal use in lavc/lavf, not for use in apps.
author rbultje
date Mon, 29 Jun 2009 19:17:03 +0000
parents b5ca6219e173
children 78b2fc137c27
files avcodec.h
diffstat 1 files changed, 6 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/avcodec.h	Mon Jun 29 19:11:53 2009 +0000
+++ b/avcodec.h	Mon Jun 29 19:17:03 2009 +0000
@@ -3717,7 +3717,9 @@
 #define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
 
 /**
- * Logs a generic warning message about a missing feature.
+ * Logs a generic warning message about a missing feature. This function is
+ * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
+ * only, and would normally not be used by applications.
  * @param[in] avc a pointer to an arbitrary struct of which the first field is
  * a pointer to an AVClass struct
  * @param[in] feature string containing the name of the missing feature
@@ -3729,7 +3731,9 @@
 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
 
 /**
- * Logs a generic warning message asking for a sample.
+ * Logs a generic warning message asking for a sample. This function is
+ * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
+ * only, and would normally not be used by applications.
  * @param[in] avc a pointer to an arbitrary struct of which the first field is
  * a pointer to an AVClass struct
  * @param[in] msg string containing an optional message, or NULL if no message