aboutsummaryrefslogtreecommitdiffstats
path: root/libavformat/rtsp.h
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2011-07-03 16:35:10 +0200
committerDiego Biurrun <diego@biurrun.de>2011-07-03 22:33:22 +0200
commitf75e3da535f297ddbe501ce866e57ccca7645455 (patch)
tree2b6d5e7b7bab506ae830defa308e3dbd6b68ea36 /libavformat/rtsp.h
parentc81a2b9b4f5488c831dc27635152394ab632c46a (diff)
downloadffmpeg-f75e3da535f297ddbe501ce866e57ccca7645455.tar.gz
RTSP: Doxygen comment cleanup
Do not use Doxygen for comments that apply to specific implementation details; merge some duplicated Doxygen comment blocks.
Diffstat (limited to 'libavformat/rtsp.h')
-rw-r--r--libavformat/rtsp.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/libavformat/rtsp.h b/libavformat/rtsp.h
index 5eae6bf4f3..7d2460fe2f 100644
--- a/libavformat/rtsp.h
+++ b/libavformat/rtsp.h
@@ -505,8 +505,9 @@ int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);
int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);
/**
- * Parse a SDP description of streams by populating an RTSPState struct
- * within the AVFormatContext.
+ * Parse an SDP description of streams by populating an RTSPState struct
+ * within the AVFormatContext; also allocate the RTP streams and the
+ * pollfd array used for UDP streams.
*/
int ff_sdp_parse(AVFormatContext *s, const char *content);
@@ -525,6 +526,7 @@ int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);
/**
* Do the SETUP requests for each stream for the chosen
* lower transport mode.
+ * @return 0 on success, <0 on error, 1 if protocol is unavailable
*/
int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
int lower_transport, const char *real_challenge);