Document ff_rtp_get_payload_type()

Originally committed as revision 17365 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/libavformat/rtp.h b/libavformat/rtp.h
index 1347045..3d8b79a 100644 (file)
--- a/libavformat/rtp.h
+++ b/libavformat/rtp.h
@@ -23,7 +23,14 @@
 
 #include "libavcodec/avcodec.h"
 
-/** return < 0 if unknown payload type */
+/**
+ * Return the payload type for a given codec.
+ *
+ * @param codec The context of the codec
+ * @return In case of unknown payload type or dynamic payload type, a
+ * negative value is returned; otherwise, the payload type (the 'PT' field
+ * in the RTP header) is returned.
+ */
 int ff_rtp_get_payload_type(AVCodecContext *codec);
 
 #define RTP_PT_PRIVATE 96