2005-06-24 18:16:14 +00:00
|
|
|
% add a _get_type for every GObject whose properties and signals you want
|
|
|
|
% documented
|
|
|
|
% add the relevant includes to be able to call those _get_type functions
|
|
|
|
|
|
|
|
% adding a get_type here will:
|
|
|
|
% - change output file name from gstreamer-(whatever).html to (whatever).html
|
|
|
|
% - document properties and signals
|
|
|
|
|
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
|
|
|
#include <gst/gst.h>
|
2004-05-14 15:17:30 +00:00
|
|
|
#include <gst/gstqueue.h>
|
2000-10-22 16:27:21 +00:00
|
|
|
|
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
|
|
|
gst_bin_get_type
|
2002-03-31 14:00:33 +00:00
|
|
|
gst_clock_get_type
|
2004-07-21 11:32:09 +00:00
|
|
|
gst_element_factory_get_type
|
|
|
|
gst_element_get_type
|
|
|
|
gst_ghost_pad_get_type
|
|
|
|
gst_implements_interface_get_type
|
|
|
|
gst_index_factory_get_type
|
|
|
|
gst_index_get_type
|
|
|
|
gst_object_get_type
|
2000-03-27 19:53:43 +00:00
|
|
|
gst_pad_get_type
|
2002-04-12 18:59:11 +00:00
|
|
|
gst_pad_template_get_type
|
2004-07-21 11:32:09 +00:00
|
|
|
gst_pipeline_get_type
|
2001-10-24 19:55:12 +00:00
|
|
|
gst_plugin_feature_get_type
|
2004-07-21 11:32:09 +00:00
|
|
|
gst_queue_get_type
|
2002-04-12 18:59:11 +00:00
|
|
|
gst_scheduler_factory_get_type
|
2002-03-31 14:00:33 +00:00
|
|
|
gst_scheduler_get_type
|
2004-07-21 11:32:09 +00:00
|
|
|
gst_tag_setter_get_type
|
|
|
|
gst_type_find_factory_get_type
|
2001-10-24 19:55:12 +00:00
|
|
|
gst_xml_get_type
|
2004-07-21 11:32:09 +00:00
|
|
|
|
2005-06-24 18:16:14 +00:00
|
|
|
% base classes
|
|
|
|
|
|
|
|
#include <gst/base/gstbasesrc.h>
|
|
|
|
#include <gst/base/gstbasesink.h>
|
2005-06-27 14:40:09 +00:00
|
|
|
#include <gst/base/gstbasetransform.h>
|
2005-06-24 18:16:14 +00:00
|
|
|
|
2005-06-28 15:36:37 +00:00
|
|
|
gst_base_src_get_type
|
|
|
|
gst_base_sink_get_type
|
2005-06-27 14:40:09 +00:00
|
|
|
gst_base_transform_get_type
|
2005-06-24 18:16:14 +00:00
|
|
|
|
|
|
|
% elements
|
|
|
|
|
|
|
|
#include <gst/elements/gstfakesrc.h>
|
|
|
|
#include <gst/elements/gstfakesink.h>
|
|
|
|
#include <gst/elements/gstfilesrc.h>
|
|
|
|
#include <gst/elements/gstfilesink.h>
|
|
|
|
|
|
|
|
gst_fakesrc_get_type
|
|
|
|
gst_fakesink_get_type
|
|
|
|
gst_filesrc_get_type
|
|
|
|
gst_filesink_get_type
|