[FFmpeg-soc] [soc]: r4758 - rtmp/rtmppkt.h

[kostya]

Author: kostya
Date: Wed Jul 22 08:06:21 2009
New Revision: 4758

Log:
Update documentation in rtmppkt.h

Modified:
   rtmp/rtmppkt.h

Modified: rtmp/rtmppkt.h
==============================================================================
--- rtmp/rtmppkt.h	Wed Jul 22 08:03:07 2009	(r4757)
+++ rtmp/rtmppkt.h	Wed Jul 22 08:06:21 2009	(r4758)
@@ -24,7 +24,7 @@
 
 #include "avformat.h"
 
-/* maximum possible number of different RTMP channels */
+/** maximum possible number of different RTMP channels */
 #define RTMP_CHANNELS 64
 
 /**
@@ -113,7 +113,7 @@ typedef struct RTMPPacket {
  * @param type       packet type
  * @param timestamp  packet timestamp
  * @param size       packet size
- * @return zero on success, -1 otherwise
+ * @return zero on success, negative value otherwise
  */
 int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
                           int timestamp, int size);
@@ -133,7 +133,7 @@ void ff_rtmp_packet_destroy(RTMPPacket *
  * @param chunk_size current chunk size
  * @param prev_pkt   previously read packet headers for all channels
  *                   (may be needed for restoring incomplete packet header)
- * @return zero on success, -1 otherwise
+ * @return zero on success, negative value otherwise
  */
 int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
                         int chunk_size, RTMPPacket *prev_pkt);
@@ -146,12 +146,18 @@ int ff_rtmp_packet_read(URLContext *h, R
  * @param chunk_size current chunk size
  * @param prev_pkt   previously sent packet headers for all channels
  *                   (may be used for packet header compressing)
- * @return zero on success, -1 otherwise
+ * @return zero on success, negative value otherwise
  */
 int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
                          int chunk_size, RTMPPacket *prev_pkt);
 
 /**
+ * @defgroup amffuncs functions used to work with AMF format (which is also used in .flv)
+ * @see amf_* funcs in libavformat/flvdec.c
+ * @{
+ */
+
+/**
  * Calculates number of bytes needed to skip first AMF entry in data.
  *
  * @param data input data
@@ -166,7 +172,7 @@ int ff_amf_skip_data(const uint8_t *data
  * @param name     name of field to retrieve
  * @param dst      buffer for storing result
  * @param dst_size output buffer size
- * @return 0 if search and retrieval succeeded, -1 otherwise
+ * @return 0 if search and retrieval succeeded, negative value otherwise
  */
 int ff_amf_find_field(const uint8_t *data, const uint8_t *name,
                       uint8_t *dst, int dst_size);
@@ -180,4 +186,6 @@ int ff_amf_find_field(const uint8_t *dat
  */
 void ff_amf_write_tag(uint8_t **dst, AMFType type, const void *data);
 
+/** @} */ // AMF funcs
+
 #endif /* AVFORMAT_RTMPPKT_H */