Commit d53d6fb8 authored by Stefan Kost's avatar Stefan Kost

Another conditional doc check.

Original commit message from CVS:
* configure.ac:
* docs/gst/gstreamer.types.in:
Another conditional doc check.
* gst/gstmessage.c:
* gst/gstparamspecs.h:
* gst/gstregistrybinary.c: (gst_registry_binary_read_cache):
* gst/gstvalue.c:
* gst/gstxml.h:
API-doc fixes.
parent f1235bdb
2007-07-25 Stefan Kost <ensonic@users.sf.net>
* configure.ac:
* docs/gst/gstreamer.types.in:
Another conditional doc check.
* gst/gstmessage.c:
* gst/gstparamspecs.h:
* gst/gstregistrybinary.c: (gst_registry_binary_read_cache):
* gst/gstvalue.c:
* gst/gstxml.h:
API-doc fixes.
2007-07-24 Stefan Kost <ensonic@users.sf.net> 2007-07-24 Stefan Kost <ensonic@users.sf.net>
* gst/gstregistrybinary.c: (gst_registry_binary_check_magic), * gst/gstregistrybinary.c: (gst_registry_binary_check_magic),
......
...@@ -106,6 +106,14 @@ AG_GST_CHECK_SUBSYSTEM_DISABLE(ENUMTYPES,[enum types]) ...@@ -106,6 +106,14 @@ AG_GST_CHECK_SUBSYSTEM_DISABLE(ENUMTYPES,[enum types])
AM_CONDITIONAL(GST_DISABLE_ENUMTYPES, test "x$GST_DISABLE_ENUMTYPES" = "xyes") AM_CONDITIONAL(GST_DISABLE_ENUMTYPES, test "x$GST_DISABLE_ENUMTYPES" = "xyes")
AG_GST_CHECK_SUBSYSTEM_DISABLE(INDEX,[index]) AG_GST_CHECK_SUBSYSTEM_DISABLE(INDEX,[index])
AM_CONDITIONAL(GST_DISABLE_INDEX, test "x$GST_DISABLE_INDEX" = "xyes") AM_CONDITIONAL(GST_DISABLE_INDEX, test "x$GST_DISABLE_INDEX" = "xyes")
dnl define a substitution to use in docs/gst/gstreamer.types
if test "x$GST_DISABLE_INDEX" = "xyes"
then
GST_INDEX_DOC_TYPES="%"
else
GST_INDEX_DOC_TYPES=
fi
AC_SUBST(GST_INDEX_DOC_TYPES)
AG_GST_CHECK_SUBSYSTEM_DISABLE(NET,[network distribution]) AG_GST_CHECK_SUBSYSTEM_DISABLE(NET,[network distribution])
AM_CONDITIONAL(GST_DISABLE_NET, test "x$GST_DISABLE_NET" = "xyes") AM_CONDITIONAL(GST_DISABLE_NET, test "x$GST_DISABLE_NET" = "xyes")
AG_GST_CHECK_SUBSYSTEM_DISABLE(PLUGIN,[plugin]) AG_GST_CHECK_SUBSYSTEM_DISABLE(PLUGIN,[plugin])
......
...@@ -15,8 +15,8 @@ gst_element_factory_get_type ...@@ -15,8 +15,8 @@ gst_element_factory_get_type
gst_element_get_type gst_element_get_type
gst_ghost_pad_get_type gst_ghost_pad_get_type
gst_implements_interface_get_type gst_implements_interface_get_type
gst_index_factory_get_type @GST_INDEX_DOC_TYPES@gst_index_factory_get_type
gst_index_get_type @GST_INDEX_DOC_TYPES@gst_index_get_type
gst_registry_get_type gst_registry_get_type
% these are not GObject derived types ! % these are not GObject derived types !
......
...@@ -757,6 +757,8 @@ gst_message_new_async_start (GstObject * src, gboolean new_base_time) ...@@ -757,6 +757,8 @@ gst_message_new_async_start (GstObject * src, gboolean new_base_time)
* gst_message_new_async_done: * gst_message_new_async_done:
* @src: The object originating the message. * @src: The object originating the message.
* *
* The message is posted when elements completed an ASYNC state change.
*
* Returns: The new async_done message. * Returns: The new async_done message.
* *
* MT safe. * MT safe.
......
...@@ -40,6 +40,19 @@ GType gst_param_spec_fraction_get_type (void); ...@@ -40,6 +40,19 @@ GType gst_param_spec_fraction_get_type (void);
typedef struct _GstParamSpecFraction GstParamSpecFraction; typedef struct _GstParamSpecFraction GstParamSpecFraction;
/**
* GstParamSpecFraction:
* @parent_instance: super class
* @min_num: minimal numerator
* @min_den: minimal denominator
* @max_num: maximal numerator
* @max_den: maximal denominator
* @def_num: default numerator
* @def_den: default denominator
*
* A GParamSpec derived structure that contains the meta data for fractional
* properties.
*/
struct _GstParamSpecFraction { struct _GstParamSpecFraction {
GParamSpec parent_instance; GParamSpec parent_instance;
......
...@@ -441,8 +441,12 @@ fail: ...@@ -441,8 +441,12 @@ fail:
/** /**
* gst_registry_binary_write_cache: * gst_registry_binary_write_cache:
* @registry: a #GstRegistry
* @location: a filename
* *
* Write the cache to file. Part of the code was taken from gstregistryxml.c * Write the @registry to a cache to file at given @location.
*
* Returns: %TRUE on success.
*/ */
gboolean gboolean
gst_registry_binary_write_cache (GstRegistry * registry, const char *location) gst_registry_binary_write_cache (GstRegistry * registry, const char *location)
......
...@@ -3146,18 +3146,6 @@ gst_value_register_subtract_func (GType minuend_type, GType subtrahend_type, ...@@ -3146,18 +3146,6 @@ gst_value_register_subtract_func (GType minuend_type, GType subtrahend_type,
* Registers functions to perform calculations on #GValues of a given * Registers functions to perform calculations on #GValues of a given
* type. * type.
*/ */
/**
* GstValueTable:
* @type: GType that the functions operate on.
* @compare: A function that compares two values of this type.
* @serialize: A function that transforms a value of this type to a
* string. Strings created by this function must be unique and should
* be human readable.
* @deserialize: A function that transforms a string to a value of
* this type. This function must transform strings created by the
* serialize function back to the original value. This function may
* optionally transform other strings into values.
*/
void void
gst_value_register (const GstValueTable * table) gst_value_register (const GstValueTable * table)
{ {
......
...@@ -43,17 +43,21 @@ typedef struct _GstXMLClass GstXMLClass; ...@@ -43,17 +43,21 @@ typedef struct _GstXMLClass GstXMLClass;
/** /**
* GstXML: * GstXML:
* @object: parent object
* @topelements: list of element nodes
* @ns: name space
* *
* XML parser object * XML parser object
*/ */
struct _GstXML { struct _GstXML {
GstObject object; GstObject object;
/*< public >*/
GList *topelements; GList *topelements;
xmlNsPtr ns; xmlNsPtr ns;
/*< private >*/ /*< private >*/
gpointer _gst_reserved[GST_PADDING]; gpointer _gst_reserved[GST_PADDING];
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment