mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 08:46:40 +00:00
more doc fixes
Original commit message from CVS: more doc fixes
This commit is contained in:
Thomas Vander Stichele
parent
8ce063f780
commit
0a602d04e0
10 changed files with 42 additions and 120 deletions
14
ChangeLog
14
ChangeLog
|
|
@ -1,3 +1,17 @@
|
|||
2004-03-30 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* gst/gstcaps.c:
|
||||
* gst/gstelement.c:
|
||||
* gst/gstelementfactory.c: (gst_element_factory_get_type):
|
||||
* gst/gstindex.c: (gst_index_resolver_get_type),
|
||||
(gst_index_get_type), (gst_index_factory_get_type):
|
||||
* gst/gstinfo.c:
|
||||
* gst/gstpad.c:
|
||||
* gst/gstplugin.c:
|
||||
* gst/gsturi.c: (gst_uri_handler_get_type):
|
||||
* gst/gstvalue.c:
|
||||
first batch of documentation fixes
|
||||
|
||||
2004-03-29 David Schleef <ds@schleef.org>
|
||||
|
||||
* docs/gst/Makefile.am: Disable a bunch of headers from being scanned
|
||||
|
|
|
|||
|
|
@ -1,19 +1,21 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstUtils
|
||||
gstutils
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Utility functions
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Some convenience functions
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -70,96 +72,6 @@ Some convenience functions
|
|||
@type:
|
||||
@type_as_function:
|
||||
@parent_type:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@\
|
||||
parent_type_macro:
|
||||
@additional_initializations:
|
||||
|
|
|
|||
|
|
@ -115,10 +115,6 @@ GstXML
|
|||
|
||||
</para>
|
||||
|
||||
@:
|
||||
@:
|
||||
@:
|
||||
|
||||
@gstxml: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
|
@ -128,7 +124,7 @@ GstXML
|
|||
|
||||
</para>
|
||||
|
||||
@gstxml: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
@:
|
||||
@:
|
||||
@:
|
||||
|
||||
|
|
|
|||
|
|
@ -2448,9 +2448,9 @@ _gst_element_error_printf (const gchar * format, ...)
|
|||
* message connected to code, or NULL
|
||||
* @debug: an allocated debug message to be used as a replacement for the
|
||||
* default debugging information, or NULL
|
||||
* @file: source filename
|
||||
* @function: source function
|
||||
* @line: source line
|
||||
* @file: the source code file where the error was generated
|
||||
* @function: the source code function where the error was generated
|
||||
* @line: the source code line where the error was generated
|
||||
*
|
||||
* Signals an error condition on an element.
|
||||
* This function is used internally by elements.
|
||||
|
|
|
|||
|
|
@ -176,12 +176,12 @@ gst_element_factory_cleanup (GstElementFactory * factory)
|
|||
|
||||
/**
|
||||
* gst_element_register:
|
||||
* @plugin:
|
||||
* @plugin: #GstPlugin to register the element with
|
||||
* @name: name of elements of this type
|
||||
* @rank: rank of element (higher rank means more importance when autoplugging)
|
||||
* @type: GType of element to register
|
||||
*
|
||||
* Create a new elementfactory capable of insantiating objects of the
|
||||
* Create a new elementfactory capable of instantiating objects of the
|
||||
* given type.
|
||||
*
|
||||
* Returns: TRUE, if the registering succeeded, FALSE on error
|
||||
|
|
|
|||
|
|
@ -413,7 +413,7 @@ gst_index_set_resolver (GstIndex * index,
|
|||
*
|
||||
* Copies an entry and returns the result.
|
||||
*
|
||||
* Returns:
|
||||
* Returns: a newly allocated #GstIndexEntry.
|
||||
*/
|
||||
GstIndexEntry *
|
||||
gst_index_entry_copy (GstIndexEntry * entry)
|
||||
|
|
|
|||
|
|
@ -317,10 +317,10 @@ gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
|
|||
* gst_debug_message_get:
|
||||
* @message: a debug message
|
||||
*
|
||||
* Gets the string representation of a GstDebugMessage. This function is used
|
||||
* Gets the string representation of a #GstDebugMessage. This function is used
|
||||
* in debug handlers to extract the message.
|
||||
*
|
||||
* Returns: the string representation
|
||||
* Returns: the string representation of a #GstDebugMessage.
|
||||
*/
|
||||
const gchar *
|
||||
gst_debug_message_get (GstDebugMessage * message)
|
||||
|
|
|
|||
|
|
@ -2261,7 +2261,7 @@ gst_pad_proxy_getcaps (GstPad * pad)
|
|||
|
||||
/**
|
||||
* gst_pad_proxy_pad_link:
|
||||
* @pad: a #GstPad to proxy.
|
||||
* @pad: a #GstPad to proxy from
|
||||
* @caps: the #GstCaps to link with
|
||||
*
|
||||
* Calls gst_pad_try_set_caps() for every other pad belonging to the
|
||||
|
|
@ -2760,7 +2760,7 @@ gst_pad_recover_caps_error (GstPad * pad, const GstCaps * allowed)
|
|||
|
||||
/**
|
||||
* gst_pad_alloc_buffer:
|
||||
* @pad: a source #GstPad.
|
||||
* @pad: a source #GstPad
|
||||
* @offset: the offset of the new buffer in the stream
|
||||
* @size: the size of the new buffer
|
||||
*
|
||||
|
|
|
|||
|
|
@ -277,10 +277,10 @@ static void _gst_plugin_fault_handler_setup ();
|
|||
|
||||
/**
|
||||
* gst_plugin_load_file:
|
||||
* @filename: The file to load
|
||||
* @error: Pointer to a NULL-valued GError.
|
||||
* @filename: the plugin filename to load
|
||||
* @error: pointer to a NULL-valued GError
|
||||
*
|
||||
* Load the given plugin.
|
||||
* Loads the given plugin.
|
||||
*
|
||||
* Returns: a new GstPlugin or NULL, if an error occurred.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -188,7 +188,7 @@ gst_value_list_get_size (const GValue * value)
|
|||
/**
|
||||
* gst_value_list_get_value:
|
||||
* @value: a GstValueList
|
||||
* @index: the index
|
||||
* @index: index of value to get from the list
|
||||
*
|
||||
* Gets the value that is a member of the list contained in @value and
|
||||
* has the index @index.
|
||||
|
|
@ -1283,7 +1283,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func)
|
|||
|
||||
/* intersection */
|
||||
|
||||
/**
|
||||
/*
|
||||
* gst_value_can_intersect:
|
||||
* @value1:
|
||||
* @value2:
|
||||
|
|
@ -1378,7 +1378,7 @@ gst_value_register_intersect_func (GType type1, GType type2,
|
|||
g_array_append_val (gst_value_intersect_funcs, intersect_info);
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* gst_value_register:
|
||||
* @table:
|
||||
*
|
||||
|
|
@ -1389,7 +1389,7 @@ gst_value_register (const GstValueTable * table)
|
|||
g_array_append_val (gst_value_table, *table);
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* gst_value_init_and_copy:
|
||||
* @dest:
|
||||
* @src:
|
||||
|
|
@ -1402,7 +1402,7 @@ gst_value_init_and_copy (GValue * dest, const GValue * src)
|
|||
g_value_copy (src, dest);
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* gst_value_serialize:
|
||||
* @value:
|
||||
*
|
||||
|
|
@ -1432,7 +1432,7 @@ gst_value_serialize (const GValue * value)
|
|||
return s;
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* gst_value_deserialize:
|
||||
* @dest:
|
||||
* @src:
|
||||
|
|
|
|||
Loading…
Reference in a new issue