mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-08 13:18:52 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: fix docs for new api

Browse source 
Some parameters where wrong, first line missed the ':' and return docs where
broken.
This commit is contained in:
Stefan Kost 2011-05-23 14:53:26 +03:00
parent 61032e7470
commit d6ea8d5cb3
2 changed files with 14 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
gst-libs/gst/audio/gstaudioiec61937.c
View file

@ -22,11 +22,11 @@
/** /**
* SECTION:gstaudioiec61937 * SECTION:gstaudioiec61937
* @short_description: Utility functions for IEC 61937 payloading * @short_description: Utility functions for IEC 61937 payloading
* @since: 0.10.35
* *
* This module contains some helper functions for encapsulating various * This module contains some helper functions for encapsulating various
* audio formats in IEC 61937 headers and padding. * audio formats in IEC 61937 headers and padding.
* *
* Since: 0.10.35
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
@ -60,12 +60,14 @@ caps_get_string_field (const GstCaps * caps, const gchar * field)
} }
/** /**
* gst_audio_iec61937_frame_size * gst_audio_iec61937_frame_size:
* @type: the type of data to be payloaded as a #GstBufferFormatType * @spec: the ringbufer spec
* *
* Returns 0 if the given @type is not supported or cannot be payloaded, else * Calculated the size of the buffer expected by gst_audio_iec61937_payload() for
* returns the size of the buffer expected by gst_audio_iec61937_payload() for * payloading type from @spec.
* payloading @type. *
* Returns: the size or 0 if the given @type is not supported or cannot be
* payloaded.
* *
* Since: 0.10.35 * Since: 0.10.35
*/ */
@ -128,19 +130,19 @@ gst_audio_iec61937_frame_size (const GstRingBufferSpec * spec)
} }
/** /**
* gst_audio_iec61937_payload * gst_audio_iec61937_payload:
* @src: a buffer containing the data to payload * @src: a buffer containing the data to payload
* @src_n: size of @src in bytes * @src_n: size of @src in bytes
* @dst: the destination buffer to store the payloaded contents in. Should not * @dst: the destination buffer to store the payloaded contents in. Should not
* overlap with @src * overlap with @src
* @dst_n: size of @dst in bytes * @dst_n: size of @dst in bytes
* @type: the type of data in @src * @spec: the ringbufer spec for @src
* *
* Payloads @src in the form specified by IEC 61937 for @type and stores * Payloads @src in the form specified by IEC 61937 for the type from @spec and
* the result in @dst. @src must contain exactly one frame of data and the * stores the result in @dst. @src must contain exactly one frame of data and
* frame is not checked for errors. * the frame is not checked for errors.
* *
* Returns: transfer-full: #TRUE if the payloading was successful, #FALSE * Returns: transfer-full: %TRUE if the payloading was successful, %FALSE
* otherwise. * otherwise.
* *
* Since: 0.10.35 * Since: 0.10.35

7
gst-libs/gst/audio/gstaudioiec61937.h
View file

@ -18,13 +18,6 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:gstaudioiec61937
* @short_description: Utility functions for IEC 61937 payloading
*
* This module contains some helper functions for encapsulating various
* audio formats in IEC 61937 headers and padding.
*/
#ifndef __GST_AUDIO_IEC61937_H__ #ifndef __GST_AUDIO_IEC61937_H__
#define __GST_AUDIO_IEC61937_H__ #define __GST_AUDIO_IEC61937_H__