summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Noël <corentin.noel@collabora.com>2021-11-05 11:24:17 +0100
committerCorentin Noël <corentin.noel@collabora.com>2021-11-05 11:24:17 +0100
commite92441a85d4191f270459d0fca763cd145e3be62 (patch)
tree4fceec3a357abc11587f3131adf4c6c8f4068a60
parent96593808296617ac00950cbf1a856b15fa4184c2 (diff)
downloadlibical-git-e92441a85d4191f270459d0fca763cd145e3be62.tar.gz
libical-glib: Enhance comments on i_cal_time_get_timezone
This ICalTimezone lifetime is a little bit special to reduce the allocated memory.
-rw-r--r--src/libical-glib/api/i-cal-time.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/libical-glib/api/i-cal-time.xml b/src/libical-glib/api/i-cal-time.xml
index be6e2685..4a97f226 100644
--- a/src/libical-glib/api/i-cal-time.xml
+++ b/src/libical-glib/api/i-cal-time.xml
@@ -86,7 +86,7 @@
<method name="i_cal_time_get_timezone" corresponds="(void *)icaltime_get_timezone" kind="get" since="1.0">
<parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/>
<returns type="ICalTimezone *" annotation="transfer none" translator_argus="(GObject *)tt, TRUE" comment="The timezone information" />
- <comment xml:space="preserve">Returns the timezone.</comment>
+ <comment xml:space="preserve">Returns the timezone, the #ICalTimezone object is cached and can be either unreferenced once the last instance is used or can be kept until i_cal_object_free_global_objects() is called (usually at the very end of the program).</comment>
</method>
<method name="i_cal_time_set_timezone" corresponds="icaltime_set_timezone" kind="set" since="1.0">
<parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The #ICalTime"/>