From 1561a0767a616ed2a3b2802dba070129c8d6b98e Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 31 Aug 2005 14:08:45 +0000 Subject: [PATCH] inlined more docs, fixed double id-ref Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/.cvsignore: * docs/gst/tmpl/gsterror.sgml: * docs/gst/tmpl/gstfilter.sgml: * docs/gst/tmpl/gsturihandler.sgml: * docs/gst/tmpl/gsturitype.sgml: * docs/gst/tmpl/gstutils.sgml: * docs/gst/tmpl/gstxml.sgml: * gst/gsterror.c: * gst/gsterror.h: * gst/gstfilter.c: * gst/gsturi.c: * gst/gsturitype.c: * gst/gstutils.c: * gst/gstxml.c: inlined more docs, fixed double id-ref --- ChangeLog | 20 ++ docs/gst/gstreamer-docs.sgml | 16 +- docs/gst/gstreamer-sections.txt | 1 - docs/gst/tmpl/.gitignore | 6 + docs/gst/tmpl/gsterror.sgml | 166 ------------- docs/gst/tmpl/gstfilter.sgml | 44 ---- docs/gst/tmpl/gsturihandler.sgml | 137 ----------- docs/gst/tmpl/gsturitype.sgml | 28 --- docs/gst/tmpl/gstutils.sgml | 384 ------------------------------- docs/gst/tmpl/gstxml.sgml | 216 ----------------- gst/gsterror.c | 5 + gst/gsterror.h | 5 + gst/gstfilter.c | 11 +- gst/gsturi.c | 8 + gst/gsturitype.c | 5 + gst/gstutils.c | 6 + gst/gstxml.c | 5 + 17 files changed, 83 insertions(+), 980 deletions(-) delete mode 100644 docs/gst/tmpl/gsterror.sgml delete mode 100644 docs/gst/tmpl/gstfilter.sgml delete mode 100644 docs/gst/tmpl/gsturihandler.sgml delete mode 100644 docs/gst/tmpl/gsturitype.sgml delete mode 100644 docs/gst/tmpl/gstutils.sgml delete mode 100644 docs/gst/tmpl/gstxml.sgml diff --git a/ChangeLog b/ChangeLog index 902bfc7533..b7079a2ab8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,23 @@ +2005-08-31 Stefan Kost + + * docs/gst/gstreamer-docs.sgml: + * docs/gst/gstreamer-sections.txt: + * docs/gst/tmpl/.cvsignore: + * docs/gst/tmpl/gsterror.sgml: + * docs/gst/tmpl/gstfilter.sgml: + * docs/gst/tmpl/gsturihandler.sgml: + * docs/gst/tmpl/gsturitype.sgml: + * docs/gst/tmpl/gstutils.sgml: + * docs/gst/tmpl/gstxml.sgml: + * gst/gsterror.c: + * gst/gsterror.h: + * gst/gstfilter.c: + * gst/gsturi.c: + * gst/gsturitype.c: + * gst/gstutils.c: + * gst/gstxml.c: + inlined more docs, fixed double id-ref + 2005-08-31 Wim Taymans * gst/base/gstbasetransform.c: (gst_base_transform_setcaps), diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 5043704aa0..2df4cfbc7e 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -109,7 +109,6 @@ &GstBuffer; &GstBus; &GstCaps; - &GstCheck; &GstChildProxy; &GstClock; &GstConfig; @@ -124,7 +123,6 @@ &GstImplementsInterface; &GstIndex; &GstIndexFactory; - &GstInfo; &GstIterator; &GstMessage; &GstMiniObject; @@ -160,7 +158,7 @@ GStreamer Core Support - Theses elements support the gstreamer core and applications using it. + Theses modules support the gstreamer core and applications using it. &GstMacros; @@ -168,6 +166,18 @@ + + GStreamer Core Internals + + Theses are internal modules which are rarely used by applications. + + + &GstCheck; + &GstInfo; + &GstTrace; + + + -GstError - - -Categorized error messages - - - - - - - - - - - - - - - - - - - -@GST_CORE_ERROR_FAILED: -@GST_CORE_ERROR_TOO_LAZY: -@GST_CORE_ERROR_NOT_IMPLEMENTED: -@GST_CORE_ERROR_STATE_CHANGE: -@GST_CORE_ERROR_PAD: -@GST_CORE_ERROR_THREAD: -@GST_CORE_ERROR_NEGOTIATION: -@GST_CORE_ERROR_EVENT: -@GST_CORE_ERROR_SEEK: -@GST_CORE_ERROR_CAPS: -@GST_CORE_ERROR_TAG: -@GST_CORE_ERROR_NUM_ERRORS: - - - - - - -@GST_LIBRARY_ERROR_FAILED: -@GST_LIBRARY_ERROR_TOO_LAZY: -@GST_LIBRARY_ERROR_INIT: -@GST_LIBRARY_ERROR_SHUTDOWN: -@GST_LIBRARY_ERROR_SETTINGS: -@GST_LIBRARY_ERROR_ENCODE: -@GST_LIBRARY_ERROR_NUM_ERRORS: - - - - - - -@GST_RESOURCE_ERROR_FAILED: -@GST_RESOURCE_ERROR_TOO_LAZY: -@GST_RESOURCE_ERROR_NOT_FOUND: -@GST_RESOURCE_ERROR_BUSY: -@GST_RESOURCE_ERROR_OPEN_READ: -@GST_RESOURCE_ERROR_OPEN_WRITE: -@GST_RESOURCE_ERROR_OPEN_READ_WRITE: -@GST_RESOURCE_ERROR_CLOSE: -@GST_RESOURCE_ERROR_READ: -@GST_RESOURCE_ERROR_WRITE: -@GST_RESOURCE_ERROR_SEEK: -@GST_RESOURCE_ERROR_SYNC: -@GST_RESOURCE_ERROR_SETTINGS: -@GST_RESOURCE_ERROR_NUM_ERRORS: - - - - - - -@GST_STREAM_ERROR_FAILED: -@GST_STREAM_ERROR_TOO_LAZY: -@GST_STREAM_ERROR_NOT_IMPLEMENTED: -@GST_STREAM_ERROR_TYPE_NOT_FOUND: -@GST_STREAM_ERROR_WRONG_TYPE: -@GST_STREAM_ERROR_CODEC_NOT_FOUND: -@GST_STREAM_ERROR_DECODE: -@GST_STREAM_ERROR_ENCODE: -@GST_STREAM_ERROR_DEMUX: -@GST_STREAM_ERROR_MUX: -@GST_STREAM_ERROR_FORMAT: -@GST_STREAM_ERROR_STOPPED: -@GST_STREAM_ERROR_NUM_ERRORS: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Generates an human readable error message out of an errno number. - - - - - - - - - -@domain: -@code: -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstfilter.sgml b/docs/gst/tmpl/gstfilter.sgml deleted file mode 100644 index 49932eec1a..0000000000 --- a/docs/gst/tmpl/gstfilter.sgml +++ /dev/null @@ -1,44 +0,0 @@ - -GstFilter - - -Take data in and spit data out - - - -Filters take data in and spit data out. They are the main Element in a filter graph. -Filters have zero or more inputs and zero or more outputs. Filters are linked -together to form filter graphs. A GstFilter is the base class and is not very usefull -on its own. - - - - - - - - - - - - - - - -@obj: -@user_data: -@Returns: - - - - - - - -@list: -@func: -@first: -@user_data: -@Returns: - - diff --git a/docs/gst/tmpl/gsturihandler.sgml b/docs/gst/tmpl/gsturihandler.sgml deleted file mode 100644 index 7a3b021117..0000000000 --- a/docs/gst/tmpl/gsturihandler.sgml +++ /dev/null @@ -1,137 +0,0 @@ - -GstUriHandler - - -Plugin feature that handles URI types - - - -The URIHandler is a pluginfeature that can be used to locate element -and the element property that can handle a given URI. - - - - - - - - - - - - - - - - - - - - - -@type: - - - - - - - -@protocol: -@Returns: - - - - - - - -@uri: -@Returns: - - - - - - - -@uri: -@Returns: - - - - - - - -@uri: -@Returns: - - - - - - - -@protocol: -@location: -@Returns: - - - - - - - -@type: -@uri: -@elementname: -@Returns: - - - - - - - -@handler: -@Returns: - - - - - - - -@handler: -@Returns: - - - - - - - -@handler: -@Returns: - - - - - - - -@handler: -@uri: -@Returns: - - - - - - - -@handler: -@uri: - - diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml deleted file mode 100644 index 1c2391cf6d..0000000000 --- a/docs/gst/tmpl/gsturitype.sgml +++ /dev/null @@ -1,28 +0,0 @@ - -GstURIType - - -describes URI types - - - - - - - - - - - - - - - - - - - -@GST_URI_UNKNOWN: -@GST_URI_SINK: -@GST_URI_SRC: - diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml deleted file mode 100644 index b4ca69ac74..0000000000 --- a/docs/gst/tmpl/gstutils.sgml +++ /dev/null @@ -1,384 +0,0 @@ - -GstUtils - - -various utility functions - - - - - - - - - - - - - - - - - - - -@type: -@type_as_function: -@parent_type: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@\ - parent_type_as_macro: -@interface_type: -@interface_type_as_macro: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: -@\ - interface_as_function: - - - - - - - -@type: -@type_as_function: -@parent_type: -@parent_type_macro: -@additional_initializations: - - - - - - - -@type: -@type_as_function: -@parent_type: -@parent_type_macro: - - - - - - - -@parent_class_cast: -@name: -@args: - - - - - - - -@parent_class_cast: -@name: -@args: -@def_return: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@data: -@num: - - - - - - - -@num: - - - - - - - -@num: - - - - - - - -@num: - - - - - - - -@num: - - - - - - - -@num: - - - - - - - -@num: - - - - - - - -@atomic_int: -@value: - - - - - - - -@bin: - - - - - - - -@ret: -@Returns: - - - - - - - -@buf: -@indent: -@element: - - - - - - - -@buf: -@indent: -@pad: - - - - - - - -@mem: -@size: - - - - - - - -@object: -@name: -@value: - - - - - - - -@value: -@value_str: - - diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml deleted file mode 100644 index 4e3f299079..0000000000 --- a/docs/gst/tmpl/gstxml.sgml +++ /dev/null @@ -1,216 +0,0 @@ - -GstXML - - -XML save/restore operations of pipelines - - - - - - - - - - - - - - - - - - - - - - - - - -@: -@: -@: - -@gstxml: the object which received the signal. -@arg1: -@arg2: - - - - - - -@registry: -@Returns: - - - - - - - -@registry: - - - - - - - -@registry: -@dest: -@size: -@Returns: - - - - - - - -@GST_XML_REGISTRY_READ: -@GST_XML_REGISTRY_WRITE: - - - - - - -@registry: -@mode: -@Returns: - - - - - - - -@context: -@tag: -@text: -@text_len: -@registry: -@error: -@Returns: - - - - - - - -@registry: -@format: -@Varargs: -@Returns: - - - - - - - -@GST_XML_REGISTRY_NONE: -@GST_XML_REGISTRY_TOP: -@GST_XML_REGISTRY_PATHS: -@GST_XML_REGISTRY_PATH: -@GST_XML_REGISTRY_PATHS_DONE: -@GST_XML_REGISTRY_PLUGIN: -@GST_XML_REGISTRY_FEATURE: -@GST_XML_REGISTRY_PADTEMPLATE: -@GST_XML_REGISTRY_CAPS: -@GST_XML_REGISTRY_STRUCTURE: -@GST_XML_REGISTRY_PROPERTIES: - - - - - - -@element: -@Returns: - - - - - - - -@element: -@out: -@Returns: - - - - - - - -@Returns: - - - - - - - -@xml: -@doc: -@root: -@Returns: - - - - - - - -@xml: -@fname: -@root: -@Returns: - - - - - - - -@xml: -@buffer: -@size: -@root: -@Returns: - - - - - - - -@xml: -@name: -@Returns: - - - - - - - -@xml: -@Returns: - - - - - - - -@cur: -@parent: -@Returns: - - diff --git a/gst/gsterror.c b/gst/gsterror.c index 59319b956b..9ccdd3a30a 100644 --- a/gst/gsterror.c +++ b/gst/gsterror.c @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsterror + * @short_description: Categorized error messages + * + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/gsterror.h b/gst/gsterror.h index be0d7e5692..319f174135 100644 --- a/gst/gsterror.h +++ b/gst/gsterror.h @@ -193,6 +193,11 @@ typedef enum #define GST_CORE_ERROR gst_core_error_quark () #define GST_STREAM_ERROR gst_stream_error_quark () +/** + * GST_ERROR_SYSTEM: + * + * Generates an human readable error message out of an errno number. + */ #define GST_ERROR_SYSTEM ("system error: %s", g_strerror (errno)) GType gst_g_error_get_type (void); diff --git a/gst/gstfilter.c b/gst/gstfilter.c index f3e84d7e4c..19f364b1fb 100644 --- a/gst/gstfilter.c +++ b/gst/gstfilter.c @@ -16,7 +16,16 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:gstfilter + * @short_description: Take data in and spit data out + * + * Filters take data in and spit data out. They are the main elements in a + * filter graph. + * Filters have zero or more inputs and zero or more outputs. Filters are + * linked together to form filter graphs. A #GstFilter is the base class and is + * not very useful on its own. + */ #include "gst_private.h" #include diff --git a/gst/gsturi.c b/gst/gsturi.c index 1eeeb1e596..4dd51c0ddc 100644 --- a/gst/gsturi.c +++ b/gst/gsturi.c @@ -19,6 +19,14 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsturihandler + * @short_description: Plugin feature that handles URI types + * @see_also: #GstPluginFeature, #GstUri + * + * The URIHandler is a pluginfeature that can be used to locate elements and the + * element property that can handle a given URI. + */ #ifdef HAVE_CONFIG_H # include "config.h" diff --git a/gst/gsturitype.c b/gst/gsturitype.c index b3abd9506e..8bb6971245 100644 --- a/gst/gsturitype.c +++ b/gst/gsturitype.c @@ -19,6 +19,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gsturitype + * @short_description: Describes URI types + * + */ #include "gst_private.h" diff --git a/gst/gstutils.c b/gst/gstutils.c index a3454feae2..05bb0f33bc 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -19,6 +19,12 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstutils + * @short_description: Various utility functions + * + * When defining own plugins, use the GST_BOILERPLATE ease gobject creation. + */ #include #include diff --git a/gst/gstxml.c b/gst/gstxml.c index fb1a3a5be3..a4a9af6050 100644 --- a/gst/gstxml.c +++ b/gst/gstxml.c @@ -19,6 +19,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstxml + * @short_description: XML save/restore operations of pipelines + * + */ #include "gst_private.h"