From 0a602d04e053ebdb64fa6698399022b8ed805d0d Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Tue, 30 Mar 2004 09:15:47 +0000 Subject: [PATCH] more doc fixes Original commit message from CVS: more doc fixes --- ChangeLog | 14 ++++++ docs/gst/tmpl/gstutils.sgml | 98 ++----------------------------------- docs/gst/tmpl/gstxml.sgml | 10 ++-- gst/gstelement.c | 8 +-- gst/gstelementfactory.c | 4 +- gst/gstindex.c | 2 +- gst/gstinfo.c | 4 +- gst/gstpad.c | 4 +- gst/gstplugin.c | 6 +-- gst/gstvalue.c | 12 ++--- 10 files changed, 42 insertions(+), 120 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6d641274de..6247bc2efe 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,17 @@ +2004-03-30 Thomas Vander Stichele + + * 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 * docs/gst/Makefile.am: Disable a bunch of headers from being scanned diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index baaca622d4..291faf1bb9 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -1,19 +1,21 @@ -GstUtils +gstutils -Utility functions + -Some convenience functions + + + @@ -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: diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 06f83d762a..65734d63e7 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -115,10 +115,6 @@ GstXML -@: -@: -@: - @gstxml: the object which received the signal. @arg1: @arg2: @@ -128,7 +124,7 @@ GstXML -@gstxml: the object which received the signal. -@arg1: -@arg2: +@: +@: +@: diff --git a/gst/gstelement.c b/gst/gstelement.c index 56dd6b6021..73aaff206e 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -2447,10 +2447,10 @@ _gst_element_error_printf (const gchar * format, ...) * @message: an allocated message to be used as a replacement for the default * 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 + * default debugging information, or NULL + * @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. diff --git a/gst/gstelementfactory.c b/gst/gstelementfactory.c index 14c8c78adf..bbe2f451d9 100644 --- a/gst/gstelementfactory.c +++ b/gst/gstelementfactory.c @@ -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 diff --git a/gst/gstindex.c b/gst/gstindex.c index 96ddf2a15f..ac17fa1cbd 100644 --- a/gst/gstindex.c +++ b/gst/gstindex.c @@ -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) diff --git a/gst/gstinfo.c b/gst/gstinfo.c index 9363631939..2600f471e5 100644 --- a/gst/gstinfo.c +++ b/gst/gstinfo.c @@ -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) diff --git a/gst/gstpad.c b/gst/gstpad.c index 4ba1bdd556..ee88b71afb 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -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 * diff --git a/gst/gstplugin.c b/gst/gstplugin.c index 5954e01912..04225a7602 100644 --- a/gst/gstplugin.c +++ b/gst/gstplugin.c @@ -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. */ diff --git a/gst/gstvalue.c b/gst/gstvalue.c index fc751ead0d..774c8a5d9d 100644 --- a/gst/gstvalue.c +++ b/gst/gstvalue.c @@ -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: