mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

some docs style cleanups

Browse source 
Original commit message from CVS:
some docs style cleanups
This commit is contained in:
Thomas Vander Stichele 2003-12-22 10:51:03 +00:00
parent 487f0893ee
commit 50b7bcab86
1 changed files with 44 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
gst/gstinfo.c
View file

@ -735,9 +735,9 @@ _gst_debug_category_new (gchar *name, guint color, gchar *description)
} }
/** /**
* gst_debug_category_free: * gst_debug_category_free:
* @category: category to remove * @category: #GstDebugCategory to free.
* *
* Removes and frees the category and all associated ressources. * Removes and frees the category and all associated resources.
*/ */
void void
gst_debug_category_free (GstDebugCategory *category) gst_debug_category_free (GstDebugCategory *category)
@ -755,10 +755,11 @@ gst_debug_category_free (GstDebugCategory *category)
g_free (category->threshold); g_free (category->threshold);
g_free (category); g_free (category);
} }
/** /**
* gst_debug_category_set_threshold: * gst_debug_category_set_threshold:
* @category: category to set threshold for * @category: a #GstDebugCategory to set threshold of.
* @level: the threshold to set * @level: the #GstDebugLevel threshold to set.
* *
* Sets the threshold of the category to the given level. Debug information will * Sets the threshold of the category to the given level. Debug information will
* only be output if the threshold is lower or equal to the level of the * only be output if the threshold is lower or equal to the level of the
@ -776,9 +777,10 @@ gst_debug_category_set_threshold (GstDebugCategory *category, GstDebugLevel leve
gst_atomic_int_set (category->threshold, level); gst_atomic_int_set (category->threshold, level);
} }
/** /**
* gst_debug_category_reset_threshold: * gst_debug_category_reset_threshold:
* @category: category to set threshold for * @category: a #GstDebugCategory to reset threshold of.
* *
* Resets the threshold of the category to the default level. Debug information * Resets the threshold of the category to the default level. Debug information
* will only be output if the threshold is lower or equal to the level of the * will only be output if the threshold is lower or equal to the level of the
@ -791,52 +793,57 @@ gst_debug_category_reset_threshold (GstDebugCategory *category)
{ {
gst_debug_reset_threshold (category, NULL); gst_debug_reset_threshold (category, NULL);
} }
/** /**
* gst_debug_category_get_threshold: * gst_debug_category_get_threshold:
* @category: category to get threshold for * @category: a #GstDebugCategory to get threshold of.
* *
* Returns the threshold of a #GstCategory. * Returns the threshold of a #GstCategory.
* *
* Returns: the level that is used as threshold * Returns: the #GstDebugLevel that is used as threshold.
*/ */
GstDebugLevel GstDebugLevel
gst_debug_category_get_threshold (GstDebugCategory *category) gst_debug_category_get_threshold (GstDebugCategory *category)
{ {
return gst_atomic_int_read (category->threshold); return gst_atomic_int_read (category->threshold);
} }
/** /**
* gst_debug_category_get_name: * gst_debug_category_get_name:
* @category: category to get name for * @category: a #GstDebugCategory to get name of.
* *
* Returns the name of a #GstCategory. * Returns the name of a debug category.
* *
* Returns: the name of the category * Returns: the name of the category.
*/ */
const gchar * const gchar *
gst_debug_category_get_name (GstDebugCategory *category) gst_debug_category_get_name (GstDebugCategory *category)
{ {
return category->name; return category->name;
} }
/** /**
* gst_debug_category_get_color: * gst_debug_category_get_color:
* @category: category to get color for * @category: a #GstDebugCategory to get the color of.
* *
* Returns the color of a #GstCategory to use when outputting this. * Returns the color of a debug category used when printing output in this
* category.
* *
* Returns: the color of the category * Returns: the color of the category.
*/ */
guint guint
gst_debug_category_get_color (GstDebugCategory *category) gst_debug_category_get_color (GstDebugCategory *category)
{ {
return category->color; return category->color;
} }
/** /**
* gst_debug_category_get_description: * gst_debug_category_get_description:
* @category: category to get description for * @category: a #GstDebugCategory to get the description of.
* *
* Returns the description of a #GstCategory * Returns the description of a debug category.
* *
* Returns: the description of the category * Returns: the description of the category.
*/ */
const gchar * const gchar *
gst_debug_category_get_description (GstDebugCategory *category) gst_debug_category_get_description (GstDebugCategory *category)