Added the cal-util library to the documentation framework - Federico

svn path=/trunk/; revision=4839

4 files changed, 61 insertions, 23 deletions

diff --git a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt
index 9fffd4c201..0574d70678 100644
--- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt
+++ b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt
@@ -83,7 +83,7 @@ CalClient *client, CalObjType type
 <FUNCTION>
 <NAME>cal_client_get_object</NAME>
 <RETURNS>CalClientGetStatus  </RETURNS>
-CalClient *client,const char *uid,iCalObject **ico
+CalClient *client,const char *uid,CalComponent **comp
 </FUNCTION>
 <FUNCTION>
 <NAME>cal_client_get_uid_by_pilot_id</NAME>
@@ -101,9 +101,14 @@ CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status
 CalClient *client, CalObjType type
 </FUNCTION>
 <FUNCTION>
-<NAME>cal_client_get_events_in_range</NAME>
+<NAME>cal_client_get_objects_in_range</NAME>
 <RETURNS>GList  *</RETURNS>
-CalClient *client, time_t start, time_t end
+CalClient *client, CalObjType type,time_t start, time_t end
+</FUNCTION>
+<FUNCTION>
+<NAME>cal_client_generate_instances</NAME>
+<RETURNS>void  </RETURNS>
+CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn cb, gpointer cb_data
 </FUNCTION>
 <FUNCTION>
 <NAME>cal_client_get_alarms_in_range</NAME>
@@ -118,7 +123,7 @@ CalClient *client, const char *uid,time_t start, time_t end,GList **alarms
 <FUNCTION>
 <NAME>cal_client_update_object</NAME>
 <RETURNS>gboolean  </RETURNS>
-CalClient *client, iCalObject *ico
+CalClient *client, CalComponent *comp
 </FUNCTION>
 <FUNCTION>
 <NAME>cal_client_remove_object</NAME>
diff --git a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt
index 5496f2f0f2..c37b223247 100644
--- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt
+++ b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt
@@ -12,10 +12,11 @@ cal_client_load_calendar
 cal_client_create_calendar
 cal_client_get_n_objects
 cal_client_get_object
+cal_client_get_objects_in_range
+cal_client_generate_instances
 cal_client_get_uid_by_pilot_id
 cal_client_update_pilot_id
 cal_client_get_uids
-cal_client_get_events_in_range
 cal_client_get_alarms_in_range
 cal_client_get_alarms_for_object
 cal_client_update_object
diff --git a/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml
index d2205b5b22..a146709b8a 100644
--- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml
+++ b/help/devel/calendar/cal-client/tmpl/cal-client.sgml
@@ -38,7 +38,6 @@ GTK+ object for communication with personal calendar server.
 
   </para>
 
-
 <!-- ##### MACRO CAL_CLIENT ##### -->
   <para>
     Casts a #GtkObject to a #CalClient.
@@ -61,14 +60,11 @@ GTK+ object for communication with personal calendar server.
 
 @CAL_CLIENT_LOAD_SUCCESS: Indicates a successful load or create
   operation; the corresponding calendar is ready for use.
-
 @CAL_CLIENT_LOAD_ERROR: Indicates an error while loading or creating
   the calendar.
-
 @CAL_CLIENT_LOAD_IN_USE: Indicates that a create request failed
   because the specified calendar was already being used by another
   client.
-
 @CAL_CLIENT_LOAD_METHOD_NOT_SUPPORTED: Indicates an error due to
   trying to load a calendar for which a backend type is not present.
 
@@ -79,10 +75,8 @@ GTK+ object for communication with personal calendar server.
   </para>
 
 @CAL_CLIENT_GET_SUCCESS: Indicates a successful get operation.
-
 @CAL_CLIENT_GET_NOT_FOUND: Indicates that the requested object was
   not found.
-
 @CAL_CLIENT_GET_SYNTAX_ERROR: Indicates a syntax error when parsing
   the requested object.  This could indicate a bug in the calendar
   client libraries or in the Wombat server.
@@ -132,10 +126,37 @@ GTK+ object for communication with personal calendar server.
 
 @client: 
 @uid: 
+@comp: 
+@Returns: 
+<!-- # Unused Parameters # -->
 @ico: 
+
+
+<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
+<para>
+
+</para>
+
+@client: 
+@type: 
+@start: 
+@end: 
 @Returns: 
 
 
+<!-- ##### FUNCTION cal_client_generate_instances ##### -->
+<para>
+
+</para>
+
+@client: 
+@type: 
+@start: 
+@end: 
+@cb: 
+@cb_data: 
+
+
 <!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
 <para>
 
@@ -168,17 +189,6 @@ GTK+ object for communication with personal calendar server.
 @Returns: 
 
 
-<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
-<para>
-
-</para>
-
-@client: 
-@start: 
-@end: 
-@Returns: 
-
-
 <!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
 <para>
 
@@ -209,8 +219,10 @@ GTK+ object for communication with personal calendar server.
 </para>
 
 @client: 
-@ico: 
+@comp: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@ico: 
 
 
 <!-- ##### FUNCTION cal_client_remove_object ##### -->
@@ -232,6 +244,9 @@ GTK+ object for communication with personal calendar server.
     request.
   </para>
 
+@calclient: the object which received the signal.
+@arg1: 
+<!-- # Unused Parameters # -->
 @client: Calendar client which received the notification.
 @status: Status of the request.  See the description of
   #CalClientLoadStatus for more details.
@@ -244,6 +259,9 @@ GTK+ object for communication with personal calendar server.
     new version of the object and update their display, for example.
   </para>
 
+@calclient: the object which received the signal.
+@arg1: 
+<!-- # Unused Parameters # -->
 @client: Calendar client which received the notification.
 @uid: Unique identifier of the calendar component that changed in the
   personal calendar server's storage.
@@ -257,6 +275,9 @@ GTK+ object for communication with personal calendar server.
     example.
   </para>
 
+@calclient: the object which received the signal.
+@arg1: 
+<!-- # Unused Parameters # -->
 @client: Calendar client which received the notification.
 @uid: Unique identifier of the calendar component that was removed
   from the personal calendar server's storage.
@@ -267,3 +288,4 @@ mode: sgml
 sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
 End:
 -->
+
diff --git a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
index e69de29bb2..5576dbd57f 100644
--- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
+++ b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
@@ -0,0 +1,10 @@
+<!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
+<para>
+
+</para>
+
+@client: 
+@start: 
+@end: 
+@Returns: 
+