mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-01 20:30:41 +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.
100 lines
989 B
Plaintext
100 lines
989 B
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GstSrc
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_SRC ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### ENUM GstSrcFlags ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GST_SRC_ASYNC:
|
|
|
|
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### MACRO GST_SRC_ASYNC ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@obj:
|
|
|
|
|
|
<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
@flag:
|
|
|
|
|
|
<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
@flag:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_src_push ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_src_push_region ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@src:
|
|
@offset:
|
|
@size:
|
|
|
|
|
|
<!-- ##### SIGNAL GstSrc::eos ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gstsrc: the object which received the signal.
|
|
@arg1:
|
|
|