From: Jan Schmidt Date: Thu, 21 Jun 2007 16:39:01 +0000 (+0000) Subject: Beef up and include the docs for gst_type_register_static_full and gst_element_class_... X-Git-Tag: RELEASE-0_10_14~63 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=71766af8c2db5b4fb641a0a0738d8da4957968e7;p=platform%2Fupstream%2Fgstreamer.git Beef up and include the docs for gst_type_register_static_full and gst_element_class_set_details_simple and add the A... Original commit message from CVS: * docs/gst/gstreamer-sections.txt: * gst/gstelement.c: * gst/gstutils.c: (gst_type_register_static_full): Beef up and include the docs for gst_type_register_static_full and gst_element_class_set_details_simple and add the API keyword in the ChangeLog. --- diff --git a/ChangeLog b/ChangeLog index c3c33c7..5031006 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,14 @@ 2007-06-21 Jan Schmidt + * docs/gst/gstreamer-sections.txt: + * gst/gstelement.c: + * gst/gstutils.c: (gst_type_register_static_full): + Beef up and include the docs for gst_type_register_static_full and + gst_element_class_set_details_simple and add the API keyword + in the ChangeLog. + +2007-06-21 Jan Schmidt + * plugins/elements/gstmultiqueue.c: (gst_multi_queue_set_property), (update_time_level), (gst_single_queue_push_one), (gst_multi_queue_chain), (gst_multi_queue_sink_event), @@ -33,6 +42,8 @@ (gst_type_find_element_base_init), (gst_type_find_element_class_init): Saving relocations for GTypeInfo and GstElementDetails. Fixes #437457. + API: add gst_type_register_static_full + API: add gst_element_class_set_details_simple 2007-06-21 Tim-Philipp Müller diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 4346a35..55b943d 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -447,6 +447,7 @@ gst_element_class_get_pad_template gst_element_class_get_pad_template_list gst_element_class_install_std_props gst_element_class_set_details +gst_element_class_set_details_simple gst_element_add_pad @@ -2139,6 +2140,7 @@ gst_print_element_args gst_print_pad_caps gst_guint64_to_gdouble gst_gdouble_to_guint64 +gst_type_register_static_full gst_util_dump_mem gst_util_uint64_scale gst_util_uint64_scale_int diff --git a/gst/gstelement.c b/gst/gstelement.c index e548c55..68e6792 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -1140,16 +1140,23 @@ gst_element_class_set_details (GstElementClass * klass, /** * gst_element_class_set_details_simple: * @klass: class to set details for - * @longname: details - * @classification: details - * @description: details - * @author: details + * @longname: The long English name of the element. E.g. "File Sink" + * @classification: String describing the type of element, as an unordered list + * separated with slashes ('/'). See draft-klass.txt of the design docs + * for more details and common types. E.g: "Sink/File" + * @description: Sentence describing the purpose of the element. + * E.g: "Write stream to a file" + * @author: Name and contact details of the author(s). Use \n to separate + * multiple author details. E.g: "Joe Bloggs <joe.blogs at foo.com>" * * Sets the detailed information for a #GstElementClass. Simpler version of - * gst_element_class_set_details() that generates less liker overhead. + * gst_element_class_set_details() that generates less linker overhead. * This function is for use in _base_init functions only. * - * The detail-strings are copied. + * The detail parameter strings are copied into the #GstElementDetails for + * the element class. + * + * Since: 0.10.14 */ void gst_element_class_set_details_simple (GstElementClass * klass, gchar * longname, diff --git a/gst/gstutils.c b/gst/gstutils.c index 7c433df..99445eb 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -3256,6 +3256,45 @@ gst_parse_bin_from_description (const gchar * bin_description, #endif } +/** + * gst_type_register_static_full: + * @parent_type: The GType of the parent type the newly registered type will + * derive from + * @type_name: NULL-terminated string used as the name of the new type + * @class_size: Size of the class structure. + * @base_init: Location of the base initialization function (optional). + * @base_finalize: Location of the base finalization function (optional). + * @class_init: Location of the class initialization function for class types + * Location of the default vtable inititalization function for interface + * types. (optional) + * @class_finalize: Location of the class finalization function for class types. + * Location of the default vtable finalization function for interface types. + * (optional) + * @class_data: User-supplied data passed to the class init/finalize functions. + * @instance_size: Size of the instance (object) structure (required for + * instantiatable types only). + * @n_preallocs: The number of pre-allocated (cached) instances to reserve + * memory for (0 indicates no caching). Ignored on recent GLib's. + * @instance_init: Location of the instance initialization function (optional, + * for instantiatable types only). + * @value_table: A GTypeValueTable function table for generic handling of + * GValues of this type (usually only useful for fundamental types). + * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT + * + * Helper function which constructs a #GTypeInfo structure and registers a + * GType, but which generates less linker overhead than a static const + * #GTypeInfo structure. For further details of the parameters, please see + * #GTypeInfo in the GLib documentation. + * + * Registers type_name as the name of a new static type derived from + * parent_type. The value of flags determines the nature (e.g. abstract or + * not) of the type. It works by filling a GTypeInfo struct and calling + * g_type_info_register_static(). + * + * Returns: A #GType for the newly-registered type. + * + * Since: 0.10.14 + */ GType gst_type_register_static_full (GType parent_type, const gchar * type_name,