[evolution-data-server] ECalCache: Be more specific regarding the signal definition and fix documentation



commit 21eabc012016f87133b0ac77d20fa7f9174ed0e0
Author: Corentin Noël <corentin noel collabora com>
Date:   Wed Jan 22 12:02:44 2020 +0100

    ECalCache: Be more specific regarding the signal definition and fix documentation
    
    Since we are now using libical-glib it is possible to specify the real type of the arguments.
    Also put transfer annotations and use two colons when descibing a signal.

 src/calendar/libedata-cal/e-cal-cache.c | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
---
diff --git a/src/calendar/libedata-cal/e-cal-cache.c b/src/calendar/libedata-cal/e-cal-cache.c
index 5aaa51e35..dee98d508 100644
--- a/src/calendar/libedata-cal/e-cal-cache.c
+++ b/src/calendar/libedata-cal/e-cal-cache.c
@@ -4521,9 +4521,15 @@ e_cal_cache_class_init (ECalCacheClass *klass)
 
        /**
         * ECalCache:dup-component-revision:
+        * ECalCache::dup-component-revision:
+        * @cal_cache: an #ECalCache
+        * @icomp: an #ICalComponent
+        *
         * A signal being called to get revision of an ICalComponent.
         * The default implementation uses a concatenation of
         * DTSTAMP '-' LASTMODIFIED '-' SEQUENCE.
+        *
+        * Returns: the revision string
         **/
        signals[DUP_COMPONENT_REVISION] = g_signal_new (
                "dup-component-revision",
@@ -4534,10 +4540,10 @@ e_cal_cache_class_init (ECalCacheClass *klass)
                NULL,
                g_cclosure_marshal_generic,
                G_TYPE_STRING, 1,
-               G_TYPE_POINTER);
+               I_CAL_TYPE_COMPONENT);
 
        /**
-        * ECalCache:get-timezone:
+        * ECalCache::get-timezone:
         * @cal_cache: an #ECalCache
         * @tzid: timezone ID
         *
@@ -4546,6 +4552,8 @@ e_cal_cache_class_init (ECalCacheClass *klass)
         * all timezones which are needed by the component. The returned
         * ICalTimezone will not be freed.
         *
+        * Returns: (transfer none): an #ICalTimezone
+        *
         * Since: 3.30
         **/
        signals[GET_TIMEZONE] = g_signal_new (
@@ -4556,7 +4564,7 @@ e_cal_cache_class_init (ECalCacheClass *klass)
                g_signal_accumulator_first_wins,
                NULL,
                g_cclosure_marshal_generic,
-               G_TYPE_POINTER, 1,
+               I_CAL_TYPE_COMPONENT, 1,
                G_TYPE_STRING);
 }
 


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