Browse code

Doxygenize comments in rtsp.h

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

Panagiotis Issaris authored on 2007/03/05 22:53:00
Showing 1 changed files
... ...
@@ -38,27 +38,27 @@ enum RTSPProtocol {
38 38
 #define RTSP_RTP_PORT_MAX 10000
39 39
 
40 40
 typedef struct RTSPTransportField {
41
-    int interleaved_min, interleaved_max;  /* interleave ids, if TCP transport */
42
-    int port_min, port_max; /* RTP ports */
43
-    int client_port_min, client_port_max; /* RTP ports */
44
-    int server_port_min, server_port_max; /* RTP ports */
45
-    int ttl; /* ttl value */
46
-    uint32_t destination; /* destination IP address */
41
+    int interleaved_min, interleaved_max;  /**< interleave ids, if TCP transport */
42
+    int port_min, port_max; /**< RTP ports */
43
+    int client_port_min, client_port_max; /**< RTP ports */
44
+    int server_port_min, server_port_max; /**< RTP ports */
45
+    int ttl; /**< ttl value */
46
+    uint32_t destination; /**< destination IP address */
47 47
     enum RTSPProtocol protocol;
48 48
 } RTSPTransportField;
49 49
 
50 50
 typedef struct RTSPHeader {
51 51
     int content_length;
52
-    enum RTSPStatusCode status_code; /* response code from server */
52
+    enum RTSPStatusCode status_code; /**< response code from server */
53 53
     int nb_transports;
54
-    /* in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
54
+    /** in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
55 55
     int64_t range_start, range_end;
56 56
     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
57
-    int seq; /* sequence number */
57
+    int seq; /**< sequence number */
58 58
     char session_id[512];
59 59
 } RTSPHeader;
60 60
 
61
-/* the callback can be used to extend the connection setup/teardown step */
61
+/** the callback can be used to extend the connection setup/teardown step */
62 62
 enum RTSPCallbackAction {
63 63
     RTSP_ACTION_SERVER_SETUP,
64 64
     RTSP_ACTION_SERVER_TEARDOWN,