diff options
author | Stefan Kost <ensonic@users.sf.net> | 2009-02-25 11:45:05 +0200 |
---|---|---|
committer | Stefan Kost <ensonic@users.sf.net> | 2009-02-25 12:42:36 +0200 |
commit | 53f975f63ce82c6466250e5f450c0663f46f5056 (patch) | |
tree | 1b4fe046cc32d9c0611a11c25845cd31f88bf854 /docs/plugins | |
parent | 9a0e1e0dca06d419af23d49ab87b681ae8313efc (diff) | |
download | gst-plugins-bad-53f975f63ce82c6466250e5f450c0663f46f5056.tar.gz gst-plugins-bad-53f975f63ce82c6466250e5f450c0663f46f5056.tar.bz2 gst-plugins-bad-53f975f63ce82c6466250e5f450c0663f46f5056.zip |
docs: various doc fixes
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.
Diffstat (limited to 'docs/plugins')
-rw-r--r-- | docs/plugins/Makefile.am | 11 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-sections.txt | 262 |
2 files changed, 136 insertions, 137 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index e12a2f13..c5504b19 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -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. diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 916c5e59..a2829ef9 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -230,6 +230,25 @@ 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> GstDvbSrc @@ -360,6 +379,38 @@ 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> GstBaseMetadata @@ -524,6 +575,71 @@ 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> GstRtpBin @@ -708,20 +824,6 @@ 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> GstTheoraExpDec @@ -777,6 +879,21 @@ 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> GstVideoAnalyse @@ -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> |