rtcpbuffer: Improve documentation of new functions a bit
authorSebastian Dröge <sebastian@centricular.com>
Fri, 5 Jun 2015 08:16:56 +0000 (10:16 +0200)
committerSebastian Dröge <sebastian@centricular.com>
Fri, 5 Jun 2015 08:18:21 +0000 (10:18 +0200)
Also actually add them to the documentation.

docs/libs/gst-plugins-base-libs-sections.txt
gst-libs/gst/rtp/gstrtcpbuffer.c
win32/common/libgstrtp.def

index 22c8fe4..26e1c1c 100644 (file)
@@ -1197,6 +1197,8 @@ GstRTCPFBType
 gst_rtcp_buffer_new_take_data
 gst_rtcp_buffer_new_copy_data
 
+gst_rtcp_buffer_validate_data_reduced
+gst_rtcp_buffer_validate_reduced
 gst_rtcp_buffer_validate_data
 gst_rtcp_buffer_validate
 
index be85e1d..7d6b541 100644 (file)
@@ -178,15 +178,17 @@ wrong_padding:
  * @data: (array length=len): the data to validate
  * @len: the length of @data to validate
  *
- * Check if the @data and @size point to the data of a valid RTCP
- * packet.
+ * Check if the @data and @size point to the data of a valid RTCP packet.
  * Use this function to validate a packet before using the other functions in
  * this module.
  *
  * This function is updated to support reduced size rtcp packets according to
- * RFC 5506
+ * RFC 5506 and will validate full compound RTCP packets as well as reduced
+ * size RTCP packets.
  *
  * Returns: TRUE if the data points to a valid RTCP packet.
+ *
+ * Since: 1.6
  */
 gboolean
 gst_rtcp_buffer_validate_data_reduced (guint8 * data, guint len)
@@ -200,12 +202,11 @@ gst_rtcp_buffer_validate_data_reduced (guint8 * data, guint len)
  * @data: (array length=len): the data to validate
  * @len: the length of @data to validate
  *
- * Check if the @data and @size point to the data of a valid RTCP (compound)
- * packet.
+ * Check if the @data and @size point to the data of a valid compound,
+ * non-reduced size RTCP packet.
  * Use this function to validate a packet before using the other functions in
  * this module.
  *
- *
  * Returns: TRUE if the data points to a valid RTCP packet.
  */
 gboolean
@@ -223,6 +224,8 @@ gst_rtcp_buffer_validate_data (guint8 * data, guint len)
  * gst_rtcp_buffer_validate_reduced().
  *
  * Returns: TRUE if @buffer is a valid RTCP packet.
+ *
+ * Since: 1.6
  */
 gboolean
 gst_rtcp_buffer_validate_reduced (GstBuffer * buffer)
index 20ef6a7..ef9ee03 100644 (file)
@@ -9,6 +9,8 @@ EXPORTS
        gst_rtcp_buffer_unmap
        gst_rtcp_buffer_validate
        gst_rtcp_buffer_validate_data
+       gst_rtcp_buffer_validate_data_reduced
+       gst_rtcp_buffer_validate_reduced
        gst_rtcp_ntp_to_unix
        gst_rtcp_packet_add_rb
        gst_rtcp_packet_bye_add_ssrc