aboutsummaryrefslogtreecommitdiffstats
path: root/libavcodec
diff options
context:
space:
mode:
authorRonald S. Bultje <rsbultje@gmail.com>2009-06-29 19:17:03 +0000
committerRonald S. Bultje <rsbultje@gmail.com>2009-06-29 19:17:03 +0000
commit684aa302510691c358bd6fca55efa738a730b4ea (patch)
tree75e86acc5f3a07305e863a29b944d10fdce5bcce /libavcodec
parent4811f89bc662c81d125c30c643f451abd70e239d (diff)
downloadffmpeg-684aa302510691c358bd6fca55efa738a730b4ea.tar.gz
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. Originally committed as revision 19296 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec')
-rw-r--r--libavcodec/avcodec.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index de777b8719..70b6c62917 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -3717,7 +3717,9 @@ int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
#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 @@ int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
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