mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-11 01:45:33 +00:00
docs/gst/: Documentation updates for registry changes.
Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/gstreamer.types: * docs/gst/tmpl/gstelement.sgml: * docs/gst/tmpl/gstplugin.sgml: * docs/gst/tmpl/gstpluginfeature.sgml: Documentation updates for registry changes.
This commit is contained in:
parent
faeaea4498
commit
3af87b55a5
7 changed files with 27 additions and 68 deletions
10
ChangeLog
10
ChangeLog
|
@ -1,3 +1,13 @@
|
||||||
|
2005-09-14 David Schleef <ds@schleef.org>
|
||||||
|
|
||||||
|
* docs/gst/gstreamer-docs.sgml:
|
||||||
|
* docs/gst/gstreamer-sections.txt:
|
||||||
|
* docs/gst/gstreamer.types:
|
||||||
|
* docs/gst/tmpl/gstelement.sgml:
|
||||||
|
* docs/gst/tmpl/gstplugin.sgml:
|
||||||
|
* docs/gst/tmpl/gstpluginfeature.sgml:
|
||||||
|
Documentation updates for registry changes.
|
||||||
|
|
||||||
2005-09-14 David Schleef <ds@schleef.org>
|
2005-09-14 David Schleef <ds@schleef.org>
|
||||||
|
|
||||||
* gst/gstregistryxml.c: Copy g_mkdir_with_parent() from glib,
|
* gst/gstregistryxml.c: Copy g_mkdir_with_parent() from glib,
|
||||||
|
|
|
@ -58,7 +58,6 @@
|
||||||
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
||||||
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
||||||
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
||||||
<!ENTITY GstXMLRegistry SYSTEM "xml/gstxmlregistry.xml">
|
|
||||||
|
|
||||||
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
|
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
|
||||||
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
|
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
|
||||||
|
@ -149,7 +148,6 @@
|
||||||
&GstValue;
|
&GstValue;
|
||||||
&GstVersion;
|
&GstVersion;
|
||||||
&GstXML;
|
&GstXML;
|
||||||
&GstXMLRegistry;
|
|
||||||
|
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|
||||||
|
|
|
@ -2197,23 +2197,6 @@ gst_xml_get_type
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstxmlregistry</FILE>
|
|
||||||
<TITLE>GstXMLRegistry</TITLE>
|
|
||||||
GstXMLRegistry
|
|
||||||
gst_xml_registry_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstXMLRegistryClass
|
|
||||||
GST_XML_REGISTRY
|
|
||||||
GST_IS_XML_REGISTRY
|
|
||||||
GST_XML_REGISTRY_CLASS
|
|
||||||
GST_IS_XML_REGISTRY_CLASS
|
|
||||||
GST_XML_REGISTRY_GET_CLASS
|
|
||||||
GST_TYPE_XML_REGISTRY
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_xml_registry_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gstenumtypes</FILE>
|
<FILE>gstenumtypes</FILE>
|
||||||
<TITLE>GstEnumTypes</TITLE>
|
<TITLE>GstEnumTypes</TITLE>
|
||||||
|
|
|
@ -34,12 +34,6 @@ gst_task_get_type
|
||||||
gst_type_find_factory_get_type
|
gst_type_find_factory_get_type
|
||||||
gst_xml_get_type
|
gst_xml_get_type
|
||||||
|
|
||||||
%registries
|
|
||||||
|
|
||||||
#include <gst/registries/gstlibxmlregistry.h>
|
|
||||||
|
|
||||||
gst_xml_registry_get_type
|
|
||||||
|
|
||||||
% base classes
|
% base classes
|
||||||
|
|
||||||
#include <gst/base/gstadapter.h>
|
#include <gst/base/gstadapter.h>
|
||||||
|
|
|
@ -973,6 +973,16 @@ Sets the parent of an element.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_element_set_state_async ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@element:
|
||||||
|
@state:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_element_state_get_name ##### -->
|
<!-- ##### FUNCTION gst_element_state_get_name ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
|
@ -67,13 +67,6 @@ The plugin loading errors
|
||||||
The plugin object
|
The plugin object
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@desc:
|
|
||||||
@filename:
|
|
||||||
@features:
|
|
||||||
@numfeatures:
|
|
||||||
@manager:
|
|
||||||
@module:
|
|
||||||
@_gst_reserved:
|
|
||||||
|
|
||||||
<!-- ##### STRUCT GstPluginDesc ##### -->
|
<!-- ##### STRUCT GstPluginDesc ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -86,7 +79,6 @@ loaded will use this variable to initialize the plugin.
|
||||||
@name: a unique name of the plugin
|
@name: a unique name of the plugin
|
||||||
@description:
|
@description:
|
||||||
@plugin_init: The init function of this plugin.
|
@plugin_init: The init function of this plugin.
|
||||||
@plugin_exit:
|
|
||||||
@version: version of the plugin
|
@version: version of the plugin
|
||||||
@license: effective license of plugin
|
@license: effective license of plugin
|
||||||
@source:
|
@source:
|
||||||
|
@ -106,14 +98,6 @@ It will be called by the loader at statup.
|
||||||
@module: The <classname>GModule</classname> it was loaded from
|
@module: The <classname>GModule</classname> it was loaded from
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### USER_FUNCTION GstPluginExitFunc ##### -->
|
|
||||||
<para>
|
|
||||||
Exiting function when plugin is unloaded.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@plugin: The plugin object that can be used to unregister stuff for this plugin.
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### MACRO GST_PLUGIN_DEFINE ##### -->
|
<!-- ##### MACRO GST_PLUGIN_DEFINE ##### -->
|
||||||
<para>
|
<para>
|
||||||
This macro needs to be used to define the entry point and meta data of a plugin.
|
This macro needs to be used to define the entry point and meta data of a plugin.
|
||||||
|
@ -129,6 +113,8 @@ One would use this macro to export a plugin, so that it can be used by other app
|
||||||
@license: under which licence the package has been released, e.g. GPL, LGPL.
|
@license: under which licence the package has been released, e.g. GPL, LGPL.
|
||||||
@package: the package-name (e.g. PACKAGE_NAME from config.h)
|
@package: the package-name (e.g. PACKAGE_NAME from config.h)
|
||||||
@origin: a description from where the package comes from (e.g. the homepage URL)
|
@origin: a description from where the package comes from (e.g. the homepage URL)
|
||||||
|
<!-- # Unused Parameters # -->
|
||||||
|
@domain:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### MACRO GST_PLUGIN_DEFINE_STATIC ##### -->
|
<!-- ##### MACRO GST_PLUGIN_DEFINE_STATIC ##### -->
|
||||||
|
@ -146,6 +132,8 @@ One would use this macro to define a local plugin that can only be used by the o
|
||||||
@license: under which licence the package has been released, e.g. GPL, LGPL.
|
@license: under which licence the package has been released, e.g. GPL, LGPL.
|
||||||
@package: the package-name (e.g. PACKAGE_NAME from config.h)
|
@package: the package-name (e.g. PACKAGE_NAME from config.h)
|
||||||
@origin: a description from where the package comes from (e.g. the homepage URL)
|
@origin: a description from where the package comes from (e.g. the homepage URL)
|
||||||
|
<!-- # Unused Parameters # -->
|
||||||
|
@domain:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### MACRO GST_LICENSE_UNKNOWN ##### -->
|
<!-- ##### MACRO GST_LICENSE_UNKNOWN ##### -->
|
||||||
|
@ -330,15 +318,6 @@ to get a list of plugins that match certain criteria.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_plugin_unload_plugin ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@plugin:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_plugin_add_feature ##### -->
|
<!-- ##### FUNCTION gst_plugin_add_feature ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -353,7 +332,9 @@ to get a list of plugins that match certain criteria.
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@name:
|
@plugin:
|
||||||
@Returns:
|
@Returns:
|
||||||
|
<!-- # Unused Parameters # -->
|
||||||
|
@name:
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -50,23 +50,6 @@ to get a list of pluginfeature that match certain criteria.
|
||||||
@Returns: TRUE for a positive match, FALSE otherwise
|
@Returns: TRUE for a positive match, FALSE otherwise
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_plugin_feature_ensure_loaded ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@feature:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_plugin_feature_unload_thyself ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@feature:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_plugin_feature_type_name_filter ##### -->
|
<!-- ##### FUNCTION gst_plugin_feature_type_name_filter ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue