mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-18 06:16:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

inlined more docs, fixed double id-ref

Browse source 
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
This commit is contained in:
Stefan Kost 2005-08-31 14:08:45 +00:00
parent 6116cdc149
commit 1561a0767a
17 changed files with 83 additions and 980 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
ChangeLog
View file

@ -1,3 +1,23 @@
2005-08-31 Stefan Kost <ensonic@users.sf.net>
* 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 <wim@fluendo.com>
* gst/base/gstbasetransform.c: (gst_base_transform_setcaps),

16
docs/gst/gstreamer-docs.sgml
View file

@ -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 @@
<chapter id="gstreamer-support">
<title>GStreamer Core Support</title>
<para>
Theses elements support the gstreamer core and applications using it.
Theses modules support the gstreamer core and applications using it.
</para>
&GstMacros;
@ -168,6 +166,18 @@
</chapter>
<chapter id="gstreamer-internal">
<title>GStreamer Core Internals</title>
<para>
Theses are internal modules which are rarely used by applications.
</para>
&GstCheck;
&GstInfo;
&GstTrace;
</chapter>
<!--
<chapter id="gstreamer-compat">
<title>GStreamer Core Compatibility</title>

1
docs/gst/gstreamer-sections.txt
View file

@ -1797,7 +1797,6 @@ gst_tag_list_get_string
gst_tag_list_get_string_index
gst_tag_list_get_pointer
gst_tag_list_get_pointer_index
gst_event_new_tag
<SUBSECTION Standard>
GST_TAG_LIST
GST_IS_TAG_LIST

6
docs/gst/tmpl/.gitignore vendored
View file

@ -15,10 +15,12 @@ gstcollectpads.sgml
gstcompat.sgml
gstconfig.sgml
gstevent.sgml
gsterror.sgml
gstfakesrc.sgml
gstfakesink.sgml
gstfilesrc.sgml
gstfilesink.sgml
gstfilter.sgml
gstformat.sgml
gstmessage.sgml
gstminiobject.sgml
@ -26,6 +28,10 @@ gstprobe.sgml
gstpushsrc.sgml
gstquery.sgml
gsttask.sgml
gsturihandler.sgml
gsturitype.sgml
gstutils.sgml
gstversion.sgml
gstxml.sgml
gstxmlregistry.sgml

166
docs/gst/tmpl/gsterror.sgml
View file

@ -1,166 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstError
<!-- ##### SECTION Short_Description ##### -->
Categorized error messages
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstCoreError ##### -->
<para>
</para>
@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:
<!-- ##### ENUM GstLibraryError ##### -->
<para>
</para>
@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:
<!-- ##### ENUM GstResourceError ##### -->
<para>
</para>
@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:
<!-- ##### ENUM GstStreamError ##### -->
<para>
</para>
@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:
<!-- ##### MACRO GST_CORE_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_LIBRARY_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_RESOURCE_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_STREAM_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO GST_ERROR_SYSTEM ##### -->
<para>
Generates an human readable error message out of an errno number.
</para>
<!-- ##### FUNCTION gst_error_get_message ##### -->
<para>
</para>
@domain:
@code:
@Returns:
<!-- ##### FUNCTION gst_stream_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_core_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_resource_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_library_error_quark ##### -->
<para>
</para>
@Returns:

44
docs/gst/tmpl/gstfilter.sgml
View file

@ -1,44 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFilter
<!-- ##### SECTION Short_Description ##### -->
Take data in and spit data out
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### USER_FUNCTION GstFilterFunc ##### -->
<para>
</para>
@obj:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_filter_run ##### -->
<para>
</para>
@list:
@func:
@first:
@user_data:
@Returns:

137
docs/gst/tmpl/gsturihandler.sgml
View file

@ -1,137 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstUriHandler
<!-- ##### SECTION Short_Description ##### -->
Plugin feature that handles URI types
<!-- ##### SECTION Long_Description ##### -->
<para>
The URIHandler is a pluginfeature that can be used to locate element
and the element property that can handle a given URI.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstURIHandler ##### -->
<para>
</para>
<!-- ##### MACRO GST_URI_TYPE_IS_VALID ##### -->
<para>
</para>
@type:
<!-- ##### FUNCTION gst_uri_protocol_is_valid ##### -->
<para>
</para>
@protocol:
@Returns:
<!-- ##### FUNCTION gst_uri_is_valid ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_get_protocol ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_get_location ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_construct ##### -->
<para>
</para>
@protocol:
@location:
@Returns:
<!-- ##### FUNCTION gst_element_make_from_uri ##### -->
<para>
</para>
@type:
@uri:
@elementname:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_uri_type ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_protocols ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_get_uri ##### -->
<para>
</para>
@handler:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_set_uri ##### -->
<para>
</para>
@handler:
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_new_uri ##### -->
<para>
</para>
@handler:
@uri:

28
docs/gst/tmpl/gsturitype.sgml
View file

@ -1,28 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstURIType
<!-- ##### SECTION Short_Description ##### -->
describes URI types
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstURIType ##### -->
<para>
</para>
@GST_URI_UNKNOWN:
@GST_URI_SINK:
@GST_URI_SRC:

384
docs/gst/tmpl/gstutils.sgml
View file

@ -1,384 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstUtils
<!-- ##### SECTION Short_Description ##### -->
various utility functions
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GST_BOILERPLATE_WITH_INTERFACE ##### -->
<para>
</para>
@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:
<!-- ##### MACRO GST_BOILERPLATE_FULL ##### -->
<para>
</para>
@type:
@type_as_function:
@parent_type:
@parent_type_macro:
@additional_initializations:
<!-- ##### MACRO GST_BOILERPLATE ##### -->
<para>
</para>
@type:
@type_as_function:
@parent_type:
@parent_type_macro:
<!-- ##### MACRO GST_CALL_PARENT ##### -->
<para>
</para>
@parent_class_cast:
@name:
@args:
<!-- ##### MACRO GST_CALL_PARENT_WITH_DEFAULT ##### -->
<para>
</para>
@parent_class_cast:
@name:
@args:
@def_return:
<!-- ##### MACRO GST_READ_UINT8 ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT16_LE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT16_BE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT32_LE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT32_BE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT64_LE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_READ_UINT64_BE ##### -->
<para>
</para>
@data:
<!-- ##### MACRO GST_WRITE_UINT8 ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT16_LE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT16_BE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT32_LE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT32_BE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT64_LE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_WRITE_UINT64_BE ##### -->
<para>
</para>
@data:
@num:
<!-- ##### MACRO GST_ROUND_UP_2 ##### -->
<para>
</para>
@num:
<!-- ##### MACRO GST_ROUND_UP_4 ##### -->
<para>
</para>
@num:
<!-- ##### MACRO GST_ROUND_UP_8 ##### -->
<para>
</para>
@num:
<!-- ##### MACRO GST_ROUND_UP_16 ##### -->
<para>
</para>
@num:
<!-- ##### MACRO GST_ROUND_UP_32 ##### -->
<para>
</para>
@num:
<!-- ##### MACRO GST_ROUND_UP_64 ##### -->
<para>
</para>
@num:
<!-- ##### FUNCTION gst_atomic_int_set ##### -->
<para>
</para>
@atomic_int:
@value:
<!-- ##### FUNCTION gst_bin_watch_for_state_change ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_flow_get_name ##### -->
<para>
</para>
@ret:
@Returns:
<!-- ##### FUNCTION gst_print_element_args ##### -->
<para>
</para>
@buf:
@indent:
@element:
<!-- ##### FUNCTION gst_print_pad_caps ##### -->
<para>
</para>
@buf:
@indent:
@pad:
<!-- ##### FUNCTION gst_util_dump_mem ##### -->
<para>
</para>
@mem:
@size:
<!-- ##### FUNCTION gst_util_set_object_arg ##### -->
<para>
</para>
@object:
@name:
@value:
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
<para>
</para>
@value:
@value_str:

216
docs/gst/tmpl/gstxml.sgml
View file

@ -1,216 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstXML
<!-- ##### SECTION Short_Description ##### -->
XML save/restore operations of pipelines
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstXML ##### -->
<para>
</para>
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- ##### USER_FUNCTION GstXMLRegistryClose ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### USER_FUNCTION GstXMLRegistryGetPerms ##### -->
<para>
</para>
@registry:
<!-- ##### USER_FUNCTION GstXMLRegistryLoad ##### -->
<para>
</para>
@registry:
@dest:
@size:
@Returns:
<!-- ##### ENUM GstXMLRegistryMode ##### -->
<para>
</para>
@GST_XML_REGISTRY_READ:
@GST_XML_REGISTRY_WRITE:
<!-- ##### USER_FUNCTION GstXMLRegistryOpen ##### -->
<para>
</para>
@registry:
@mode:
@Returns:
<!-- ##### USER_FUNCTION GstXMLRegistryParser ##### -->
<para>
</para>
@context:
@tag:
@text:
@text_len:
@registry:
@error:
@Returns:
<!-- ##### USER_FUNCTION GstXMLRegistrySave ##### -->
<para>
</para>
@registry:
@format:
@Varargs:
@Returns:
<!-- ##### ENUM GstXMLRegistryState ##### -->
<para>
</para>
@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:
<!-- ##### FUNCTION gst_xml_write ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_xml_write_file ##### -->
<para>
</para>
@element:
@out:
@Returns:
<!-- ##### FUNCTION gst_xml_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_xml_parse_doc ##### -->
<para>
</para>
@xml:
@doc:
@root:
@Returns:
<!-- ##### FUNCTION gst_xml_parse_file ##### -->
<para>
</para>
@xml:
@fname:
@root:
@Returns:
<!-- ##### FUNCTION gst_xml_parse_memory ##### -->
<para>
</para>
@xml:
@buffer:
@size:
@root:
@Returns:
<!-- ##### FUNCTION gst_xml_get_element ##### -->
<para>
</para>
@xml:
@name:
@Returns:
<!-- ##### FUNCTION gst_xml_get_topelements ##### -->
<para>
</para>
@xml:
@Returns:
<!-- ##### FUNCTION gst_xml_make_element ##### -->
<para>
</para>
@cur:
@parent:
@Returns:

5
gst/gsterror.c
View file

@ -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"

5
gst/gsterror.h
View file

@ -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);

11
gst/gstfilter.c
View file

@ -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 <gst/gstfilter.h>

8
gst/gsturi.c
View file

@ -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"

5
gst/gsturitype.c
View file

@ -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"

6
gst/gstutils.c
View file

@ -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 <stdio.h>
#include <string.h>

5
gst/gstxml.c
View file

@ -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"