2007-06-21 Jan Schmidt <thaytan@mad.scientist.com>
+ * 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 <thaytan@mad.scientist.com>
+
* 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),
(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 <tim at centricular dot net>
gst_element_class_get_pad_template_list
gst_element_class_install_std_props
gst_element_class_set_details
+gst_element_class_set_details_simple
<SUBSECTION element-pads>
gst_element_add_pad
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
/**
* 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.
* <note>This function is for use in _base_init functions only.</note>
*
- * 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,
#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,