On Sun, 3 Jul 2011, Diego Biurrun wrote:
> Do not use Doxygen for comments that apply to specific implementation details;
> merge some duplicated Doxygen comment blocks; delete inappropriate ones.
> ---
> libavformat/rtsp.c | 18 +++++-------------
> libavformat/rtsp.h | 1 +
> 2 files changed, 6 insertions(+), 13 deletions(-)
>
> diff --git a/libavformat/rtsp.c b/libavformat/rtsp.c
> index eeea9be..80cd587 100644
> --- a/libavformat/rtsp.c
> +++ b/libavformat/rtsp.c
> @@ -428,11 +428,6 @@ static void sdp_parse_line(AVFormatContext *s,
> SDPParseState *s1,
> }
> }
>
> -/**
> - * Parse the sdp description and allocate the rtp streams and the
> - * pollfd array used for udp ones.
> - */
> -
Why is this removed? If not appropriate as a doxy comment, I'd rather keep
it as a normal comment.
> int ff_sdp_parse(AVFormatContext *s, const char *content)
> {
> RTSPState *rt = s->priv_data;
> @@ -1050,9 +1045,6 @@ retry:
> return 0;
> }
>
> -/**
> - * @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)
> {
> @@ -1078,7 +1070,7 @@ int ff_rtsp_make_setup_request(AVFormatContext *s,
> const char *host, int port,
> for (j = RTSP_RTP_PORT_MIN, i = 0; i < rt->nb_rtsp_streams; ++i) {
> char transport[2048];
>
> - /**
> + /*
> * WMS serves all UDP data over a single connection, the RTX, which
> * isn't necessarily the first in the SDP but has to be the first
> * to be set up, else the second/third SETUP will fail with a 461.
> @@ -1151,7 +1143,7 @@ int ff_rtsp_make_setup_request(AVFormatContext *s,
> const char *host, int port,
>
> /* RTP/TCP */
> else if (lower_transport == RTSP_LOWER_TRANSPORT_TCP) {
> - /** For WMS streams, the application streams are only used for
> + /* For WMS streams, the application streams are only used for
> * UDP. When trying to set it up for TCP streams, the server
> * will return an error. Therefore, we skip those streams. */
> if (rt->server_type == RTSP_SERVER_WMS &&
> @@ -1482,14 +1474,14 @@ redirect:
> cmd[0] = 0;
> if (rt->server_type == RTSP_SERVER_REAL)
> av_strlcat(cmd,
> - /**
> + /*
> * The following entries are required for proper
> * streaming from a Realmedia server. They are
> * interdependent in some way although we currently
> * don't quite understand how. Values were copied
> * from mplayer SVN r23589.
> - * @param CompanyID is a 16-byte ID in base64
> - * @param ClientChallenge is a 16-byte ID in hex
> + * ClientChallenge is a 16-byte ID in hex
> + * CompanyID is a 16-byte ID in base64
> */
> "ClientChallenge:
> 9e26d33f2984236010ef6253fb1887f7\r\n"
> "PlayerStarttime: [28/03/2003:22:50:23 00:00]\r\n"
> diff --git a/libavformat/rtsp.h b/libavformat/rtsp.h
> index 0625692..28e83dd 100644
> --- a/libavformat/rtsp.h
> +++ b/libavformat/rtsp.h
> @@ -525,6 +525,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);
> --
> 1.7.1
The rest looks ok.
// Martin
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
