Browse code

RTSP: Doxygen comment cleanup

Do not use Doxygen for comments that apply to specific implementation
details; merge some duplicated Doxygen comment blocks.

Diego Biurrun authored on 2011/07/03 23:35:10
Showing 2 changed files
... ...
@@ -428,11 +428,6 @@ static void sdp_parse_line(AVFormatContext *s, SDPParseState *s1,
428 428
     }
429 429
 }
430 430
 
431
-/**
432
- * Parse the sdp description and allocate the rtp streams and the
433
- * pollfd array used for udp ones.
434
- */
435
-
436 431
 int ff_sdp_parse(AVFormatContext *s, const char *content)
437 432
 {
438 433
     RTSPState *rt = s->priv_data;
... ...
@@ -1050,9 +1045,6 @@ retry:
1050 1050
     return 0;
1051 1051
 }
1052 1052
 
1053
-/**
1054
- * @return 0 on success, <0 on error, 1 if protocol is unavailable.
1055
- */
1056 1053
 int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
1057 1054
                               int lower_transport, const char *real_challenge)
1058 1055
 {
... ...
@@ -1078,7 +1070,7 @@ int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
1078 1078
     for (j = RTSP_RTP_PORT_MIN, i = 0; i < rt->nb_rtsp_streams; ++i) {
1079 1079
         char transport[2048];
1080 1080
 
1081
-        /**
1081
+        /*
1082 1082
          * WMS serves all UDP data over a single connection, the RTX, which
1083 1083
          * isn't necessarily the first in the SDP but has to be the first
1084 1084
          * 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,
1151 1151
 
1152 1152
         /* RTP/TCP */
1153 1153
         else if (lower_transport == RTSP_LOWER_TRANSPORT_TCP) {
1154
-            /** For WMS streams, the application streams are only used for
1154
+            /* For WMS streams, the application streams are only used for
1155 1155
              * UDP. When trying to set it up for TCP streams, the server
1156 1156
              * will return an error. Therefore, we skip those streams. */
1157 1157
             if (rt->server_type == RTSP_SERVER_WMS &&
... ...
@@ -1482,14 +1474,14 @@ redirect:
1482 1482
         cmd[0] = 0;
1483 1483
         if (rt->server_type == RTSP_SERVER_REAL)
1484 1484
             av_strlcat(cmd,
1485
-                       /**
1485
+                       /*
1486 1486
                         * The following entries are required for proper
1487 1487
                         * streaming from a Realmedia server. They are
1488 1488
                         * interdependent in some way although we currently
1489 1489
                         * don't quite understand how. Values were copied
1490 1490
                         * from mplayer SVN r23589.
1491
-                        * @param CompanyID is a 16-byte ID in base64
1492
-                        * @param ClientChallenge is a 16-byte ID in hex
1491
+                        *   ClientChallenge is a 16-byte ID in hex
1492
+                        *   CompanyID is a 16-byte ID in base64
1493 1493
                         */
1494 1494
                        "ClientChallenge: 9e26d33f2984236010ef6253fb1887f7\r\n"
1495 1495
                        "PlayerStarttime: [28/03/2003:22:50:23 00:00]\r\n"
... ...
@@ -505,8 +505,9 @@ int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);
505 505
 int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);
506 506
 
507 507
 /**
508
- * Parse a SDP description of streams by populating an RTSPState struct
509
- * within the AVFormatContext.
508
+ * Parse an SDP description of streams by populating an RTSPState struct
509
+ * within the AVFormatContext; also allocate the RTP streams and the
510
+ * pollfd array used for UDP streams.
510 511
  */
511 512
 int ff_sdp_parse(AVFormatContext *s, const char *content);
512 513
 
... ...
@@ -525,6 +526,7 @@ int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);
525 525
 /**
526 526
  * Do the SETUP requests for each stream for the chosen
527 527
  * lower transport mode.
528
+ * @return 0 on success, <0 on error, 1 if protocol is unavailable
528 529
  */
529 530
 int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
530 531
                                int lower_transport, const char *real_challenge);