mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-03 09:12:19 +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.
121 lines
1.2 KiB
Text
121 lines
1.2 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
gsttrace
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gst_trace_read_tsc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dst:
|
|
|
|
|
|
<!-- ##### STRUCT GstTrace ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@filename:
|
|
@fd:
|
|
@buf:
|
|
@bufsize:
|
|
@bufoffset:
|
|
|
|
<!-- ##### STRUCT GstTraceEntry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@timestamp:
|
|
@sequence:
|
|
@data:
|
|
@message:
|
|
|
|
<!-- ##### FUNCTION gst_trace_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@filename:
|
|
@size:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_trace_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_trace_flush ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### MACRO gst_trace_get_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### MACRO gst_trace_get_offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### MACRO gst_trace_get_remaining ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_trace_set_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
|
|
|
|
<!-- ##### MACRO TRACE_ENABLE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_trace_add_entry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@trace:
|
|
@seq:
|
|
@data:
|
|
@msg:
|
|
|
|
|