diff rtmppkt.h @ 6199:fa244b4fe683 libavformat

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 81b2509db2ad
children ccb05424c391
line wrap: on
line diff
--- a/rtmppkt.h	Wed Jun 30 07:55:05 2010 +0000
+++ b/rtmppkt.h	Wed Jun 30 15:38:06 2010 +0000
@@ -83,7 +83,7 @@
 } RTMPPacket;
 
 /**
- * Creates new RTMP packet with given attributes.
+ * Create new RTMP packet with given attributes.
  *
  * @param pkt        packet
  * @param channel_id packet channel ID
@@ -96,14 +96,14 @@
                           int timestamp, int size);
 
 /**
- * Frees RTMP packet.
+ * Free RTMP packet.
  *
  * @param pkt packet
  */
 void ff_rtmp_packet_destroy(RTMPPacket *pkt);
 
 /**
- * Reads RTMP packet sent by the server.
+ * Read RTMP packet sent by the server.
  *
  * @param h          reader context
  * @param p          packet
@@ -116,7 +116,7 @@
                         int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * Sends RTMP packet to the server.
+ * Send RTMP packet to the server.
  *
  * @param h          reader context
  * @param p          packet to send
@@ -129,7 +129,7 @@
                          int chunk_size, RTMPPacket *prev_pkt);
 
 /**
- * Prints information and contents of RTMP packet.
+ * Print information and contents of RTMP packet.
  *
  * @param h          output context
  * @param p          packet to dump
@@ -143,7 +143,7 @@
  */
 
 /**
- * Calculates number of bytes taken by first AMF entry in data.
+ * Calculate number of bytes taken by first AMF entry in data.
  *
  * @param data input data
  * @param data_end input buffer end
@@ -152,7 +152,7 @@
 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end);
 
 /**
- * Retrieves value of given AMF object field in string form.
+ * Retrieve value of given AMF object field in string form.
  *
  * @param data     AMF object data
  * @param data_end input buffer end
@@ -165,7 +165,7 @@
                            const uint8_t *name, uint8_t *dst, int dst_size);
 
 /**
- * Writes boolean value in AMF format to buffer.
+ * Write boolean value in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param val value to write
@@ -173,7 +173,7 @@
 void ff_amf_write_bool(uint8_t **dst, int val);
 
 /**
- * Writes number in AMF format to buffer.
+ * Write number in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param num value to write
@@ -181,7 +181,7 @@
 void ff_amf_write_number(uint8_t **dst, double num);
 
 /**
- * Writes string in AMF format to buffer.
+ * Write string in AMF format to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -189,21 +189,21 @@
 void ff_amf_write_string(uint8_t **dst, const char *str);
 
 /**
- * Writes AMF NULL value to buffer.
+ * Write AMF NULL value to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_null(uint8_t **dst);
 
 /**
- * Writes marker for AMF object to buffer.
+ * Write marker for AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */
 void ff_amf_write_object_start(uint8_t **dst);
 
 /**
- * Writes string used as field name in AMF object to buffer.
+ * Write string used as field name in AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  * @param str string to write
@@ -211,7 +211,7 @@
 void ff_amf_write_field_name(uint8_t **dst, const char *str);
 
 /**
- * Writes marker for end of AMF object to buffer.
+ * Write marker for end of AMF object to buffer.
  *
  * @param dst pointer to the input buffer (will be modified)
  */