aboutsummaryrefslogtreecommitdiffstats
path: root/calendar
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@src.gnome.org>2000-07-18 07:57:22 +0800
committerFederico Mena Quintero <federico@src.gnome.org>2000-07-18 07:57:22 +0800
commit86ec303a21211ab79c4e7a0c160e59b5605bfe15 (patch)
treeee5105d51bd89373c6fd0df53a44ecabe96d8ac4 /calendar
parentb016d8e474ab80e57e7f5475274831807cd7ec5c (diff)
downloadgsoc2013-evolution-86ec303a21211ab79c4e7a0c160e59b5605bfe15.tar.gz
gsoc2013-evolution-86ec303a21211ab79c4e7a0c160e59b5605bfe15.tar.zst
gsoc2013-evolution-86ec303a21211ab79c4e7a0c160e59b5605bfe15.zip
Docs docs docs - Federico
svn path=/trunk/; revision=4206
Diffstat (limited to 'calendar')
-rw-r--r--calendar/ChangeLog1
-rw-r--r--calendar/cal-client/cal-client.c10
2 files changed, 11 insertions, 0 deletions
diff --git a/calendar/ChangeLog b/calendar/ChangeLog
index 8934fb9fa0..b7a7dcea40 100644
--- a/calendar/ChangeLog
+++ b/calendar/ChangeLog
@@ -3,6 +3,7 @@
* cal-client/cal-client.c (cal_client_get_object): Fixed inline
docs.
(cal_client_new): Ditto.
+ (cal_client_get_n_objects): Added inline docs.
2000-07-14 Federico Mena Quintero <federico@helixcode.com>
diff --git a/calendar/cal-client/cal-client.c b/calendar/cal-client/cal-client.c
index 90b4dcdbed..1e0a0561d5 100644
--- a/calendar/cal-client/cal-client.c
+++ b/calendar/cal-client/cal-client.c
@@ -550,6 +550,16 @@ cal_client_create_calendar (CalClient *client, const char *str_uri)
return load_or_create (client, str_uri, FALSE);
}
+/**
+ * cal_client_get_n_objects:
+ * @client: A calendar client.
+ * @type: Type of objects that will be counted.
+ *
+ * Counts the number of calendar components of the specified @type. This can be
+ * used to count how many events, to-dos, or journals there are, for example.
+ *
+ * Return value: Number of components.
+ **/
int
cal_client_get_n_objects (CalClient *client, CalObjType type)
{