[evolution-patches] patch for missing documentation (calendar)
- From: Rodrigo Moya <rodrigo novell com>
- To: Evolution Patches <evolution-patches lists ximian com>
- Subject: [evolution-patches] patch for missing documentation (calendar)
- Date: Thu, 12 Aug 2004 17:52:09 +0200
While looking at e-cal.c code, found some public functions with no
documentation.
There seems to be more missing gtk-doc comments, so we probably should
be adding them.
--
Rodrigo Moya <rodrigo novell com>
Index: ChangeLog
===================================================================
RCS file: /cvs/gnome/evolution-data-server/calendar/ChangeLog,v
retrieving revision 1.308
diff -u -p -r1.308 ChangeLog
--- ChangeLog 10 Aug 2004 15:19:44 -0000 1.308
+++ ChangeLog 12 Aug 2004 15:50:39 -0000
@@ -1,3 +1,8 @@
+2004-08-12 Rodrigo Moya <rodrigo novell com>
+
+ * libecal/e-cal.c (e_cal_remove_object, e_cal_receive_objects):
+ added missing gtk-doc comments.
+
2004-08-09 Jeffrey Stedfast <fejj novell com>
Fixes bug #58150
Index: libecal/e-cal.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/calendar/libecal/e-cal.c,v
retrieving revision 1.70
diff -u -p -r1.70 e-cal.c
--- libecal/e-cal.c 10 Aug 2004 15:19:44 -0000 1.70
+++ libecal/e-cal.c 12 Aug 2004 15:50:41 -0000
@@ -3710,15 +3710,14 @@ e_cal_remove_object_with_mod (ECal *ecal
* e_cal_remove_object:
* @ecal: A calendar ecal.
* @uid: Unique identifier of the calendar component to remove.
- * @error:
+ * @error: Error placeholder.
*
*
* Asks a calendar to remove a component. If the server is able to remove the
* component, all ecals will be notified and they will emit the "obj_removed"
* signal.
*
- * Return value: an #ECalResult value indicating the result of the
- * operation.
+ * Return value: %TRUE if successful, %FALSE otherwise.
**/
gboolean
e_cal_remove_object (ECal *ecal, const char *uid, GError **error)
@@ -3729,6 +3728,18 @@ e_cal_remove_object (ECal *ecal, const c
return e_cal_remove_object_with_mod (ecal, uid, NULL, CALOBJ_MOD_ALL, error);
}
+/**
+ * e_cal_receive_objects:
+ * @ecal: A calendar ecal.
+ * @icalcomp: An icalcomponent.
+ * @error: Error placeholder.
+ *
+ * Makes the backend receive the set of iCalendar objects specified in the
+ * @icalcomp argument. This is used for iTIP confirmation/cancellation
+ * messages for scheduled meetings.
+ *
+ * Return value: %TRUE if successful, %FALSE otherwise.
+ */
gboolean
e_cal_receive_objects (ECal *ecal, icalcomponent *icalcomp, GError **error)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]