From 87d6d3143b094f7126aa1323a6ef38d9af6e07c0 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Fri, 24 Jun 2005 18:16:14 +0000 Subject: [PATCH] start pulling in base classes and elements for docs Original commit message from CVS: start pulling in base classes and elements for docs --- ChangeLog | 23 +++++++- docs/gst/Makefile.am | 7 +-- docs/gst/gstreamer-docs.sgml | 39 ++++++++----- docs/gst/gstreamer-sections.txt | 99 +++++++++++++++++++++++++++++++++ docs/gst/gstreamer.types | 27 +++++++++ docs/gst/tmpl/gstbasesink.sgml | 37 +++++++++++++ docs/gst/tmpl/gstbasesrc.sgml | 37 +++++++++++++ docs/gst/tmpl/gstbin.sgml | 8 +-- docs/gst/tmpl/gstcompat.sgml | 5 +- docs/gst/tmpl/gstfakesink.sgml | 61 ++++++++++++++++++++ docs/gst/tmpl/gstfakesrc.sgml | 120 ++++++++++++++++++++++++++++++++++++++++ docs/gst/tmpl/gstfilesink.sgml | 27 +++++++++ docs/gst/tmpl/gstfilesrc.sgml | 42 ++++++++++++++ docs/gst/tmpl/gstindex.sgml | 2 +- docs/manual/appendix-quotes.xml | 21 +++++++ gst/base/gstbasesrc.h | 1 + gst/elements/gstfakesrc.h | 2 + gst/gstmessage.h | 2 +- libs/gst/base/gstbasesrc.h | 1 + plugins/elements/gstfakesrc.h | 2 + 20 files changed, 537 insertions(+), 26 deletions(-) create mode 100644 docs/gst/tmpl/gstbasesink.sgml create mode 100644 docs/gst/tmpl/gstbasesrc.sgml create mode 100644 docs/gst/tmpl/gstfakesink.sgml create mode 100644 docs/gst/tmpl/gstfakesrc.sgml create mode 100644 docs/gst/tmpl/gstfilesink.sgml create mode 100644 docs/gst/tmpl/gstfilesrc.sgml diff --git a/ChangeLog b/ChangeLog index 79a11d5..1e5f777 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,8 +1,29 @@ +2005-06-24 Thomas Vander Stichele + + * docs/gst/Makefile.am: + * docs/gst/gstreamer-docs.sgml: + * docs/gst/gstreamer-sections.txt: + * docs/gst/gstreamer.types: + * docs/gst/tmpl/gstbasesink.sgml: + * docs/gst/tmpl/gstbasesrc.sgml: + * docs/gst/tmpl/gstbin.sgml: + * docs/gst/tmpl/gstcompat.sgml: + * docs/gst/tmpl/gstfakesink.sgml: + * docs/gst/tmpl/gstfakesrc.sgml: + * docs/gst/tmpl/gstfilesink.sgml: + * docs/gst/tmpl/gstfilesrc.sgml: + * docs/gst/tmpl/gstindex.sgml: + * docs/manual/appendix-quotes.xml: + * gst/base/gstbasesrc.h: + * gst/elements/gstfakesrc.h: + * gst/gstmessage.h: + start pulling in base classes and elements in our docs + 2005-06-24 Stefan Kost * docs/gst/Makefile.am: * docs/libs/Makefile.am: - fixed make distcheck with gtk-doc 1.3 + fixed make distcheck with gtk-doc 1.3 2005-06-23 Wim Taymans diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index ba535fa..924d8d2 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -57,6 +57,9 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c #SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \ # $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la +SCANOBJ_DEPS = \ + $(top_builddir)/gst/elements/libgstelements.la \ + $(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la # Header files to ignore when scanning. Use base file name, no paths IGNORE_HFILES= \ @@ -75,12 +78,8 @@ IGNORE_HFILES= \ gstmarshal.h \ gstaggregator.h \ gstbufferstore.h \ - gstfakesink.h \ - gstfakesrc.h \ gstfdsink.h \ gstfdsrc.h \ - gstfilesink.h \ - gstfilesrc.h \ gstidentity.h \ gstmd5sink.h \ gstmultifilesrc.h \ diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 70ffeea..cc3d044 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -55,12 +55,15 @@ - + + + + GStreamer Base Classes + + These base classes are provided to be extended by elements. + + + &GstBaseSrc; + &GstBaseSink; + - --> diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index b833bc3..9d2e9b1 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -1852,3 +1852,102 @@ gst_xml_get_type GstEnumTypes +
+gstfakesrc +GstFakeSrc +GstFakeSrc + +GstFakeSrcClass +GST_FAKESRC +GST_IS_FAKESRC +GST_TYPE_FAKESRC +GST_FAKESRC_CLASS +GST_IS_FAKESRC_CLASS +GST_FAKESRC_GET_CLASS + +gst_fakesrc_get_type +
+ +
+gstfakesink +GstFakeSink +GstFakeSink + + +GstFakeSinkClass +GST_FAKESINK +GST_IS_FAKESINK +GST_TYPE_FAKESINK +GST_FAKESINK_CLASS +GST_IS_FAKESINK_CLASS +GST_FAKESINK_GET_CLASS + +gst_fakesink_get_type +
+ +
+gstbasesrc +GstBaseSrc +GstBaseSrc + +GstBaseSrcClass +GST_BASESRC +GST_IS_BASESRC +GST_TYPE_BASESRC +GST_BASESRC_CLASS +GST_IS_BASESRC_CLASS +GST_BASESRC_GET_CLASS + +gst_basesrc_get_type +
+ +
+gstfilesrc +GstFileSrc +GstFileSrc + +GstFileSrcClass +GST_FILESRC +GST_IS_FILESRC +GST_TYPE_FILESRC +GST_FILESRC_CLASS +GST_IS_FILESRC_CLASS +GST_FILESRC_GET_CLASS + +gst_filesrc_get_type +
+ +
+gstfilesink +GstFileSink +GstFileSink + + +GstFileSinkClass +GST_FILESINK +GST_IS_FILESINK +GST_TYPE_FILESINK +GST_FILESINK_CLASS +GST_IS_FILESINK_CLASS +GST_FILESINK_GET_CLASS + +gst_filesink_get_type +
+ + +
+gstbasesink +GstBaseSink +GstBaseSink + + +GstBaseSinkClass +GST_BASESINK +GST_IS_BASESINK +GST_TYPE_BASESINK +GST_BASESINK_CLASS +GST_IS_BASESINK_CLASS +GST_BASESINK_GET_CLASS + +gst_basesink_get_type +
diff --git a/docs/gst/gstreamer.types b/docs/gst/gstreamer.types index f7affae..252209b 100644 --- a/docs/gst/gstreamer.types +++ b/docs/gst/gstreamer.types @@ -1,3 +1,11 @@ +% 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 + #include #include @@ -21,3 +29,22 @@ gst_tag_setter_get_type gst_type_find_factory_get_type gst_xml_get_type +% base classes + +#include +#include + +gst_basesrc_get_type +gst_basesink_get_type + +% elements + +#include +#include +#include +#include + +gst_fakesrc_get_type +gst_fakesink_get_type +gst_filesrc_get_type +gst_filesink_get_type diff --git a/docs/gst/tmpl/gstbasesink.sgml b/docs/gst/tmpl/gstbasesink.sgml new file mode 100644 index 0000000..1c1cf46 --- /dev/null +++ b/docs/gst/tmpl/gstbasesink.sgml @@ -0,0 +1,37 @@ + +GstBaseSink + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstbasesrc.sgml b/docs/gst/tmpl/gstbasesrc.sgml new file mode 100644 index 0000000..989536c --- /dev/null +++ b/docs/gst/tmpl/gstbasesrc.sgml @@ -0,0 +1,37 @@ + +GstBaseSrc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 3a2cac7..74c7990 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -66,19 +66,19 @@ clock providers in the bin. -Will be emmited if a new element was removed/added to this bin. +Will be emitted if a new element was removed/added to this bin. @gstbin: the object which received the signal. -@arg1: the element that was added to the bin +@arg1: the element that was added to the bin. -Will be emmited if an element was removed from this bin. +Will be emitted if an element was removed from this bin. @gstbin: the object which received the signal. -@arg1: the element that was removed from the bin +@arg1: the element that was removed from the bin. diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml index ba67b5b..16c29cd 100644 --- a/docs/gst/tmpl/gstcompat.sgml +++ b/docs/gst/tmpl/gstcompat.sgml @@ -6,8 +6,9 @@ Deprecated API entries. -Please do not use in new code. This symbols are hidden by the GST_DISABLE_DEPRECATED define. -One would have to add this to the CFLAGS when compiling old code. +Please do not use these in new code. +These symbols are only available by defining GST_DISABLE_DEPRECATED. +This can be done in CFLAGS for compiling old code. diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml new file mode 100644 index 0000000..7755271 --- /dev/null +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -0,0 +1,61 @@ + +GstFakeSink + + + + + + + + + + + + + + + + + + + + + + + + + +@gstfakesink: the object which received the signal. +@arg1: +@arg2: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml new file mode 100644 index 0000000..c6dc59b --- /dev/null +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -0,0 +1,120 @@ + +GstFakeSrc + + + + + + + + + + + + + + + + + + + + + + + + + +@gstfakesrc: the object which received the signal. +@arg1: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstfilesink.sgml b/docs/gst/tmpl/gstfilesink.sgml new file mode 100644 index 0000000..e3bd8dd --- /dev/null +++ b/docs/gst/tmpl/gstfilesink.sgml @@ -0,0 +1,27 @@ + +GstFileSink + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstfilesrc.sgml b/docs/gst/tmpl/gstfilesrc.sgml new file mode 100644 index 0000000..e7d7274 --- /dev/null +++ b/docs/gst/tmpl/gstfilesrc.sgml @@ -0,0 +1,42 @@ + +GstFileSrc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index 04a60a2..74254d5 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -23,7 +23,7 @@ in a pipeline. -Is emited when a new entry is added to the index. +Is emitted when a new entry is added to the index. @gstindex: the object which received the signal. diff --git a/docs/manual/appendix-quotes.xml b/docs/manual/appendix-quotes.xml index 21d67f6..ea3497d 100644 --- a/docs/manual/appendix-quotes.xml +++ b/docs/manual/appendix-quotes.xml @@ -32,10 +32,31 @@ --- You are now known as thomasvs <Illbe> back --- Illbe is now known as bilboed + + + + 20 Apr 2005 + + + thomas: +jrb, somehow his screenshotsrc grabs whatever X is showing and makes it +available as a stream of frames + + + jrb: +thomas: so, is the point that the screenshooter takes a video? +but won't the dialog be in the video? oh, nevermind. I'll just send mail... + + + thomas: +jrb, well, it would shoot first and ask questions later + + + 14 Oct 2004 diff --git a/gst/base/gstbasesrc.h b/gst/base/gstbasesrc.h index eb39a3d..945e9cb 100644 --- a/gst/base/gstbasesrc.h +++ b/gst/base/gstbasesrc.h @@ -98,6 +98,7 @@ struct _GstBaseSrc { struct _GstBaseSrcClass { GstElementClass parent_class; + /*< public >*/ /* get caps from subclass */ GstCaps* (*get_caps) (GstBaseSrc *src); /* notify the subclass of new caps */ diff --git a/gst/elements/gstfakesrc.h b/gst/elements/gstfakesrc.h index af286fd..1c7c288 100644 --- a/gst/elements/gstfakesrc.h +++ b/gst/elements/gstfakesrc.h @@ -76,6 +76,7 @@ typedef struct _GstFakeSrcClass GstFakeSrcClass; struct _GstFakeSrc { GstBaseSrc element; + /*< private >*/ gboolean has_loop; gboolean has_getrange; gboolean eos; @@ -114,6 +115,7 @@ struct _GstFakeSrc { struct _GstFakeSrcClass { GstBaseSrcClass parent_class; + /*< public >*/ /* signals */ void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad); }; diff --git a/gst/gstmessage.h b/gst/gstmessage.h index 3d1846f..935362c 100644 --- a/gst/gstmessage.h +++ b/gst/gstmessage.h @@ -43,7 +43,7 @@ G_BEGIN_DECLS * @GST_MESSAGE_STEP_DONE: a framestep finished. * @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline * @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed. - * @GST_MESSAGE_STREAM_STATUS: status about a stream, emited when it starts, + * @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts, * stops, errors, etc.. * @GST_MESSAGE_APPLICATION: message posted by the application, possibly * via an application-specific element. diff --git a/libs/gst/base/gstbasesrc.h b/libs/gst/base/gstbasesrc.h index eb39a3d..945e9cb 100644 --- a/libs/gst/base/gstbasesrc.h +++ b/libs/gst/base/gstbasesrc.h @@ -98,6 +98,7 @@ struct _GstBaseSrc { struct _GstBaseSrcClass { GstElementClass parent_class; + /*< public >*/ /* get caps from subclass */ GstCaps* (*get_caps) (GstBaseSrc *src); /* notify the subclass of new caps */ diff --git a/plugins/elements/gstfakesrc.h b/plugins/elements/gstfakesrc.h index af286fd..1c7c288 100644 --- a/plugins/elements/gstfakesrc.h +++ b/plugins/elements/gstfakesrc.h @@ -76,6 +76,7 @@ typedef struct _GstFakeSrcClass GstFakeSrcClass; struct _GstFakeSrc { GstBaseSrc element; + /*< private >*/ gboolean has_loop; gboolean has_getrange; gboolean eos; @@ -114,6 +115,7 @@ struct _GstFakeSrc { struct _GstFakeSrcClass { GstBaseSrcClass parent_class; + /*< public >*/ /* signals */ void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad); }; -- 2.7.4