[libical-glib] Add more comment on the method i_cal_timezone_destroy to differentiate it from i_cal_timezone_free



commit 0e82a5705371b66d023ac32adb475aa0c5e2c0dc
Author: William Yu <williamyu gnome org>
Date:   Sat Mar 21 10:44:20 2015 -0400

    Add more comment on the method i_cal_timezone_destroy to differentiate it from i_cal_timezone_free

 src/api/i-cal-timezone.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
---
diff --git a/src/api/i-cal-timezone.xml b/src/api/i-cal-timezone.xml
index 00ddcb2..4db69f8 100644
--- a/src/api/i-cal-timezone.xml
+++ b/src/api/i-cal-timezone.xml
@@ -20,7 +20,7 @@
   </method>
   <method name="i_cal_timezone_destroy" corresponds="CUSTOM" annotation="skip" kind="destructor" since="1.0">
     <parameter type="icaltimezone *" name="zone" comment="The #ICalTimezone to be freed"/> 
-       <comment xml:space="preserve">The destructor of the type #ICalTimezone</comment>
+       <comment xml:space="preserve">The destructor of the type #ICalTimezone to fully destroy the object by 
providing 1 as the second argument of i_cal_time_zone_free. The method is used as a default destructor for 
introspection.</comment>
        <custom>        icaltimezone_free (zone, 1);</custom>
   </method>
    <method name="i_cal_timezone_copy" corresponds="icaltimezone_copy" kind="clone" since="1.0">


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]