From 167306dbe019197f5c245afd4a46f41ba940aa06 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 2 Dec 2015 13:50:02 +0100 Subject: [PATCH] validate: Add some documentation and annotiations --- validate/gst/validate/gst-validate-utils.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/validate/gst/validate/gst-validate-utils.c b/validate/gst/validate/gst-validate-utils.c index e948a10d12..0a6c8707ee 100644 --- a/validate/gst/validate/gst-validate-utils.c +++ b/validate/gst/validate/gst-validate-utils.c @@ -679,6 +679,18 @@ done: return result; } +/** + * gst_validate_utils_get_clocktime: + * @structure: A #GstStructure to retrieve @name as a GstClockTime. + * @name: The name of the field containing a #GstClockTime + * @retval: (out): The clocktime contained in @structure + * + * Get @name from @structure as a #GstClockTime, it handles various types + * for the value, if it is a double, it conciders the value to be in second + * it can be a gint, gint64 a guint, a gint64. + * + * Return: %TRUE in case of success, %FALSE otherwize. + */ gboolean gst_validate_utils_get_clocktime (GstStructure * structure, const gchar * name, GstClockTime * retval)