From 16733a82f476177edb569686bf2e7c15abfea43b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Wed, 25 Nov 2020 13:35:57 +0200 Subject: [PATCH] datetime: Improve documentation a bit to explain when NULL is returned Part-of: --- gst/gstdatetime.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/gst/gstdatetime.c b/gst/gstdatetime.c index 4b57c6e209..d61afd15e4 100644 --- a/gst/gstdatetime.c +++ b/gst/gstdatetime.c @@ -70,14 +70,14 @@ static void gst_date_time_free (GstDateTime * datetime); /** * gst_date_time_new_from_g_date_time: - * @dt: (transfer full): the #GDateTime. The new #GstDateTime takes ownership. + * @dt: (transfer full) (nullable): the #GDateTime. The new #GstDateTime takes ownership. * * Creates a new #GstDateTime from a #GDateTime object. * * Free-function: gst_date_time_unref * * Returns: (transfer full) (nullable): a newly created #GstDateTime, - * or %NULL on error + * or %NULL if @dt is %NULL. */ GstDateTime * gst_date_time_new_from_g_date_time (GDateTime * dt) @@ -106,7 +106,8 @@ gst_date_time_new_from_g_date_time (GDateTime * dt) * Free-function: g_date_time_unref * * Returns: (transfer full) (nullable): a newly created #GDateTime, or - * %NULL on error + * %NULL on error or if @datetime does not have a year, month, day, hour, + * minute and second. */ GDateTime * gst_date_time_to_g_date_time (GstDateTime * datetime)