diff --git a/ChangeLog b/ChangeLog index c4ca45d4c6..dea768edc4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,27 @@ +2005-09-02 Stefan Kost + + * docs/gst/gstreamer-docs.sgml: + * docs/gst/tmpl/.cvsignore: + * docs/gst/tmpl/gstghostpad.sgml: + * docs/gst/tmpl/gstiterator.sgml: + * docs/gst/tmpl/gstmacros.sgml: + * docs/gst/tmpl/gstrealpad.sgml: + * docs/gst/tmpl/gstregistry.sgml: + * docs/gst/tmpl/gstregistrypool.sgml: + * docs/gst/tmpl/gststructure.sgml: + * docs/gst/tmpl/gstsystemclock.sgml: + * docs/gst/tmpl/gsttrace.sgml: + * gst/gstghostpad.c: + * gst/gstmacros.h: + * gst/gstmemchunk.c: + * gst/gstmemchunk.h: + * gst/gstqueue.c: + * gst/gstregistry.c: + * gst/gstregistrypool.c: + * gst/gststructure.c: + * gst/gstsystemclock.c: + more docs inlined + 2005-09-02 Andy Wingo * gst/gstelement.h (GstState): Renamed from GstElementState, diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 2df4cfbc7e..9449d8de5e 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -158,22 +158,14 @@ GStreamer Core Support - Theses modules support the gstreamer core and applications using it. - - - &GstMacros; - &GstMemChunk; - - - - - GStreamer Core Internals - - Theses are internal modules which are rarely used by applications. + Theses modules support the gstreamer core and plugin development. + Application developers will rarely need to know about it. &GstCheck; &GstInfo; + &GstMacros; + &GstMemChunk; &GstTrace; diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore index 89d86a0884..c6a2474a5d 100644 --- a/docs/gst/tmpl/.gitignore +++ b/docs/gst/tmpl/.gitignore @@ -23,12 +23,21 @@ gstfilesrc.sgml gstfilesink.sgml gstfilter.sgml gstformat.sgml +gstghostpad.sgml +gstiterator.sgml +gstmacros.sgml +gstmemchunck.sgml gstmessage.sgml gstminiobject.sgml gstprobe.sgml gstpushsrc.sgml +gstqueue.sgml gstquery.sgml gstreamer-unused.sgml +gstregistry.sgml +gstregistrypool.sgml +gststructure.sgml +gstsystemclock.sgml gsttask.sgml gsturihandler.sgml gsturitype.sgml diff --git a/docs/gst/tmpl/gstghostpad.sgml b/docs/gst/tmpl/gstghostpad.sgml deleted file mode 100644 index 0d8f2bf64b..0000000000 --- a/docs/gst/tmpl/gstghostpad.sgml +++ /dev/null @@ -1,66 +0,0 @@ - -GstGhostPad - - -Pseudo link pads - - - - - - - - - - - - - - - - - - - - - - - - - -@name: -@target: -@Returns: - -@pad: - - - - - - - -@gpad: -@newtarget: -@Returns: - - - - - - - -@gpad: -@Returns: - - - - - - - -@name: -@dir: -@Returns: - - diff --git a/docs/gst/tmpl/gstiterator.sgml b/docs/gst/tmpl/gstiterator.sgml deleted file mode 100644 index b8f532ac55..0000000000 --- a/docs/gst/tmpl/gstiterator.sgml +++ /dev/null @@ -1,250 +0,0 @@ - -GstIterator - - - - - - - - - - - - - - - - - - - - - - -@next: -@item: -@resync: -@free: -@pushed: -@lock: -@cookie: -@master_cookie: - - - - - - -@GST_ITERATOR_ITEM_SKIP: -@GST_ITERATOR_ITEM_PASS: -@GST_ITERATOR_ITEM_END: - - - - - - -@GST_ITERATOR_DONE: -@GST_ITERATOR_OK: -@GST_ITERATOR_RESYNC: -@GST_ITERATOR_ERROR: - - - - - - -@owner: - - - - - - - -@it: -@result: -@Returns: - - - - - - - -@it: -@item: -@Returns: - - - - - - - -@it: - - - - - - - -@it: - - - - - - - -@item: -@ret: -@user_data: -@Returns: - - - - - - - -@it: - - - - - - - -@it: - - - - - - - -@it: - - - - - - - -@it: - - - - - - - -@size: -@lock: -@master_cookie: -@next: -@item: -@resync: -@free: -@Returns: - - - - - - - -@lock: -@master_cookie: -@list: -@owner: -@item: -@free: -@Returns: - - - - - - - -@it: -@elem: -@Returns: - -@result: - - - - - - - -@it: - - - - - - - -@it: - - - - - - - -@it: -@other: - - - - - - - -@it: -@func: -@user_data: -@Returns: - - - - - - - -@iter: -@func: -@ret: -@user_data: -@Returns: - - - - - - - -@iter: -@func: -@user_data: -@Returns: - - - - - - - -@it: -@func: -@user_data: -@Returns: - - diff --git a/docs/gst/tmpl/gstmacros.sgml b/docs/gst/tmpl/gstmacros.sgml deleted file mode 100644 index 8149bca8d2..0000000000 --- a/docs/gst/tmpl/gstmacros.sgml +++ /dev/null @@ -1,19 +0,0 @@ - -GstMacros - - -various portabillity helper macros - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstrealpad.sgml b/docs/gst/tmpl/gstrealpad.sgml deleted file mode 100644 index 94cf055c36..0000000000 --- a/docs/gst/tmpl/gstrealpad.sgml +++ /dev/null @@ -1,16 +0,0 @@ - -GstRealPad - - -Real link pads - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml deleted file mode 100644 index be6b3810d4..0000000000 --- a/docs/gst/tmpl/gstregistry.sgml +++ /dev/null @@ -1,20 +0,0 @@ - -GstRegistry - - -Abstract base class for management of #GstPlugin objects. - - - -One registry holds the metadata of a set of plugins. -All registries build the #GstRegistryPool. - - - - -#GstPlugin, #GstPluginFeature - - - - - diff --git a/docs/gst/tmpl/gstregistrypool.sgml b/docs/gst/tmpl/gstregistrypool.sgml deleted file mode 100644 index 99de4f98c9..0000000000 --- a/docs/gst/tmpl/gstregistrypool.sgml +++ /dev/null @@ -1,127 +0,0 @@ - -GstRegistryPool - - -Management of a group of #GstRegistry objects - - - -The registry pool manages the available registries and plugins in -the system. - - - - -GstRegistry - - - - - - - - - - -@Returns: - - - - - - - -@registry: -@priority: - - - - - - - -@registry: - - - - - - - -@plugin: - - - - - - - - - - - - - - -@filter: -@first: -@user_data: -@Returns: - - - - - - - -@filter: -@first: -@user_data: -@Returns: - - - - - - - -@Returns: - - - - - - - -@type: -@Returns: - - - - - - - -@name: -@Returns: - - - - - - - -@name: -@type: -@Returns: - - - - - - - -@flags: -@Returns: - - diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml deleted file mode 100644 index 77f3a1752b..0000000000 --- a/docs/gst/tmpl/gststructure.sgml +++ /dev/null @@ -1,446 +0,0 @@ - -GstStructure - - -Generic structure containing fields of names and values - - - - - - - - - - - - - - - - - - - -@type: - - - - - - -@field_id: -@value: -@user_data: -@Returns: - - - - - - - -@field_id: -@value: -@user_data: -@Returns: - - - - - - - -@name: -@Returns: - - - - - - - -@quark: -@Returns: - - - - - - - -@name: -@firstfield: -@Varargs: -@Returns: - - - - - - - -@name: -@firstfield: -@varargs: -@Returns: - - - - - - - -@structure: -@Returns: - - - - - - - -@structure: - - - - - - - -@structure: -@Returns: - - - - - - - -@structure: -@name: -@Returns: - - - - - - - -@structure: -@name: - - - - - - - -@structure: -@Returns: - - - - - - - -@structure: -@field: -@Returns: - - - - - - - -@structure: -@field: -@value: - - - - - - - -@structure: -@fieldname: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@value: - -@field: - - - - - - - -@structure: -@fieldname: -@Varargs: - -@field: - - - - - - - -@structure: -@fieldname: -@varargs: - -@field: - - - - - - - -@structure: -@fieldname: - -@field: - - - - - - - -@structure: -@fieldname: -@Varargs: - -@fieldnamename: - - - - - - - -@structure: -@fieldname: -@varargs: - -@fieldnamename: - - - - - - - -@structure: - - - - - - - -@structure: -@fieldname: -@Returns: - -@field: - - - - - - - -@structure: -@func: -@user_data: -@Returns: - - - - - - - -@structure: -@Returns: - - - - - - - -@structure: -@fieldname: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@type: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@value: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@value: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@value: -@Returns: - -@field: - - - - - - - -@structure: -@fieldname: -@value: -@Returns: - -@fieldnamename: -@field: - - - - - - - -@structure: -@fieldname: -@Returns: - -@field: - - - - - - - -@structure: -@func: -@user_data: -@Returns: - - - - - - - -@structure: -@index: -@Returns: - - - - - - - -@structure: -@refcount: - - - - - - - -@structure: -@Returns: - - - - - - - -@string: -@end: -@Returns: - - - - - - - -@structure: -@field_name: -@target: -@Returns: - - - - - - - -@structure: -@field_name: -@target: -@Returns: - - diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml deleted file mode 100644 index 71c56fd94f..0000000000 --- a/docs/gst/tmpl/gstsystemclock.sgml +++ /dev/null @@ -1,35 +0,0 @@ - -GstSystemClock - - -Default clock that uses the current system time - - - -The System clock is an implementation of GstClock using the -system time. - - - - -#GstClock - - - - - - - - - - -@clock: - - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml index 168b2aa988..0f69f428c8 100644 --- a/docs/gst/tmpl/gsttrace.sgml +++ b/docs/gst/tmpl/gsttrace.sgml @@ -224,7 +224,7 @@ Use the tracer to trace a new memory allocation Trace a memory free operation -@trace: The traver to use +@trace: The tracer to use @mem: The memory that is freed diff --git a/gst/gstghostpad.c b/gst/gstghostpad.c index cb710eaaee..0aae989d9f 100644 --- a/gst/gstghostpad.c +++ b/gst/gstghostpad.c @@ -20,7 +20,12 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:gstghostpad + * @short_description: Pseudo link pads + * @see_also: #GstPad + * + */ #include "gst_private.h" diff --git a/gst/gstmacros.h b/gst/gstmacros.h index 6f20ac8273..c347fc144a 100644 --- a/gst/gstmacros.h +++ b/gst/gstmacros.h @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstmacros + * @short_description: Various portabillity helper macros + * + */ #ifndef __GST_MACROS_H__ #define __GST_MACROS_H__ diff --git a/gst/gstmemchunk.c b/gst/gstmemchunk.c index 9d0d3d1907..7754c2d413 100644 --- a/gst/gstmemchunk.c +++ b/gst/gstmemchunk.c @@ -20,6 +20,18 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstmacros + * @short_description: Atomic chunk allocator + * @see_also: #GstBuffer, #GstEvent, #GstData + * + * GstMemChunk is an atomic chunk allocator. It uses atomic operations to + * allocate fixed size memory regions and is therefore thread safe without the + * overhead of mutexes or other heavyweight locking mechanisms. + * + * The GstMemChunk is used to allocate critical resources for #GstBuffer and + * #GstEvent. + */ #include "gst_private.h" #include /* memset */ diff --git a/gst/gstmemchunk.h b/gst/gstmemchunk.h index 6e0d7087e5..89e032a9f9 100644 --- a/gst/gstmemchunk.h +++ b/gst/gstmemchunk.h @@ -24,6 +24,11 @@ G_BEGIN_DECLS +/** + * GstMemChunk: + * + * The memchunk data structure + */ typedef struct _GstMemChunk GstMemChunk; GstMemChunk* gst_mem_chunk_new (gchar *name, diff --git a/gst/gstqueue.c b/gst/gstqueue.c index 5cb4469136..656d280778 100644 --- a/gst/gstqueue.c +++ b/gst/gstqueue.c @@ -21,6 +21,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstqueue + * @short_description: Simple asynchronous data queue. + * + * Data is queued till max_level buffers have been stored. Any subsequent + * buffers sent to this filter will block until free space becomes available in + * the buffer. The queue is typically used in conjunction with a thread. + * + * You can query how many buffers are queued with the level argument. + * + * The default queue length is set to 100. + * + * The queue blocks by default. + */ #include "gst_private.h" diff --git a/gst/gstregistry.c b/gst/gstregistry.c index 1d4323212a..611ec7c4c5 100644 --- a/gst/gstregistry.c +++ b/gst/gstregistry.c @@ -19,6 +19,14 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstregistry + * @short_description: Abstract base class for management of #GstPlugin objects + * @see_also: #GstPlugin, #GstPluginFeature + * + * One registry holds the metadata of a set of plugins. + * All registries build the #GstRegistryPool. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/gstregistrypool.c b/gst/gstregistrypool.c index 011bcec148..ed1e63a29b 100644 --- a/gst/gstregistrypool.c +++ b/gst/gstregistrypool.c @@ -19,6 +19,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstregistrypool + * @short_description: Management of a group of #GstRegistry objects + * @see_also: #GstRegistry + * + * The registry pool manages the available registries and plugins in the system. + */ #include diff --git a/gst/gststructure.c b/gst/gststructure.c index 20fd8da549..d1699ae2e6 100644 --- a/gst/gststructure.c +++ b/gst/gststructure.c @@ -18,6 +18,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gststructure + * @short_description: Generic structure containing fields of names and values + * + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/gstsystemclock.c b/gst/gstsystemclock.c index 1366233dd1..d60cfaf2bf 100644 --- a/gst/gstsystemclock.c +++ b/gst/gstsystemclock.c @@ -19,6 +19,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstsystemclock + * @short_description: Default clock that uses the current system time + * @see_also: #GstClock + * + * The System clock is an implementation of GstClock using the system time. + */ #include "gst_private.h" #include "gstinfo.h" diff --git a/plugins/elements/gstqueue.c b/plugins/elements/gstqueue.c index 5cb4469136..656d280778 100644 --- a/plugins/elements/gstqueue.c +++ b/plugins/elements/gstqueue.c @@ -21,6 +21,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstqueue + * @short_description: Simple asynchronous data queue. + * + * Data is queued till max_level buffers have been stored. Any subsequent + * buffers sent to this filter will block until free space becomes available in + * the buffer. The queue is typically used in conjunction with a thread. + * + * You can query how many buffers are queued with the level argument. + * + * The default queue length is set to 100. + * + * The queue blocks by default. + */ #include "gst_private.h"