mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-02 00:32:43 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: various doc fixes

Browse source 
No short-desc as we have them in the element details.
Also keep things (Makefile.am and sections.txt) sorted.
Reword ambigous returns. No text after since please.
This commit is contained in:
Stefan Kost 2009-02-25 11:45:05 +02:00
parent 9a0e1e0dca
commit 53f975f63c
11 changed files with 148 additions and 154 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/plugins/Makefile.am
View file

@ -117,14 +117,18 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/aacparse/gstaacparse.h \
$(top_srcdir)/gst/amrparse/gstamrparse.h \
$(top_srcdir)/gst/camerabin/gstcamerabin.h \
$(top_srcdir)/gst/legacyresample/gstlegacyresample.h \
$(top_srcdir)/gst/deinterlace/gstdeinterlace.h \
$(top_srcdir)/gst/dccp/gstdccpclientsink.h \
$(top_srcdir)/gst/dccp/gstdccpclientsrc.h \
$(top_srcdir)/gst/dccp/gstdccpserversink.h \
$(top_srcdir)/gst/dccp/gstdccpserversrc.h \
$(top_srcdir)/gst/dtmf/gstdtmfsrc.h \
$(top_srcdir)/gst/dtmf/gstrtpdtmfsrc.h \
$(top_srcdir)/gst/dtmf/gstrtpdtmfdepay.h \
$(top_srcdir)/gst/dvdspu/gstdvdspu.h \
$(top_srcdir)/gst/festival/gstfestival.h \
$(top_srcdir)/gst/legacyresample/gstlegacyresample.h \
$(top_srcdir)/gst/liveadder/liveadder.h \
$(top_srcdir)/gst/mxf/mxfdemux.h \
$(top_srcdir)/gst/nuvdemux/gstnuvdemux.h \
$(top_srcdir)/gst/rawparse/gstaudioparse.h \
@ -148,11 +152,6 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/videosignal/gstvideomark.h \
$(top_srcdir)/gst/valve/gstvalve.h \
$(top_srcdir)/gst/y4m/gsty4mencode.h \
$(top_srcdir)/gst/liveadder/liveadder.h \
$(top_srcdir)/gst/dtmf/gstdtmfsrc.h \
$(top_srcdir)/gst/dtmf/gstrtpdtmfsrc.h \
$(top_srcdir)/gst/dtmf/gstrtpdtmfdepay.h \
$(top_srcdir)/gst/dtmf/gstrtpdtmfcommon.h \
$(top_srcdir)/sys/dvb/gstdvbsrc.h
# Images to copy into HTML directory.

262
docs/plugins/gst-plugins-bad-plugins-sections.txt
View file

@ -229,6 +229,25 @@ GST_TYPE_DFBSURFACE
gst_dfbsurface_get_type
</SECTION>
<SECTION>
<FILE>element-dtmfsrc</FILE>
<TITLE>dtmfsrc</TITLE>
GstDTMFSrc
<SUBSECTION Standard>
GstDTMFEventType
GstDTMFSrcEvent
GstDTMFSrcClass
GST_TYPE_DTMF_SRC
GST_DTMF_SRC
GST_DTMF_SRC_CAST
GST_DTMF_SRC_CLASS
GST_DTMF_SRC_GET_CLASS
GST_IS_DTMF_SRC
GST_IS_DTMF_SRC_CLASS
gst_dtmf_src_get_type
gst_dtmf_src_plugin_init
</SECTION>
<SECTION>
<FILE>element-dvbsrc</FILE>
<TITLE>dvbsrc</TITLE>
@ -359,6 +378,38 @@ GST_TYPE_JACK_AUDIO_SINK
gst_jack_audio_sink_get_type
</SECTION>
<SECTION>
<FILE>element-legacyresample</FILE>
<TITLE>legacyresample</TITLE>
GstLegacyresample
<SUBSECTION Standard>
GstLegacyresampleClass
GST_LEGACYRESAMPLE
GST_LEGACYRESAMPLE_CLASS
GST_IS_LEGACYRESAMPLE
GST_IS_LEGACYRESAMPLE_CLASS
GST_TYPE_LEGACYRESAMPLE
gst_legacyresample_get_type
</SECTION>
<SECTION>
<FILE>element-liveadder</FILE>
<TITLE>liveadder</TITLE>
GstLiveAdder
<SUBSECTION Standard>
GstLiveAdderClass
GST_IS_LIVE_ADDER
GST_IS_LIVE_ADDER_CLASS
GST_IS_MXF_DEMUX_PAD
GST_LIVE_ADDER
GST_LIVE_ADDER_CLASS
GST_LIVE_ADDER_GET_CLASS
GST_TYPE_LIVE_ADDER
GstLiveAdderFormat
GstLiveAdderFunction
gst_live_adder_get_type
</SECTION>
<SECTION>
<FILE>gstbasemetadata</FILE>
<TITLE>GstBaseMetadata</TITLE>
@ -523,6 +574,71 @@ GST_TYPE_OUTPUT_SELECTOR
gst_output_selector_get_type
</SECTION>
<SECTION>
<FILE>element-rtpdtmfdepay</FILE>
<TITLE>rtpdtmfdepay</TITLE>
GstRtpDTMFDepay
<SUBSECTION Standard>
GstRtpDTMFDepayClass
GST_TYPE_RTP_DTMF_DEPAY
GST_IS_RTP_DTMF_DEPAY
GST_IS_RTP_DTMF_DEPAY_CLASS
GST_RTP_DTMF_DEPAY
GST_RTP_DTMF_DEPAY_CLASS
gst_rtp_dtmf_depay_plugin_init
</SECTION>
<SECTION>
<FILE>element-rtpdtmfmux</FILE>
<TITLE>rtpdtmfmux</TITLE>
GstRTPDTMFMux
<SUBSECTION Standard>
GST_IS_RTP_DTMF_MUX
GST_IS_RTP_DTMF_MUX_CLASS
GST_TYPE_RTP_DTMF_MUX
GstRTPDTMFMuxClass
GST_RTP_DTMF_MUX
GST_RTP_DTMF_MUX_CLASS
gst_rtp_dtmf_mux_get_type
gst_rtp_dtmf_mux_plugin_init
</SECTION>
<SECTION>
<FILE>element-rtpdtmfsrc</FILE>
<TITLE>rtpdtmfsrc</TITLE>
GstRTPDTMFSrc
<SUBSECTION Standard>
GstRTPDTMFSrcClass
GST_TYPE_RTP_DTMF_SRC
GST_IS_RTP_DTMF_SRC
GST_IS_RTP_DTMF_SRC_CLASS
GST_RTP_DTMF_SRC
GST_RTP_DTMF_SRC_CAST
GST_RTP_DTMF_SRC_CLASS
GST_RTP_DTMF_SRC_GET_CLASS
gst_rtp_dtmf_src_get_type
gst_rtp_dtmf_src_plugin_init
GstRTPDTMFPayload
GstRTPDTMFSrcEvent
GstRTPDTMFEventType
</SECTION>
<SECTION>
<FILE>element-rtpmux</FILE>
<TITLE>rtpmux</TITLE>
GstRTPMux
<SUBSECTION Standard>
GST_IS_RTP_MUX
GST_IS_RTP_MUX_CLASS
GST_RTP_MUX
GST_RTP_MUX_CLASS
GST_RTP_MUX_GET_CLASS
GST_TYPE_RTP_MUX
GstRTPMuxClass
gst_rtp_mux_plugin_init
gst_rtp_session_set_ssrc
</SECTION>
<SECTION>
<FILE>element-gstrtpbin</FILE>
<TITLE>gstrtpbin</TITLE>
@ -707,20 +823,6 @@ GST_TYPE_STEREO
gst_stereo_get_type
</SECTION>
<SECTION>
<FILE>element-legacyresample</FILE>
<TITLE>legacyresample</TITLE>
GstLegacyresample
<SUBSECTION Standard>
GstLegacyresampleClass
GST_LEGACYRESAMPLE
GST_LEGACYRESAMPLE_CLASS
GST_IS_LEGACYRESAMPLE
GST_IS_LEGACYRESAMPLE_CLASS
GST_TYPE_LEGACYRESAMPLE
gst_legacyresample_get_type
</SECTION>
<SECTION>
<FILE>element-theoradecexp</FILE>
<TITLE>theoradecexp</TITLE>
@ -776,6 +878,21 @@ GST_TYPE_TRM
gst_trm_get_type
</SECTION>
<SECTION>
<FILE>element-valve</FILE>
<TITLE>valve</TITLE>
GstValve
<SUBSECTION Standard>
GstValveClass
GstValvePrivate
gst_valve_get_type
GST_IS_VALVE
GST_IS_VALVE_CLASS
GST_TYPE_VALVE
GST_VALVE
GST_VALVE_CLASS
</SECTION>
<SECTION>
<FILE>element-videoanalyse</FILE>
<TITLE>videoanalyse</TITLE>
@ -874,120 +991,3 @@ GST_TYPE_Y4M_ENCODE
gst_y4m_encode_get_type
</SECTION>
<SECTION>
<FILE>element-liveadder</FILE>
<TITLE>liveadder</TITLE>
GstLiveAdder
<SUBSECTION Standard>
GstLiveAdderClass
GST_IS_LIVE_ADDER
GST_IS_LIVE_ADDER_CLASS
GST_IS_MXF_DEMUX_PAD
GST_LIVE_ADDER
GST_LIVE_ADDER_CLASS
GST_LIVE_ADDER_GET_CLASS
GST_TYPE_LIVE_ADDER
GstLiveAdderFormat
GstLiveAdderFunction
gst_live_adder_get_type
</SECTION>
<SECTION>
<FILE>element-valve</FILE>
<TITLE>valve</TITLE>
GstValve
<SUBSECTION Standard>
GstValveClass
GstValvePrivate
gst_valve_get_type
GST_IS_VALVE
GST_IS_VALVE_CLASS
GST_TYPE_VALVE
GST_VALVE
GST_VALVE_CLASS
</SECTION>
<SECTION>
<FILE>element-dtmfsrc</FILE>
<TITLE>dtmfsrc</TITLE>
GstDTMFSrc
<SUBSECTION Standard>
GstDTMFEventType
GstDTMFSrcEvent
GstDTMFSrcClass
GST_TYPE_DTMF_SRC
GST_DTMF_SRC
GST_DTMF_SRC_CAST
GST_DTMF_SRC_CLASS
GST_DTMF_SRC_GET_CLASS
GST_IS_DTMF_SRC
GST_IS_DTMF_SRC_CLASS
gst_dtmf_src_get_type
gst_dtmf_src_plugin_init
</SECTION>
<SECTION>
<FILE>element-rtpdtmfsrc</FILE>
<TITLE>rtpdtmfsrc</TITLE>
GstRTPDTMFSrc
<SUBSECTION Standard>
GstRTPDTMFSrcClass
GST_TYPE_RTP_DTMF_SRC
GST_IS_RTP_DTMF_SRC
GST_IS_RTP_DTMF_SRC_CLASS
GST_RTP_DTMF_SRC
GST_RTP_DTMF_SRC_CAST
GST_RTP_DTMF_SRC_CLASS
GST_RTP_DTMF_SRC_GET_CLASS
gst_rtp_dtmf_src_get_type
gst_rtp_dtmf_src_plugin_init
GstRTPDTMFPayload
GstRTPDTMFSrcEvent
GstRTPDTMFEventType
</SECTION>
<SECTION>
<FILE>element-rtpdtmfdepay</FILE>
<TITLE>rtpdtmfdepay</TITLE>
GstRtpDTMFDepay
<SUBSECTION Standard>
GstRtpDTMFDepayClass
GST_TYPE_RTP_DTMF_DEPAY
GST_IS_RTP_DTMF_DEPAY
GST_IS_RTP_DTMF_DEPAY_CLASS
GST_RTP_DTMF_DEPAY
GST_RTP_DTMF_DEPAY_CLASS
gst_rtp_dtmf_depay_plugin_init
</SECTION>
<SECTION>
<FILE>element-rtpmux</FILE>
<TITLE>rtpmux</TITLE>
GstRTPMux
<SUBSECTION Standard>
GST_IS_RTP_MUX
GST_IS_RTP_MUX_CLASS
GST_RTP_MUX
GST_RTP_MUX_CLASS
GST_RTP_MUX_GET_CLASS
GST_TYPE_RTP_MUX
GstRTPMuxClass
gst_rtp_mux_plugin_init
gst_rtp_session_set_ssrc
</SECTION>
<SECTION>
<FILE>element-rtpdtmfmux</FILE>
<TITLE>rtpdtmfmux</TITLE>
GstRTPDTMFMux
<SUBSECTION Standard>
GST_IS_RTP_DTMF_MUX
GST_IS_RTP_DTMF_MUX_CLASS
GST_TYPE_RTP_DTMF_MUX
GstRTPDTMFMuxClass
GST_RTP_DTMF_MUX
GST_RTP_DTMF_MUX_CLASS
gst_rtp_dtmf_mux_get_type
gst_rtp_dtmf_mux_plugin_init
</SECTION>

1
gst/camerabin/gstcamerabin.c
View file

@ -20,7 +20,6 @@
/**
* SECTION:element-camerabin
* @short_description: camera capture bin
*
* GstCameraBin is a high-level camera object that encapsulates the gstreamer
* internals and provides a task based API for the application. It consists of

1
gst/dtmf/gstdtmfsrc.c
View file

@ -27,7 +27,6 @@
/**
* SECTION:element-dtmfsrc
* @short_description: Generates DTMF packets
* @see_also: rtpdtmsrc, rtpdtmfmuxx
*
* The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request

13
gst/dtmf/gstdtmfsrc.h
View file

@ -42,13 +42,6 @@ G_BEGIN_DECLS
typedef struct _GstDTMFSrc GstDTMFSrc;
typedef struct _GstDTMFSrcClass GstDTMFSrcClass;
/**
* GstDTMFSrc:
* @element: the parent element.
*
* The opaque #GstDTMFSrc data structure.
*/
enum _GstDTMFEventType
{
DTMF_EVENT_TYPE_START,
@ -69,6 +62,12 @@ struct _GstDTMFSrcEvent
typedef struct _GstDTMFSrcEvent GstDTMFSrcEvent;
/**
* GstDTMFSrc:
* @element: the parent element.
*
* The opaque #GstDTMFSrc data structure.
*/
struct _GstDTMFSrc
{
/*< private >*/

1
gst/dtmf/gstrtpdtmfdepay.c
View file

@ -21,7 +21,6 @@
*/
/**
* SECTION:element-rtpdtmfdepay
* @short_description: Transforms RFC 4733/2833 RTP dtmf packets into sound
* @see_also: rtpdtmfsrc, rtpdtmfmux
*
* This element takes RTP DTMF packets and produces sound. It also emits a

1
gst/dtmf/gstrtpdtmfsrc.c
View file

@ -25,7 +25,6 @@
/**
* SECTION:element-rtpdtmfsrc
* @short_description: Generates RTP DTMF packets
* @see_also: dtmfsrc, rtpdtmfdepay, rtpdtmfmux
*
* The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request

2
gst/rtpmanager/rtpjitterbuffer.c
View file

@ -569,7 +569,7 @@ rtp_jitter_buffer_get_ts_diff (RTPJitterBuffer * jbuf)
* @clock_rate: clock-rate of @rtptime
* @last_rtptime: last seen rtptime.
*
* Returns the relation between the RTP timestamp and the GStreamer timestamp
* Calculates the relation between the RTP timestamp and the GStreamer timestamp
* used for constructing timestamps.
*
* For extended RTP timestamp @rtptime with a clock-rate of @clock_rate,

1
gst/rtpmux/gstrtpdtmfmux.c
View file

@ -25,7 +25,6 @@
/**
* SECTION:element-rtpdtmfmux
* @short_description: mixes RTP DTMF streams into other RTP streams
* @see_also: rtpdtmfsrc, dtmfsrc
*
* The RTPDTMFMuxer mixes/muxes RTP DTMF stream(s) into other RTP

2
gst/rtpmux/gstrtpmux.c
View file

@ -25,8 +25,6 @@
/**
* SECTION:element-rtpmux
* @short_description: Muxer that takes one or several RTP streams
* and muxes them to a single rtp stream.
*
* The rtp muxer takes multiple RTP streams having the same clock-rate and
* muxes into a single stream with a single SSRC.

7
gst/selector/gstinputselector.c
View file

@ -802,8 +802,11 @@ gst_input_selector_class_init (GstInputSelectorClass * klass)
* If @pad is the same as the current active pad, the element will cancel any
* previous block without adjusting segments.
*
* Since: 0.10.7 the signal changed from accepting the pad name to the pad
* object.
* <note><simpara>
* the signal changed from accepting the pad name to the pad object.
* </simpara></note>
*
* Since: 0.10.7
*/
gst_input_selector_signals[SIGNAL_SWITCH] =
g_signal_new ("switch", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,