[evolution-data-server] Bug 760794 - Correct some annotations in the Calendar code



commit 78c59a6aff2c493872d631b816b72268e6db3605
Author: Corentin Noël <corentin elementary io>
Date:   Wed Jan 20 12:48:42 2016 +0100

    Bug 760794 - Correct some annotations in the Calendar code

 calendar/libecal/e-cal-check-timezones.c |    4 ++--
 calendar/libecal/e-cal-client-view.c     |    2 +-
 calendar/libecal/e-cal-client.c          |    8 ++++----
 calendar/libecal/e-cal-component.c       |    8 ++++++++
 calendar/libecal/e-cal-component.h       |    4 +++-
 calendar/libecal/e-cal-types.h           |    2 +-
 6 files changed, 19 insertions(+), 9 deletions(-)
---
diff --git a/calendar/libecal/e-cal-check-timezones.c b/calendar/libecal/e-cal-check-timezones.c
index 834aaec..32d067a 100644
--- a/calendar/libecal/e-cal-check-timezones.c
+++ b/calendar/libecal/e-cal-check-timezones.c
@@ -277,10 +277,10 @@ e_cal_check_timezones (icalcomponent *comp,
        gchar *tzid = NULL;
        GList *l;
 
-       /** a hash from old to new tzid; strings dynamically allocated */
+       /* a hash from old to new tzid; strings dynamically allocated */
        GHashTable *mapping = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
 
-       /** a hash of all system time zone IDs which have to be added; strings are shared with mapping hash */
+       /* a hash of all system time zone IDs which have to be added; strings are shared with mapping hash */
        GHashTable *systemtzids = g_hash_table_new (g_str_hash, g_str_equal);
 
        *error = NULL;
diff --git a/calendar/libecal/e-cal-client-view.c b/calendar/libecal/e-cal-client-view.c
index 00ab084..63b7282 100644
--- a/calendar/libecal/e-cal-client-view.c
+++ b/calendar/libecal/e-cal-client-view.c
@@ -890,7 +890,7 @@ e_cal_client_view_init (ECalClientView *client_view)
  * The returned #ECalClient is referenced for thread-safety.  Unreference
  * the #ECalClient with g_object_unref() when finished with it.
  *
- * Returns: an #ECalClient
+ * Returns: (transfer full): an #ECalClient
  *
  * Since: 3.10
  **/
diff --git a/calendar/libecal/e-cal-client.c b/calendar/libecal/e-cal-client.c
index 2beb839..32b9895 100644
--- a/calendar/libecal/e-cal-client.c
+++ b/calendar/libecal/e-cal-client.c
@@ -1667,7 +1667,7 @@ e_cal_client_init (ECalClient *client)
  * function will have a descriptive prefix that includes the display
  * name of @source.
  *
- * Returns: a new #ECalClient, or %NULL
+ * Returns: (transfer full): a new #ECalClient, or %NULL
  *
  * Since: 3.8
  **/
@@ -1930,7 +1930,7 @@ e_cal_client_connect (ESource *source,
  * function will have a descriptive prefix that includes the display
  * name of the #ESource passed to e_cal_client_connect().
  *
- * Returns: a new #ECalClient, or %NULL
+ * Returns: (transfer full): a new #ECalClient, or %NULL
  *
  * Since: 3.8
  **/
@@ -6677,7 +6677,7 @@ e_cal_client_get_view (ECalClient *client,
  * e_cal_client_get_view_finish:
  * @client: an #ECalClient
  * @result: a #GAsyncResult
- * @out_view: (out) an #ECalClientView
+ * @out_view: (out): an #ECalClientView
  * @error: (out): a #GError to set an error, if any
  *
  * Finishes previous call of e_cal_client_get_view().
@@ -6720,7 +6720,7 @@ e_cal_client_get_view_finish (ECalClient *client,
  * e_cal_client_get_view_sync:
  * @client: an #ECalClient
  * @sexp: an S-expression representing the query.
- * @out_view: (out) an #ECalClientView
+ * @out_view: (out): an #ECalClientView
  * @cancellable: a #GCancellable; can be %NULL
  * @error: (out): a #GError to set an error, if any
  *
diff --git a/calendar/libecal/e-cal-component.c b/calendar/libecal/e-cal-component.c
index 67bcee0..4b19e0a 100644
--- a/calendar/libecal/e-cal-component.c
+++ b/calendar/libecal/e-cal-component.c
@@ -48,6 +48,14 @@
        ((obj), E_TYPE_CAL_COMPONENT, ECalComponentPrivate))
 
 G_DEFINE_TYPE (ECalComponent, e_cal_component, G_TYPE_OBJECT)
+G_DEFINE_BOXED_TYPE (ECalComponentId,
+               e_cal_component_id,
+               e_cal_component_id_copy,
+               e_cal_component_free_id)
+G_DEFINE_BOXED_TYPE (ECalComponentAlarm,
+               e_cal_component_alarm,
+               e_cal_component_alarm_clone,
+               e_cal_component_alarm_free)
 
 /* Extension property for alarm components so that we can reference them by UID */
 #define EVOLUTION_ALARM_UID_PROPERTY "X-EVOLUTION-ALARM-UID"
diff --git a/calendar/libecal/e-cal-component.h b/calendar/libecal/e-cal-component.h
index bfc9c19..d8c2a05 100644
--- a/calendar/libecal/e-cal-component.h
+++ b/calendar/libecal/e-cal-component.h
@@ -367,6 +367,7 @@ void                e_cal_component_set_uid         (ECalComponent *comp,
 ECalComponentId *
                e_cal_component_get_id          (ECalComponent *comp);
 void           e_cal_component_free_id         (ECalComponentId *id);
+GType          e_cal_component_id_get_type     (void);
 ECalComponentId *
                e_cal_component_id_new          (const gchar *uid,
                                                 const gchar *rid);
@@ -628,7 +629,7 @@ typedef struct {
 /**
  * ECalComponentAlarms:
  * @comp: The actual alarm component
- * @alarms: (element-type: ECalComponentAlarmInstance): List of #ECalComponentAlarmInstance structures
+ * @alarms: (element-type ECalComponentAlarmInstance): List of #ECalComponentAlarmInstance structures
  *
  * Alarm trigger instances for a particular component
  **/
@@ -723,6 +724,7 @@ ECalComponentAlarm *
 void           e_cal_component_alarms_free     (ECalComponentAlarms *alarms);
 
 /* ECalComponentAlarms */
+GType          e_cal_component_alarm_get_type  (void);
 ECalComponentAlarm *
                e_cal_component_alarm_new       (void);
 ECalComponentAlarm *
diff --git a/calendar/libecal/e-cal-types.h b/calendar/libecal/e-cal-types.h
index 0a1bdaa..f0f02b8 100644
--- a/calendar/libecal/e-cal-types.h
+++ b/calendar/libecal/e-cal-types.h
@@ -67,7 +67,7 @@ typedef enum {
        E_CAL_OBJ_MOD_ONLY_THIS = 1 << 3
 } ECalObjModType;
 
-/** Everything below this point is deprecated. **/
+/* Everything below this point is deprecated. */
 
 #ifndef EDS_DISABLE_DEPRECATED
 


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