aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/calendar.h
diff options
context:
space:
mode:
Diffstat (limited to 'calendar/calendar.h')
-rw-r--r--calendar/calendar.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/calendar/calendar.h b/calendar/calendar.h
index 0a0e949d92..c12ce639b7 100644
--- a/calendar/calendar.h
+++ b/calendar/calendar.h
@@ -48,15 +48,17 @@ gint calendar_compare_by_dtstart (gpointer a, gpointer b);
void calendar_iterate_on_objects (GList *objects, time_t start, time_t end, calendarfn cb, void *closure);
void calendar_iterate (Calendar *cal, time_t start, time_t end, calendarfn cb, void *closure);
-/* Note this routine returns a GList with CalendarObjects */
-GList *calendar_get_events_in_range (Calendar *cal, time_t start, time_t end);
+/* Returns a list of CalendarObject structures. These represent the events in the calendar that are
+ * in the specified range.
+ */
+GList *calendar_get_events_in_range (Calendar *cal, time_t start, time_t end);
+
+/* Destroy list returned by calendar_get_events_in_range() with this function */
+void calendar_destroy_event_list (GList *l);
/* Informs the calendar that obj information has changed */
void calendar_object_changed (Calendar *cal, iCalObject *obj, int flags);
-/* Destroy the above list with this method */
-void calendar_destroy_event_list (GList *l);
-
void calendar_notify (time_t, void *data);
END_GNOME_DECLS