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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
2000-03-27 19:53:43 +00:00
|
|
|
GstUtils
|
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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2000-03-27 19:53:43 +00:00
|
|
|
Utility functions
|
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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
|
<para>
|
2000-11-11 15:13:50 +00:00
|
|
|
Some convenience functions
|
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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
2001-03-21 21:43:56 +00:00
|
|
|
<!-- ##### FUNCTION gst_util_set_object_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@name:
|
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
2000-12-28 21:42:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_util_get_bool_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
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 ...
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.
2000-02-01 09:16:43 +00:00
|
|
|
<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_util_get_float_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_util_get_double_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_util_get_string_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_util_get_pointer_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@object:
|
|
|
|
|
@argname:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
2000-09-13 19:04:55 +00:00
|
|
|
<!-- ##### FUNCTION gst_util_dump_mem ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@mem:
|
|
|
|
|
@size:
|
|
|
|
|
|
|
|
|
|
|
