mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-14 13:21:28 +00:00
56a79fbfcc
Original commit message from CVS: Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the HTML output somewhere on the website tonight. In order to actually generate the docs, you'll have to install all the DocBook tools, as well as gtk-doc from GNOME cvs. (see http://developer.gnome.org/arch/doc/tools.html) Notes (I'll codify these some day): - Don't believe the Gnome page, always edit the SOURCES when documenting a given function, never the tmpl file. - I'll be re-arranging things a lot, but gtk-doc is smart enough to merge any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are two entirely separate animals. We should probably have a virtual mutex on the entire docs/gst/ directory, over and above what CVS does. - I'm going to try to end up with a book set (docbook terms), where docs/gst/ is only one book. There'd be another called docs/manual/, and another docs/plugins/, etc. If you have any comments as to how these should be done, gstreamer-devel is the place.
230 lines
2.2 KiB
Text
230 lines
2.2 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstPad
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_PAD ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### MACRO GST_PAD_CONNECTED ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@buf:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
|
|
|
|
<!-- ##### ENUM GstPadDirection ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GST_PAD_UNKNOWN:
|
|
@GST_PAD_SRC:
|
|
@GST_PAD_SINK:
|
|
|
|
<!-- ##### FUNCTION gst_pad_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@direction:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@chain:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_type_id ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@id:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@name:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_directory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_set_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_parent ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_get_peer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_connect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@srcpad:
|
|
@sinkpad:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_push ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@buffer:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_pull ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_pad_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@pad:
|
|
@parent:
|
|
@Returns:
|
|
|
|
|