[gnome-calendar] docs: fixed docs string



commit 0c03de1631fbb3925ad0b2aa52a9c53351cbb719
Author: Erick Pérez Castellanos <erick red gmail com>
Date:   Wed Jun 12 11:54:10 2013 -0400

    docs: fixed docs string

 src/gcal-manager.c   |   20 ++++++++++++++++++++
 src/gcal-week-view.c |    4 ++--
 src/gcal-year-view.c |    4 ++--
 3 files changed, 24 insertions(+), 4 deletions(-)
---
diff --git a/src/gcal-manager.c b/src/gcal-manager.c
index aef0eff..cd56687 100644
--- a/src/gcal-manager.c
+++ b/src/gcal-manager.c
@@ -1297,6 +1297,16 @@ gcal_manager_get_event_start_date (GcalManager *manager,
   return dtstart;
 }
 
+/**
+ * gcal_manager_get_event_end_date:
+ * @manager: a #GcalManager object
+ * @source_uid: the uid of the #ESource
+ * @event_uid: the uid of the #ECalComponent
+ *
+ * Get the date/time end of a calendar event
+ *
+ * Returns: (transfer full) An #icaltimetype object, free with g_free().
+ **/
 icaltimetype*
 gcal_manager_get_event_end_date (GcalManager *manager,
                                  const gchar *source_uid,
@@ -1323,6 +1333,16 @@ gcal_manager_get_event_end_date (GcalManager *manager,
   return dtend;
 }
 
+/**
+ * gcal_manager_get_event_summary:
+ * @manager: a #GcalManager object
+ * @source_uid: the uid of the #ESource
+ * @event_uid: the uid of the #ECalComponent
+ *
+ * Returns the summary of a calendar event.
+ *
+ * Returns: (transfer full) a c-string to be freed with g_free()
+ **/
 gchar*
 gcal_manager_get_event_summary (GcalManager *manager,
                                 const gchar *source_uid,
diff --git a/src/gcal-week-view.c b/src/gcal-week-view.c
index e388bc6..ac84e7e 100644
--- a/src/gcal-week-view.c
+++ b/src/gcal-week-view.c
@@ -1460,7 +1460,7 @@ gcal_week_view_scroll_value_changed (GtkAdjustment *adjusment,
  *
  * Since: 0.1
  * Return value: the first day of the month
- * Returns: (transfer full): Release with g_free
+ * Returns: (transfer full): Release with g_free()
  **/
 static icaltimetype*
 gcal_week_view_get_initial_date (GcalView *view)
@@ -1483,7 +1483,7 @@ gcal_week_view_get_initial_date (GcalView *view)
  *
  * Since: 0.1
  * Return value: the last day of the month
- * Returns: (transfer full): Release with g_free
+ * Returns: (transfer full): Release with g_free()
  **/
 static icaltimetype*
 gcal_week_view_get_final_date (GcalView *view)
diff --git a/src/gcal-year-view.c b/src/gcal-year-view.c
index 0eb6e0f..cfc0a5f 100644
--- a/src/gcal-year-view.c
+++ b/src/gcal-year-view.c
@@ -986,7 +986,7 @@ gcal_year_view_draw_grid (GcalYearView *view,
  *
  * Since: 0.1
  * Return value: the January first of the current year.
- * Returns: (transfer full): Release with g_free
+ * Returns: (transfer full): Release with g_free()
  **/
 static icaltimetype*
 gcal_year_view_get_initial_date (GcalView *view)
@@ -1008,7 +1008,7 @@ gcal_year_view_get_initial_date (GcalView *view)
  *
  * Since: 0.1
  * Return value: the last day of the month
- * Returns: (transfer full): Release with g_free
+ * Returns: (transfer full): Release with g_free()
  **/
 static icaltimetype*
 gcal_year_view_get_final_date (GcalView *view)


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