GNOME.org
 

[evolution-data-server] Bug 773723 - Fix a few annotations in libecal

commit b103f13481f1ed968218e3998fc405e2ad2e0d26
Author: Corentin Noël <corentin elementary io>
Date:   Tue Nov 1 12:38:18 2016 +0100

    Bug 773723 - Fix a few annotations in libecal

 src/calendar/libecal/e-cal-client.c    |    2 +-
 src/calendar/libecal/e-cal-component.c |   54 ++++++++++++++++----------------
 src/calendar/libecal/e-cal-recur.c     |    8 ++--
 src/calendar/libecal/e-cal-recur.h     |    2 +-
 src/calendar/libecal/e-cal-time-util.c |    6 ++--
 src/calendar/libecal/e-cal-util.c      |    4 +-
 src/calendar/libecal/e-cal.c           |    4 +-
 src/calendar/libecal/e-cal.h           |    4 +-
 tests/libecal/ecal-test-utils.c        |    2 +-
 tests/libecal/ecal-test-utils.h        |    2 +-
 10 files changed, 44 insertions(+), 44 deletions(-)
---
diff --git a/src/calendar/libecal/e-cal-client.c b/src/calendar/libecal/e-cal-client.c
index fe2fca3..66b2a52 100644
--- a/src/calendar/libecal/e-cal-client.c
+++ b/src/calendar/libecal/e-cal-client.c
@@ -86,7 +86,7 @@ struct _AsyncContext {
        gchar *uid;
        gchar *rid;
        gchar *auid;
-       CalObjModType mod;
+       ECalObjModType mod;
        time_t start;
        time_t end;
 };
diff --git a/src/calendar/libecal/e-cal-component.c b/src/calendar/libecal/e-cal-component.c
index 8eadd65..d100f61 100644
--- a/src/calendar/libecal/e-cal-component.c
+++ b/src/calendar/libecal/e-cal-component.c
@@ -1485,7 +1485,7 @@ e_cal_component_get_id (ECalComponent *comp)
 /**
  * e_cal_component_get_uid:
  * @comp: A calendar component object.
- * @uid: Return value for the UID string.
+ * @uid: (out) (transfer none): Return value for the UID string.
  *
  * Queries the unique identifier of a calendar component object.
  **/
@@ -1807,7 +1807,7 @@ e_cal_component_get_num_attachments (ECalComponent *comp)
 /**
  * e_cal_component_get_categories:
  * @comp: A calendar component object.
- * @categories: Return holder for the categories.
+ * @categories: (out) (transfer none): Return holder for the categories.
  *
  * Queries the categories of the given calendar component. The categories
  * are returned in the @categories argument, which, on success, will contain
@@ -2006,7 +2006,7 @@ e_cal_component_set_categories_list (ECalComponent *comp,
 /**
  * e_cal_component_get_classification:
  * @comp: A calendar component object.
- * @classif: Return value for the classification.
+ * @classif: (out): Return value for the classification.
  *
  * Queries the classification of a calendar component object.  If the
  * classification property is not set on this component, this function returns
@@ -2351,7 +2351,7 @@ set_icaltimetype (ECalComponent *comp,
 /**
  * e_cal_component_get_completed:
  * @comp: A calendar component object.
- * @t: Return value for the completion date.  This should be freed using the
+ * @t: (out): Return value for the completion date.  This should be freed using the
  * e_cal_component_free_icaltimetype() function.
  *
  * Queries the date at which a calendar compoment object was completed.
@@ -2401,7 +2401,7 @@ e_cal_component_set_completed (ECalComponent *comp,
 /**
  * e_cal_component_get_created:
  * @comp: A calendar component object.
- * @t: Return value for the creation date.  This should be freed using the
+ * @t: (out): Return value for the creation date.  This should be freed using the
  * e_cal_component_free_icaltimetype() function.
  *
  * Queries the date in which a calendar component object was created in the
@@ -2483,12 +2483,12 @@ e_cal_component_get_description_list (ECalComponent *comp,
 /**
  * e_cal_component_set_description_list:
  * @comp: A calendar component object.
- * @text_list: (element-type ECalComponentSummary): List of
- * #ECalComponentSummary structures.
+ * @text_list: (element-type ECalComponentText): List of
+ * #ECalComponentText structures.
  *
  * Sets the description of a calendar component object.  Journal components may
  * have more than one description, and as such this function takes in a list of
- * #ECalComponentDescription structures.  All other types of components can have
+ * #ECalComponentText structures.  All other types of components can have
  * at most one description.
  **/
 void
@@ -2636,7 +2636,7 @@ e_cal_component_get_start_plus_duration (ECalComponent *comp,
 /**
  * e_cal_component_get_dtend:
  * @comp: A calendar component object.
- * @dt: Return value for the date/time end.  This should be freed with the
+ * @dt: (out): Return value for the date/time end.  This should be freed with the
  * e_cal_component_free_datetime() function.
  *
  * Queries the date/time end of a calendar component object.
@@ -2706,7 +2706,7 @@ e_cal_component_set_dtend (ECalComponent *comp,
 /**
  * e_cal_component_get_dtstamp:
  * @comp: A calendar component object.
- * @t: A value for the date/timestamp.
+ * @t: (out): A value for the date/timestamp.
  *
  * Queries the date/timestamp property of a calendar component object, which is
  * the last time at which the object was modified by a calendar user agent.
@@ -2761,7 +2761,7 @@ e_cal_component_set_dtstamp (ECalComponent *comp,
 /**
  * e_cal_component_get_dtstart:
  * @comp: A calendar component object.
- * @dt: Return value for the date/time start.  This should be freed with the
+ * @dt: (out): Return value for the date/time start.  This should be freed with the
  * e_cal_component_free_datetime() function.
  *
  * Queries the date/time start of a calendar component object.
@@ -2817,7 +2817,7 @@ e_cal_component_set_dtstart (ECalComponent *comp,
 /**
  * e_cal_component_get_due:
  * @comp: A calendar component object.
- * @dt: Return value for the due date/time.  This should be freed with the
+ * @dt: (out): Return value for the due date/time.  This should be freed with the
  * e_cal_component_free_datetime() function.
  *
  * Queries the due date/time of a calendar component object.
@@ -3343,7 +3343,7 @@ e_cal_component_has_exceptions (ECalComponent *comp)
 /**
  * e_cal_component_get_geo:
  * @comp: A calendar component object.
- * @geo: Return value for the geographic position property.  This should be
+ * @geo: (out): Return value for the geographic position property.  This should be
  * freed using the e_cal_component_free_geo() function.
  *
  * Gets the geographic position property of a calendar component object.
@@ -3459,7 +3459,7 @@ e_cal_component_set_last_modified (ECalComponent *comp,
 /**
  * e_cal_component_get_organizer:
  * @comp:  A calendar component object
- * @organizer: A value for the organizer
+ * @organizer: (out): A value for the organizer
  *
  * Queries the organizer property of a calendar component object
  **/
@@ -3623,7 +3623,7 @@ e_cal_component_has_organizer (ECalComponent *comp)
 /**
  * e_cal_component_get_percent:
  * @comp: A calendar component object.
- * @percent: Return value for the percent-complete property.  This should be
+ * @percent: (out): Return value for the percent-complete property.  This should be
  * freed using the e_cal_component_free_percent() function.
  *
  * Queries the percent-complete property of a calendar component object.
@@ -3760,7 +3760,7 @@ e_cal_component_set_percent (ECalComponent *comp,
 /**
  * e_cal_component_get_priority:
  * @comp: A calendar component object.
- * @priority: Return value for the priority property.  This should be freed using
+ * @priority: (out): Return value for the priority property.  This should be freed using
  * the e_cal_component_free_priority() function.
  *
  * Queries the priority property of a calendar component object.
@@ -3827,7 +3827,7 @@ e_cal_component_set_priority (ECalComponent *comp,
 /**
  * e_cal_component_get_recurid:
  * @comp: A calendar component object.
- * @recur_id: Return value for the recurrence id property
+ * @recur_id: (out): Return value for the recurrence id property
  *
  * Queries the recurrence id property of a calendar component object.
  **/
@@ -4300,7 +4300,7 @@ e_cal_component_is_instance (ECalComponent *comp)
 /**
  * e_cal_component_get_sequence:
  * @comp: A calendar component object.
- * @sequence: Return value for the sequence number.  This should be freed using
+ * @sequence: (out): Return value for the sequence number.  This should be freed using
  * e_cal_component_free_sequence().
  *
  * Queries the sequence number of a calendar component object.
@@ -4440,7 +4440,7 @@ e_cal_component_set_status (ECalComponent *comp,
 /**
  * e_cal_component_get_summary:
  * @comp: A calendar component object.
- * @summary: Return value for the summary property and its parameters.
+ * @summary: (out): Return value for the summary property and its parameters.
  *
  * Queries the summary of a calendar component object.
  **/
@@ -4595,7 +4595,7 @@ e_cal_component_set_summary (ECalComponent *comp,
 /**
  * e_cal_component_get_transparency:
  * @comp: A calendar component object.
- * @transp: Return value for the time transparency.
+ * @transp: (out): Return value for the time transparency.
  *
  * Queries the time transparency of a calendar component object.
  **/
@@ -4694,7 +4694,7 @@ e_cal_component_set_transparency (ECalComponent *comp,
 /**
  * e_cal_component_get_url:
  * @comp: A calendar component object.
- * @url: Return value for the URL.
+ * @url: (out) (transfer none): Return value for the URL.
  *
  * Queries the uniform resource locator property of a calendar component object.
  **/
@@ -4971,7 +4971,7 @@ e_cal_component_has_attendees (ECalComponent *comp)
 /**
  * e_cal_component_get_location:
  * @comp: A calendar component object
- * @location: Return value for the location.
+ * @location: (out) (transfer none): Return value for the location.
  *
  * Queries the location property of a calendar component object.
  **/
@@ -5801,7 +5801,7 @@ e_cal_component_alarm_get_uid (ECalComponentAlarm *alarm)
 /**
  * e_cal_component_alarm_get_action:
  * @alarm: An alarm.
- * @action: Return value for the alarm's action type.
+ * @action: (out): Return value for the alarm's action type.
  *
  * Queries the action type of an alarm.
  **/
@@ -5899,7 +5899,7 @@ e_cal_component_alarm_set_action (ECalComponentAlarm *alarm,
 /**
  * e_cal_component_alarm_get_attach:
  * @alarm: An alarm.
- * @attach: Return value for the attachment; should be freed using icalattach_unref().
+ * @attach: (out): Return value for the attachment; should be freed using icalattach_unref().
  *
  * Queries the attachment property of an alarm.
  **/
@@ -5947,7 +5947,7 @@ e_cal_component_alarm_set_attach (ECalComponentAlarm *alarm,
 /**
  * e_cal_component_alarm_get_description:
  * @alarm: An alarm.
- * @description: Return value for the description property and its parameters.
+ * @description: (out): Return value for the description property and its parameters.
  *
  * Queries the description property of an alarm.
  **/
@@ -6012,7 +6012,7 @@ e_cal_component_alarm_set_description (ECalComponentAlarm *alarm,
 /**
  * e_cal_component_alarm_get_repeat:
  * @alarm: An alarm.
- * @repeat: Return value for the repeat/duration properties.
+ * @repeat: (out): Return value for the repeat/duration properties.
  *
  * Queries the repeat/duration properties of an alarm.
  **/
@@ -6079,7 +6079,7 @@ e_cal_component_alarm_set_repeat (ECalComponentAlarm *alarm,
 /**
  * e_cal_component_alarm_get_trigger:
  * @alarm: An alarm.
- * @trigger: Return value for the trigger time.
+ * @trigger: (out): Return value for the trigger time.
  *
  * Queries the trigger time for an alarm.
  **/
diff --git a/src/calendar/libecal/e-cal-recur.c b/src/calendar/libecal/e-cal-recur.c
index 0b0d3d9..d497293 100644
--- a/src/calendar/libecal/e-cal-recur.c
+++ b/src/calendar/libecal/e-cal-recur.c
@@ -298,10 +298,10 @@ intersects_interval (const struct icaltimetype *tt,
  * @comp: an icalcomponent
  * @interval_start: an interval start, for which generate instances
  * @interval_end: an interval end, for which generate instances
- * @callback: a callback to be called for each instance
- * @callback_user_data: user data for @callback
- * @get_tz_callback: a callback to call when resolving timezone
- * @get_tz_callback_user_data: user data for @get_tz_callback
+ * @callback: (scope call): a callback to be called for each instance
+ * @callback_user_data: (closure callback): user data for @callback
+ * @get_tz_callback: (scope call): a callback to call when resolving timezone
+ * @get_tz_callback_user_data: (closure get_tz_callback): user data for @get_tz_callback
  * @default_timezone: a default icaltimezone
  * @cancellable: a #GCancellable; can be %NULL
  * @error: (out): a #GError to set an error, if any
diff --git a/src/calendar/libecal/e-cal-recur.h b/src/calendar/libecal/e-cal-recur.h
index 1264e1d..9d87562 100644
--- a/src/calendar/libecal/e-cal-recur.h
+++ b/src/calendar/libecal/e-cal-recur.h
@@ -60,7 +60,7 @@ gboolean      e_cal_recur_generate_instances_sync     (icalcomponent *comp,
 typedef gboolean (* ECalRecurInstanceFn) (ECalComponent *comp,
                                         time_t        instance_start,
                                         time_t        instance_end,
-                                        gpointer      data);
+                                        gpointer      user_data);
 
 typedef icaltimezone * (* ECalRecurResolveTimezoneFn)  (const gchar   *tzid,
                                                         gpointer      data);
diff --git a/src/calendar/libecal/e-cal-time-util.c b/src/calendar/libecal/e-cal-time-util.c
index 84446ba..7bcbc8b 100644
--- a/src/calendar/libecal/e-cal-time-util.c
+++ b/src/calendar/libecal/e-cal-time-util.c
@@ -674,7 +674,7 @@ time_from_isodate (const gchar *str)
  *
  * Convers an icaltimetype structure into a GLibc's struct tm.
  *
- * Returns: The converted time as a struct tm. All fields will be
+ * Returns: (transfer full): The converted time as a struct tm. All fields will be
  * set properly except for tm.tm_yday.
  *
  * Since: 2.22
@@ -710,7 +710,7 @@ icaltimetype_to_tm (struct icaltimetype *itt)
  * Converts a time value from one timezone to another, and returns a struct tm
  * representation of the time.
  *
- * Returns: The converted time as a struct tm. All fields will be
+ * Returns: (transfer full): The converted time as a struct tm. All fields will be
  * set properly except for tm.tm_yday.
  *
  * Since: 2.22
@@ -743,7 +743,7 @@ icaltimetype_to_tm_with_zone (struct icaltimetype *itt,
  *
  * Converts a struct tm into an icaltimetype.
  *
- * Returns: The converted time as an icaltimetype.
+ * Returns: (transfer full): The converted time as an icaltimetype.
  *
  * Since: 2.22
  */
diff --git a/src/calendar/libecal/e-cal-util.c b/src/calendar/libecal/e-cal-util.c
index d65dd4e..3486b4a 100644
--- a/src/calendar/libecal/e-cal-util.c
+++ b/src/calendar/libecal/e-cal-util.c
@@ -34,7 +34,7 @@
 
 /**
  * cal_obj_instance_list_free:
- * @list: List of #CalObjInstance structures.
+ * @list: (element-type CalObjInstance): List of #CalObjInstance structures.
  *
  * Frees a list of #CalObjInstance structures.
  **/
@@ -59,7 +59,7 @@ cal_obj_instance_list_free (GList *list)
 
 /**
  * cal_obj_uid_list_free:
- * @list: List of strings with unique identifiers.
+ * @list: (element-type utf8): List of strings with unique identifiers.
  *
  * Frees a list of unique identifiers for calendar objects.
  **/
diff --git a/src/calendar/libecal/e-cal.c b/src/calendar/libecal/e-cal.c
index 2b75086..26eebbf 100644
--- a/src/calendar/libecal/e-cal.c
+++ b/src/calendar/libecal/e-cal.c
@@ -1985,7 +1985,7 @@ e_cal_create_object (ECal *ecal,
 gboolean
 e_cal_modify_object (ECal *ecal,
                      icalcomponent *icalcomp,
-                     CalObjModType mod,
+                     ECalObjModType mod,
                      GError **error)
 {
        g_return_val_if_fail (E_IS_CAL (ecal), FALSE);
@@ -2046,7 +2046,7 @@ gboolean
 e_cal_remove_object_with_mod (ECal *ecal,
                               const gchar *uid,
                               const gchar *rid,
-                              CalObjModType mod,
+                              ECalObjModType mod,
                               GError **error)
 {
        g_return_val_if_fail (E_IS_CAL (ecal), FALSE);
diff --git a/src/calendar/libecal/e-cal.h b/src/calendar/libecal/e-cal.h
index b0ee252..5089ae9 100644
--- a/src/calendar/libecal/e-cal.h
+++ b/src/calendar/libecal/e-cal.h
@@ -228,9 +228,9 @@ gboolean e_cal_get_alarms_for_object (ECal *ecal, const ECalComponentId *id,
                                      ECalComponentAlarms **alarms);
 
 gboolean e_cal_create_object (ECal *ecal, icalcomponent *icalcomp, gchar **uid, GError **error);
-gboolean e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, CalObjModType mod, GError **error);
+gboolean e_cal_modify_object (ECal *ecal, icalcomponent *icalcomp, ECalObjModType mod, GError **error);
 gboolean e_cal_remove_object (ECal *ecal, const gchar *uid, GError **error);
-gboolean e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid, const gchar *rid, CalObjModType mod, 
GError **error);
+gboolean e_cal_remove_object_with_mod (ECal *ecal, const gchar *uid, const gchar *rid, ECalObjModType mod, 
GError **error);
 
 gboolean e_cal_discard_alarm (ECal *ecal, ECalComponent *comp, const gchar *auid, GError **error);
 
diff --git a/tests/libecal/ecal-test-utils.c b/tests/libecal/ecal-test-utils.c
index a4aa8cb..4dbcbdb 100644
--- a/tests/libecal/ecal-test-utils.c
+++ b/tests/libecal/ecal-test-utils.c
@@ -239,7 +239,7 @@ ecal_test_utils_cal_get_object (ECal *cal,
 void
 ecal_test_utils_cal_modify_object (ECal *cal,
                                    icalcomponent *component,
-                                   CalObjModType mod_type)
+                                   ECalObjModType mod_type)
 {
        GError *error = NULL;
 
diff --git a/tests/libecal/ecal-test-utils.h b/tests/libecal/ecal-test-utils.h
index 6f036f5..6602547 100644
--- a/tests/libecal/ecal-test-utils.h
+++ b/tests/libecal/ecal-test-utils.h
@@ -56,7 +56,7 @@ ecal_test_utils_cal_get_object (ECal       *cal,
 void
 ecal_test_utils_cal_modify_object (ECal          *cal,
                                    icalcomponent *component,
-                                   CalObjModType  mod_type);
+                                   ECalObjModType  mod_type);
 
 void
 ecal_test_utils_cal_remove_object (ECal       *cal,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]