diff options
| author | Allen Winter <allen.winter@kdab.com> | 2020-07-19 11:55:50 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-19 11:55:50 -0400 |
| commit | 8629f4bb13913f4e59f54ed48bfba300b91d06fb (patch) | |
| tree | 41571ac88a12c7876adc1f85870a80f7d83c4edc | |
| parent | f23a2f86acb1b6a91d386f77dc58bab901177470 (diff) | |
| parent | 05b9a45bb986177d531b551b167818b4e431f7b4 (diff) | |
| download | libical-git-8629f4bb13913f4e59f54ed48bfba300b91d06fb.tar.gz | |
Merge pull request #431 from mcclurgm/docs-fixes-3.0
Consistency, grammar, typo fixes to 3.0 docs
99 files changed, 3076 insertions, 3062 deletions
diff --git a/cmake/modules/GObjectIntrospectionMacros.cmake b/cmake/modules/GObjectIntrospectionMacros.cmake index 0f9a386b..1e7ecd79 100644 --- a/cmake/modules/GObjectIntrospectionMacros.cmake +++ b/cmake/modules/GObjectIntrospectionMacros.cmake @@ -35,7 +35,7 @@ macro(gir_add_introspections introspections_girs) string(REGEX REPLACE ".*-([^-]+).gir" "\\1" _gir_version "${gir}") endif () - # _PROGRAM is an optional variable which needs it's own --program argument + # _PROGRAM is an optional variable which needs its own --program argument set(_gir_program "${${_gir_name}_PROGRAM}") if (NOT _gir_program STREQUAL "") set(_gir_program "--program=${_gir_program}") diff --git a/examples/access_properties_and_parameters.c b/examples/access_properties_and_parameters.c index d17d91c0..9988dba0 100644 --- a/examples/access_properties_and_parameters.c +++ b/examples/access_properties_and_parameters.c @@ -3,7 +3,7 @@ #include <libical/ical.h> #include <stdlib.h> -/* Get a particular parameter out of a component. This routine will +/* Gets a particular parameter out of a component. This routine will return a list of strings of all attendees who are required. Note that this routine assumes that the component that we pass in is a VEVENT. */ @@ -143,7 +143,7 @@ void test_properties() printf("Value: %s", str); free(str); - /* Free the original and the clone */ + /* Frees the original and the clone */ icalproperty_free(clone); icalproperty_free(prop); diff --git a/src/Net-ICal-Libical/netical.i b/src/Net-ICal-Libical/netical.i index 981f142c..e0dad14b 100644 --- a/src/Net-ICal-Libical/netical.i +++ b/src/Net-ICal-Libical/netical.i @@ -161,7 +161,7 @@ icalcomponent* icallangbind_get_next_component(icalcomponent *c, const char* comp); -/* Return a string that can be evaluated in perl or python to +/* Returns a string that can be evaluated in perl or python to generated a hash that holds the property's name, value and parameters. Sep is the hash seperation string, "=>" for perl and ":" for python */ @@ -192,12 +192,12 @@ struct icaltimetype /* Convert seconds past UNIX epoch to a timetype*/ struct icaltimetype icaltime_from_timet_with_zone(int v, int is_date, const char* tzid); -/* Return the time as seconds past the UNIX epoch */ +/* Returns the time as seconds past the UNIX epoch */ /* Normally, this returns a time_t, but SWIG tries to turn that type into a pointer */ int icaltime_as_timet(struct icaltimetype); -/* Return a string represention of the time, in RFC2445 format. The +/* Returns a string represention of the time, in RFC2445 format. The string is owned by libical */ char* icaltime_as_ical_string(struct icaltimetype tt); @@ -205,7 +205,7 @@ char* icaltime_as_ical_string(struct icaltimetype tt); struct icaltimetype icaltime_from_string(const char* str); /* Routines for handling timezones */ -/* Return the offset of the named zone as seconds. tt is a time +/* Returns the offset of the named zone as seconds. tt is a time indicating the date for which you want the offset */ int icaltime_utc_offset(struct icaltimetype tt, const char* tzid); @@ -218,10 +218,10 @@ struct icaltimetype icaltime_as_utc(struct icaltimetype tt, struct icaltimetype icaltime_as_zone(struct icaltimetype tt, const char* tzid); -/* Return a null time, which indicates no time has been set. This time represent the beginning of the epoch */ +/* Returns a null time, which indicates no time has been set. This time represent the beginning of the epoch */ struct icaltimetype icaltime_null_time(void); -/* Return true of the time is null. */ +/* Returns true if the time is null. */ int icaltime_is_null_time(struct icaltimetype t); /* Returns false if the time is clearly invalid, but is not null. This @@ -236,32 +236,32 @@ int icaltime_is_valid_time(struct icaltimetype t); underflow. */ struct icaltimetype icaltime_normalize(struct icaltimetype t); -/* Return the day of the year of the given time */ +/* Returns the day of the year of the given time */ short icaltime_day_of_year(struct icaltimetype t); /* Create a new time, given a day of year and a year. */ struct icaltimetype icaltime_from_day_of_year(short doy, short year); -/* Return the day of the week of the given time. Sunday is 0 */ +/* Returns the day of the week of the given time. Sunday is 0 */ short icaltime_day_of_week(struct icaltimetype t); -/* Return the day of the year for the first day of the week that the +/* Returns the day of the year for the first day of the week that the given time is within. */ short icaltime_start_doy_week(struct icaltimetype t, int fdow); -/* Return a string with the time represented in the same format as ctime(). THe string is owned by libical */ +/* Returns a string with the time represented in the same format as ctime(). THe string is owned by libical */ char* icaltime_as_ctime(struct icaltimetype); -/* Return the week number for the week the given time is within */ +/* Returns the week number for the week the given time is within */ short icaltime_week_number(struct icaltimetype t); -/* Return -1, 0, or 1 to indicate that a<b, a==b or a>b */ +/* Returns -1, 0, or 1 to indicate that a<b, a==b or a>b */ int icaltime_compare(struct icaltimetype a,struct icaltimetype b); /* like icaltime_compare, but only use the date parts. */ int icaltime_compare_date_only(struct icaltimetype a, struct icaltimetype b); -/* Return the number of days in the given month */ +/* Returns the number of days in the given month */ short icaltime_days_in_month(short month,short year); diff --git a/src/Net-ICal-Libical/test-data/2446.mime b/src/Net-ICal-Libical/test-data/2446.mime index 919bfc42..2e74cfe5 100644 --- a/src/Net-ICal-Libical/test-data/2446.mime +++ b/src/Net-ICal-Libical/test-data/2446.mime @@ -1140,7 +1140,7 @@ X-LIC-ERROR ;X-LIC-ERRORTYPE=PARAMETER_PARSE_ERROR :Can't parse parameter name: 'TYPE=INDIVIDUAL' COMMENT - :Mr. B cannot attend. It's raining. Lets cancel. + :Mr. B cannot attend. It's raining. Let's cancel. UID :calsrv.example.com-873970198738777@example.com SEQUENCE diff --git a/src/Net-ICal-Libical/test-data/rfc2446.ics b/src/Net-ICal-Libical/test-data/rfc2446.ics index 8bf5c7e8..bd3f8ef2 100644 --- a/src/Net-ICal-Libical/test-data/rfc2446.ics +++ b/src/Net-ICal-Libical/test-data/rfc2446.ics @@ -327,7 +327,7 @@ ATTENDEE;CUTYPE=INDIVIDUAL:Mailto:A@example.com ATTENDEE;CUTYPE=INDIVIDUAL:Mailto:B@example.com ATTENDEE;CUTYPE=INDIVIDUAL:Mailto:C@example.com ATTENDEE;CUTYPE=INDIVIDUAL:Mailto:D@example.com -COMMENT:Mr. B cannot attend. It's raining. Lets cancel. +COMMENT:Mr. B cannot attend. It's raining. Let's cancel. UID:calsrv.example.com-873970198738777@example.com SEQUENCE:1 STATUS:CANCELLED diff --git a/src/java/ICalParameter.java b/src/java/ICalParameter.java index 74bf3db8..af764e27 100644 --- a/src/java/ICalParameter.java +++ b/src/java/ICalParameter.java @@ -90,7 +90,7 @@ public class ICalParameter } /** - * Create instance from a string of form "PARAMNAME=VALUE" + * Creates instance from a string of form "PARAMNAME=VALUE" */ public ICalParameter(String str) { @@ -98,7 +98,7 @@ public class ICalParameter } /** - * Create from just the value, the part after the "=" + * Creates from just the value, the part after the "=" */ public ICalParameter(/* ICalParameterKind */ int kind, String str) { @@ -106,7 +106,7 @@ public class ICalParameter } /** - * Create empty value for specified kind + * Creates empty value for specified kind */ public ICalParameter(/* ICalParameterKind */ int kind) { @@ -114,22 +114,22 @@ public class ICalParameter } /** - * Return ical String representation + * Returns ical String representation */ public native String as_ical_string(); /** - * Return true if this instance is valid + * Returns true if this instance is valid */ //public native boolean is_valid(); /** - * Return what kind of parameter this instance represents + * Returns what kind of parameter this instance represents */ public native /* ICalParameterKind */ int isa(); /** - * Return true if this is a parameter + * Returns true if this is a parameter */ public native boolean isa_parameter(Object parameter); diff --git a/src/java/ICalProperty.java b/src/java/ICalProperty.java index 6aa8dae1..87e99f6e 100644 --- a/src/java/ICalProperty.java +++ b/src/java/ICalProperty.java @@ -189,7 +189,7 @@ public class ICalProperty public native ICalValue get_value(); public native String get_value_as_string(); - /* Return the name of the property -- the type name converted to a + /* Returns the name of the property -- the type name converted to a String, or the value of get_x_name if the type is X property */ public native String get_name(); diff --git a/src/java/VComponent.java b/src/java/VComponent.java index 70c5915c..d77c5bb9 100644 --- a/src/java/VComponent.java +++ b/src/java/VComponent.java @@ -80,7 +80,7 @@ public class VComponent /* Working with components */ - /* Return the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types */ + /* Returns the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types */ public native VComponent get_inner(); public native void add_component(VComponent child); diff --git a/src/libical-glib/api/i-cal-array.xml b/src/libical-glib/api/i-cal-array.xml index c8bf111e..12b9c676 100644 --- a/src/libical-glib/api/i-cal-array.xml +++ b/src/libical-glib/api/i-cal-array.xml @@ -17,7 +17,7 @@ <method name="i_cal_array_size" corresponds="CUSTOM" kind="other" since="1.0"> <parameter type="ICalArray *" name="array" comment="The #ICalArray"/> <returns type="gint" comment="The size of current array."/> - <comment>Get the size of the array.</comment> + <comment>Gets the size of the array.</comment> <custom> icalarray *native; gint ret; g_return_val_if_fail (array != NULL && I_CAL_IS_ARRAY (array), -1); @@ -29,38 +29,38 @@ <!-- <method name="i_cal_array_new" corresponds="icalarray_new" kind="constructor" since="1.0"> <parameter type="gint" name="element_size" comment="The size of the element of the array"/> <parameter type="gint" name="increment_size" comment="The incremental size when the array is full"/> - <returns type="ICalArray *" annotation="transfer full" translator_argus="NULL, FALSE" comment="The newly create #ICalArray with the properties set by @element_size and @increment_size"/> - <comment xml:space="preserve">Create a #ICalArray with the element size to be @element_size and increment size to be @increment_size</comment> + <returns type="ICalArray *" annotation="transfer full" translator_argus="NULL, FALSE" comment="The newly created #ICalArray with the properties set by @element_size and @increment_size"/> + <comment xml:space="preserve">Creates a #ICalArray with the element size to be @element_size and increment size to be @increment_size.</comment> </method> --> <method name="i_cal_array_copy" corresponds="icalarray_copy" kind="clone" since="1.0"> - <parameter type="ICalArray *" name="array" annotation="in" comment="The #ICalArray to be cloned."/> + <parameter type="ICalArray *" name="array" annotation="in" comment="The #ICalArray to be cloned"/> <returns type="ICalArray *" annotation="transfer full" translator_argus="NULL, FALSE" comment="The newly cloned #ICalArray with the same value as the @array"/> - <comment xml:space="preserve">Create a deep copy of #ICalArray with the same properties as the @array</comment> + <comment xml:space="preserve">Creates a deep copy of #ICalArray with the same properties as the @array.</comment> </method> <method name="i_cal_array_free" corresponds="icalarray_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalArray *" name="array" comment="The #ICalArray to be freed."/> - <comment xml:space="preserve">Free the #ICalArray</comment> + <parameter type="ICalArray *" name="array" comment="The #ICalArray to be freed"/> + <comment xml:space="preserve">Frees the #ICalArray.</comment> </method> <!-- <method name="i_cal_array_append" corresponds="icalarray_append" kind="others" since="1.0"> - <parameter type="ICalArray *" name="array" comment="The #ICalArray to be appended."/> + <parameter type="ICalArray *" name="array" comment="The #ICalArray to be appended"/> <parameter type="GObject *" name="element" comment="The element to be appended to the #ICalArray. The reason why to use GOjbect * instead of gpointer is that the variable of type gpointer can only be assigned with none, integer or capsule type. The support for other types would be added in the future."/> - <comment xml:space="preserve">Append @element to the end of the array</comment> + <comment xml:space="preserve">Append @element to the end of the array.</comment> </method> --> <method name="i_cal_array_remove_element_at" corresponds="icalarray_remove_element_at" kind="others" since="1.0"> - <parameter type="ICalArray *" name="array" comment="The #ICalArray to be modified."/> + <parameter type="ICalArray *" name="array" comment="The #ICalArray to be modified"/> <parameter type="gint" name="position" comment="The position in which the element will be removed from the array"/> - <comment xml:space="preserve">Remove the element at the @position from the array</comment> + <comment xml:space="preserve">Removes the element at the @position from the array.</comment> </method> <method name="i_cal_array_element_at" corresponds="icalarray_element_at" annotation="skip" kind="private" since="1.0"> - <parameter type="ICalArray *" name="array" comment="The #ICalArray to be queried."/> + <parameter type="ICalArray *" name="array" comment="The #ICalArray to be queried"/> <parameter type="gint" name="position" comment="The position the target element is located"/> <returns type="GObject *" annotation="transfer none, allow-none" comment="The element located at the @position in the @array"/> - <comment xml:space="preserve">Get the element located in the @position in the @array. NULL if position if out of bound</comment> + <comment xml:space="preserve">Gets the element located in the @position in the @array. NULL if position if out of bound.</comment> </method> <method name="i_cal_array_sort" corresponds="CUSTOM" annotation="skip" kind="others" since="1.0"> - <parameter type="ICalArray *" name="array" comment="The #ICalArray to be sorted."/> - <parameter type="gint (*compare)" name="(const void *, const void *)" annotation="scope call" comment="FULL: @compare: (scope call): The comapre function."/> - <comment xml:space="preserve">Does not work right now. Sort the @array using the sort function @compare</comment> + <parameter type="ICalArray *" name="array" comment="The #ICalArray to be sorted"/> + <parameter type="gint (*compare)" name="(const void *, const void *)" annotation="scope call" comment="FULL: @compare: (scope call): The comapre function"/> + <comment xml:space="preserve">Does not work right now. Sorts the @array using the sort function @compare.</comment> <custom> g_return_if_fail (I_CAL_IS_ARRAY (array)); g_return_if_fail (array != NULL); g_return_if_fail (compare != NULL); diff --git a/src/libical-glib/api/i-cal-attach.xml b/src/libical-glib/api/i-cal-attach.xml index 69108e48..816de1e3 100644 --- a/src/libical-glib/api/i-cal-attach.xml +++ b/src/libical-glib/api/i-cal-attach.xml @@ -17,14 +17,14 @@ <method name="i_cal_attach_new_from_url" corresponds="icalattach_new_from_url" kind="constructor" since="1.0"> <parameter type="const gchar *" name="url" comment="The url from which the object is created"/> <returns type="ICalAttach *" annotation="transfer full" comment="The newly created #ICalAttach from the @url" /> - <comment xml:space="preserve">Create a new #ICalAttach from the url</comment> + <comment xml:space="preserve">Creates a new #ICalAttach from the url.</comment> </method> <method name="i_cal_attach_new_from_data" corresponds="CUSTOM" kind="constructor" since="1.0"> <parameter type="const gchar *" name="data" comment="The data used to create the #ICalAttach"/> - <parameter type="GFunc" name="free_fn" translator="(icalattach_free_fn_t)" annotation="scope call, allow-none" comment="The function used to free the data when the create #ICalAttach is detroyed."/> + <parameter type="GFunc" name="free_fn" translator="(icalattach_free_fn_t)" annotation="scope call, allow-none" comment="The function used to free the data when the create #ICalAttach is detroyed"/> <parameter type="void *" name="free_fn_data" annotation="allow-none" comment="The userdata used for the free function @free_fn"/> <returns type="ICalAttach *" annotation="transfer full" comment="The newly created #ICalAttach" /> - <comment xml:space="preserve">Create a new #ICalAttach from the data.</comment> + <comment xml:space="preserve">Creates a new #ICalAttach from the data.</comment> <custom> g_return_val_if_fail (data != NULL, NULL); return i_cal_attach_new_full (icalattach_new_from_data (data, (icalattach_free_fn_t) (free_fn), free_fn_data), NULL);</custom> @@ -42,33 +42,33 @@ static void unref_g_bytes(char *data, void *user_data) <method name="i_cal_attach_new_from_bytes" corresponds="CUSTOM" kind="constructor" since="1.0"> <parameter type="GBytes *" annotation="transfer full" name="bytes" comment="The #GBytes holding the data used to create the #ICalAttach"/> <returns type="ICalAttach *" annotation="transfer full" comment="The newly created #ICalAttach" /> - <comment xml:space="preserve">Create a new #ICalAttach from the data in bytes. Takes a reference of @bytes, increase the reference before calling this function if you with to use it afterward. The stored bytes should be already encoded with used encoding (like base64).</comment> + <comment xml:space="preserve">Creates a new #ICalAttach from the data in bytes. Takes a reference of @bytes, increase the reference before calling this function if you with to use it afterward. The stored bytes should be already encoded with used encoding (like base64).</comment> <custom> g_return_val_if_fail (bytes != NULL, NULL); return i_cal_attach_new_full (icalattach_new_from_data (g_bytes_get_data (bytes, NULL), unref_g_bytes, bytes), NULL);</custom> </method> <method name="i_cal_attach_ref" corresponds="icalattach_ref" annotation="skip" kind="others" since="1.0"> <parameter type="ICalAttach *" name="attach" comment="The #ICalAttach to be referenced by once"/> - <comment xml:space="preserve">Increase the ref counter by 1 for the @attach</comment> + <comment xml:space="preserve">Increases the reference counter by 1 for the @attach.</comment> </method> <method name="i_cal_attach_unref" corresponds="icalattach_unref" annotation="skip" kind="others" since="1.0"> <parameter type="ICalAttach *" name="attach" comment="The #ICalAttach to be unreferenced by once"/> - <comment xml:space="preserve">Decrese the ref counter by 1 for the @attach</comment> + <comment xml:space="preserve">Decreases the reference counter by 1 for the @attach.</comment> </method> <method name="i_cal_attach_get_is_url" corresponds="icalattach_get_is_url" kind="others" since="1.0"> <parameter type="ICalAttach *" name="attach" comment="The #ICalAttach to be queried"/> - <returns type="gboolean" comment="whether the @attach is built from url" /> - <comment xml:space="preserve">Check whether the #ICalAttach is built from url</comment> + <returns type="gboolean" comment="Whether the @attach is built from url" /> + <comment xml:space="preserve">Checks whether the #ICalAttach is built from url.</comment> </method> <method name="i_cal_attach_get_url" corresponds="icalattach_get_url" kind="others" since="1.0"> <parameter type="ICalAttach *" name="attach" comment="The #ICalAttach to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The url component of the @attach. %NULL if it is built from data or there is an error." /> - <comment xml:space="preserve">Get the url, if the #ICalAttach is built from the url.</comment> + <comment xml:space="preserve">Gets the url, if the #ICalAttach is built from the url.</comment> </method> <method name="i_cal_attach_get_data" corresponds="CUSTOM" kind="others" since="1.0"> <parameter type="ICalAttach *" name="attach" comment="The #ICalAttach to be queried"/> <returns type="const gchar *" annotation="nullable, transfer none" comment="The data component of the @attach. %NULL if it is built from url or there is an error." /> - <comment xml:space="preserve">Get the data, if the #ICalAttach is built from the data.</comment> + <comment xml:space="preserve">Gets the data, if the #ICalAttach is built from the data.</comment> <custom> g_return_val_if_fail (I_CAL_IS_ATTACH (attach), NULL); return (const gchar *) (icalattach_get_data ((icalattach *)i_cal_object_get_native (I_CAL_OBJECT (attach))));</custom> diff --git a/src/libical-glib/api/i-cal-component.xml b/src/libical-glib/api/i-cal-component.xml index 4f099ebd..fcde0f42 100644 --- a/src/libical-glib/api/i-cal-component.xml +++ b/src/libical-glib/api/i-cal-component.xml @@ -15,58 +15,58 @@ --> <structure namespace="ICal" name="Component" native="icalcomponent" destroy_func="icalcomponent_free" includes="libical-glib/i-cal-parameter.h"> <method name="i_cal_component_new" corresponds="icalcomponent_new" kind="constructor" since="1.0"> - <parameter type="ICalComponentKind" name="kind" comment="The #ICalComponentKind."/> + <parameter type="ICalComponentKind" name="kind" comment="The #ICalComponentKind"/> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a new #ICalComponent with specific type.</comment> + <comment xml:space="preserve">Creates a new #ICalComponent with specific type.</comment> </method> <method name="i_cal_component_clone" corresponds="icalcomponent_new_clone" kind="clone" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be created."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be created"/> <returns type="ICalComponent *" annotation="transfer full" comment="The newly deeply cloned #ICalComponent."/> <comment xml:space="preserve">Deeply clone a #ICalComponent.</comment> </method> <method name="i_cal_component_new_from_string" corresponds="icalcomponent_new_from_string" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="str" comment="The string used to create #ICalComponent."/> + <parameter type="const gchar *" name="str" comment="The string used to create #ICalComponent"/> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent based on @str."/> - <comment xml:space="preserve">Create a new #ICalComponent based on a string.</comment> + <comment xml:space="preserve">Creates a new #ICalComponent based on a string.</comment> </method> <method name="i_cal_component_new_x" corresponds="icalcomponent_new_x" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="x_name" comment="The name of x property."/> + <parameter type="const gchar *" name="x_name" comment="The name of x property"/> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a new #ICalComponent based on name of x property.</comment> + <comment xml:space="preserve">Creates a new #ICalComponent based on name of x property.</comment> </method> <method name="i_cal_component_free" corresponds="icalcomponent_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be freed."/> - <comment xml:space="preserve">Free a #ICalComponent.</comment> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be freed"/> + <comment xml:space="preserve">Frees a #ICalComponent.</comment> </method> <method name="i_cal_component_as_ical_string" corresponds="icalcomponent_as_ical_string_r" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be converted."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of #ICalComponent."/> - <comment xml:space="preserve">Convert a #ICalComponent to a string.</comment> + <comment xml:space="preserve">Converts a #ICalComponent to a string.</comment> </method> <method name="i_cal_component_is_valid" corresponds="icalcomponent_is_valid" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check whether #ICalComponent is valid.</comment> + <comment xml:space="preserve">Checks whether #ICalComponent is valid.</comment> </method> <method name="i_cal_component_isa" corresponds="icalcomponent_isa" since="1.0"> - <parameter type="const ICalComponent *" name="component" comment="The #ICalComponent to be checked."/> + <parameter type="const ICalComponent *" name="component" comment="The #ICalComponent to be checked"/> <returns type="ICalComponentKind" error_return_value="I_CAL_NO_COMPONENT" comment="A #ICalComponentKind."/> - <comment xml:space="preserve">Get the type of #ICalComponent.</comment> + <comment xml:space="preserve">Gets the type of #ICalComponent.</comment> </method> <method name="i_cal_component_isa_component" corresponds="icalcomponent_isa_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked"/> <returns type="gint" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check whether the native part of #ICalComponent is icalcomponent.</comment> + <comment xml:space="preserve">Checks whether the native part of #ICalComponent is icalcomponent.</comment> </method> <method name="i_cal_component_add_property" corresponds="icalcomponent_add_property" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalProperty *" name="property" translator_argus="component" comment="An #ICalProperty."/> - <comment xml:space="preserve">Add an #ICalProperty into #ICalComponent.</comment> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalProperty *" name="property" translator_argus="component" comment="An #ICalProperty"/> + <comment xml:space="preserve">Adds an #ICalProperty into #ICalComponent.</comment> </method> <method name="i_cal_component_take_property" corresponds="CUSTOM" annotation="skip" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="An #ICalComponent."/> - <parameter type="ICalProperty *" name="property" annotation="transfer full" comment="An #ICalProperty."/> - <comment xml:space="preserve">Add the @property into the @component and unrefs the @property.</comment> + <parameter type="ICalComponent *" name="component" comment="An #ICalComponent"/> + <parameter type="ICalProperty *" name="property" annotation="transfer full" comment="An #ICalProperty"/> + <comment xml:space="preserve">Adds the @property into the @component and unrefs the @property.</comment> <custom> g_return_if_fail(I_CAL_IS_COMPONENT(component)); g_return_if_fail(I_CAL_IS_PROPERTY(property)); @@ -74,65 +74,65 @@ g_object_unref(property);</custom> </method> <method name="i_cal_component_remove_property" corresponds="icalcomponent_remove_property" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalProperty *" name="property" owner_op="REMOVE" comment="A #ICalProperty."/> - <comment xml:space="preserve">Remove #ICalProperty from #ICalComponent. Caution: The compare is based on address. So you must use the original #ICalProperty as the target.</comment> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalProperty *" name="property" owner_op="REMOVE" comment="A #ICalProperty"/> + <comment xml:space="preserve">Removes #ICalProperty from #ICalComponent. Caution: The compare is based on address. So you must use the original #ICalProperty as the target.</comment> </method> <method name="i_cal_component_count_properties" corresponds="icalcomponent_count_properties" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent."/> - <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent"/> + <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> <returns type="gint" comment="The number of #ICalProperty."/> - <comment xml:space="preserve">Count the #ICalProperty in #ICalComponent.</comment> + <comment xml:space="preserve">Counts the number of #ICalProperty in #ICalComponent.</comment> </method> <method name="i_cal_property_get_parent" corresponds="icalproperty_get_parent" since="2.0"> - <parameter type="ICalProperty *" name="property" comment="The #ICalProperty."/> + <parameter type="ICalProperty *" name="property" comment="The #ICalProperty"/> <returns type="ICalComponent *" annotation="transfer full, nullable" translator_argus="(GObject *)property" comment="The parent #ICalComponent of #ICalProperty."/> - <comment xml:space="preserve">Get the parent component of the property. Use with caution. When icalproperty is deallocated, it won't deallocate its parent. However the #ICalComponent object created using this method will be deallocated (if no reference in other places). So You need to make sure there is another reference except the one in #ICalProperty.</comment> + <comment xml:space="preserve">Gets the parent component of the property. Use with caution. When icalproperty is deallocated, it won't deallocate its parent. However the #ICalComponent object created using this method will be deallocated (if no reference in other places). So You need to make sure there is another reference except the one in #ICalProperty.</comment> </method> <method name="i_cal_property_set_parent" corresponds="icalproperty_set_parent" since="3.0"> - <parameter type="ICalProperty *" name="property" comment="An #ICalProperty."/> - <parameter type="ICalComponent *" name="component" annotation="nullable" comment="An #ICalComponent."/> - <comment xml:space="preserve">Set the parent #ICalComponent of the specified #ICalProperty.</comment> + <parameter type="ICalProperty *" name="property" comment="An #ICalProperty"/> + <parameter type="ICalComponent *" name="component" annotation="nullable" comment="An #ICalComponent"/> + <comment xml:space="preserve">Sets the parent #ICalComponent of the specified #ICalProperty.</comment> </method> <method name="i_cal_property_get_datetime_with_component" corresponds="icalproperty_get_datetime_with_component" kind="get" since="3.0.5"> - <parameter type="ICalProperty *" name="prop" comment="An #ICalProperty."/> - <parameter type="ICalComponent *" name="comp" annotation="nullable" comment="An #ICalComponent."/> + <parameter type="ICalProperty *" name="prop" comment="An #ICalProperty"/> + <parameter type="ICalComponent *" name="comp" annotation="nullable" comment="An #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="Get a DATE or DATE-TIME property as an #ICalTime."/> <comment xml:space="preserve">If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it. * * The @comp can be NULL, in which case the parent of the @prop is used to find the corresponding time zone.</comment> </method> <method name="i_cal_component_get_current_property" corresponds="icalcomponent_get_current_property" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> <returns type="ICalProperty *" annotation="transfer full" translator_argus="(GObject *)component" comment="The current #ICalProperty."/> - <comment xml:space="preserve">Get the current #ICalProperty in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the current #ICalProperty in #ICalComponent.</comment> </method> <method name="i_cal_component_get_first_property" corresponds="icalcomponent_get_first_property" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> <returns type="ICalProperty *" annotation="transfer full, nullable" translator_argus="(GObject *)component" comment="The first #ICalProperty."/> - <comment xml:space="preserve">Get the first #ICalProperty with specific kind in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the first #ICalProperty with specific kind in #ICalComponent.</comment> </method> <method name="i_cal_component_get_next_property" corresponds="icalcomponent_get_next_property" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> <returns type="ICalProperty *" annotation="transfer full, nullable" translator_argus="(GObject *)component" comment="The next #ICalProperty."/> - <comment xml:space="preserve">Get the next #ICalProperty with specific kind in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the next #ICalProperty with specific kind in #ICalComponent.</comment> </method> <method name="i_cal_component_get_inner" corresponds="icalcomponent_get_inner" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalComponent *" annotation="transfer full, nullable" translator_argus="(GObject *)comp" comment="The first VEVENT, VTODO or VJOURNAL sub-component."/> - <comment xml:space="preserve">Return the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.</comment> + <comment xml:space="preserve">Returns the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types.</comment> </method> <method name="i_cal_component_add_component" corresponds="icalcomponent_add_component" since="1.0"> - <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent."/> - <parameter type="ICalComponent *" name="child" translator_argus="(GObject*) parent" comment="A child #ICalComponent."/> - <comment xml:space="preserve">Add a #ICalComponent into another #ICalComponent as a child component.</comment> + <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent"/> + <parameter type="ICalComponent *" name="child" translator_argus="(GObject*) parent" comment="A child #ICalComponent"/> + <comment xml:space="preserve">Adds a #ICalComponent into another #ICalComponent as a child component.</comment> </method> <method name="i_cal_component_take_component" corresponds="CUSTOM" annotation="skip" since="1.0"> - <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent."/> - <parameter type="ICalComponent *" name="child" annotation="transfer full" comment="A child #ICalComponent."/> - <comment xml:space="preserve">Add the @child into the @parent as a child component and unrefs the @child.</comment> + <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent"/> + <parameter type="ICalComponent *" name="child" annotation="transfer full" comment="A child #ICalComponent"/> + <comment xml:space="preserve">Adds the @child into the @parent as a child component and unrefs the @child.</comment> <custom> g_return_if_fail(I_CAL_IS_COMPONENT(parent)); g_return_if_fail(I_CAL_IS_COMPONENT(child)); @@ -140,267 +140,267 @@ g_object_unref(child);</custom> </method> <method name="i_cal_component_remove_component" corresponds="icalcomponent_remove_component" since="1.0"> - <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent."/> - <parameter type="ICalComponent *" name="child" owner_op="REMOVE" comment="A child #ICalComponent."/> - <comment xml:space="preserve">Remove a child #ICalComponent from another #ICalComponent.</comment> + <parameter type="ICalComponent *" name="parent" comment="A #ICalComponent"/> + <parameter type="ICalComponent *" name="child" owner_op="REMOVE" comment="A child #ICalComponent"/> + <comment xml:space="preserve">Removes a child #ICalComponent from another #ICalComponent.</comment> </method> <method name="i_cal_component_count_components" corresponds="icalcomponent_count_components" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be checked"/> <parameter type="ICalComponentKind" name="kind" comment="The target #ICalComponentKind"/> <returns type="gint" comment="The count of child #ICalComponent in the parent one."/> - <comment xml:space="preserve">Count the child #ICalComponent with the target kind in the parent one.</comment> + <comment xml:space="preserve">Counts the child #ICalComponent with the target kind in the parent one.</comment> </method> <method name="i_cal_component_get_parent" corresponds="icalcomponent_get_parent" since="3.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent"/> <returns type="ICalComponent *" annotation="transfer full, nullable" translator_argus="(GObject *)component" comment="The parent #ICalComponent of the @component."/> - <comment xml:space="preserve">Get the parent component of the @component.</comment> + <comment xml:space="preserve">Gets the parent component of the @component.</comment> </method> <method name="i_cal_component_set_parent" corresponds="icalcomponent_set_parent" since="3.0"> - <parameter type="ICalComponent *" name="component" comment="An #ICalComponent, a child."/> - <parameter type="ICalComponent *" name="parent" annotation="nullable" comment="An #ICalComponent, a new parent."/> - <comment xml:space="preserve">Set the @parent #ICalComponent of the specified @component.</comment> + <parameter type="ICalComponent *" name="component" comment="An #ICalComponent, a child"/> + <parameter type="ICalComponent *" name="parent" annotation="nullable" comment="An #ICalComponent, a new parent"/> + <comment xml:space="preserve">Sets the @parent #ICalComponent of the specified @component.</comment> </method> <method name="i_cal_component_merge_component" corresponds="icalcomponent_merge_component" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent"/> <parameter type="ICalComponent *" name="comp_to_merge" annotation="in" native_op="STEAL" comment="A #ICalComponent. After merged it will not exist any more."/> - <comment xml:space="preserve">This takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs. comp_to_merge will no longer exist after calling this function.</comment> + <comment xml:space="preserve">Takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs. comp_to_merge will no longer exist after calling this function.</comment> </method> <method name="i_cal_component_get_current_component" corresponds="icalcomponent_get_current_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> <returns type="ICalComponent *" annotation="transfer full" translator_argus="(GObject *)component" comment="The current #ICalComponent."/> - <comment xml:space="preserve">Get the current #ICalComponent in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the current #ICalComponent in #ICalComponent.</comment> </method> <method name="i_cal_component_get_first_component" corresponds="icalcomponent_get_first_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="ICalComponent *" annotation="transfer full, nullable" translator_argus="(GObject *)component" comment="The first #ICalComponent."/> - <comment xml:space="preserve">Get the first #ICalComponent with specific kind in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the first #ICalComponent with specific kind in #ICalComponent.</comment> </method> <method name="i_cal_component_get_next_component" corresponds="icalcomponent_get_next_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="ICalComponent *" annotation="transfer full, nullable" translator_argus="(GObject *)component" comment="The next #ICalComponent."/> - <comment xml:space="preserve">Get the next #ICalComponent with specific kind in #ICalComponent.</comment> + <comment xml:space="preserve">Gets the next #ICalComponent with specific kind in #ICalComponent.</comment> </method> <method name="i_cal_component_begin_component" corresponds="icalcomponent_begin_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="ICalCompIter *" annotation="transfer full" comment="A #ICalCompIter"/> - <comment xml:space="preserve">Get the #ICalCompIter pointing to the first child #ICalComponent. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> + <comment xml:space="preserve">Gets the #ICalCompIter pointing to the first child #ICalComponent. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> </method> <method name="i_cal_component_end_component" corresponds="icalcomponent_end_component" since="1.0"> - <parameter type="ICalComponent *" name="component" comment="A #ICalComponent."/> - <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="ICalComponent *" name="component" comment="A #ICalComponent"/> + <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="ICalCompIter *" annotation="transfer full" comment="A #ICalCompIter"/> - <comment xml:space="preserve">Get the #ICalCompIter pointing to the end child #ICalComponent. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> + <comment xml:space="preserve">Gets the #ICalCompIter pointing to the end child #ICalComponent. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> </method> <method name="i_cal_comp_iter_next" corresponds="icalcompiter_next" since="1.0"> - <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter."/> + <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter"/> <returns type="ICalComponent *" annotation="transfer full" comment="A #ICalCompIter"/> - <comment xml:space="preserve">Get the next #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> + <comment xml:space="preserve">Gets the next #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> </method> <method name="i_cal_comp_iter_prior" corresponds="icalcompiter_prior" since="1.0"> - <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter."/> + <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter"/> <returns type="ICalComponent *" annotation="transfer full" comment="A #ICalCompIter"/> - <comment xml:space="preserve">Get the prior #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> + <comment xml:space="preserve">Gets the prior #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> </method> <method name="i_cal_comp_iter_deref" corresponds="icalcompiter_deref" since="1.0"> - <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter."/> + <parameter type="ICalCompIter *" name="i" native_op="POINTER" comment="A #ICalCompIter"/> <returns type="ICalComponent *" annotation="transfer full" comment="A #ICalComponent"/> - <comment xml:space="preserve">Get the current #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> + <comment xml:space="preserve">Gets the current #ICalComponent pointed by #ICalCompIter. Use #ICalCompIter when you need remove the child component from the parent. For traversing, i_cal_object_set_owner needs to be called after this API. See component.py in tests for details.</comment> </method> <method name="i_cal_component_check_restrictions" corresponds="icalcomponent_check_restrictions" kind="other" since="1.0"> <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent to be checked"/> <returns type="gint" comment="The number of restrictions in @comp"/> - <comment xml:space="preserve">Check the number of restrictions in #ICalComponent</comment> + <comment xml:space="preserve">Checks the number of restrictions in #ICalComponent.</comment> </method> <method name="i_cal_component_count_errors" corresponds="icalcomponent_count_errors" since="1.0"> <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="gint" comment="The count of errors."/> - <comment xml:space="preserve">Count the number of errors in #ICalComponent.</comment> + <comment xml:space="preserve">Counts the number of errors in #ICalComponent.</comment> </method> <method name="i_cal_component_strip_errors" corresponds="icalcomponent_strip_errors" since="1.0"> <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> - <comment xml:space="preserve">Remove all X-LIC-ERROR properties.</comment> + <comment xml:space="preserve">Removes all X-LIC-ERROR properties.</comment> </method> <method name="i_cal_component_convert_errors" corresponds="icalcomponent_convert_errors" since="1.0"> <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> - <comment xml:space="preserve">Convert some X-LIC-ERROR properties into RETURN-STATUS properties.</comment> + <comment xml:space="preserve">Converts some X-LIC-ERROR properties into RETURN-STATUS properties.</comment> </method> <method name="i_cal_component_kind_is_valid" corresponds="icalcomponent_kind_is_valid" since="1.0"> - <parameter type="const ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="const ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="gboolean" comment="1 if @kind id a #ICalComponent but not the I_CAL_NO_COMPONENT, 0 if not."/> - <comment xml:space="preserve">Check if a #ICalComponentKind is valid.</comment> + <comment xml:space="preserve">Checks if a #ICalComponentKind is valid.</comment> </method> <method name="i_cal_component_kind_from_string" corresponds="icalcomponent_string_to_kind" since="1.0"> - <parameter type="const gchar *" name="string" comment="A string."/> + <parameter type="const gchar *" name="string" comment="A string"/> <returns type="ICalComponentKind" error_return_value="I_CAL_NO_COMPONENT" comment="A #ICalComponentKind"/> - <comment xml:space="preserve">Convert a string to a #ICalComponentKind.</comment> + <comment xml:space="preserve">Converts a string to a #ICalComponentKind.</comment> </method> <method name="i_cal_component_kind_to_string" corresponds="icalcomponent_kind_to_string" since="1.0"> - <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind."/> + <parameter type="ICalComponentKind" name="kind" comment="A #ICalComponentKind"/> <returns type="const gchar *" annotation="transfer none" comment="The string representation of @kind."/> - <comment xml:space="preserve">Convert a #ICalComponentKind to a string.</comment> + <comment xml:space="preserve">Converts a #ICalComponentKind to a string.</comment> </method> <method name="i_cal_component_get_first_real_component" corresponds="icalcomponent_get_first_real_component" since="1.0"> - <parameter type="ICalComponent *" name="c" comment="A VCOMPONENT type of #ICalComponent."/> + <parameter type="ICalComponent *" name="c" comment="A VCOMPONENT type of #ICalComponent"/> <returns type="ICalComponent *" annotation="transfer full" translator_argus="(GObject *)c" comment="A reference to the first VEVENT, VTODO or VJOURNAL"/> - <comment xml:space="preserve">For VCOMPONENT: Return a reference to the first VEVENT, VTODO or VJOURNAL.</comment> + <comment xml:space="preserve">For VCOMPONENT: Returns a reference to the first VEVENT, VTODO or VJOURNAL.</comment> </method> <method name="i_cal_component_get_span" corresponds="icalcomponent_get_span" since="1.0"> <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTimeSpan *" annotation="transfer full" comment="A #ICalTimeSpan."/> - <comment xml:space="preserve">For VEVENT, VTODO, VJOURNAL and VTIMEZONE: report the start and end times of an event in UTC</comment> + <comment xml:space="preserve">For VEVENT, VTODO, VJOURNAL and VTIMEZONE: reports the start and end times of an event in UTC.</comment> </method> <method name="i_cal_component_set_dtstart" corresponds="icalcomponent_set_dtstart" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="v" comment="A #ICalTime."/> - <comment xml:space="preserve">Set the dtstart of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="v" comment="A #ICalTime"/> + <comment xml:space="preserve">Sets the dtstart of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_dtstart" corresponds="icalcomponent_get_dtstart" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="A #ICalTime."/> - <comment xml:space="preserve">Get the dtstart of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the dtstart of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_dtend" corresponds="icalcomponent_set_dtend" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="v" comment="A #ICalTime."/> - <comment xml:space="preserve">Set the dtend of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="v" comment="A #ICalTime"/> + <comment xml:space="preserve">Sets the dtend of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_dtend" corresponds="icalcomponent_get_dtend" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="A #ICalTime."/> - <comment xml:space="preserve">Get the dtend of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the dtend of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_due" corresponds="icalcomponent_set_due" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="v" comment="A #ICalTime."/> - <comment xml:space="preserve">Set the due of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="v" comment="A #ICalTime"/> + <comment xml:space="preserve">Sets the due of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_due" corresponds="icalcomponent_get_due" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="A #ICalTime."/> - <comment xml:space="preserve">Get the due of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the due of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_duration" corresponds="icalcomponent_set_duration" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalDuration *" name="v" comment="A #ICalDuration."/> - <comment xml:space="preserve">Set the duration of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalDuration *" name="v" comment="A #ICalDuration"/> + <comment xml:space="preserve">Sets the duration of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_duration" corresponds="icalcomponent_get_duration" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalDuration *" annotation="transfer full" comment="An #ICalDuration."/> - <comment xml:space="preserve">Get the duration of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the duration of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_method" corresponds="icalcomponent_set_method" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalPropertyMethod" name="method" comment="A #ICalPropertyMethod."/> - <comment xml:space="preserve">Set the method of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalPropertyMethod" name="method" comment="A #ICalPropertyMethod"/> + <comment xml:space="preserve">Sets the method of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_method" corresponds="icalcomponent_get_method" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalPropertyMethod" comment="A #ICalPropertyMethod."/> - <comment xml:space="preserve">Get the method of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the method of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_dtstamp" corresponds="icalcomponent_set_dtstamp" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="v" comment="A #ICalTime."/> - <comment xml:space="preserve">Set the dtstamp of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="v" comment="A #ICalTime"/> + <comment xml:space="preserve">Sets the dtstamp of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_dtstamp" corresponds="icalcomponent_get_dtstamp" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="A #ICalTime."/> - <comment xml:space="preserve">Get the dtstamp of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the dtstamp of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_summary" corresponds="icalcomponent_set_summary" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing summary."/> - <comment xml:space="preserve">Set the summary of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing summary"/> + <comment xml:space="preserve">Sets the summary of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_summary" corresponds="icalcomponent_get_summary" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The summary of @comp."/> - <comment xml:space="preserve">Get the summary of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the summary of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_comment" corresponds="icalcomponent_set_comment" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing comment."/> - <comment xml:space="preserve">Set the comment of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing comment"/> + <comment xml:space="preserve">Sets the comment of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_comment" corresponds="icalcomponent_get_comment" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The comment of @comp."/> - <comment xml:space="preserve">Get the comment of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the comment of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_uid" corresponds="icalcomponent_set_uid" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing uid."/> - <comment xml:space="preserve">Set the uid of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing uid"/> + <comment xml:space="preserve">Sets the uid of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_uid" corresponds="icalcomponent_get_uid" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The uid of @comp."/> - <comment xml:space="preserve">Get the uid of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the uid of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_relcalid" corresponds="icalcomponent_set_relcalid" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing relcalid."/> - <comment xml:space="preserve">Set the relcalid of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing relcalid"/> + <comment xml:space="preserve">Sets the relcalid of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_relcalid" corresponds="icalcomponent_get_relcalid" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The relcalid of @comp."/> - <comment xml:space="preserve">Get the relcalid of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the relcalid of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_recurrenceid" corresponds="icalcomponent_set_recurrenceid" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="v" comment="A #ICalTime."/> - <comment xml:space="preserve">Set the recurrenceid of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="v" comment="A #ICalTime"/> + <comment xml:space="preserve">Sets the recurrenceid of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_recurrenceid" corresponds="icalcomponent_get_recurrenceid" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalTime *" annotation="transfer full" comment="A #ICalTime."/> - <comment xml:space="preserve">Get the recurrenceid of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the recurrenceid of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_description" corresponds="icalcomponent_set_description" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing description."/> - <comment xml:space="preserve">Set the description of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing description"/> + <comment xml:space="preserve">Sets the description of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_description" corresponds="icalcomponent_get_description" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The description of @comp."/> - <comment xml:space="preserve">Get the description of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the description of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_location" corresponds="icalcomponent_set_location" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="v" comment="A string representing location."/> - <comment xml:space="preserve">Set the location of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="v" comment="A string representing location"/> + <comment xml:space="preserve">Sets the location of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_location" corresponds="icalcomponent_get_location" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="const gchar *" annotation="transfer none" comment="The location of @comp."/> - <comment xml:space="preserve">Get the location of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the location of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_sequence" corresponds="icalcomponent_set_sequence" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="gint" name="v" comment="The sequence number."/> - <comment xml:space="preserve">Set the sequence of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="gint" name="v" comment="The sequence number"/> + <comment xml:space="preserve">Sets the sequence of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_sequence" corresponds="icalcomponent_get_sequence" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="gint" comment="The sequence of @comp."/> - <comment xml:space="preserve">Get the sequence of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the sequence of the #ICalComponent.</comment> </method> <method name="i_cal_component_set_status" corresponds="icalcomponent_set_status" kind="set" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalPropertyStatus" name="status" comment="A #ICalPropertyStatus."/> - <comment xml:space="preserve">Set the status of the #ICalComponent.</comment> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalPropertyStatus" name="status" comment="A #ICalPropertyStatus"/> + <comment xml:space="preserve">Sets the status of the #ICalComponent.</comment> </method> <method name="i_cal_component_get_status" corresponds="icalcomponent_get_status" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> <returns type="ICalPropertyStatus" comment="A #ICalPropertyStatus."/> - <comment xml:space="preserve">Get the status of the #ICalComponent.</comment> + <comment xml:space="preserve">Gets the status of the #ICalComponent.</comment> </method> <declaration position="header" content="typedef void (*ICalComponentForeachTZIDFunc)(ICalParameter *param, gpointer user_data);"/> <declaration position="body"> @@ -422,10 +422,10 @@ static void foreach_tzid_cb(icalparameter *in_param, void *user_data) g_object_unref(param); }</declaration> <method name="i_cal_component_foreach_tzid" corresponds="CUSTOM" kind="other" since="3.0.5"> - <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent to be queried."/> - <parameter type="ICalComponentForeachTZIDFunc" name="callback" annotation="scope call" comment="The callback function."/> + <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent to be queried"/> + <parameter type="ICalComponentForeachTZIDFunc" name="callback" annotation="scope call" comment="The callback function"/> <parameter type="gpointer" name="user_data" annotation="nullable, closure callback" comment="The data for callback function"/> - <comment>Apply the same manipulation on every tzid in #ICalComponent.</comment> + <comment>Applies the same manipulation on every tzid in #ICalComponent.</comment> <custom> struct ForeachTZIDData data; icalcomponent *native_comp; @@ -462,12 +462,12 @@ static void foreach_recurrence_cb(icalcomponent *in_comp, struct icaltime_span * g_object_unref(span); }</declaration> <method name="i_cal_component_foreach_recurrence" corresponds="CUSTOM" kind="other" since="3.0.5"> - <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent to be queried."/> + <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent to be queried"/> <parameter type="ICalTime *" name="start" comment="Ignore timespans before this"/> <parameter type="ICalTime *" name="end" comment="Ignore timespans after this"/> - <parameter type="ICalComponentForeachRecurrenceFunc" name="callback" annotation="scope call" comment="Function called for each timespan within the range."/> + <parameter type="ICalComponentForeachRecurrenceFunc" name="callback" annotation="scope call" comment="Function called for each timespan within the range"/> <parameter type="gpointer" name="user_data" annotation="nullable, closure callback" comment="The user data for callback function"/> - <comment>Cycle through all recurrances of an event. This function will call the specified callback function for once for the base value of DTSTART, and foreach recurring date/time value. It will filter out events that are specified as an EXDATE or an EXRULE.</comment> + <comment>Cycles through all recurrences of an event. This function will call the specified callback function for once for the base value of DTSTART, and foreach recurring date/time value. It will filter out events that are specified as an EXDATE or an EXRULE.</comment> <custom> struct ForeachRecurrenceData data; icalcomponent *native_comp; struct icaltimetype *native_start, *native_end; @@ -491,80 +491,80 @@ static void foreach_recurrence_cb(icalcomponent *in_comp, struct icaltime_span * icalcomponent_foreach_recurrence(native_comp, *native_start, *native_end, foreach_recurrence_cb, &data);</custom> </method> <method name="i_cal_component_get_timezone" corresponds="icalcomponent_get_timezone" kind="get" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="const gchar *" name="tzid" comment="A string representing timezone."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="const gchar *" name="tzid" comment="A string representing timezone"/> <returns type="ICalTimezone *" annotation="transfer full, allow-none" translator_argus="(GObject *)comp, FALSE" comment="A #ICalTimezone."/> <comment xml:space="preserve">Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.</comment> </method> <method name="i_cal_property_recurrence_is_excluded" corresponds="icalproperty_recurrence_is_excluded" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent."/> - <parameter type="ICalTime *" name="dtstart" native_op="POINTER" comment="The base dtstart value for this component."/> - <parameter type="ICalTime *" name="recurtime" native_op="POINTER" comment="The time to test against."/> + <parameter type="ICalComponent *" name="comp" comment="A #ICalComponent"/> + <parameter type="ICalTime *" name="dtstart" native_op="POINTER" comment="The base dtstart value for this component"/> + <parameter type="ICalTime *" name="recurtime" native_op="POINTER" comment="The time to test against"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Decide if this recurrance is acceptable. This function decides if a specific recurrence value is excluded by EXRULE or EXDATE properties.</comment> + <comment xml:space="preserve">Decides if this recurrence is acceptable. This function decides if a specific recurrence value is excluded by EXRULE or EXDATE properties.</comment> </method> <method name="i_cal_component_new_vcalendar" corresponds="icalcomponent_new_vcalendar" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vcalendar</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vcalendar.</comment> </method> <method name="i_cal_component_new_vevent" corresponds="icalcomponent_new_vevent" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vevent</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vevent.</comment> </method> <method name="i_cal_component_new_vtodo" corresponds="icalcomponent_new_vtodo" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vtodo</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vtodo.</comment> </method> <method name="i_cal_component_new_vjournal" corresponds="icalcomponent_new_vjournal" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vjournal</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vjournal.</comment> </method> <method name="i_cal_component_new_valarm" corresponds="icalcomponent_new_valarm" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be valarm</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be valarm.</comment> </method> <method name="i_cal_component_new_vfreebusy" corresponds="icalcomponent_new_vfreebusy" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vfreebusy</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vfreebusy.</comment> </method> <method name="i_cal_component_new_vtimezone" corresponds="icalcomponent_new_vtimezone" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vtimezone</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vtimezone.</comment> </method> <method name="i_cal_component_new_xstandard" corresponds="icalcomponent_new_xstandard" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be xstandard</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be xstandard.</comment> </method> <method name="i_cal_component_new_xdaylight" corresponds="icalcomponent_new_xdaylight" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be xdaylight</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be xdaylight.</comment> </method> <method name="i_cal_component_new_vagenda" corresponds="icalcomponent_new_vagenda" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vagenda</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vagenda.</comment> </method> <method name="i_cal_component_new_vquery" corresponds="icalcomponent_new_vquery" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vquery</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vquery.</comment> </method> <method name="i_cal_component_new_vavailability" corresponds="icalcomponent_new_vavailability" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vavailability</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vavailability.</comment> </method> <method name="i_cal_component_new_xavailable" corresponds="icalcomponent_new_xavailable" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be xavailable</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be xavailable.</comment> </method> <method name="i_cal_component_new_vpoll" corresponds="icalcomponent_new_vpoll" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vpoll</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vpoll.</comment> </method> <method name="i_cal_component_new_vvoter" corresponds="icalcomponent_new_vvoter" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be vvoter</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be vvoter.</comment> </method> <method name="i_cal_component_new_xvote" corresponds="icalcomponent_new_xvote" kind="constructor" since="1.0"> <returns type="ICalComponent *" annotation="transfer full" comment="The newly created #ICalComponent."/> - <comment xml:space="preserve">Create a #ICalComponent with the type to be xvote</comment> + <comment xml:space="preserve">Creates a #ICalComponent with the type to be xvote.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-datetimeperiod.xml b/src/libical-glib/api/i-cal-datetimeperiod.xml index 226a4095..bfeadab1 100644 --- a/src/libical-glib/api/i-cal-datetimeperiod.xml +++ b/src/libical-glib/api/i-cal-datetimeperiod.xml @@ -16,7 +16,7 @@ <structure namespace="ICal" name="Datetimeperiod" native="struct icaldatetimeperiodtype" is_bare="true" default_native="i_cal_datetimeperiod_new_default ()" includes="libical-glib/i-cal-time.h, libical-glib/i-cal-period.h"> <method name="i_cal_datetimeperiod_new_default" corresponds="CUSTOM" annotation="skip" kind="private" since="1.0"> <returns type="struct icaldatetimeperiodtype" annotation="transfer full" comment="The newly created #ICalDatetimeperiod" /> - <comment xml:space="preserve">Create a new default #ICalDatetimeperiod</comment> + <comment xml:space="preserve">Creates a new default #ICalDatetimeperiod.</comment> <custom> struct icaldatetimeperiodtype datetimeperiodtype; datetimeperiodtype.time = icaltime_null_time (); datetimeperiodtype.period = icalperiodtype_null_period (); @@ -24,20 +24,20 @@ </method> <method name="i_cal_datetimeperiod_new" corresponds="CUSTOM" kind="constructor" since="1.0"> <returns type="ICalDatetimeperiod *" annotation="transfer full" comment="The newly created #ICalDatetimeperiod." /> - <comment xml:space="preserve">Create a new #ICalDatetimeperiod.</comment> + <comment xml:space="preserve">Creates a new #ICalDatetimeperiod.</comment> <custom> return i_cal_datetimeperiod_new_full(i_cal_datetimeperiod_new_default());</custom> </method> <method name="i_cal_datetimeperiod_get_time" corresponds="CUSTOM" kind="get" since="1.0"> <parameter type="ICalDatetimeperiod *" name="dtp" comment="The #ICalDatetimeperiod to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="The time attribute of @dtp."/> - <comment>Get the time attribute of #ICalDatetimeperiod.</comment> + <comment>Gets the time attribute of #ICalDatetimeperiod.</comment> <custom> g_return_val_if_fail (dtp != NULL && I_CAL_IS_DATETIMEPERIOD (dtp), NULL); return i_cal_time_new_full (((struct icaldatetimeperiodtype *)i_cal_object_get_native ((ICalObject *)dtp))->time);</custom> </method> <method name="i_cal_datetimeperiod_set_time" corresponds="CUSTOM" kind="set" since="1.0"> <parameter type="ICalDatetimeperiod *" name="dtp" comment="The #ICalDatetimeperiod to be set"/> - <parameter type="ICalTime *" name="time" comment="The time attribute of @dtp."/> - <comment>Set the time attribute of #ICalDatetimeperiod.</comment> + <parameter type="ICalTime *" name="time" comment="The time attribute of @dtp"/> + <comment>Sets the time attribute of #ICalDatetimeperiod.</comment> <custom> g_return_if_fail (dtp != NULL && I_CAL_IS_DATETIMEPERIOD (dtp)); g_return_if_fail (time != NULL && I_CAL_IS_TIME(time)); ((struct icaldatetimeperiodtype *)i_cal_object_get_native ((ICalObject *)dtp))->time = *(struct icaltimetype *)i_cal_object_get_native ((ICalObject *)time);</custom> @@ -45,14 +45,14 @@ <method name="i_cal_datetimeperiod_get_period" corresponds="CUSTOM" kind="get" since="1.0"> <parameter type="ICalDatetimeperiod *" name="dtp" comment="The #ICalDatetimeperiod to be queried"/> <returns type="ICalPeriod *" annotation="transfer full" comment="The period attribute of @dtp."/> - <comment>Get the period attribute of #ICalDatetimeperiod.</comment> + <comment>Gets the period attribute of #ICalDatetimeperiod.</comment> <custom> g_return_val_if_fail (dtp != NULL && I_CAL_IS_DATETIMEPERIOD (dtp), NULL); return i_cal_period_new_full (((struct icaldatetimeperiodtype *)i_cal_object_get_native ((ICalObject *)dtp))->period);</custom> </method> <method name="i_cal_datetimeperiod_set_period" corresponds="CUSTOM" kind="set" since="1.0"> <parameter type="ICalDatetimeperiod *" name="dtp" comment="The #ICalDatetimeperiod to be set"/> - <parameter type="ICalPeriod *" name="period" comment="The period attribute of @dtp."/> - <comment>Set the period attribute of #ICalDatetimeperiod.</comment> + <parameter type="ICalPeriod *" name="period" comment="The period attribute of @dtp"/> + <comment>Sets the period attribute of #ICalDatetimeperiod.</comment> <custom> g_return_if_fail (dtp != NULL && I_CAL_IS_DATETIMEPERIOD (dtp)); g_return_if_fail (period != NULL && I_CAL_IS_PERIOD(period)); ((struct icaldatetimeperiodtype *)i_cal_object_get_native ((ICalObject *)dtp))->period = *(struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period);</custom> diff --git a/src/libical-glib/api/i-cal-derived-parameter.xml b/src/libical-glib/api/i-cal-derived-parameter.xml index 6a84a7e3..1a309e4a 100644 --- a/src/libical-glib/api/i-cal-derived-parameter.xml +++ b/src/libical-glib/api/i-cal-derived-parameter.xml @@ -228,7 +228,7 @@ <method name="i_cal_parameter_new_actionparam" corresponds="icalparameter_new_actionparam" kind="constructor" since="1.0"> <parameter type="ICalParameterAction" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the action type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the action type.</comment> </method> <method name="i_cal_parameter_get_actionparam" corresponds="icalparameter_get_actionparam" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -247,7 +247,7 @@ </method> <method name="i_cal_parameter_get_altrep" corresponds="icalparameter_get_altrep" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_altrep" corresponds="icalparameter_set_altrep" kind="set" since="1.0"> @@ -262,7 +262,7 @@ </method> <method name="i_cal_parameter_get_charset" corresponds="icalparameter_get_charset" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_charset" corresponds="icalparameter_set_charset" kind="set" since="1.0"> @@ -277,7 +277,7 @@ </method> <method name="i_cal_parameter_get_cn" corresponds="icalparameter_get_cn" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_cn" corresponds="icalparameter_set_cn" kind="set" since="1.0"> @@ -292,12 +292,12 @@ </method> <method name="i_cal_parameter_get_cutype" corresponds="icalparameter_get_cutype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="ICalParameterCutype" annotation="allow-none" comment="the property of the @value" /> + <returns type="ICalParameterCutype" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_cutype" corresponds="icalparameter_set_cutype" kind="set" since="1.0"> <parameter type="ICalParameter *" name="value" comment="The #ICalParameter to be set"/> - <parameter type="ICalParameterCutype" name="v" comment="The @ICalParameterCutype used to set @value."/> + <parameter type="ICalParameterCutype" name="v" comment="The @ICalParameterCutype used to set @value"/> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_new_delegatedfrom" corresponds="icalparameter_new_delegatedfrom" kind="constructor" since="1.0"> @@ -307,7 +307,7 @@ </method> <method name="i_cal_parameter_get_delegatedfrom" corresponds="icalparameter_get_delegatedfrom" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_delegatedfrom" corresponds="icalparameter_set_delegatedfrom" kind="set" since="1.0"> @@ -322,7 +322,7 @@ </method> <method name="i_cal_parameter_get_delegatedto" corresponds="icalparameter_get_delegatedto" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_delegatedto" corresponds="icalparameter_set_delegatedto" kind="set" since="1.0"> @@ -337,7 +337,7 @@ </method> <method name="i_cal_parameter_get_dir" corresponds="icalparameter_get_dir" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_dir" corresponds="icalparameter_set_dir" kind="set" since="1.0"> @@ -348,7 +348,7 @@ <method name="i_cal_parameter_new_enable" corresponds="icalparameter_new_enable" kind="constructor" since="1.0"> <parameter type="ICalParameterEnable" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the enable type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the enable type.</comment> </method> <method name="i_cal_parameter_get_enable" corresponds="icalparameter_get_enable" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -363,7 +363,7 @@ <method name="i_cal_parameter_new_encoding" corresponds="icalparameter_new_encoding" kind="constructor" since="1.0"> <parameter type="ICalParameterEncoding" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the encoding type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the encoding type.</comment> </method> <method name="i_cal_parameter_get_encoding" corresponds="icalparameter_get_encoding" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -378,7 +378,7 @@ <method name="i_cal_parameter_new_fbtype" corresponds="icalparameter_new_fbtype" kind="constructor" since="1.0"> <parameter type="ICalParameterFbtype" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the fbtype type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the fbtype type.</comment> </method> <method name="i_cal_parameter_get_fbtype" corresponds="icalparameter_get_fbtype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -397,7 +397,7 @@ </method> <method name="i_cal_parameter_get_filename" corresponds="icalparameter_get_filename" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_filename" corresponds="icalparameter_set_filename" kind="set" since="2.0"> @@ -412,7 +412,7 @@ </method> <method name="i_cal_parameter_get_fmttype" corresponds="icalparameter_get_fmttype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_fmttype" corresponds="icalparameter_set_fmttype" kind="set" since="1.0"> @@ -427,7 +427,7 @@ </method> <method name="i_cal_parameter_get_iana" corresponds="icalparameter_get_iana" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_iana" corresponds="icalparameter_set_iana" kind="set" since="1.0"> @@ -442,7 +442,7 @@ </method> <method name="i_cal_parameter_get_id" corresponds="icalparameter_get_id" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_id" corresponds="icalparameter_set_id" kind="set" since="1.0"> @@ -457,7 +457,7 @@ </method> <method name="i_cal_parameter_get_language" corresponds="icalparameter_get_language" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_language" corresponds="icalparameter_set_language" kind="set" since="1.0"> @@ -472,7 +472,7 @@ </method> <method name="i_cal_parameter_get_latency" corresponds="icalparameter_get_latency" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_latency" corresponds="icalparameter_set_latency" kind="set" since="1.0"> @@ -483,7 +483,7 @@ <method name="i_cal_parameter_new_local" corresponds="icalparameter_new_local" kind="constructor" since="1.0"> <parameter type="ICalParameterLocal" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the local type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the local type.</comment> </method> <method name="i_cal_parameter_get_local" corresponds="icalparameter_get_local" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -502,7 +502,7 @@ </method> <method name="i_cal_parameter_get_localize" corresponds="icalparameter_get_localize" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_localize" corresponds="icalparameter_set_localize" kind="set" since="1.0"> @@ -517,7 +517,7 @@ </method> <method name="i_cal_parameter_get_managedid" corresponds="icalparameter_get_managedid" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_managedid" corresponds="icalparameter_set_managedid" kind="set" since="2.0"> @@ -532,7 +532,7 @@ </method> <method name="i_cal_parameter_get_member" corresponds="icalparameter_get_member" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_member" corresponds="icalparameter_set_member" kind="set" since="1.0"> @@ -547,7 +547,7 @@ </method> <method name="i_cal_parameter_get_modified" corresponds="icalparameter_get_modified" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_modified" corresponds="icalparameter_set_modified" kind="set" since="2.0"> @@ -562,7 +562,7 @@ </method> <method name="i_cal_parameter_get_options" corresponds="icalparameter_get_options" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_options" corresponds="icalparameter_set_options" kind="set" since="1.0"> @@ -573,7 +573,7 @@ <method name="i_cal_parameter_new_partstat" corresponds="icalparameter_new_partstat" kind="constructor" since="1.0"> <parameter type="ICalParameterPartstat" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the partstat type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the partstat type.</comment> </method> <method name="i_cal_parameter_get_partstat" corresponds="icalparameter_get_partstat" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -592,7 +592,7 @@ </method> <method name="i_cal_parameter_get_publiccomment" corresponds="icalparameter_get_publiccomment" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_publiccomment" corresponds="icalparameter_set_publiccomment" kind="set" since="2.0"> @@ -603,7 +603,7 @@ <method name="i_cal_parameter_new_range" corresponds="icalparameter_new_range" kind="constructor" since="1.0"> <parameter type="ICalParameterRange" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the range type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the range type.</comment> </method> <method name="i_cal_parameter_get_range" corresponds="icalparameter_get_range" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -622,7 +622,7 @@ </method> <method name="i_cal_parameter_get_reason" corresponds="icalparameter_get_reason" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_reason" corresponds="icalparameter_set_reason" kind="set" since="2.0"> @@ -633,7 +633,7 @@ <method name="i_cal_parameter_new_related" corresponds="icalparameter_new_related" kind="constructor" since="1.0"> <parameter type="ICalParameterRelated" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the related type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the related type.</comment> </method> <method name="i_cal_parameter_get_related" corresponds="icalparameter_get_related" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -648,7 +648,7 @@ <method name="i_cal_parameter_new_reltype" corresponds="icalparameter_new_reltype" kind="constructor" since="1.0"> <parameter type="ICalParameterReltype" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the reltype type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the reltype type.</comment> </method> <method name="i_cal_parameter_get_reltype" corresponds="icalparameter_get_reltype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -663,7 +663,7 @@ <method name="i_cal_parameter_new_required" corresponds="icalparameter_new_required" kind="constructor" since="2.0"> <parameter type="ICalParameterRequired" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the required type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the required type.</comment> </method> <method name="i_cal_parameter_get_required" corresponds="icalparameter_get_required" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -678,7 +678,7 @@ <method name="i_cal_parameter_new_response" corresponds="icalparameter_new_response" kind="constructor" since="2.0"> <parameter type="gint" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the response type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the response type.</comment> </method> <method name="i_cal_parameter_get_response" corresponds="icalparameter_get_response" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -693,7 +693,7 @@ <method name="i_cal_parameter_new_role" corresponds="icalparameter_new_role" kind="constructor" since="1.0"> <parameter type="ICalParameterRole" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the role type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the role type.</comment> </method> <method name="i_cal_parameter_get_role" corresponds="icalparameter_get_role" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -708,7 +708,7 @@ <method name="i_cal_parameter_new_rsvp" corresponds="icalparameter_new_rsvp" kind="constructor" since="1.0"> <parameter type="ICalParameterRsvp" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the rsvp type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the rsvp type.</comment> </method> <method name="i_cal_parameter_get_rsvp" corresponds="icalparameter_get_rsvp" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -723,7 +723,7 @@ <method name="i_cal_parameter_new_scheduleagent" corresponds="icalparameter_new_scheduleagent" kind="constructor" since="1.0"> <parameter type="ICalParameterScheduleagent" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the scheduleagent type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the scheduleagent type.</comment> </method> <method name="i_cal_parameter_get_scheduleagent" corresponds="icalparameter_get_scheduleagent" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -738,7 +738,7 @@ <method name="i_cal_parameter_new_scheduleforcesend" corresponds="icalparameter_new_scheduleforcesend" kind="constructor" since="1.0"> <parameter type="ICalParameterScheduleforcesend" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the scheduleforcesend type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the scheduleforcesend type.</comment> </method> <method name="i_cal_parameter_get_scheduleforcesend" corresponds="icalparameter_get_scheduleforcesend" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -757,7 +757,7 @@ </method> <method name="i_cal_parameter_get_schedulestatus" corresponds="icalparameter_get_schedulestatus" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_schedulestatus" corresponds="icalparameter_set_schedulestatus" kind="set" since="1.0"> @@ -772,7 +772,7 @@ </method> <method name="i_cal_parameter_get_sentby" corresponds="icalparameter_get_sentby" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_sentby" corresponds="icalparameter_set_sentby" kind="set" since="1.0"> @@ -787,7 +787,7 @@ </method> <method name="i_cal_parameter_get_size" corresponds="icalparameter_get_size" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_size" corresponds="icalparameter_set_size" kind="set" since="2.0"> @@ -798,7 +798,7 @@ <method name="i_cal_parameter_new_stayinformed" corresponds="icalparameter_new_stayinformed" kind="constructor" since="2.0"> <parameter type="ICalParameterStayinformed" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the stayinformed type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the stayinformed type.</comment> </method> <method name="i_cal_parameter_get_stayinformed" corresponds="icalparameter_get_stayinformed" kind="get" since="2.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -813,7 +813,7 @@ <method name="i_cal_parameter_new_substate" corresponds="icalparameter_new_substate" kind="constructor" since="1.0"> <parameter type="ICalParameterSubstate" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the substate type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the substate type.</comment> </method> <method name="i_cal_parameter_get_substate" corresponds="icalparameter_get_substate" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -832,7 +832,7 @@ </method> <method name="i_cal_parameter_get_tzid" corresponds="icalparameter_get_tzid" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_tzid" corresponds="icalparameter_set_tzid" kind="set" since="1.0"> @@ -843,7 +843,7 @@ <method name="i_cal_parameter_new_value" corresponds="icalparameter_new_value" kind="constructor" since="1.0"> <parameter type="ICalParameterValue" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the value type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the value type.</comment> </method> <method name="i_cal_parameter_get_value" corresponds="icalparameter_get_value" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -862,7 +862,7 @@ </method> <method name="i_cal_parameter_get_x" corresponds="icalparameter_get_x" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> <comment xml:space="preserve"></comment> </method> <method name="i_cal_parameter_set_x" corresponds="icalparameter_set_x" kind="set" since="1.0"> @@ -873,7 +873,7 @@ <method name="i_cal_parameter_new_xliccomparetype" corresponds="icalparameter_new_xliccomparetype" kind="constructor" since="1.0"> <parameter type="ICalParameterXliccomparetype" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the xliccomparetype type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the xliccomparetype type.</comment> </method> <method name="i_cal_parameter_get_xliccomparetype" corresponds="icalparameter_get_xliccomparetype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> @@ -888,7 +888,7 @@ <method name="i_cal_parameter_new_xlicerrortype" corresponds="icalparameter_new_xlicerrortype" kind="constructor" since="1.0"> <parameter type="ICalParameterXlicerrortype" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the xlicerrortype type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the xlicerrortype type.</comment> </method> <method name="i_cal_parameter_get_xlicerrortype" corresponds="icalparameter_get_xlicerrortype" kind="get" since="1.0"> <parameter type="const ICalParameter *" name="value" comment="The #ICalParameter to be queried"/> diff --git a/src/libical-glib/api/i-cal-derived-property.xml b/src/libical-glib/api/i-cal-derived-property.xml index be73088e..24e31ef5 100644 --- a/src/libical-glib/api/i-cal-derived-property.xml +++ b/src/libical-glib/api/i-cal-derived-property.xml @@ -133,69 +133,69 @@ <element name="ICAL_NO_PROPERTY"/> </enum> <method name="i_cal_property_new_acceptresponse" corresponds="icalproperty_new_acceptresponse" kind="constructor" since="2.0"> - <parameter type="const gchar *" name="v" comment="The acceptresponse."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The acceptresponse"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_acceptresponse" corresponds="icalproperty_set_acceptresponse" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The acceptresponse."/> - <comment>Set the acceptresponse for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The acceptresponse"/> + <comment>Sets the acceptresponse for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_acceptresponse" corresponds="icalproperty_get_acceptresponse" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the acceptresponse of #ICalProperty."/> - <comment>Get the acceptresponse of #ICalProperty.</comment> + <comment>Gets the acceptresponse of #ICalProperty.</comment> </method> <method name="i_cal_property_new_acknowledged" corresponds="icalproperty_new_acknowledged" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of acknowledgement."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of acknowledgement"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_acknowledged" corresponds="icalproperty_set_acknowledged" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The acknowledgement time."/> - <comment>Set the acknowledged time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The acknowledgement time"/> + <comment>Sets the acknowledged time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_acknowledged" corresponds="icalproperty_get_acknowledged" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the acknowledged time of #ICalProperty."/> - <comment>Get the acknowledged time of #ICalProperty.</comment> + <comment>Gets the acknowledged time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_action" corresponds="icalproperty_new_action" kind="constructor" since="1.0"> - <parameter type="ICalPropertyAction" name="v" comment="The action."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyAction" name="v" comment="The action"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_action" corresponds="icalproperty_set_action" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyAction" name="v" comment="The action."/> - <comment>Set the action for the #ICalProperty.</comment> + <parameter type="ICalPropertyAction" name="v" comment="The action"/> + <comment>Sets the action for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_action" corresponds="icalproperty_get_action" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyAction" comment="Get the action of #ICalProperty."/> - <comment>Get the action of #ICalProperty.</comment> + <comment>Gets the action of #ICalProperty.</comment> </method> <method name="i_cal_property_new_allowconflict" corresponds="icalproperty_new_allowconflict" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The allowconflict."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The allowconflict"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_allowconflict" corresponds="icalproperty_set_allowconflict" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The allowconflict."/> - <comment>Set the allowconflict for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The allowconflict"/> + <comment>Sets the allowconflict for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_allowconflict" corresponds="icalproperty_get_allowconflict" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the allowconflict of #ICalProperty."/> - <comment>Get the allowconflict of #ICalProperty.</comment> + <comment>Gets the allowconflict of #ICalProperty.</comment> </method> <method name="i_cal_property_new_attach" corresponds="CUSTOM" kind="constructor" since="1.0"> - <parameter type="ICalAttach *" name="v" comment="The #ICalAttach."/> + <parameter type="ICalAttach *" name="v" comment="The #ICalAttach"/> <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> <custom> ICalProperty *property; g_return_val_if_fail (I_CAL_IS_ATTACH (v), NULL); property = i_cal_property_new_full (icalproperty_new_attach (i_cal_object_get_native ((ICalObject *)v)), NULL); @@ -203,1647 +203,1647 @@ </method> <method name="i_cal_property_set_attach" corresponds="icalproperty_set_attach" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalAttach *" name="v" annotation="transfer none" comment="The attach."/> - <comment>Set the attach for the #ICalProperty.</comment> + <parameter type="ICalAttach *" name="v" annotation="transfer none" comment="The attach"/> + <comment>Sets the attach for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_attach" corresponds="icalproperty_get_attach" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalAttach *" annotation="transfer full" translator_argus="(GObject *)prop" comment="Get the attach of #ICalProperty."/> - <comment>Get the attach of #ICalProperty.</comment> + <comment>Gets the attach of #ICalProperty.</comment> </method> <method name="i_cal_property_new_attendee" corresponds="icalproperty_new_attendee" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The attendee."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The attendee"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_attendee" corresponds="icalproperty_set_attendee" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The attendee."/> - <comment>Set the attendee for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The attendee"/> + <comment>Sets the attendee for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_attendee" corresponds="icalproperty_get_attendee" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the attendee of #ICalProperty."/> - <comment>Get the attendee of #ICalProperty.</comment> + <comment>Gets the attendee of #ICalProperty.</comment> </method> <method name="i_cal_property_new_busytype" corresponds="icalproperty_new_busytype" kind="constructor" since="2.0"> - <parameter type="ICalPropertyBusytype" name="v" comment="The busytype."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyBusytype" name="v" comment="The busytype"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_busytype" corresponds="icalproperty_set_busytype" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyBusytype" name="v" comment="The busytype."/> - <comment>Set the busytype for the #ICalProperty.</comment> + <parameter type="ICalPropertyBusytype" name="v" comment="The busytype"/> + <comment>Sets the busytype for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_busytype" corresponds="icalproperty_get_busytype" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyBusytype" comment="Get the busytype of #ICalProperty."/> - <comment>Get the busytype of #ICalProperty.</comment> + <comment>Gets the busytype of #ICalProperty.</comment> </method> <method name="i_cal_property_new_calid" corresponds="icalproperty_new_calid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The calid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_calid" corresponds="icalproperty_set_calid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The calid."/> - <comment>Set the calid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calid"/> + <comment>Sets the calid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_calid" corresponds="icalproperty_get_calid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the calid of #ICalProperty."/> - <comment>Get the calid of #ICalProperty.</comment> + <comment>Gets the calid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_calmaster" corresponds="icalproperty_new_calmaster" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The calmaster."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calmaster"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_calmaster" corresponds="icalproperty_set_calmaster" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The calmaster."/> - <comment>Set the calmaster for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calmaster"/> + <comment>Sets the calmaster for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_calmaster" corresponds="icalproperty_get_calmaster" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the calmaster of #ICalProperty."/> - <comment>Get the calmaster of #ICalProperty.</comment> + <comment>Gets the calmaster of #ICalProperty.</comment> </method> <method name="i_cal_property_new_calscale" corresponds="icalproperty_new_calscale" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The calscale."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calscale"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_calscale" corresponds="icalproperty_set_calscale" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The calscale."/> - <comment>Set the calscale for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The calscale"/> + <comment>Sets the calscale for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_calscale" corresponds="icalproperty_get_calscale" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the calscale of #ICalProperty."/> - <comment>Get the calscale of #ICalProperty.</comment> + <comment>Gets the calscale of #ICalProperty.</comment> </method> <method name="i_cal_property_new_capversion" corresponds="icalproperty_new_capversion" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The capversion."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The capversion"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_capversion" corresponds="icalproperty_set_capversion" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The capversion."/> - <comment>Set the capversion for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The capversion"/> + <comment>Sets the capversion for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_capversion" corresponds="icalproperty_get_capversion" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the capversion of #ICalProperty."/> - <comment>Get the capversion of #ICalProperty.</comment> + <comment>Gets the capversion of #ICalProperty.</comment> </method> <method name="i_cal_property_new_carlevel" corresponds="icalproperty_new_carlevel" kind="constructor" since="1.0"> - <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_carlevel" corresponds="icalproperty_set_carlevel" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel."/> - <comment>Set the carlevel for the #ICalProperty.</comment> + <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel"/> + <comment>Sets the carlevel for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_carlevel" corresponds="icalproperty_get_carlevel" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyCarlevel" comment="Get the carlevel of #ICalProperty."/> - <comment>Get the carlevel of #ICalProperty.</comment> + <comment>Gets the carlevel of #ICalProperty.</comment> </method> <method name="i_cal_property_new_carid" corresponds="icalproperty_new_carid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The carid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The carid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_carid" corresponds="icalproperty_set_carid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The carid."/> - <comment>Set the carid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The carid"/> + <comment>Sets the carid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_carid" corresponds="icalproperty_get_carid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the carid of #ICalProperty."/> - <comment>Get the carid of #ICalProperty.</comment> + <comment>Gets the carid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_categories" corresponds="icalproperty_new_categories" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The categories."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The categories"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_categories" corresponds="icalproperty_set_categories" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The categories."/> - <comment>Set the categories for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The categories"/> + <comment>Sets the categories for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_categories" corresponds="icalproperty_get_categories" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the categories of #ICalProperty."/> - <comment>Get the categories of #ICalProperty.</comment> + <comment>Gets the categories of #ICalProperty.</comment> </method> <method name="i_cal_property_new_class" corresponds="icalproperty_new_class" kind="constructor" since="1.0"> - <parameter type="ICalProperty_Class" name="v" comment="The class."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalProperty_Class" name="v" comment="The class"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_class" corresponds="icalproperty_set_class" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalProperty_Class" name="v" comment="The class."/> - <comment>Set the class for the #ICalProperty.</comment> + <parameter type="ICalProperty_Class" name="v" comment="The class"/> + <comment>Sets the class for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_class" corresponds="icalproperty_get_class" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalProperty_Class" comment="Get the class of #ICalProperty."/> - <comment>Get the class of #ICalProperty.</comment> + <comment>Gets the class of #ICalProperty.</comment> </method> <method name="i_cal_property_new_cmd" corresponds="icalproperty_new_cmd" kind="constructor" since="1.0"> - <parameter type="ICalPropertyCmd" name="v" comment="The cmd."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyCmd" name="v" comment="The cmd"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_cmd" corresponds="icalproperty_set_cmd" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyCmd" name="v" comment="The cmd."/> - <comment>Set the cmd for the #ICalProperty.</comment> + <parameter type="ICalPropertyCmd" name="v" comment="The cmd"/> + <comment>Sets the cmd for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_cmd" corresponds="icalproperty_get_cmd" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyCmd" comment="Get the cmd of #ICalProperty."/> - <comment>Get the cmd of #ICalProperty.</comment> + <comment>Gets the cmd of #ICalProperty.</comment> </method> <method name="i_cal_property_new_comment" corresponds="icalproperty_new_comment" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The comment."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The comment"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_comment" corresponds="icalproperty_set_comment" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The comment."/> - <comment>Set the comment for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The comment"/> + <comment>Sets the comment for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_color" corresponds="icalproperty_get_color" kind="get" since="3.0.5"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the color property."/> - <comment>Get the color property of the @prop.</comment> + <comment>Gets the color property of the @prop.</comment> </method> <method name="i_cal_property_new_color" corresponds="icalproperty_new_color" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The color."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new color #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The color"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new color #ICalProperty.</comment> </method> <method name="i_cal_property_set_color" corresponds="icalproperty_set_color" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The color."/> - <comment>Set the color for the @prop.</comment> + <parameter type="const gchar *" name="v" comment="The color"/> + <comment>Sets the color for the @prop.</comment> </method> <method name="i_cal_property_get_comment" corresponds="icalproperty_get_comment" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the comment of #ICalProperty."/> - <comment>Get the comment of #ICalProperty.</comment> + <comment>Gets the comment of #ICalProperty.</comment> </method> <method name="i_cal_property_new_completed" corresponds="icalproperty_new_completed" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of completed."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of completed"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_completed" corresponds="icalproperty_set_completed" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The completed time."/> - <comment>Set the completed time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The completed time"/> + <comment>Sets the completed time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_completed" corresponds="icalproperty_get_completed" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the completed time of #ICalProperty."/> - <comment>Get the completed time of #ICalProperty.</comment> + <comment>Gets the completed time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_components" corresponds="icalproperty_new_components" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The components."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The components"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_components" corresponds="icalproperty_set_components" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The components."/> - <comment>Set the components for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The components"/> + <comment>Sets the components for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_components" corresponds="icalproperty_get_components" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the components of #ICalProperty."/> - <comment>Get the components of #ICalProperty.</comment> + <comment>Gets the components of #ICalProperty.</comment> </method> <method name="i_cal_property_new_contact" corresponds="icalproperty_new_contact" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The contact."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The contact"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_contact" corresponds="icalproperty_set_contact" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The contact."/> - <comment>Set the contact for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The contact"/> + <comment>Sets the contact for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_contact" corresponds="icalproperty_get_contact" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the contact of #ICalProperty."/> - <comment>Get the contact of #ICalProperty.</comment> + <comment>Gets the contact of #ICalProperty.</comment> </method> <method name="i_cal_property_new_created" corresponds="icalproperty_new_created" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of created."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of created"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_created" corresponds="icalproperty_set_created" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The created time."/> - <comment>Set the created time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The created time"/> + <comment>Sets the created time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_created" corresponds="icalproperty_get_created" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the created time of #ICalProperty."/> - <comment>Get the created time of #ICalProperty.</comment> + <comment>Gets the created time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_csid" corresponds="icalproperty_new_csid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The csid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The csid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_csid" corresponds="icalproperty_set_csid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The csid."/> - <comment>Set the csid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The csid"/> + <comment>Sets the csid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_csid" corresponds="icalproperty_get_csid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the csid of #ICalProperty."/> - <comment>Get the csid of #ICalProperty.</comment> + <comment>Gets the csid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_datemax" corresponds="icalproperty_new_datemax" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of datemax."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of datemax"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_datemax" corresponds="icalproperty_set_datemax" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The datemax time."/> - <comment>Set the datemax time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The datemax time"/> + <comment>Sets the datemax time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_datemax" corresponds="icalproperty_get_datemax" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the datemax time of #ICalProperty."/> - <comment>Get the datemax time of #ICalProperty.</comment> + <comment>Gets the datemax time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_datemin" corresponds="icalproperty_new_datemin" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of datemin."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of datemin"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_datemin" corresponds="icalproperty_set_datemin" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The datemin time."/> - <comment>Set the datemin time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The datemin time"/> + <comment>Sets the datemin time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_datemin" corresponds="icalproperty_get_datemin" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the datemin time of #ICalProperty."/> - <comment>Get the datemin time of #ICalProperty.</comment> + <comment>Gets the datemin time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_decreed" corresponds="icalproperty_new_decreed" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The decreed."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The decreed"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_decreed" corresponds="icalproperty_set_decreed" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The decreed."/> - <comment>Set the decreed for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The decreed"/> + <comment>Sets the decreed for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_decreed" corresponds="icalproperty_get_decreed" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the decreed of #ICalProperty."/> - <comment>Get the decreed of #ICalProperty.</comment> + <comment>Gets the decreed of #ICalProperty.</comment> </method> <method name="i_cal_property_new_defaultcharset" corresponds="icalproperty_new_defaultcharset" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The defaultcharset."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultcharset"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_defaultcharset" corresponds="icalproperty_set_defaultcharset" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The defaultcharset."/> - <comment>Set the defaultcharset for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultcharset"/> + <comment>Sets the defaultcharset for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_defaultcharset" corresponds="icalproperty_get_defaultcharset" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the defaultcharset of #ICalProperty."/> - <comment>Get the defaultcharset of #ICalProperty.</comment> + <comment>Gets the defaultcharset of #ICalProperty.</comment> </method> <method name="i_cal_property_new_defaultlocale" corresponds="icalproperty_new_defaultlocale" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The defaultlocale."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultlocale"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_defaultlocale" corresponds="icalproperty_set_defaultlocale" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The defaultlocale."/> - <comment>Set the defaultlocale for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultlocale"/> + <comment>Sets the defaultlocale for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_defaultlocale" corresponds="icalproperty_get_defaultlocale" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the defaultlocale of #ICalProperty."/> - <comment>Get the defaultlocale of #ICalProperty.</comment> + <comment>Gets the defaultlocale of #ICalProperty.</comment> </method> <method name="i_cal_property_new_defaulttzid" corresponds="icalproperty_new_defaulttzid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The defaulttzid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaulttzid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_defaulttzid" corresponds="icalproperty_set_defaulttzid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The defaulttzid."/> - <comment>Set the defaulttzid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaulttzid"/> + <comment>Sets the defaulttzid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_defaulttzid" corresponds="icalproperty_get_defaulttzid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the defaulttzid of #ICalProperty."/> - <comment>Get the defaulttzid of #ICalProperty.</comment> + <comment>Gets the defaulttzid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_defaultvcars" corresponds="icalproperty_new_defaultvcars" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The defaultvcars."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultvcars"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_defaultvcars" corresponds="icalproperty_set_defaultvcars" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The defaultvcars."/> - <comment>Set the defaultvcars for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The defaultvcars"/> + <comment>Sets the defaultvcars for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_defaultvcars" corresponds="icalproperty_get_defaultvcars" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the defaultvcars of #ICalProperty."/> - <comment>Get the defaultvcars of #ICalProperty.</comment> + <comment>Gets the defaultvcars of #ICalProperty.</comment> </method> <method name="i_cal_property_new_deny" corresponds="icalproperty_new_deny" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The deny."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The deny"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_deny" corresponds="icalproperty_set_deny" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The deny."/> - <comment>Set the deny for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The deny"/> + <comment>Sets the deny for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_deny" corresponds="icalproperty_get_deny" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the deny of #ICalProperty."/> - <comment>Get the deny of #ICalProperty.</comment> + <comment>Gets the deny of #ICalProperty.</comment> </method> <method name="i_cal_property_new_description" corresponds="icalproperty_new_description" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The description."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The description"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_description" corresponds="icalproperty_set_description" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The description."/> - <comment>Set the description for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The description"/> + <comment>Sets the description for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_description" corresponds="icalproperty_get_description" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the description of #ICalProperty."/> - <comment>Get the description of #ICalProperty.</comment> + <comment>Gets the description of #ICalProperty.</comment> </method> <method name="i_cal_property_new_dtend" corresponds="icalproperty_new_dtend" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of dtend."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of dtend"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_dtend" corresponds="icalproperty_set_dtend" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The dtend time."/> - <comment>Set the dtend time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The dtend time"/> + <comment>Sets the dtend time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_dtend" corresponds="icalproperty_get_dtend" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the dtend time of #ICalProperty."/> - <comment>Get the dtend time of #ICalProperty.</comment> + <comment>Gets the dtend time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_dtstamp" corresponds="icalproperty_new_dtstamp" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of dtstamp."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of dtstamp"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_dtstamp" corresponds="icalproperty_set_dtstamp" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The dtstamp time."/> - <comment>Set the dtstamp time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The dtstamp time"/> + <comment>Sets the dtstamp time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_dtstamp" corresponds="icalproperty_get_dtstamp" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the dtstamp time of #ICalProperty."/> - <comment>Get the dtstamp time of #ICalProperty.</comment> + <comment>Gets the dtstamp time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_dtstart" corresponds="icalproperty_new_dtstart" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of dtstart."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of dtstart"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_dtstart" corresponds="icalproperty_set_dtstart" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The dtstart time."/> - <comment>Set the dtstart time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The dtstart time"/> + <comment>Sets the dtstart time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_dtstart" corresponds="icalproperty_get_dtstart" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the dtstart time of #ICalProperty."/> - <comment>Get the dtstart time of #ICalProperty.</comment> + <comment>Gets the dtstart time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_due" corresponds="icalproperty_new_due" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of due."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of due"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_due" corresponds="icalproperty_set_due" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The due time."/> - <comment>Set the due time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The due time"/> + <comment>Sets the due time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_due" corresponds="icalproperty_get_due" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the due time of #ICalProperty."/> - <comment>Get the due time of #ICalProperty.</comment> + <comment>Gets the due time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_duration" corresponds="icalproperty_new_duration" kind="constructor" since="1.0"> - <parameter type="ICalDuration *" name="v" comment="The duration."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalDuration *" name="v" comment="The duration"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_duration" corresponds="icalproperty_set_duration" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalDuration *" name="v" comment="The duration."/> - <comment>Set the duration for the #ICalProperty.</comment> + <parameter type="ICalDuration *" name="v" comment="The duration"/> + <comment>Sets the duration for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_duration" corresponds="icalproperty_get_duration" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalDuration *" annotation="transfer full" comment="Get the duration of #ICalProperty."/> - <comment>Get the duration of #ICalProperty.</comment> + <comment>Gets the duration of #ICalProperty.</comment> </method> <method name="i_cal_property_new_estimatedduration" corresponds="icalproperty_new_estimatedduration" kind="constructor" since="1.0"> - <parameter type="ICalDuration *" name="v" comment="The estimatedduration."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalDuration *" name="v" comment="The estimatedduration"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_estimatedduration" corresponds="icalproperty_set_estimatedduration" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalDuration *" name="v" comment="The estimatedduration."/> - <comment>Set the estimatedduration for the #ICalProperty.</comment> + <parameter type="ICalDuration *" name="v" comment="The estimatedduration"/> + <comment>Sets the estimatedduration for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_estimatedduration" corresponds="icalproperty_get_estimatedduration" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalDuration *" annotation="transfer full" comment="Get the estimatedduration of #ICalProperty."/> - <comment>Get the estimatedduration of #ICalProperty.</comment> + <comment>Gets the estimatedduration of #ICalProperty.</comment> </method> <method name="i_cal_property_new_exdate" corresponds="icalproperty_new_exdate" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of exdate."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of exdate"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_exdate" corresponds="icalproperty_set_exdate" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The exdate time."/> - <comment>Set the exdate time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The exdate time"/> + <comment>Sets the exdate time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_exdate" corresponds="icalproperty_get_exdate" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the exdate time of #ICalProperty."/> - <comment>Get the exdate time of #ICalProperty.</comment> + <comment>Gets the exdate time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_expand" corresponds="icalproperty_new_expand" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The expand."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The expand"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_expand" corresponds="icalproperty_set_expand" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The expand."/> - <comment>Set the expand for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The expand"/> + <comment>Sets the expand for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_expand" corresponds="icalproperty_get_expand" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the expand of #ICalProperty."/> - <comment>Get the expand of #ICalProperty.</comment> + <comment>Gets the expand of #ICalProperty.</comment> </method> <method name="i_cal_property_new_exrule" corresponds="icalproperty_new_exrule" kind="constructor" since="1.0"> - <parameter type="ICalRecurrence *" name="v" comment="The exrule recurrence type."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalRecurrence *" name="v" comment="The exrule recurrence type"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_exrule" corresponds="icalproperty_set_exrule" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalRecurrence *" name="v" comment="The exrule recurrence type."/> - <comment>Set the exrule time for the #ICalProperty.</comment> + <parameter type="ICalRecurrence *" name="v" comment="The exrule recurrence type"/> + <comment>Sets the exrule time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_exrule" corresponds="icalproperty_get_exrule" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalRecurrence *" annotation="transfer full" comment="Get the exrule recurrence type of #ICalProperty."/> - <comment>Get the exrule recurrence type of #ICalProperty.</comment> + <comment>Gets the exrule recurrence type of #ICalProperty.</comment> </method> <method name="i_cal_property_new_freebusy" corresponds="icalproperty_new_freebusy" kind="constructor" since="1.0"> - <parameter type="ICalPeriod *" name="v" comment="The freebusy period type."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPeriod *" name="v" comment="The freebusy period type"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_freebusy" corresponds="icalproperty_set_freebusy" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPeriod *" name="v" comment="The freebusy period type."/> - <comment>Set the freebusy time for the #ICalProperty.</comment> + <parameter type="ICalPeriod *" name="v" comment="The freebusy period type"/> + <comment>Sets the freebusy time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_freebusy" corresponds="icalproperty_get_freebusy" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPeriod *" annotation="transfer full" comment="Get the freebusy period type of #ICalProperty."/> - <comment>Get the freebusy period type of #ICalProperty.</comment> + <comment>Gets the freebusy period type of #ICalProperty.</comment> </method> <method name="i_cal_property_new_geo" corresponds="icalproperty_new_geo" kind="constructor" since="1.0"> - <parameter type="ICalGeo *" name="v" comment="The geo type."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalGeo *" name="v" comment="The geo type"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_geo" corresponds="icalproperty_set_geo" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalGeo *" name="v" comment="The geo type."/> - <comment>Set the geo for the #ICalProperty.</comment> + <parameter type="ICalGeo *" name="v" comment="The geo type"/> + <comment>Sets the geo for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_geo" corresponds="icalproperty_get_geo" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalGeo *" annotation="transfer full" comment="Get the geo type of #ICalProperty."/> - <comment>Get the geo type of #ICalProperty.</comment> + <comment>Gets the geo type of #ICalProperty.</comment> </method> <method name="i_cal_property_new_grant" corresponds="icalproperty_new_grant" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The grant."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The grant"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_grant" corresponds="icalproperty_set_grant" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The grant."/> - <comment>Set the grant for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The grant"/> + <comment>Sets the grant for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_grant" corresponds="icalproperty_get_grant" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the grant of #ICalProperty."/> - <comment>Get the grant of #ICalProperty.</comment> + <comment>Gets the grant of #ICalProperty.</comment> </method> <method name="i_cal_property_new_itipversion" corresponds="icalproperty_new_itipversion" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The itipversion."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The itipversion"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_itipversion" corresponds="icalproperty_set_itipversion" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The itipversion."/> - <comment>Set the itipversion for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The itipversion"/> + <comment>Sets the itipversion for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_itipversion" corresponds="icalproperty_get_itipversion" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the itipversion of #ICalProperty."/> - <comment>Get the itipversion of #ICalProperty.</comment> + <comment>Gets the itipversion of #ICalProperty.</comment> </method> <method name="i_cal_property_new_lastmodified" corresponds="icalproperty_new_lastmodified" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of lastmodified."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of lastmodified"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_lastmodified" corresponds="icalproperty_set_lastmodified" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The lastmodified time."/> - <comment>Set the lastmodified time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The lastmodified time"/> + <comment>Sets the lastmodified time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_lastmodified" corresponds="icalproperty_get_lastmodified" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the lastmodified time of #ICalProperty."/> - <comment>Get the lastmodified time of #ICalProperty.</comment> + <comment>Gets the lastmodified time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_location" corresponds="icalproperty_new_location" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The location."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The location"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_location" corresponds="icalproperty_set_location" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The location."/> - <comment>Set the location for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The location"/> + <comment>Sets the location for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_location" corresponds="icalproperty_get_location" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the location of #ICalProperty."/> - <comment>Get the location of #ICalProperty.</comment> + <comment>Gets the location of #ICalProperty.</comment> </method> <method name="i_cal_property_new_maxcomponentsize" corresponds="icalproperty_new_maxcomponentsize" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The maxcomponentsize."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxcomponentsize"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_maxcomponentsize" corresponds="icalproperty_set_maxcomponentsize" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The maxcomponentsize."/> - <comment>Set the maxcomponentsize for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxcomponentsize"/> + <comment>Sets the maxcomponentsize for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_maxcomponentsize" corresponds="icalproperty_get_maxcomponentsize" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the maxcomponentsize of #ICalProperty."/> - <comment>Get the maxcomponentsize of #ICalProperty.</comment> + <comment>Gets the maxcomponentsize of #ICalProperty.</comment> </method> <method name="i_cal_property_new_maxdate" corresponds="icalproperty_new_maxdate" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of maxdate."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of maxdate"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_maxdate" corresponds="icalproperty_set_maxdate" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The maxdate time."/> - <comment>Set the maxdate time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The maxdate time"/> + <comment>Sets the maxdate time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_maxdate" corresponds="icalproperty_get_maxdate" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the maxdate time of #ICalProperty."/> - <comment>Get the maxdate time of #ICalProperty.</comment> + <comment>Gets the maxdate time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_maxresults" corresponds="icalproperty_new_maxresults" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The maxresults."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxresults"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_maxresults" corresponds="icalproperty_set_maxresults" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The maxresults."/> - <comment>Set the maxresults for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxresults"/> + <comment>Sets the maxresults for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_maxresults" corresponds="icalproperty_get_maxresults" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the maxresults of #ICalProperty."/> - <comment>Get the maxresults of #ICalProperty.</comment> + <comment>Gets the maxresults of #ICalProperty.</comment> </method> <method name="i_cal_property_new_maxresultssize" corresponds="icalproperty_new_maxresultssize" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The maxresultssize."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxresultssize"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_maxresultssize" corresponds="icalproperty_set_maxresultssize" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The maxresultssize."/> - <comment>Set the maxresultssize for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The maxresultssize"/> + <comment>Sets the maxresultssize for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_maxresultssize" corresponds="icalproperty_get_maxresultssize" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the maxresultssize of #ICalProperty."/> - <comment>Get the maxresultssize of #ICalProperty.</comment> + <comment>Gets the maxresultssize of #ICalProperty.</comment> </method> <method name="i_cal_property_new_method" corresponds="icalproperty_new_method" kind="constructor" since="1.0"> - <parameter type="ICalPropertyMethod" name="v" comment="The method."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyMethod" name="v" comment="The method"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_method" corresponds="icalproperty_set_method" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyMethod" name="v" comment="The method."/> - <comment>Set the method for the #ICalProperty.</comment> + <parameter type="ICalPropertyMethod" name="v" comment="The method"/> + <comment>Sets the method for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_method" corresponds="icalproperty_get_method" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyMethod" comment="Get the method of #ICalProperty."/> - <comment>Get the method of #ICalProperty.</comment> + <comment>Gets the method of #ICalProperty.</comment> </method> <method name="i_cal_property_new_mindate" corresponds="icalproperty_new_mindate" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of mindate."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of mindate"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_mindate" corresponds="icalproperty_set_mindate" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The mindate time."/> - <comment>Set the mindate time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The mindate time"/> + <comment>Sets the mindate time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_mindate" corresponds="icalproperty_get_mindate" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the mindate time of #ICalProperty."/> - <comment>Get the mindate time of #ICalProperty.</comment> + <comment>Gets the mindate time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_multipart" corresponds="icalproperty_new_multipart" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The multipart."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The multipart"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_multipart" corresponds="icalproperty_set_multipart" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The multipart."/> - <comment>Set the multipart for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The multipart"/> + <comment>Sets the multipart for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_multipart" corresponds="icalproperty_get_multipart" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the multipart of #ICalProperty."/> - <comment>Get the multipart of #ICalProperty.</comment> + <comment>Gets the multipart of #ICalProperty.</comment> </method> <method name="i_cal_property_new_name" corresponds="icalproperty_new_name" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The name."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The name"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_name" corresponds="icalproperty_set_name" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The name."/> - <comment>Set the name for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The name"/> + <comment>Sets the name for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_name" corresponds="icalproperty_get_name" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the name of #ICalProperty."/> - <comment>Get the name of #ICalProperty.</comment> + <comment>Gets the name of #ICalProperty.</comment> </method> <method name="i_cal_property_new_organizer" corresponds="icalproperty_new_organizer" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The organizer."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The organizer"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_organizer" corresponds="icalproperty_set_organizer" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The organizer."/> - <comment>Set the organizer for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The organizer"/> + <comment>Sets the organizer for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_organizer" corresponds="icalproperty_get_organizer" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the organizer of #ICalProperty."/> - <comment>Get the organizer of #ICalProperty.</comment> + <comment>Gets the organizer of #ICalProperty.</comment> </method> <method name="i_cal_property_new_owner" corresponds="icalproperty_new_owner" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The owner."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The owner"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_owner" corresponds="icalproperty_set_owner" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The owner."/> - <comment>Set the owner for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The owner"/> + <comment>Sets the owner for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_owner" corresponds="icalproperty_get_owner" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the owner of #ICalProperty."/> - <comment>Get the owner of #ICalProperty.</comment> + <comment>Gets the owner of #ICalProperty.</comment> </method> <method name="i_cal_property_new_percentcomplete" corresponds="icalproperty_new_percentcomplete" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The percentcomplete."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The percentcomplete"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_percentcomplete" corresponds="icalproperty_set_percentcomplete" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The percentcomplete."/> - <comment>Set the percentcomplete for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The percentcomplete"/> + <comment>Sets the percentcomplete for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_percentcomplete" corresponds="icalproperty_get_percentcomplete" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the percentcomplete of #ICalProperty."/> - <comment>Get the percentcomplete of #ICalProperty.</comment> + <comment>Gets the percentcomplete of #ICalProperty.</comment> </method> <method name="i_cal_property_new_permission" corresponds="icalproperty_new_permission" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The permission."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The permission"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_permission" corresponds="icalproperty_set_permission" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The permission."/> - <comment>Set the permission for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The permission"/> + <comment>Sets the permission for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_permission" corresponds="icalproperty_get_permission" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the permission of #ICalProperty."/> - <comment>Get the permission of #ICalProperty.</comment> + <comment>Gets the permission of #ICalProperty.</comment> </method> <method name="i_cal_property_new_pollcompletion" corresponds="icalproperty_new_pollcompletion" kind="constructor" since="1.0"> - <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_pollcompletion" corresponds="icalproperty_set_pollcompletion" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion."/> - <comment>Set the pollcompletion for the #ICalProperty.</comment> + <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion"/> + <comment>Sets the pollcompletion for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_pollcompletion" corresponds="icalproperty_get_pollcompletion" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyPollcompletion" comment="Get the pollcompletion of #ICalProperty."/> - <comment>Get the pollcompletion of #ICalProperty.</comment> + <comment>Gets the pollcompletion of #ICalProperty.</comment> </method> <method name="i_cal_property_new_pollitemid" corresponds="icalproperty_new_pollitemid" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The pollitemid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The pollitemid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_pollitemid" corresponds="icalproperty_set_pollitemid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The pollitemid."/> - <comment>Set the pollitemid for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The pollitemid"/> + <comment>Sets the pollitemid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_pollitemid" corresponds="icalproperty_get_pollitemid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the pollitemid of #ICalProperty."/> - <comment>Get the pollitemid of #ICalProperty.</comment> + <comment>Gets the pollitemid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_pollmode" corresponds="icalproperty_new_pollmode" kind="constructor" since="1.0"> - <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_pollmode" corresponds="icalproperty_set_pollmode" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode."/> - <comment>Set the pollmode for the #ICalProperty.</comment> + <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode"/> + <comment>Sets the pollmode for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_pollmode" corresponds="icalproperty_get_pollmode" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyPollmode" comment="Get the pollmode of #ICalProperty."/> - <comment>Get the pollmode of #ICalProperty.</comment> + <comment>Gets the pollmode of #ICalProperty.</comment> </method> <method name="i_cal_property_new_pollproperties" corresponds="icalproperty_new_pollproperties" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The pollproperties."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The pollproperties"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_pollproperties" corresponds="icalproperty_set_pollproperties" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The pollproperties."/> - <comment>Set the pollproperties for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The pollproperties"/> + <comment>Sets the pollproperties for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_pollproperties" corresponds="icalproperty_get_pollproperties" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" comment="Get the pollproperties of #ICalProperty."/> - <comment>Get the pollproperties of #ICalProperty.</comment> + <comment>Gets the pollproperties of #ICalProperty.</comment> </method> <method name="i_cal_property_new_pollwinner" corresponds="icalproperty_new_pollwinner" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The pollwinner."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The pollwinner"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_pollwinner" corresponds="icalproperty_set_pollwinner" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The pollwinner."/> - <comment>Set the pollwinner for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The pollwinner"/> + <comment>Sets the pollwinner for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_pollwinner" corresponds="icalproperty_get_pollwinner" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the pollwinner of #ICalProperty."/> - <comment>Get the pollwinner of #ICalProperty.</comment> + <comment>Gets the pollwinner of #ICalProperty.</comment> </method> <method name="i_cal_property_new_priority" corresponds="icalproperty_new_priority" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The priority."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The priority"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_priority" corresponds="icalproperty_set_priority" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The priority."/> - <comment>Set the priority for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The priority"/> + <comment>Sets the priority for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_priority" corresponds="icalproperty_get_priority" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the priority of #ICalProperty."/> - <comment>Get the priority of #ICalProperty.</comment> + <comment>Gets the priority of #ICalProperty.</comment> </method> <method name="i_cal_property_new_prodid" corresponds="icalproperty_new_prodid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The prodid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The prodid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_prodid" corresponds="icalproperty_set_prodid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The prodid."/> - <comment>Set the prodid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The prodid"/> + <comment>Sets the prodid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_prodid" corresponds="icalproperty_get_prodid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the prodid of #ICalProperty."/> - <comment>Get the prodid of #ICalProperty.</comment> + <comment>Gets the prodid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_query" corresponds="icalproperty_new_query" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The query."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The query"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_query" corresponds="icalproperty_set_query" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The query."/> - <comment>Set the query for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The query"/> + <comment>Sets the query for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_query" corresponds="icalproperty_get_query" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the query of #ICalProperty."/> - <comment>Get the query of #ICalProperty.</comment> + <comment>Gets the query of #ICalProperty.</comment> </method> <method name="i_cal_property_new_querylevel" corresponds="icalproperty_new_querylevel" kind="constructor" since="1.0"> - <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_querylevel" corresponds="icalproperty_set_querylevel" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel."/> - <comment>Set the querylevel for the #ICalProperty.</comment> + <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel"/> + <comment>Sets the querylevel for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_querylevel" corresponds="icalproperty_get_querylevel" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyQuerylevel" comment="Get the querylevel of #ICalProperty."/> - <comment>Get the querylevel of #ICalProperty.</comment> + <comment>Gets the querylevel of #ICalProperty.</comment> </method> <method name="i_cal_property_new_queryid" corresponds="icalproperty_new_queryid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The queryid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The queryid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_queryid" corresponds="icalproperty_set_queryid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The queryid."/> - <comment>Set the queryid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The queryid"/> + <comment>Sets the queryid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_queryid" corresponds="icalproperty_get_queryid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the queryid of #ICalProperty."/> - <comment>Get the queryid of #ICalProperty.</comment> + <comment>Gets the queryid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_queryname" corresponds="icalproperty_new_queryname" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The queryname."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The queryname"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_queryname" corresponds="icalproperty_set_queryname" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The queryname."/> - <comment>Set the queryname for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The queryname"/> + <comment>Sets the queryname for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_queryname" corresponds="icalproperty_get_queryname" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the queryname of #ICalProperty."/> - <comment>Get the queryname of #ICalProperty.</comment> + <comment>Gets the queryname of #ICalProperty.</comment> </method> <method name="i_cal_property_new_rdate" corresponds="icalproperty_new_rdate" kind="constructor" since="1.0"> - <parameter type="ICalDatetimeperiod *" name="v" comment="The rdate."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalDatetimeperiod *" name="v" comment="The rdate"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_rdate" corresponds="icalproperty_set_rdate" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalDatetimeperiod *" name="v" comment="The rdate."/> - <comment>Set the rdate for the #ICalProperty.</comment> + <parameter type="ICalDatetimeperiod *" name="v" comment="The rdate"/> + <comment>Sets the rdate for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_rdate" corresponds="icalproperty_get_rdate" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalDatetimeperiod *" annotation="transfer full" comment="Get the rdate of #ICalProperty."/> - <comment>Get the rdate of #ICalProperty.</comment> + <comment>Gets the rdate of #ICalProperty.</comment> </method> <method name="i_cal_property_new_recuraccepted" corresponds="icalproperty_new_recuraccepted" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The recuraccepted."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recuraccepted"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_recuraccepted" corresponds="icalproperty_set_recuraccepted" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The recuraccepted."/> - <comment>Set the recuraccepted for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recuraccepted"/> + <comment>Sets the recuraccepted for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_recuraccepted" corresponds="icalproperty_get_recuraccepted" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the recuraccepted of #ICalProperty."/> - <comment>Get the recuraccepted of #ICalProperty.</comment> + <comment>Gets the recuraccepted of #ICalProperty.</comment> </method> <method name="i_cal_property_new_recurexpand" corresponds="icalproperty_new_recurexpand" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The recurexpand."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recurexpand"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_recurexpand" corresponds="icalproperty_set_recurexpand" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The recurexpand."/> - <comment>Set the recurexpand for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recurexpand"/> + <comment>Sets the recurexpand for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_recurexpand" corresponds="icalproperty_get_recurexpand" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the recurexpand of #ICalProperty."/> - <comment>Get the recurexpand of #ICalProperty.</comment> + <comment>Gets the recurexpand of #ICalProperty.</comment> </method> <method name="i_cal_property_new_recurlimit" corresponds="icalproperty_new_recurlimit" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The recurlimit."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recurlimit"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_recurlimit" corresponds="icalproperty_set_recurlimit" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The recurlimit."/> - <comment>Set the recurlimit for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The recurlimit"/> + <comment>Sets the recurlimit for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_recurlimit" corresponds="icalproperty_get_recurlimit" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the recurlimit of #ICalProperty."/> - <comment>Get the recurlimit of #ICalProperty.</comment> + <comment>Gets the recurlimit of #ICalProperty.</comment> </method> <method name="i_cal_property_new_recurrenceid" corresponds="icalproperty_new_recurrenceid" kind="constructor" since="1.0"> - <parameter type="ICalTime *" name="v" comment="The time of recurrenceid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of recurrenceid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_recurrenceid" corresponds="icalproperty_set_recurrenceid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The recurrenceid time."/> - <comment>Set the recurrenceid time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The recurrenceid time"/> + <comment>Sets the recurrenceid time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_recurrenceid" corresponds="icalproperty_get_recurrenceid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the recurrenceid time of #ICalProperty."/> - <comment>Get the recurrenceid time of #ICalProperty.</comment> + <comment>Gets the recurrenceid time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_relatedto" corresponds="icalproperty_new_relatedto" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The relatedto."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The relatedto"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_relatedto" corresponds="icalproperty_set_relatedto" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The relatedto."/> - <comment>Set the relatedto for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The relatedto"/> + <comment>Sets the relatedto for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_relatedto" corresponds="icalproperty_get_relatedto" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the relatedto of #ICalProperty."/> - <comment>Get the relatedto of #ICalProperty.</comment> + <comment>Gets the relatedto of #ICalProperty.</comment> </method> <method name="i_cal_property_new_relcalid" corresponds="icalproperty_new_relcalid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The relcalid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The relcalid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_relcalid" corresponds="icalproperty_set_relcalid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The relcalid."/> - <comment>Set the relcalid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The relcalid"/> + <comment>Sets the relcalid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_relcalid" corresponds="icalproperty_get_relcalid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the relcalid of #ICalProperty."/> - <comment>Get the relcalid of #ICalProperty.</comment> + <comment>Gets the relcalid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_repeat" corresponds="icalproperty_new_repeat" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The repeat."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The repeat"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_repeat" corresponds="icalproperty_set_repeat" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The repeat."/> - <comment>Set the repeat for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The repeat"/> + <comment>Sets the repeat for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_repeat" corresponds="icalproperty_get_repeat" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the repeat of #ICalProperty."/> - <comment>Get the repeat of #ICalProperty.</comment> + <comment>Gets the repeat of #ICalProperty.</comment> </method> <method name="i_cal_property_new_replyurl" corresponds="icalproperty_new_replyurl" kind="constructor" since="2.0"> - <parameter type="const gchar *" name="v" comment="The replyurl."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The replyurl"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_replyurl" corresponds="icalproperty_set_replyurl" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The replyurl."/> - <comment>Set the replyurl for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The replyurl"/> + <comment>Sets the replyurl for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_replyurl" corresponds="icalproperty_get_replyurl" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the replyurl of #ICalProperty."/> - <comment>Get the replyurl of #ICalProperty.</comment> + <comment>Gets the replyurl of #ICalProperty.</comment> </method> <method name="i_cal_property_new_requeststatus" corresponds="icalproperty_new_requeststatus" kind="constructor" since="1.0"> - <parameter type="ICalReqstat *" name="v" comment="The requeststatus."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalReqstat *" name="v" comment="The requeststatus"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_requeststatus" corresponds="icalproperty_set_requeststatus" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalReqstat *" name="v" comment="The requeststatus."/> - <comment>Set the requeststatus for the #ICalProperty.</comment> + <parameter type="ICalReqstat *" name="v" comment="The requeststatus"/> + <comment>Sets the requeststatus for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_requeststatus" corresponds="icalproperty_get_requeststatus" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalReqstat *" annotation="transfer full" comment="Get the requeststatus of #ICalProperty."/> - <comment>Get the requeststatus of #ICalProperty.</comment> + <comment>Gets the requeststatus of #ICalProperty.</comment> </method> <method name="i_cal_property_new_resources" corresponds="icalproperty_new_resources" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The resources."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The resources"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_resources" corresponds="icalproperty_set_resources" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The resources."/> - <comment>Set the resources for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The resources"/> + <comment>Sets the resources for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_resources" corresponds="icalproperty_get_resources" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the resources of #ICalProperty."/> - <comment>Get the resources of #ICalProperty.</comment> + <comment>Gets the resources of #ICalProperty.</comment> </method> <method name="i_cal_property_new_response" corresponds="icalproperty_new_response" kind="constructor" since="2.0"> - <parameter type="gint" name="v" comment="The response."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The response"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_response" corresponds="icalproperty_set_response" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The response."/> - <comment>Set the response for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The response"/> + <comment>Sets the response for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_response" corresponds="icalproperty_get_response" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the response of #ICalProperty."/> - <comment>Get the response of #ICalProperty.</comment> + <comment>Gets the response of #ICalProperty.</comment> </method> <method name="i_cal_property_new_restriction" corresponds="icalproperty_new_restriction" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The restriction."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The restriction"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_restriction" corresponds="icalproperty_set_restriction" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The restriction."/> - <comment>Set the restriction for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The restriction"/> + <comment>Sets the restriction for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_restriction" corresponds="icalproperty_get_restriction" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the restriction of #ICalProperty."/> - <comment>Get the restriction of #ICalProperty.</comment> + <comment>Gets the restriction of #ICalProperty.</comment> </method> <method name="i_cal_property_new_rrule" corresponds="icalproperty_new_rrule" kind="constructor" since="1.0"> - <parameter type="ICalRecurrence *" name="v" comment="The rrule recurrence type."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalRecurrence *" name="v" comment="The rrule recurrence type"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_rrule" corresponds="icalproperty_set_rrule" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalRecurrence *" name="v" comment="The rrule recurrence type."/> - <comment>Set the rrule for the #ICalProperty.</comment> + <parameter type="ICalRecurrence *" name="v" comment="The rrule recurrence type"/> + <comment>Sets the rrule for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_rrule" corresponds="icalproperty_get_rrule" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalRecurrence *" annotation="transfer full" comment="Get the rrule recurrence type of #ICalProperty."/> - <comment>Get the rrule recurrence type of #ICalProperty.</comment> + <comment>Gets the rrule recurrence type of #ICalProperty.</comment> </method> <method name="i_cal_property_new_scope" corresponds="icalproperty_new_scope" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The scope."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The scope"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_scope" corresponds="icalproperty_set_scope" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The scope."/> - <comment>Set the scope for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The scope"/> + <comment>Sets the scope for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_scope" corresponds="icalproperty_get_scope" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the scope of #ICalProperty."/> - <comment>Get the scope of #ICalProperty.</comment> + <comment>Gets the scope of #ICalProperty.</comment> </method> <method name="i_cal_property_new_sequence" corresponds="icalproperty_new_sequence" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The sequence."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The sequence"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_sequence" corresponds="icalproperty_set_sequence" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The sequence."/> - <comment>Set the sequence for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The sequence"/> + <comment>Sets the sequence for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_sequence" corresponds="icalproperty_get_sequence" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the sequence of #ICalProperty."/> - <comment>Get the sequence of #ICalProperty.</comment> + <comment>Gets the sequence of #ICalProperty.</comment> </method> <method name="i_cal_property_new_status" corresponds="icalproperty_new_status" kind="constructor" since="1.0"> - <parameter type="ICalPropertyStatus" name="v" comment="The status."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyStatus" name="v" comment="The status"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_status" corresponds="icalproperty_set_status" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyStatus" name="v" comment="The status."/> - <comment>Set the status for the #ICalProperty.</comment> + <parameter type="ICalPropertyStatus" name="v" comment="The status"/> + <comment>Sets the status for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_status" corresponds="icalproperty_get_status" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyStatus" comment="Get the status of #ICalProperty."/> - <comment>Get the status of #ICalProperty.</comment> + <comment>Gets the status of #ICalProperty.</comment> </method> <method name="i_cal_property_new_storesexpanded" corresponds="icalproperty_new_storesexpanded" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The storesexpanded."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The storesexpanded"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_storesexpanded" corresponds="icalproperty_set_storesexpanded" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The storesexpanded."/> - <comment>Set the storesexpanded for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The storesexpanded"/> + <comment>Sets the storesexpanded for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_storesexpanded" corresponds="icalproperty_get_storesexpanded" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the storesexpanded of #ICalProperty."/> - <comment>Get the storesexpanded of #ICalProperty.</comment> + <comment>Gets the storesexpanded of #ICalProperty.</comment> </method> <method name="i_cal_property_new_summary" corresponds="icalproperty_new_summary" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The summary."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The summary"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_summary" corresponds="icalproperty_set_summary" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The summary."/> - <comment>Set the summary for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The summary"/> + <comment>Sets the summary for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_summary" corresponds="icalproperty_get_summary" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the summary of #ICalProperty."/> - <comment>Get the summary of #ICalProperty.</comment> + <comment>Gets the summary of #ICalProperty.</comment> </method> <method name="i_cal_property_new_target" corresponds="icalproperty_new_target" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The target."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The target"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_target" corresponds="icalproperty_set_target" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The target."/> - <comment>Set the target for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The target"/> + <comment>Sets the target for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_target" corresponds="icalproperty_get_target" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the target of #ICalProperty."/> - <comment>Get the target of #ICalProperty.</comment> + <comment>Gets the target of #ICalProperty.</comment> </method> <method name="i_cal_property_new_taskmode" corresponds="icalproperty_new_taskmode" kind="constructor" since="2.0"> - <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_taskmode" corresponds="icalproperty_set_taskmode" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode."/> - <comment>Set the taskmode for the #ICalProperty.</comment> + <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode"/> + <comment>Sets the taskmode for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_taskmode" corresponds="icalproperty_get_taskmode" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyTaskmode" comment="Get the taskmode of #ICalProperty."/> - <comment>Get the taskmode of #ICalProperty.</comment> + <comment>Gets the taskmode of #ICalProperty.</comment> </method> <method name="i_cal_property_new_transp" corresponds="icalproperty_new_transp" kind="constructor" since="1.0"> - <parameter type="ICalPropertyTransp" name="v" comment="The transp."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyTransp" name="v" comment="The transp"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_transp" corresponds="icalproperty_set_transp" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyTransp" name="v" comment="The transp."/> - <comment>Set the transp for the #ICalProperty.</comment> + <parameter type="ICalPropertyTransp" name="v" comment="The transp"/> + <comment>Sets the transp for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_transp" corresponds="icalproperty_get_transp" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyTransp" comment="Get the transp of #ICalProperty."/> - <comment>Get the transp of #ICalProperty.</comment> + <comment>Gets the transp of #ICalProperty.</comment> </method> <method name="i_cal_property_new_trigger" corresponds="icalproperty_new_trigger" kind="constructor" since="1.0"> - <parameter type="ICalTrigger *" name="v" comment="The trigger period type."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTrigger *" name="v" comment="The trigger period type"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_trigger" corresponds="icalproperty_set_trigger" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTrigger *" name="v" comment="The trigger period type."/> - <comment>Set the trigger time for the #ICalProperty.</comment> + <parameter type="ICalTrigger *" name="v" comment="The trigger period type"/> + <comment>Sets the trigger time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_trigger" corresponds="icalproperty_get_trigger" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTrigger *" annotation="transfer full" comment="Get the trigger period type of #ICalProperty."/> - <comment>Get the trigger period type of #ICalProperty.</comment> + <comment>Gets the trigger period type of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzid" corresponds="icalproperty_new_tzid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The tzid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzid" corresponds="icalproperty_set_tzid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The tzid."/> - <comment>Set the tzid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzid"/> + <comment>Sets the tzid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzid" corresponds="icalproperty_get_tzid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the tzid of #ICalProperty."/> - <comment>Get the tzid of #ICalProperty.</comment> + <comment>Gets the tzid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzidaliasof" corresponds="icalproperty_new_tzidaliasof" kind="constructor" since="2.0"> - <parameter type="const gchar *" name="v" comment="The tzidaliasof."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzidaliasof"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzidaliasof" corresponds="icalproperty_set_tzidaliasof" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The tzidaliasof."/> - <comment>Set the tzidaliasof for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzidaliasof"/> + <comment>Sets the tzidaliasof for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzidaliasof" corresponds="icalproperty_get_tzidaliasof" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the tzidaliasof of #ICalProperty."/> - <comment>Get the tzidaliasof of #ICalProperty.</comment> + <comment>Gets the tzidaliasof of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzname" corresponds="icalproperty_new_tzname" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The tzname."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzname"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzname" corresponds="icalproperty_set_tzname" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The tzname."/> - <comment>Set the tzname for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzname"/> + <comment>Sets the tzname for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzname" corresponds="icalproperty_get_tzname" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the tzname of #ICalProperty."/> - <comment>Get the tzname of #ICalProperty.</comment> + <comment>Gets the tzname of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzoffsetfrom" corresponds="icalproperty_new_tzoffsetfrom" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The tzoffsetfrom."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The tzoffsetfrom"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzoffsetfrom" corresponds="icalproperty_set_tzoffsetfrom" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The tzoffsetfrom."/> - <comment>Set the tzoffsetfrom for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The tzoffsetfrom"/> + <comment>Sets the tzoffsetfrom for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzoffsetfrom" corresponds="icalproperty_get_tzoffsetfrom" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the tzoffsetfrom of #ICalProperty."/> - <comment>Get the tzoffsetfrom of #ICalProperty.</comment> + <comment>Gets the tzoffsetfrom of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzoffsetto" corresponds="icalproperty_new_tzoffsetto" kind="constructor" since="1.0"> - <parameter type="gint" name="v" comment="The tzoffsetto."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The tzoffsetto"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzoffsetto" corresponds="icalproperty_set_tzoffsetto" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="gint" name="v" comment="The tzoffsetto."/> - <comment>Set the tzoffsetto for the #ICalProperty.</comment> + <parameter type="gint" name="v" comment="The tzoffsetto"/> + <comment>Sets the tzoffsetto for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzoffsetto" corresponds="icalproperty_get_tzoffsetto" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gint" comment="Get the tzoffsetto of #ICalProperty."/> - <comment>Get the tzoffsetto of #ICalProperty.</comment> + <comment>Gets the tzoffsetto of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzuntil" corresponds="icalproperty_new_tzuntil" kind="constructor" since="2.0"> - <parameter type="ICalTime *" name="v" comment="The time of acknowledgement."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The time of acknowledgement"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzuntil" corresponds="icalproperty_set_tzuntil" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalTime *" name="v" comment="The acknowledgement time."/> - <comment>Set the tzuntil time for the #ICalProperty.</comment> + <parameter type="ICalTime *" name="v" comment="The acknowledgement time"/> + <comment>Sets the tzuntil time for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzuntil" corresponds="icalproperty_get_tzuntil" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="Get the tzuntil time of #ICalProperty."/> - <comment>Get the tzuntil time of #ICalProperty.</comment> + <comment>Gets the tzuntil time of #ICalProperty.</comment> </method> <method name="i_cal_property_new_tzurl" corresponds="icalproperty_new_tzurl" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The tzurl."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzurl"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_tzurl" corresponds="icalproperty_set_tzurl" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The tzurl."/> - <comment>Set the tzurl for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The tzurl"/> + <comment>Sets the tzurl for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_tzurl" corresponds="icalproperty_get_tzurl" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the tzurl of #ICalProperty."/> - <comment>Get the tzurl of #ICalProperty.</comment> + <comment>Gets the tzurl of #ICalProperty.</comment> </method> <method name="i_cal_property_new_uid" corresponds="icalproperty_new_uid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The uid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The uid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_uid" corresponds="icalproperty_set_uid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The uid."/> - <comment>Set the uid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The uid"/> + <comment>Sets the uid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_uid" corresponds="icalproperty_get_uid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the uid of #ICalProperty."/> - <comment>Get the uid of #ICalProperty.</comment> + <comment>Gets the uid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_url" corresponds="icalproperty_new_url" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The url."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The url"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_url" corresponds="icalproperty_set_url" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The url."/> - <comment>Set the url for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The url"/> + <comment>Sets the url for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_url" corresponds="icalproperty_get_url" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the url of #ICalProperty."/> - <comment>Get the url of #ICalProperty.</comment> + <comment>Gets the url of #ICalProperty.</comment> </method> <method name="i_cal_property_new_version" corresponds="icalproperty_new_version" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The version."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The version"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_version" corresponds="icalproperty_set_version" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The version."/> - <comment>Set the version for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The version"/> + <comment>Sets the version for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_version" corresponds="icalproperty_get_version" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the version of #ICalProperty."/> - <comment>Get the version of #ICalProperty.</comment> + <comment>Gets the version of #ICalProperty.</comment> </method> <method name="i_cal_property_new_voter" corresponds="icalproperty_new_voter" kind="constructor" since="2.0"> - <parameter type="const gchar *" name="v" comment="The voter."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The voter"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_voter" corresponds="icalproperty_set_voter" kind="set" since="2.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The voter."/> - <comment>Set the voter for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The voter"/> + <comment>Sets the voter for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_voter" corresponds="icalproperty_get_voter" kind="get" since="2.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the voter of #ICalProperty."/> - <comment>Get the voter of #ICalProperty.</comment> + <comment>Gets the voter of #ICalProperty.</comment> </method> <method name="i_cal_property_new_x" corresponds="icalproperty_new_x" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The x."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The x"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_x" corresponds="icalproperty_set_x" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The x."/> - <comment>Set the x for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The x"/> + <comment>Sets the x for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_x" corresponds="icalproperty_get_x" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the x of #ICalProperty."/> - <comment>Get the x of #ICalProperty.</comment> + <comment>Gets the x of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicclass" corresponds="icalproperty_new_xlicclass" kind="constructor" since="1.0"> - <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicclass" corresponds="icalproperty_set_xlicclass" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass."/> - <comment>Set the xlicclass for the #ICalProperty.</comment> + <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass"/> + <comment>Sets the xlicclass for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicclass" corresponds="icalproperty_get_xlicclass" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalPropertyXlicclass" comment="Get the xlicclass of #ICalProperty."/> - <comment>Get the xlicclass of #ICalProperty.</comment> + <comment>Gets the xlicclass of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicclustercount" corresponds="icalproperty_new_xlicclustercount" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicclustercount."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicclustercount"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicclustercount" corresponds="icalproperty_set_xlicclustercount" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicclustercount."/> - <comment>Set the xlicclustercount for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicclustercount"/> + <comment>Sets the xlicclustercount for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicclustercount" corresponds="icalproperty_get_xlicclustercount" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicclustercount of #ICalProperty."/> - <comment>Get the xlicclustercount of #ICalProperty.</comment> + <comment>Gets the xlicclustercount of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicerror" corresponds="icalproperty_new_xlicerror" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicerror."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicerror"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicerror" corresponds="icalproperty_set_xlicerror" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicerror."/> - <comment>Set the xlicerror for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicerror"/> + <comment>Sets the xlicerror for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicerror" corresponds="icalproperty_get_xlicerror" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicerror of #ICalProperty."/> - <comment>Get the xlicerror of #ICalProperty.</comment> + <comment>Gets the xlicerror of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimecharset" corresponds="icalproperty_new_xlicmimecharset" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimecharset."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecharset"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimecharset" corresponds="icalproperty_set_xlicmimecharset" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimecharset."/> - <comment>Set the xlicmimecharset for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecharset"/> + <comment>Sets the xlicmimecharset for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimecharset" corresponds="icalproperty_get_xlicmimecharset" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimecharset of #ICalProperty."/> - <comment>Get the xlicmimecharset of #ICalProperty.</comment> + <comment>Gets the xlicmimecharset of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimecid" corresponds="icalproperty_new_xlicmimecid" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimecid."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecid"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimecid" corresponds="icalproperty_set_xlicmimecid" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimecid."/> - <comment>Set the xlicmimecid for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecid"/> + <comment>Sets the xlicmimecid for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimecid" corresponds="icalproperty_get_xlicmimecid" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimecid of #ICalProperty."/> - <comment>Get the xlicmimecid of #ICalProperty.</comment> + <comment>Gets the xlicmimecid of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimecontenttype" corresponds="icalproperty_new_xlicmimecontenttype" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimecontenttype."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecontenttype"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimecontenttype" corresponds="icalproperty_set_xlicmimecontenttype" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimecontenttype."/> - <comment>Set the xlicmimecontenttype for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimecontenttype"/> + <comment>Sets the xlicmimecontenttype for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimecontenttype" corresponds="icalproperty_get_xlicmimecontenttype" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimecontenttype of #ICalProperty."/> - <comment>Get the xlicmimecontenttype of #ICalProperty.</comment> + <comment>Gets the xlicmimecontenttype of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimeencoding" corresponds="icalproperty_new_xlicmimeencoding" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimeencoding."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimeencoding"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimeencoding" corresponds="icalproperty_set_xlicmimeencoding" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimeencoding."/> - <comment>Set the xlicmimeencoding for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimeencoding"/> + <comment>Sets the xlicmimeencoding for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimeencoding" corresponds="icalproperty_get_xlicmimeencoding" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimeencoding of #ICalProperty."/> - <comment>Get the xlicmimeencoding of #ICalProperty.</comment> + <comment>Gets the xlicmimeencoding of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimefilename" corresponds="icalproperty_new_xlicmimefilename" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimefilename."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimefilename"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimefilename" corresponds="icalproperty_set_xlicmimefilename" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimefilename."/> - <comment>Set the xlicmimefilename for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimefilename"/> + <comment>Sets the xlicmimefilename for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimefilename" corresponds="icalproperty_get_xlicmimefilename" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimefilename of #ICalProperty."/> - <comment>Get the xlicmimefilename of #ICalProperty.</comment> + <comment>Gets the xlicmimefilename of #ICalProperty.</comment> </method> <method name="i_cal_property_new_xlicmimeoptinfo" corresponds="icalproperty_new_xlicmimeoptinfo" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="v" comment="The xlicmimeoptinfo."/> - <returns type="ICalProperty *" annotation="transfer full" comment="The newly create #ICalProperty"/> - <comment xml:space="preserve">Create a new #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimeoptinfo"/> + <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty"/> + <comment xml:space="preserve">Creates a new #ICalProperty.</comment> </method> <method name="i_cal_property_set_xlicmimeoptinfo" corresponds="icalproperty_set_xlicmimeoptinfo" kind="set" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> - <parameter type="const gchar *" name="v" comment="The xlicmimeoptinfo."/> - <comment>Set the xlicmimeoptinfo for the #ICalProperty.</comment> + <parameter type="const gchar *" name="v" comment="The xlicmimeoptinfo"/> + <comment>Sets the xlicmimeoptinfo for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_xlicmimeoptinfo" corresponds="icalproperty_get_xlicmimeoptinfo" kind="get" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="const gchar *" annotation="transfer none" comment="Get the xlicmimeoptinfo of #ICalProperty."/> - <comment>Get the xlicmimeoptinfo of #ICalProperty.</comment> + <comment>Gets the xlicmimeoptinfo of #ICalProperty.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-derived-value.xml b/src/libical-glib/api/i-cal-derived-value.xml index 71581140..aa58a233 100644 --- a/src/libical-glib/api/i-cal-derived-value.xml +++ b/src/libical-glib/api/i-cal-derived-value.xml @@ -199,532 +199,532 @@ <element name="ICAL_XLICCLASS_NONE"/> </enum> <method name="i_cal_value_set_x" corresponds="icalvalue_set_x" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The x value."/> - <comment>Set the x in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The x value"/> + <comment>Sets the x in the #ICalValue.</comment> </method> <method name="i_cal_value_new_x" corresponds="icalvalue_new_x" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The x value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type x.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type x.</comment> </method> <method name="i_cal_value_get_x" corresponds="icalvalue_get_x" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The x within #ICalValue"/> - <comment>Get the x of #ICalValue.</comment> + <comment>Gets the x of #ICalValue.</comment> </method> <method name="i_cal_value_set_recur" corresponds="icalvalue_set_recur" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalRecurrence *" name="v" comment="The recur value."/> - <comment>Set the recur in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalRecurrence *" name="v" comment="The recur value"/> + <comment>Sets the recur in the #ICalValue.</comment> </method> <method name="i_cal_value_new_recur" corresponds="icalvalue_new_recur" kind="constructor" since="1.0"> <parameter type="ICalRecurrence *" name="v" comment="The recur value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type recur.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type recur.</comment> </method> <method name="i_cal_value_get_recur" corresponds="icalvalue_get_recur" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalRecurrence *" annotation="allow-none, transfer full" comment="The recur within #ICalValue"/> - <comment>Get the recur of #ICalValue.</comment> + <comment>Gets the recur of #ICalValue.</comment> </method> <method name="i_cal_value_set_trigger" corresponds="icalvalue_set_trigger" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalTrigger *" name="v" comment="The trigger value."/> - <comment>Set the trigger in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalTrigger *" name="v" comment="The trigger value"/> + <comment>Sets the trigger in the #ICalValue.</comment> </method> <method name="i_cal_value_new_trigger" corresponds="icalvalue_new_trigger" kind="constructor" since="1.0"> <parameter type="ICalTrigger *" name="v" comment="The trigger value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type trigger.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type trigger.</comment> </method> <method name="i_cal_value_get_trigger" corresponds="icalvalue_get_trigger" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalTrigger *" annotation="allow-none, transfer full" comment="The trigger within #ICalValue"/> - <comment>Get the trigger of #ICalValue.</comment> + <comment>Gets the trigger of #ICalValue.</comment> </method> <method name="i_cal_value_set_datetime" corresponds="icalvalue_set_datetime" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalTime *" name="v" comment="The datetime value."/> - <comment>Set the datetime in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalTime *" name="v" comment="The datetime value"/> + <comment>Sets the datetime in the #ICalValue.</comment> </method> <method name="i_cal_value_new_datetime" corresponds="icalvalue_new_datetime" kind="constructor" since="1.0"> <parameter type="ICalTime *" name="v" comment="The datetime value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type datetime.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type datetime.</comment> </method> <method name="i_cal_value_get_datetime" corresponds="icalvalue_get_datetime" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalTime *" annotation="allow-none, transfer full" comment="The datetime within #ICalValue"/> - <comment>Get the datetime of #ICalValue.</comment> + <comment>Gets the datetime of #ICalValue.</comment> </method> <method name="i_cal_value_set_datetimedate" corresponds="icalvalue_set_datetimedate" kind="set" since="3.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalTime *" name="v" comment="The datetimedate (DATE-TIME or DATE) value."/> - <comment>Set the datetimedate (DATE-TIME or DATE) in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalTime *" name="v" comment="The datetimedate (DATE-TIME or DATE) value"/> + <comment>Sets the datetimedate (DATE-TIME or DATE) in the #ICalValue.</comment> </method> <method name="i_cal_value_new_datetimedate" corresponds="icalvalue_new_datetimedate" kind="constructor" since="3.0"> <parameter type="ICalTime *" name="v" comment="The DATE-TIME or DATE value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type datetimedate (DATE-TIME or DATE).</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type datetimedate (DATE-TIME or DATE).</comment> </method> <method name="i_cal_value_get_datetimedate" corresponds="icalvalue_get_datetimedate" kind="get" since="3.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalTime *" annotation="allow-none, transfer full" comment="The datetimedate within #ICalValue"/> - <comment>Get the datetimedate (DATE-TIME or DATE) of #ICalValue.</comment> + <comment>Gets the datetimedate (DATE-TIME or DATE) of #ICalValue.</comment> </method> <method name="i_cal_value_set_datetimeperiod" corresponds="icalvalue_set_datetimeperiod" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalDatetimeperiod *" name="v" comment="The datetimeperiod value."/> - <comment>Set the datetimeperiod in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalDatetimeperiod *" name="v" comment="The datetimeperiod value"/> + <comment>Sets the datetimeperiod in the #ICalValue.</comment> </method> <method name="i_cal_value_new_datetimeperiod" corresponds="icalvalue_new_datetimeperiod" kind="constructor" since="1.0"> <parameter type="ICalDatetimeperiod *" name="v" comment="The datetimeperiod value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type datetimeperiod.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type datetimeperiod.</comment> </method> <method name="i_cal_value_get_datetimeperiod" corresponds="icalvalue_get_datetimeperiod" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalDatetimeperiod *" annotation="allow-none, transfer full" comment="The datetimeperiod within #ICalValue"/> - <comment>Get the datetimeperiod of #ICalValue.</comment> + <comment>Gets the datetimeperiod of #ICalValue.</comment> </method> <method name="i_cal_value_set_geo" corresponds="icalvalue_set_geo" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalGeo *" name="v" comment="The geo value."/> - <comment>Set the geo in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalGeo *" name="v" comment="The geo value"/> + <comment>Sets the geo in the #ICalValue.</comment> </method> <method name="i_cal_value_new_geo" corresponds="icalvalue_new_geo" kind="constructor" since="1.0"> <parameter type="ICalGeo *" name="v" comment="The geo value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type geo.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type geo.</comment> </method> <method name="i_cal_value_get_geo" corresponds="icalvalue_get_geo" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalGeo *" annotation="allow-none, transfer full" comment="The geo within #ICalValue"/> - <comment>Get the geo of #ICalValue.</comment> + <comment>Gets the geo of #ICalValue.</comment> </method> <method name="i_cal_value_set_attach" corresponds="icalvalue_set_attach" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalAttach *" name="v" translator_argus="value" comment="The attach value."/> - <comment>Set the attach in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalAttach *" name="v" translator_argus="value" comment="The attach value"/> + <comment>Sets the attach in the #ICalValue.</comment> </method> <method name="i_cal_value_new_attach" corresponds="icalvalue_new_attach" kind="constructor" since="1.0"> <parameter type="ICalAttach *" name="v" comment="The attach value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type attach.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type attach.</comment> </method> <method name="i_cal_value_get_attach" corresponds="icalvalue_get_attach" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalAttach *" annotation="allow-none, transfer none" translator_argus="(GObject *)value" comment="The attach within #ICalValue"/> - <comment>Get the attach of #ICalValue.</comment> + <comment>Gets the attach of #ICalValue.</comment> </method> <method name="i_cal_value_reset_kind" corresponds="icalvalue_reset_kind" kind="other" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue's kind to be reset."/> - <comment>Reset the kind of #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue's kind to be reset"/> + <comment>Resets the kind of #ICalValue.</comment> </method> <method name="i_cal_value_set_xlicclass" corresponds="icalvalue_set_xlicclass" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass value."/> - <comment>Set the xlicclass in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass value"/> + <comment>Sets the xlicclass in the #ICalValue.</comment> </method> <method name="i_cal_value_new_xlicclass" corresponds="icalvalue_new_xlicclass" kind="constructor" since="1.0"> <parameter type="ICalPropertyXlicclass" name="v" comment="The xlicclass value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type xlicclass.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type xlicclass.</comment> </method> <method name="i_cal_value_get_xlicclass" corresponds="icalvalue_get_xlicclass" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyXlicclass" comment="The xlicclass within #ICalValue"/> - <comment>Get the xlicclass of #ICalValue.</comment> + <comment>Gets the xlicclass of #ICalValue.</comment> </method> <method name="i_cal_value_set_boolean" corresponds="icalvalue_set_boolean" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="gint" name="v" comment="The boolean value."/> - <comment>Set the boolean in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="gint" name="v" comment="The boolean value"/> + <comment>Sets the boolean in the #ICalValue.</comment> </method> <method name="i_cal_value_new_boolean" corresponds="icalvalue_new_boolean" kind="constructor" since="1.0"> <parameter type="gint" name="v" comment="The boolean value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type boolean.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type boolean.</comment> </method> <method name="i_cal_value_get_boolean" corresponds="icalvalue_get_boolean" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="gint" comment="The boolean within #ICalValue"/> - <comment>Get the boolean of #ICalValue.</comment> + <comment>Gets the boolean of #ICalValue.</comment> </method> <method name="i_cal_value_set_busytype" corresponds="icalvalue_set_busytype" kind="set" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyBusytype" name="v" comment="The busytype value."/> - <comment>Set the busytype in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyBusytype" name="v" comment="The busytype value"/> + <comment>Sets the busytype in the #ICalValue.</comment> </method> <method name="i_cal_value_new_busytype" corresponds="icalvalue_new_busytype" kind="constructor" since="2.0"> <parameter type="ICalPropertyBusytype" name="v" comment="The busytype value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type busytype.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type busytype.</comment> </method> <method name="i_cal_value_get_busytype" corresponds="icalvalue_get_busytype" kind="get" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyBusytype" comment="The busytype within #ICalValue"/> - <comment>Get the busytype of #ICalValue.</comment> + <comment>Gets the busytype of #ICalValue.</comment> </method> <method name="i_cal_value_set_pollcompletion" corresponds="icalvalue_set_pollcompletion" kind="set" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion value."/> - <comment>Set the pollcompletion in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion value"/> + <comment>Sets the pollcompletion in the #ICalValue.</comment> </method> <method name="i_cal_value_new_pollcompletion" corresponds="icalvalue_new_pollcompletion" kind="constructor" since="2.0"> <parameter type="ICalPropertyPollcompletion" name="v" comment="The pollcompletion value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type pollcompletion.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type pollcompletion.</comment> </method> <method name="i_cal_value_get_pollcompletion" corresponds="icalvalue_get_pollcompletion" kind="get" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyPollcompletion" comment="The pollcompletion within #ICalValue"/> - <comment>Get the pollcompletion of #ICalValue.</comment> + <comment>Gets the pollcompletion of #ICalValue.</comment> </method> <method name="i_cal_value_set_taskmode" corresponds="icalvalue_set_taskmode" kind="set" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode value."/> - <comment>Set the taskmode in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode value"/> + <comment>Sets the taskmode in the #ICalValue.</comment> </method> <method name="i_cal_value_new_taskmode" corresponds="icalvalue_new_taskmode" kind="constructor" since="2.0"> <parameter type="ICalPropertyTaskmode" name="v" comment="The taskmode value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type taskmode.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type taskmode.</comment> </method> <method name="i_cal_value_get_taskmode" corresponds="icalvalue_get_taskmode" kind="get" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyTaskmode" comment="The taskmode within #ICalValue"/> - <comment>Get the taskmode of #ICalValue.</comment> + <comment>Gets the taskmode of #ICalValue.</comment> </method> <method name="i_cal_value_set_pollmode" corresponds="icalvalue_set_pollmode" kind="set" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode value."/> - <comment>Set the pollmode in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode value"/> + <comment>Sets the pollmode in the #ICalValue.</comment> </method> <method name="i_cal_value_new_pollmode" corresponds="icalvalue_new_pollmode" kind="constructor" since="2.0"> <parameter type="ICalPropertyPollmode" name="v" comment="The pollmode value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type pollmode.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type pollmode.</comment> </method> <method name="i_cal_value_get_pollmode" corresponds="icalvalue_get_pollmode" kind="get" since="2.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyPollmode" comment="The pollmode within #ICalValue"/> - <comment>Get the pollmode of #ICalValue.</comment> + <comment>Gets the pollmode of #ICalValue.</comment> </method> <method name="i_cal_value_set_utcoffset" corresponds="icalvalue_set_utcoffset" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="gint" name="v" comment="The utcoffset value."/> - <comment>Set the utcoffset in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="gint" name="v" comment="The utcoffset value"/> + <comment>Sets the utcoffset in the #ICalValue.</comment> </method> <method name="i_cal_value_new_utcoffset" corresponds="icalvalue_new_utcoffset" kind="constructor" since="1.0"> <parameter type="gint" name="v" comment="The utcoffset value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type utcoffset.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type utcoffset.</comment> </method> <method name="i_cal_value_get_utcoffset" corresponds="icalvalue_get_utcoffset" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="gint" comment="The utcoffset within #ICalValue"/> - <comment>Get the utcoffset of #ICalValue.</comment> + <comment>Gets the utcoffset of #ICalValue.</comment> </method> <method name="i_cal_value_set_method" corresponds="icalvalue_set_method" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyMethod" name="v" comment="The method value."/> - <comment>Set the method in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyMethod" name="v" comment="The method value"/> + <comment>Sets the method in the #ICalValue.</comment> </method> <method name="i_cal_value_new_method" corresponds="icalvalue_new_method" kind="constructor" since="1.0"> <parameter type="ICalPropertyMethod" name="v" comment="The method value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type method.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type method.</comment> </method> <method name="i_cal_value_get_method" corresponds="icalvalue_get_method" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyMethod" comment="The method within #ICalValue"/> - <comment>Get the method of #ICalValue.</comment> + <comment>Gets the method of #ICalValue.</comment> </method> <method name="i_cal_value_set_caladdress" corresponds="icalvalue_set_caladdress" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The caladdress value."/> - <comment>Set the caladdress in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The caladdress value"/> + <comment>Sets the caladdress in the #ICalValue.</comment> </method> <method name="i_cal_value_new_caladdress" corresponds="icalvalue_new_caladdress" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The caladdress value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type caladdress.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type caladdress.</comment> </method> <method name="i_cal_value_get_caladdress" corresponds="icalvalue_get_caladdress" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The caladdress within #ICalValue"/> - <comment>Get the caladdress of #ICalValue.</comment> + <comment>Gets the caladdress of #ICalValue.</comment> </method> <method name="i_cal_value_set_period" corresponds="icalvalue_set_period" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPeriod *" name="v" comment="The period value."/> - <comment>Set the period in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPeriod *" name="v" comment="The period value"/> + <comment>Sets the period in the #ICalValue.</comment> </method> <method name="i_cal_value_new_period" corresponds="icalvalue_new_period" kind="constructor" since="1.0"> <parameter type="ICalPeriod *" name="v" comment="The period value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type period.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type period.</comment> </method> <method name="i_cal_value_get_period" corresponds="icalvalue_get_period" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPeriod *" annotation="allow-none, transfer full" comment="The period within #ICalValue"/> - <comment>Get the period of #ICalValue.</comment> + <comment>Gets the period of #ICalValue.</comment> </method> <method name="i_cal_value_set_status" corresponds="icalvalue_set_status" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyStatus" name="v" comment="The status value."/> - <comment>Set the status in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyStatus" name="v" comment="The status value"/> + <comment>Sets the status in the #ICalValue.</comment> </method> <method name="i_cal_value_new_status" corresponds="icalvalue_new_status" kind="constructor" since="1.0"> <parameter type="ICalPropertyStatus" name="v" comment="The status value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type status.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type status.</comment> </method> <method name="i_cal_value_get_status" corresponds="icalvalue_get_status" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyStatus" comment="The status within #ICalValue"/> - <comment>Get the status of #ICalValue.</comment> + <comment>Gets the status of #ICalValue.</comment> </method> <method name="i_cal_value_set_binary" corresponds="icalvalue_set_binary" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The binary value."/> - <comment>Set the binary in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The binary value"/> + <comment>Sets the binary in the #ICalValue.</comment> </method> <method name="i_cal_value_new_binary" corresponds="icalvalue_new_binary" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The binary value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type binary.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type binary.</comment> </method> <method name="i_cal_value_get_binary" corresponds="icalvalue_get_binary" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The binary within #ICalValue"/> - <comment>Get the binary of #ICalValue.</comment> + <comment>Gets the binary of #ICalValue.</comment> </method> <method name="i_cal_value_set_text" corresponds="icalvalue_set_text" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The text value."/> - <comment>Set the text in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The text value"/> + <comment>Sets the text in the #ICalValue.</comment> </method> <method name="i_cal_value_new_text" corresponds="icalvalue_new_text" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The text value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type text.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type text.</comment> </method> <method name="i_cal_value_get_text" corresponds="icalvalue_get_text" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The text within #ICalValue"/> - <comment>Get the text of #ICalValue.</comment> + <comment>Gets the text of #ICalValue.</comment> </method> <method name="i_cal_value_set_duration" corresponds="icalvalue_set_duration" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalDuration *" name="v" comment="The duration value."/> - <comment>Set the duration in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalDuration *" name="v" comment="The duration value"/> + <comment>Sets the duration in the #ICalValue.</comment> </method> <method name="i_cal_value_new_duration" corresponds="icalvalue_new_duration" kind="constructor" since="1.0"> <parameter type="ICalDuration *" name="v" comment="The duration value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type duration.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type duration.</comment> </method> <method name="i_cal_value_get_duration" corresponds="icalvalue_get_duration" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalDuration *" annotation="allow-none, transfer full" comment="The duration within #ICalValue"/> - <comment>Get the duration of #ICalValue.</comment> + <comment>Gets the duration of #ICalValue.</comment> </method> <method name="i_cal_value_set_integer" corresponds="icalvalue_set_integer" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="gint" name="v" comment="The integer value."/> - <comment>Set the integer in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="gint" name="v" comment="The integer value"/> + <comment>Sets the integer in the #ICalValue.</comment> </method> <method name="i_cal_value_new_integer" corresponds="icalvalue_new_integer" kind="constructor" since="1.0"> <parameter type="gint" name="v" comment="The integer value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type integer.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type integer.</comment> </method> <method name="i_cal_value_get_integer" corresponds="icalvalue_get_integer" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="gint" comment="The integer within #ICalValue"/> - <comment>Get the integer of #ICalValue.</comment> + <comment>Gets the integer of #ICalValue.</comment> </method> <method name="i_cal_value_set_uri" corresponds="icalvalue_set_uri" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The uri value."/> - <comment>Set the uri in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The uri value"/> + <comment>Sets the uri in the #ICalValue.</comment> </method> <method name="i_cal_value_new_uri" corresponds="icalvalue_new_uri" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The uri value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type uri.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type uri.</comment> </method> <method name="i_cal_value_get_uri" corresponds="icalvalue_get_uri" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The uri within #ICalValue"/> - <comment>Get the uri of #ICalValue.</comment> + <comment>Gets the uri of #ICalValue.</comment> </method> <method name="i_cal_value_set_class" corresponds="icalvalue_set_class" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalProperty_Class" name="v" comment="The class value."/> - <comment>Set the class in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalProperty_Class" name="v" comment="The class value"/> + <comment>Sets the class in the #ICalValue.</comment> </method> <method name="i_cal_value_new_class" corresponds="icalvalue_new_class" kind="constructor" since="1.0"> <parameter type="ICalProperty_Class" name="v" comment="The class value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type class.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type class.</comment> </method> <method name="i_cal_value_get_class" corresponds="icalvalue_get_class" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalProperty_Class" comment="The class within #ICalValue"/> - <comment>Get the class of #ICalValue.</comment> + <comment>Gets the class of #ICalValue.</comment> </method> <method name="i_cal_value_set_float" corresponds="icalvalue_set_float" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="gdouble" name="v" comment="The float value."/> - <comment>Set the float in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="gdouble" name="v" comment="The float value"/> + <comment>Sets the float in the #ICalValue.</comment> </method> <method name="i_cal_value_new_float" corresponds="icalvalue_new_float" kind="constructor" since="1.0"> <parameter type="gdouble" name="v" comment="The float value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type float.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type float.</comment> </method> <method name="i_cal_value_get_float" corresponds="icalvalue_get_float" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="gdouble" comment="The float within #ICalValue"/> - <comment>Get the float of #ICalValue.</comment> + <comment>Gets the float of #ICalValue.</comment> </method> <method name="i_cal_value_set_query" corresponds="icalvalue_set_query" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The query value."/> - <comment>Set the query in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The query value"/> + <comment>Sets the query in the #ICalValue.</comment> </method> <method name="i_cal_value_new_query" corresponds="icalvalue_new_query" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The query value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type query.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type query.</comment> </method> <method name="i_cal_value_get_query" corresponds="icalvalue_get_query" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The query within #ICalValue"/> - <comment>Get the query of #ICalValue.</comment> + <comment>Gets the query of #ICalValue.</comment> </method> <method name="i_cal_value_set_string" corresponds="icalvalue_set_string" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="const gchar *" name="v" comment="The string value."/> - <comment>Set the string in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="const gchar *" name="v" comment="The string value"/> + <comment>Sets the string in the #ICalValue.</comment> </method> <method name="i_cal_value_new_string" corresponds="icalvalue_new_string" kind="constructor" since="1.0"> <parameter type="const gchar *" name="v" comment="The string value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type string.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type string.</comment> </method> <method name="i_cal_value_get_string" corresponds="icalvalue_get_string" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The string within #ICalValue"/> - <comment>Get the string of #ICalValue.</comment> + <comment>Gets the string of #ICalValue.</comment> </method> <method name="i_cal_value_set_transp" corresponds="icalvalue_set_transp" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyTransp" name="v" comment="The transp value."/> - <comment>Set the transp in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyTransp" name="v" comment="The transp value"/> + <comment>Sets the transp in the #ICalValue.</comment> </method> <method name="i_cal_value_new_transp" corresponds="icalvalue_new_transp" kind="constructor" since="1.0"> <parameter type="ICalPropertyTransp" name="v" comment="The transp value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type transp.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type transp.</comment> </method> <method name="i_cal_value_get_transp" corresponds="icalvalue_get_transp" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyTransp" comment="The transp within #ICalValue"/> - <comment>Get the transp of #ICalValue.</comment> + <comment>Gets the transp of #ICalValue.</comment> </method> <method name="i_cal_value_set_requeststatus" corresponds="icalvalue_set_requeststatus" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalReqstat *" name="v" comment="The requeststatus value."/> - <comment>Set the requeststatus in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalReqstat *" name="v" comment="The requeststatus value"/> + <comment>Sets the requeststatus in the #ICalValue.</comment> </method> <method name="i_cal_value_new_requeststatus" corresponds="icalvalue_new_requeststatus" kind="constructor" since="1.0"> <parameter type="ICalReqstat *" name="v" comment="The requeststatus value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type requeststatus.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type requeststatus.</comment> </method> <method name="i_cal_value_get_requeststatus" corresponds="icalvalue_get_requeststatus" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalReqstat *" annotation="allow-none, transfer full" comment="The requeststatus within #ICalValue"/> - <comment>Get the requeststatus of #ICalValue.</comment> + <comment>Gets the requeststatus of #ICalValue.</comment> </method> <method name="i_cal_value_set_date" corresponds="icalvalue_set_date" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalTime *" name="v" comment="The date value."/> - <comment>Set the date in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalTime *" name="v" comment="The date value"/> + <comment>Sets the date in the #ICalValue.</comment> </method> <method name="i_cal_value_new_date" corresponds="icalvalue_new_date" kind="constructor" since="1.0"> <parameter type="ICalTime *" name="v" comment="The date value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type date.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type date.</comment> </method> <method name="i_cal_value_get_date" corresponds="icalvalue_get_date" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalTime *" annotation="allow-none, transfer full" comment="The date within #ICalValue"/> - <comment>Get the date of #ICalValue.</comment> + <comment>Gets the date of #ICalValue.</comment> </method> <method name="i_cal_value_set_action" corresponds="icalvalue_set_action" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyAction" name="v" comment="The action value."/> - <comment>Set the action in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyAction" name="v" comment="The action value"/> + <comment>Sets the action in the #ICalValue.</comment> </method> <method name="i_cal_value_new_action" corresponds="icalvalue_new_action" kind="constructor" since="1.0"> <parameter type="ICalPropertyAction" name="v" comment="The action value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type action.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type action.</comment> </method> <method name="i_cal_value_get_action" corresponds="icalvalue_get_action" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyAction" comment="The action within #ICalValue"/> - <comment>Get the action of #ICalValue.</comment> + <comment>Gets the action of #ICalValue.</comment> </method> <method name="i_cal_value_set_cmd" corresponds="icalvalue_set_cmd" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyCmd" name="v" comment="The cmd value."/> - <comment>Set the cmd in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyCmd" name="v" comment="The cmd value"/> + <comment>Sets the cmd in the #ICalValue.</comment> </method> <method name="i_cal_value_new_cmd" corresponds="icalvalue_new_cmd" kind="constructor" since="1.0"> <parameter type="ICalPropertyCmd" name="v" comment="The cmd value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type cmd.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type cmd.</comment> </method> <method name="i_cal_value_get_cmd" corresponds="icalvalue_get_cmd" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyCmd" comment="The cmd within #ICalValue"/> - <comment>Get the cmd of #ICalValue.</comment> + <comment>Gets the cmd of #ICalValue.</comment> </method> <method name="i_cal_value_set_querylevel" corresponds="icalvalue_set_querylevel" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel value."/> - <comment>Set the querylevel in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel value"/> + <comment>Sets the querylevel in the #ICalValue.</comment> </method> <method name="i_cal_value_new_querylevel" corresponds="icalvalue_new_querylevel" kind="constructor" since="1.0"> <parameter type="ICalPropertyQuerylevel" name="v" comment="The querylevel value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type querylevel.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type querylevel.</comment> </method> <method name="i_cal_value_get_querylevel" corresponds="icalvalue_get_querylevel" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyQuerylevel" comment="The querylevel within #ICalValue"/> - <comment>Get the querylevel of #ICalValue.</comment> + <comment>Gets the querylevel of #ICalValue.</comment> </method> <method name="i_cal_value_set_carlevel" corresponds="icalvalue_set_carlevel" kind="set" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue."/> - <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel value."/> - <comment>Set the carlevel in the #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue"/> + <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel value"/> + <comment>Sets the carlevel in the #ICalValue.</comment> </method> <method name="i_cal_value_new_carlevel" corresponds="icalvalue_new_carlevel" kind="constructor" since="1.0"> <parameter type="ICalPropertyCarlevel" name="v" comment="The carlevel value"/> - <returns type="ICalValue *" annotation="transfer full" comment="The newly create #ICalValue."/> - <comment>Create a new #ICalValue with the type carlevel.</comment> + <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> + <comment>Creates a new #ICalValue with the type carlevel.</comment> </method> <method name="i_cal_value_get_carlevel" corresponds="icalvalue_get_carlevel" kind="get" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried."/> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be queried"/> <returns type="ICalPropertyCarlevel" comment="The carlevel within #ICalValue"/> - <comment>Get the carlevel of #ICalValue.</comment> + <comment>Gets the carlevel of #ICalValue.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-duration.xml b/src/libical-glib/api/i-cal-duration.xml index 4850e628..bffab54b 100644 --- a/src/libical-glib/api/i-cal-duration.xml +++ b/src/libical-glib/api/i-cal-duration.xml @@ -15,125 +15,125 @@ --> <structure namespace="ICal" name="Duration" native="struct icaldurationtype" is_bare="true" default_native="icaldurationtype_null_duration()"> <method name="i_cal_duration_is_neg" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="gboolean" comment="The is_neg." /> - <comment xml:space="preserve">Get the is_neg of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the is_neg of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return (((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->is_neg) ? TRUE : FALSE;</custom> </method> <method name="i_cal_duration_set_is_neg" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="gboolean" name="is_neg" comment="The is_neg."/> - <comment>Set the is_neg of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="gboolean" name="is_neg" comment="The is_neg"/> + <comment>Sets the is_neg of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->is_neg = is_neg ? 1 : 0;</custom> </method> <method name="i_cal_duration_get_days" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="guint" comment="The days." /> - <comment xml:space="preserve">Get the days of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the days of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->days;</custom> </method> <method name="i_cal_duration_set_days" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="guint" name="days" comment="The days."/> - <comment>Set the days of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="guint" name="days" comment="The days"/> + <comment>Sets the days of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->days = days;</custom> </method> <method name="i_cal_duration_get_weeks" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="guint" comment="The weeks." /> - <comment xml:space="preserve">Get the weeks of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the weeks of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->weeks;</custom> </method> <method name="i_cal_duration_set_weeks" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="guint" name="weeks" comment="The weeks."/> - <comment>Set the weeks of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="guint" name="weeks" comment="The weeks"/> + <comment>Sets the weeks of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->weeks = weeks;</custom> </method> <method name="i_cal_duration_get_hours" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="guint" comment="The hours." /> - <comment xml:space="preserve">Get the hours of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the hours of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->hours;</custom> </method> <method name="i_cal_duration_set_hours" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="guint" name="hours" comment="The hours."/> - <comment>Set the hours of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="guint" name="hours" comment="The hours"/> + <comment>Sets the hours of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->hours = hours;</custom> </method> <method name="i_cal_duration_get_minutes" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="guint" comment="The minutes." /> - <comment xml:space="preserve">Get the minutes of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the minutes of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->minutes;</custom> </method> <method name="i_cal_duration_set_minutes" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="guint" name="minutes" comment="The minutes."/> - <comment>Set the minutes of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="guint" name="minutes" comment="The minutes"/> + <comment>Sets the minutes of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->minutes = minutes;</custom> </method> <method name="i_cal_duration_get_seconds" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried."/> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be queried"/> <returns type="guint" comment="The seconds." /> - <comment xml:space="preserve">Get the seconds of #ICalDuration.</comment> + <comment xml:space="preserve">Gets the seconds of #ICalDuration.</comment> <custom> g_return_val_if_fail (duration != NULL, 0); return ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->seconds;</custom> </method> <method name="i_cal_duration_set_seconds" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set."/> - <parameter type="guint" name="seconds" comment="The seconds."/> - <comment>Set the seconds of #ICalDuration.</comment> + <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be set"/> + <parameter type="guint" name="seconds" comment="The seconds"/> + <comment>Sets the seconds of #ICalDuration.</comment> <custom> g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration))->seconds = seconds;</custom> </method> <method name="i_cal_duration_new_from_int" corresponds="icaldurationtype_from_int" kind="constructor" since="1.0"> - <parameter type="gint" name="t" comment="the duration in second"/> + <parameter type="gint" name="t" comment="The duration in second"/> <returns type="ICalDuration *" annotation="transfer full" comment="The newly created #ICalDuration" /> - <comment xml:space="preserve">Create a #ICalDuration from the duration in second</comment> + <comment xml:space="preserve">Creates a #ICalDuration from the duration in second.</comment> </method> <method name="i_cal_duration_new_from_string" corresponds="icaldurationtype_from_string" kind="constructor" since="1.0"> <parameter type="const gchar *" name="str" comment="The string representation of the duration"/> <returns type="ICalDuration *" annotation="transfer full" comment="The newly created #ICalDuration" /> - <comment xml:space="preserve">Create a #ICalDuration from the duration in string</comment> + <comment xml:space="preserve">Creates a #ICalDuration from the duration in string.</comment> </method> <method name="i_cal_duration_as_int" corresponds="icaldurationtype_as_int" kind="others" since="1.0"> <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be converted"/> <returns type="gint" comment="The duration in second" /> - <comment xml:space="preserve">Convert the #ICalDuration to the representation in second</comment> + <comment xml:space="preserve">Converts the #ICalDuration to the representation in second.</comment> </method> <method name="i_cal_duration_as_ical_string" corresponds="icaldurationtype_as_ical_string_r" kind="others" since="1.0"> <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The duration in string" /> - <comment xml:space="preserve">Convert the #ICalDuration to the representation in string</comment> + <comment xml:space="preserve">Converts the #ICalDuration to the representation in string.</comment> </method> <method name="i_cal_duration_new_null_duration" corresponds="icaldurationtype_null_duration" kind="constructor" since="1.0"> <returns type="ICalDuration *" annotation="transfer full" comment="The newly created #ICalDuration" /> - <comment xml:space="preserve">Create a #ICalDuration with all the fields to be zero</comment> + <comment xml:space="preserve">Creates a #ICalDuration with all the fields to be zero.</comment> </method> <method name="i_cal_duration_new_bad_duration" corresponds="icaldurationtype_bad_duration" kind="constructor" since="1.0"> <returns type="ICalDuration *" annotation="transfer full" comment="The newly created #ICalDuration" /> - <comment xml:space="preserve">Create a bad #ICalDuration</comment> + <comment xml:space="preserve">Creates a bad #ICalDuration.</comment> </method> <method name="i_cal_duration_is_null_duration" corresponds="icaldurationtype_is_null_duration" kind="others" since="1.0"> <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be checked"/> <returns type="gboolean" comment="1 if @duration is the null_duration, 0 if not." /> - <comment xml:space="preserve">Check whether the #ICalDuration is the null_duration</comment> + <comment xml:space="preserve">Checks whether the #ICalDuration is the null_duration.</comment> </method> <method name="i_cal_duration_is_bad_duration" corresponds="icaldurationtype_is_bad_duration" kind="others" since="1.0"> <parameter type="ICalDuration *" name="duration" comment="The #ICalDuration to be checked"/> <returns type="gboolean" comment="1 if @duration is the bad_duration, 0 if not." /> - <comment xml:space="preserve">Check whether the #ICalDuration is the bad_duration</comment> + <comment xml:space="preserve">Checks whether the #ICalDuration is the bad_duration.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-enums.xml b/src/libical-glib/api/i-cal-enums.xml index 3da32879..61e12a79 100644 --- a/src/libical-glib/api/i-cal-enums.xml +++ b/src/libical-glib/api/i-cal-enums.xml @@ -91,27 +91,27 @@ <method name="i_cal_request_status_desc" corresponds="icalenum_reqstat_desc" since="1.0"> <parameter type="ICalRequestStatus" name="stat" comment="The #ICalRequestStatus to be translated"/> <returns type="const gchar *" comment="The description of the @stat" /> - <comment xml:space="preserve">Return the descriptive text for a request status</comment> + <comment xml:space="preserve">Returns the descriptive text for a request status.</comment> </method> <method name="i_cal_request_status_major" corresponds="icalenum_reqstat_major" since="1.0"> <parameter type="ICalRequestStatus" name="stat" comment="The #ICalRequestStatus to be queried"/> <returns type="gshort" comment="The major number for a request status" /> - <comment xml:space="preserve">Return the major number for a request status</comment> + <comment xml:space="preserve">Returns the major number for a request status.</comment> </method> <method name="i_cal_request_status_minor" corresponds="icalenum_reqstat_minor" since="1.0"> <parameter type="ICalRequestStatus" name="stat" comment="The #ICalRequestStatus to be queried"/> <returns type="gshort" comment="The minor number for a request status" /> - <comment xml:space="preserve">Return the minor number for a request status</comment> + <comment xml:space="preserve">Returns the minor number for a request status.</comment> </method> <method name="i_cal_request_status_from_num" corresponds="icalenum_num_to_reqstat" since="1.0"> <parameter type="gshort" name="major" comment="The major number"/> <parameter type="gshort" name="minor" comment="The minor number"/> <returns type="ICalRequestStatus" comment="The corresponding #ICalRequestStatus" /> - <comment xml:space="preserve">Return a request status for major/minor status numbers</comment> + <comment xml:space="preserve">Returns a request status for major/minor status numbers.</comment> </method> <method name="i_cal_request_status_code" corresponds="icalenum_reqstat_code_r" since="1.0"> <parameter type="ICalRequestStatus" name="stat" comment="The #ICalRequestStatus to be queried"/> <returns type="gchar *" annotation="transfer full" comment="The code for a request status" /> - <comment xml:space="preserve">Return the code for a request status</comment> + <comment xml:space="preserve">Returns the code for a request status.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-error.xml b/src/libical-glib/api/i-cal-error.xml index f7427391..e2692f71 100644 --- a/src/libical-glib/api/i-cal-error.xml +++ b/src/libical-glib/api/i-cal-error.xml @@ -35,45 +35,45 @@ </enum> <method name="i_cal_error_stop_here" corresponds="icalerror_stop_here" since="1.0"></method> <method name="i_cal_error_crash_here" corresponds="icalerror_crash_here" since="1.0"> - <comment xml:space="preserve">Shout out the errors to the compiler</comment> + <comment xml:space="preserve">Shout out the errors to the compiler.</comment> </method> <method name="i_cal_errno_return" corresponds="icalerrno_return" since="1.0"> <returns type="ICalErrorEnum" annotation="transfer full" translator="(ICalErrorEnum) *" translator_argus="NONE" comment="Return the error happened" /> - <comment xml:space="preserve">Return the error stored in the library. If no error, return I_CAL_NO_ERROR.</comment> + <comment xml:space="preserve">Returns the error stored in the library. If no error, return I_CAL_NO_ERROR.</comment> </method> <method name="i_cal_error_clear_errno" corresponds="icalerror_clear_errno" since="1.0"></method> <method name="i_cal_error_strerror" corresponds="icalerror_strerror" since="1.0"> <parameter type="ICalErrorEnum" name="e" comment="The #ICalErrorEnum to be translated"/> <returns type="const gchar *" annotation="transfer none" comment="The string representation of @e" /> - <comment xml:space="preserve">Translate the #ICalErrorEnum to the string representation</comment> + <comment xml:space="preserve">Translates the #ICalErrorEnum to the string representation.</comment> </method> <method name="i_cal_error_perror" corresponds="icalerror_perror" since="1.0"> <returns type="const gchar *" annotation="transfer none" comment="The string representation of the current error" /> - <comment xml:space="preserve">Get the #ICalErrorEnum in the string representation. This method called the icalerrorno_return to get the current error</comment> + <comment xml:space="preserve">Gets the #ICalErrorEnum in the string representation. This method called the icalerrorno_return to get the current error.</comment> </method> <method name="i_cal_bt" corresponds="ical_bt" kind="other" since="1.0"></method> <method name="i_cal_error_set_error_state" corresponds="icalerror_set_error_state" kind="set" since="1.0"> <parameter type="ICalErrorEnum" name="error" comment="The error enum"/> <parameter type="ICalErrorState" name="state" comment="The error state"/> - <comment xml:space="preserve">Set the state to the corresponding error in the library.</comment> + <comment xml:space="preserve">Sets the state to the corresponding error in the library.</comment> </method> <method name="i_cal_error_get_error_state" corresponds="icalerror_get_error_state" kind="get" since="1.0"> <parameter type="ICalErrorEnum" name="error" comment="The error to be checked"/> <returns type="ICalErrorState" comment="The state of the @error" /> - <comment xml:space="preserve">Get the state of an error</comment> + <comment xml:space="preserve">Gets the state of an error.</comment> </method> <method name="i_cal_error_set_errno" corresponds="icalerror_set_errno" kind="set" since="1.0"> <parameter type="ICalErrorEnum" name="x" comment="The error to be set"/> - <comment xml:space="preserve">Set the errno.</comment> + <comment xml:space="preserve">Sets the errno.</comment> </method> <method name="i_cal_error_supress" corresponds="icalerror_supress" since="1.0"> <parameter type="const gchar *" name="error" comment="The error to be suppressed"/> <returns type="ICalErrorState" comment="The error state suppressed" /> - <comment xml:space="preserve">Suppress the error</comment> + <comment xml:space="preserve">Suppresses the error.</comment> </method> <method name="i_cal_error_restore" corresponds="icalerror_restore" since="1.0"> <parameter type="const gchar *" name="error" comment="The error to be restored"/> <parameter type="ICalErrorState" name="es" comment="The error state to be restored"/> - <comment xml:space="preserve">Restore the error to specified state</comment> + <comment xml:space="preserve">Restores the error to specified state.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-geo.xml b/src/libical-glib/api/i-cal-geo.xml index fbfba3fc..cf647976 100644 --- a/src/libical-glib/api/i-cal-geo.xml +++ b/src/libical-glib/api/i-cal-geo.xml @@ -16,17 +16,17 @@ <structure namespace="ICal" name="Geo" native="struct icalgeotype" is_bare="true" default_native="i_cal_geo_new_default ()"> <method name="i_cal_geo_new_default" corresponds="CUSTOM" annotation="skip" kind="private" since="1.0"> <returns type="struct icalgeotype" annotation="transfer full" comment="The newly created #ICalGeo" /> - <comment xml:space="preserve">Create a new default #ICalGeo.</comment> + <comment xml:space="preserve">Creates a new default #ICalGeo.</comment> <custom> struct icalgeotype geotype; geotype.lat = 0; geotype.lon = 0; return geotype;</custom> </method> <method name="i_cal_geo_new" corresponds="CUSTOM" kind="constructor" since="1.0"> - <parameter type="gdouble" name="lat" comment="Latitude."/> - <parameter type="gdouble" name="lon" comment="Longitude."/> + <parameter type="gdouble" name="lat" comment="Latitude"/> + <parameter type="gdouble" name="lon" comment="Longitude"/> <returns type="ICalGeo *" annotation="transfer full" comment="The newly created #ICalGeo." /> - <comment xml:space="preserve">Create a new #ICalGeo.</comment> + <comment xml:space="preserve">Creates a new #ICalGeo.</comment> <custom> struct icalgeotype geo; geo = i_cal_geo_new_default(); @@ -36,9 +36,9 @@ return i_cal_geo_new_full(geo);</custom> </method> <method name="i_cal_geo_clone" corresponds="CUSTOM" kind="clone" since="1.0"> - <parameter type="const ICalGeo *" name="geo" comment="The #ICalGeo to clone."/> + <parameter type="const ICalGeo *" name="geo" comment="The #ICalGeo to clone"/> <returns type="ICalGeo *" annotation="transfer full" comment="The newly created #ICalGeo, copy of @geo." /> - <comment xml:space="preserve">Create a new #ICalGeo, copy of @geo.</comment> + <comment xml:space="preserve">Creates a new #ICalGeo, copy of @geo.</comment> <custom> struct icalgeotype *src; g_return_val_if_fail(I_CAL_IS_GEO(geo), NULL); @@ -49,30 +49,30 @@ return i_cal_geo_new_full(*src);</custom> </method> <method name="i_cal_geo_get_lat" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be queried."/> - <returns type="gdouble" comment="The lat." /> - <comment xml:space="preserve">Get the lat of #ICalGeo.</comment> + <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be queried"/> + <returns type="gdouble" comment="The latitude." /> + <comment xml:space="preserve">Gets the latitude of #ICalGeo.</comment> <custom> g_return_val_if_fail (geo != NULL, 0); return ((struct icalgeotype *)i_cal_object_get_native ((ICalObject *)geo))->lat;</custom> </method> <method name="i_cal_geo_set_lat" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be set."/> - <parameter type="gdouble" name="lat" comment="The lat."/> - <comment>Set the lat of #ICalGeo.</comment> + <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be set"/> + <parameter type="gdouble" name="lat" comment="The latitude"/> + <comment>Sets the latitude of #ICalGeo.</comment> <custom> g_return_if_fail (geo != NULL && I_CAL_IS_GEO (geo)); ((struct icalgeotype *)i_cal_object_get_native ((ICalObject *)geo))->lat = lat;</custom> </method> <method name="i_cal_geo_get_lon" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be queried."/> - <returns type="gdouble" comment="The lon." /> - <comment xml:space="preserve">Get the lon of #ICalGeo.</comment> + <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be queried"/> + <returns type="gdouble" comment="The longitude." /> + <comment xml:space="preserve">Gets the longitude of #ICalGeo.</comment> <custom> g_return_val_if_fail (geo != NULL, 0); return ((struct icalgeotype *)i_cal_object_get_native ((ICalObject *)geo))->lon;</custom> </method> <method name="i_cal_geo_set_lon" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be set."/> - <parameter type="gdouble" name="lon" comment="The lon."/> - <comment>Set the lon of #ICalGeo.</comment> + <parameter type="ICalGeo *" name="geo" comment="The #ICalGeo to be set"/> + <parameter type="gdouble" name="lon" comment="The longitude"/> + <comment>Sets the longitude of #ICalGeo.</comment> <custom> g_return_if_fail (geo != NULL && I_CAL_IS_GEO (geo)); ((struct icalgeotype *)i_cal_object_get_native ((ICalObject *)geo))->lon = lon;</custom> </method> diff --git a/src/libical-glib/api/i-cal-memory.xml b/src/libical-glib/api/i-cal-memory.xml index 34ef8198..49980a60 100644 --- a/src/libical-glib/api/i-cal-memory.xml +++ b/src/libical-glib/api/i-cal-memory.xml @@ -15,9 +15,9 @@ --> <structure namespace="ICal" name="Memory"> <method name="i_cal_memory_tmp_buffer" corresponds="icalmemory_tmp_buffer" since="1.0"> - <parameter type="size_t" name="size" comment="The size of the buffer to be created."/> + <parameter type="size_t" name="size" comment="The size of the buffer to be created"/> <returns type="void *" annotation="transfer full" comment="The newly created buffer"/> - <comment xml:space="preserve">Create a buffer with target size.</comment> + <comment xml:space="preserve">Creates a buffer with target size.</comment> </method> <method name="i_cal_memory_tmp_copy" corresponds="icalmemory_tmp_copy" since="1.0"> <parameter type="const gchar *" name="str" comment="The string to be copied"/> @@ -26,43 +26,43 @@ </method> <method name="i_cal_memory_add_tmp_buffer" corresponds="icalmemory_add_tmp_buffer" since="1.0"> <parameter type="void *" name="buf" annotation="transfer full" comment="The existing buffer to be added into the ical"/> - <comment xml:space="preserve">Add an existing buffer to the buffer ring</comment> + <comment xml:space="preserve">Adds an existing buffer to the buffer ring.</comment> </method> <method name="i_cal_memory_free_ring" annotation="skip" corresponds="icalmemory_free_ring" since="1.0"> - <comment xml:space="preserve">Free all the memory used in the ring.</comment> + <comment xml:space="preserve">Frees all the memory used in the ring.</comment> </method> <method name="i_cal_memory_new_buffer" corresponds="icalmemory_new_buffer" since="1.0"> - <parameter type="size_t" name="size" comment="The size of the new buffer to be created."/> + <parameter type="size_t" name="size" comment="The size of the new buffer to be created"/> <returns type="void *" annotation="transfer full" comment="The newly created buffer with the target size."/> - <comment xml:space="preserve">Create a new buffer with target size. The caller should deallocate it when necessary.</comment> + <comment xml:space="preserve">Creates a new buffer with target size. The caller should deallocate it when necessary.</comment> </method> <method name="i_cal_memory_resize_buffer" corresponds="icalmemory_resize_buffer" since="1.0"> - <parameter type="void *" name="buf" annotation="transfer full" comment="The buffer needs to be resized."/> - <parameter type="size_t" name="size" comment="The target size the buffer to be resized to."/> + <parameter type="void *" name="buf" annotation="transfer full" comment="The buffer needs to be resized"/> + <parameter type="size_t" name="size" comment="The target size the buffer to be resized to"/> <returns type="void *" annotation="transfer full" comment="The buffer after being resized."/> - <comment xml:space="preserve">Resize the buffer to the target size.</comment> + <comment xml:space="preserve">Resizes the buffer to the target size.</comment> </method> <method name="i_cal_memory_free_buffer" corresponds="icalmemory_free_buffer" since="1.0"> - <parameter type="void *" name="buf" annotation="transfer full" comment="The buffer to be freed."/> - <comment xml:space="preserve">Free the buffer.</comment> + <parameter type="void *" name="buf" annotation="transfer full" comment="The buffer to be freed"/> + <comment xml:space="preserve">Frees the buffer.</comment> </method> <method name="i_cal_memory_append_string" corresponds="icalmemory_append_string" since="1.0"> <parameter type="gchar **" name="buf" annotation="array length=buf_size, element-type gchar, inout" comment="The buffer to be appended. It should not be the memory in ical."/> - <parameter type="gchar **" name="pos" annotation="array, element-type gchar, inout" comment="The position at which the new string to be appended."/> + <parameter type="gchar **" name="pos" annotation="array, element-type gchar, inout" comment="The position at which the new string to be appended"/> <parameter type="size_t *" name="buf_size" comment="The size of the buffer before appended"/> <parameter type="const gchar *" name="str" comment="The string to be allocated"/> - <comment xml:space="preserve">Append the string to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it an you will have memory problems.</comment> + <comment xml:space="preserve">Appends the string to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it an you will have memory problems.</comment> </method> <method name="i_cal_memory_append_char" corresponds="icalmemory_append_char" since="1.0"> <parameter type="gchar **" name="buf" annotation="array length=buf_size, element-type gchar, inout" comment="The buffer to be appended. It should not be the memory in ical."/> - <parameter type="gchar **" name="pos" annotation="array, element-type gchar, inout" comment="The position at which the new string to be appended."/> + <parameter type="gchar **" name="pos" annotation="array, element-type gchar, inout" comment="The position at which the new string to be appended"/> <parameter type="size_t *" name="buf_size" comment="The size of the buffer before appended"/> <parameter type="gchar" name="ch" comment="The character to be allocated"/> <comment xml:space="preserve">Append the character to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it an you will have memory problems.</comment> </method> <method name="i_cal_memory_strdup" corresponds="icalmemory_strdup" since="1.0"> - <parameter type="const gchar *" name="s" comment="The string to be cloned."/> + <parameter type="const gchar *" name="s" comment="The string to be cloned"/> <returns type="gchar *" annotation="transfer full" comment="The cloned string."/> - <comment xml:space="preserve">A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims that strdup is undeclared</comment> + <comment xml:space="preserve">A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims that strdup is undeclared.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-mime.xml b/src/libical-glib/api/i-cal-mime.xml index 9294c9dc..2fa40f9f 100644 --- a/src/libical-glib/api/i-cal-mime.xml +++ b/src/libical-glib/api/i-cal-mime.xml @@ -24,10 +24,10 @@ */ typedef gchar *(*ICalMimeParseFunc)(gchar *bytes, size_t size, gpointer user_data);</declaration> <method name="i_cal_mime_parse" corresponds="CUSTOM" since="1.0"> - <parameter type="ICalMimeParseFunc" name="func" annotation="scope call" comment="The parsing function."/> - <parameter type="gpointer" name="user_data" annotation="closure" comment="The date given to @func."/> + <parameter type="ICalMimeParseFunc" name="func" annotation="scope call" comment="The parsing function"/> + <parameter type="gpointer" name="user_data" annotation="closure" comment="The date given to @func"/> <returns type="ICalComponent *" annotation="transfer full" comment="The parsed #ICalComponent"/> - <comment xml:space="preserve">Parse data to #ICalComponent using the given function.</comment> + <comment xml:space="preserve">Parses data to #ICalComponent using the given function.</comment> <custom> g_return_val_if_fail (func != NULL, NULL); g_return_val_if_fail (user_data != NULL, NULL); diff --git a/src/libical-glib/api/i-cal-parameter.xml b/src/libical-glib/api/i-cal-parameter.xml index 94a4dd29..ec9b17ff 100644 --- a/src/libical-glib/api/i-cal-parameter.xml +++ b/src/libical-glib/api/i-cal-parameter.xml @@ -17,102 +17,102 @@ <method name="i_cal_parameter_new" corresponds="icalparameter_new" kind="constructor" since="1.0"> <parameter type="ICalParameterKind" name="v" comment="The type of #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." /> - <comment xml:space="preserve">Create a new #ICalParameter according to the kind type</comment> + <comment xml:space="preserve">Creates a new #ICalParameter according to the kind type.</comment> </method> <method name="i_cal_parameter_clone" corresponds="icalparameter_new_clone" kind="clone" since="1.0"> <parameter type="ICalParameter *" name="p" annotation="in" comment="The #ICalParameter to be cloned"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter with the same properties as the @p." /> - <comment xml:space="preserve">Deep clone a #ICalParameter</comment> + <comment xml:space="preserve">Deep clone a #ICalParameter.</comment> </method> <method name="i_cal_parameter_new_from_string" corresponds="icalparameter_new_from_string" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="value" annotation="in, transfer none" comment="The string from which the #ICalParameter is created."/> + <parameter type="const gchar *" name="value" annotation="in, transfer none" comment="The string from which the #ICalParameter is created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created $ICalParameter with the properties specified in the @value." /> - <comment xml:space="preserve">Create a #ICalParameter from a string of form "PARAMNAME=VALUE".</comment> + <comment xml:space="preserve">Creates a #ICalParameter from a string of form "PARAMNAME=VALUE".</comment> </method> <method name="i_cal_parameter_new_from_value_string" corresponds="icalparameter_new_from_value_string" kind="constructor" since="1.0"> - <parameter type="ICalParameterKind" name="kind" comment="The kind of #ICalParameter to be created."/> - <parameter type="const gchar *" name="value" comment="The string from which #ICalParameter to be created."/> + <parameter type="ICalParameterKind" name="kind" comment="The kind of #ICalParameter to be created"/> + <parameter type="const gchar *" name="value" comment="The string from which #ICalParameter to be created"/> <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter" /> - <comment xml:space="preserve">Create a new #ICalParameter from just the value, the part after the "="</comment> + <comment xml:space="preserve">Creates a new #ICalParameter from just the value, the part after the "="</comment> </method> <method name="i_cal_parameter_free" corresponds="icalparameter_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be freeed."/> - <comment xml:space="preserve">Free the native part of the ICalParameter.</comment> + <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be freeed"/> + <comment xml:space="preserve">Frees the native part of the ICalParameter.</comment> </method> <method name="i_cal_parameter_as_ical_string" corresponds="icalparameter_as_ical_string_r" kind="others" since="1.0"> - <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be converted."/> + <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of the @parameter." /> - <comment xml:space="preserve">Convert an #ICalParameter to the string representation.</comment> + <comment xml:space="preserve">Converts an #ICalParameter to the string representation.</comment> </method> <method name="i_cal_parameter_isa" corresponds="icalparameter_isa" kind="others" since="1.0"> - <parameter type="ICalParameter *" name="parameter" comment="The #ICalParameter to be determined for the type."/> + <parameter type="ICalParameter *" name="parameter" comment="The #ICalParameter to be determined for the type"/> <returns type="ICalParameterKind" comment="The type of the @parameter." /> - <comment xml:space="preserve">Check the type of a #ICalParameter.</comment> + <comment xml:space="preserve">Checks the type of a #ICalParameter.</comment> </method> <method name="i_cal_parameter_isa_parameter" corresponds="icalparameter_isa_parameter" kind="others" since="1.0"> - <parameter type="ICalParameter *" name="param" annotation="in" comment="The #ICalParameter to be checked."/> + <parameter type="ICalParameter *" name="param" annotation="in" comment="The #ICalParameter to be checked"/> <returns type="gint" comment="1 if the native part is of type icalparameter, 0 if not." /> - <comment xml:space="preserve">Check whether the native part of the #ICalParameter is of type icalparameter.</comment> + <comment xml:space="preserve">Checks whether the native part of the #ICalParameter is of type icalparameter.</comment> </method> <method name="i_cal_parameter_set_xname" corresponds="icalparameter_set_xname" kind="set" since="1.0"> - <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xname to be set."/> - <parameter type="const gchar *" name="v" comment="The name to be set into the @param."/> - <comment xml:space="preserve">Set the xname property of the native part of the #ICalParameter.</comment> + <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xname to be set"/> + <parameter type="const gchar *" name="v" comment="The name to be set into the @param"/> + <comment xml:space="preserve">Sets the xname property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_get_xname" corresponds="icalparameter_get_xname" kind="get" since="1.0"> <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> - <comment xml:space="preserve">Get the xname property of the native part of the #ICalParameter.</comment> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> + <comment xml:space="preserve">Gets the xname property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_set_xvalue" corresponds="icalparameter_set_xvalue" kind="set" since="1.0"> - <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xvalue to be set."/> - <parameter type="const gchar *" name="v" comment="The value to be set into the @param."/> - <comment xml:space="preserve">Set the xvalue property of the native part of the #ICalParameter.</comment> + <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xvalue to be set"/> + <parameter type="const gchar *" name="v" comment="The value to be set into the @param"/> + <comment xml:space="preserve">Sets the xvalue property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_get_xvalue" corresponds="icalparameter_get_xvalue" kind="get" since="1.0"> <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> - <comment xml:space="preserve">Get the xvalue property of the native part of the #ICalParameter.</comment> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> + <comment xml:space="preserve">Gets the xvalue property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_set_iana_name" corresponds="icalparameter_set_iana_name" kind="set" since="1.0"> - <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_name to be set."/> - <parameter type="const gchar *" name="v" comment="The name to be set into the @param."/> - <comment xml:space="preserve">Set the iana_name property of the native part of the #ICalParameter.</comment> + <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_name to be set"/> + <parameter type="const gchar *" name="v" comment="The name to be set into the @param"/> + <comment xml:space="preserve">Sets the iana_name property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_get_iana_name" corresponds="icalparameter_get_iana_name" kind="get" since="1.0"> <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> - <comment xml:space="preserve">Get the iana_name property of the native part of the #ICalParameter.</comment> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> + <comment xml:space="preserve">Gets the iana_name property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_set_iana_value" corresponds="icalparameter_set_iana_value" kind="set" since="1.0"> - <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_value to be set."/> - <parameter type="const gchar *" name="v" comment="The value to be set into the @param."/> - <comment xml:space="preserve">Set the iana_value property of the native part of the #ICalParameter.</comment> + <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_value to be set"/> + <parameter type="const gchar *" name="v" comment="The value to be set into the @param"/> + <comment xml:space="preserve">Sets the iana_value property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_get_iana_value" corresponds="icalparameter_get_iana_value" kind="get" since="1.0"> <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/> - <returns type="const gchar *" annotation="allow-none" comment="the property of the @value" /> - <comment xml:space="preserve">Get the iana_value property of the native part of the #ICalParameter.</comment> + <returns type="const gchar *" annotation="allow-none" comment="The property of the @value" /> + <comment xml:space="preserve">Gets the iana_value property of the native part of the #ICalParameter.</comment> </method> <method name="i_cal_parameter_has_same_name" corresponds="icalparameter_has_same_name" kind="others" since="1.0"> <parameter type="ICalParameter *" name="param1" comment="The #ICalParameter to be checked"/> <parameter type="ICalParameter *" name="param2" comment="The #ICalParameter to be checked"/> <returns type="gint" comment="1 if the parameters have the same name, 0 or not." /> - <comment xml:space="preserve">Check whether native parts of two #ICalParameters have the same name</comment> + <comment xml:space="preserve">Checks whether native parts of two #ICalParameters have the same name.</comment> </method> <method name="i_cal_parameter_kind_to_string" corresponds="icalparameter_kind_to_string" kind="others" since="1.0"> <parameter type="ICalParameterKind" name="kind" comment="The #ICalParameterKind to be converted"/> <returns type="const gchar *" comment="The string representation of @kind." /> - <comment xml:space="preserve">Convert the #ICalParameter to the string representation</comment> + <comment xml:space="preserve">Converts the #ICalParameter to the string representation.</comment> </method> <method name="i_cal_parameter_kind_from_string" corresponds="icalparameter_string_to_kind" kind="others" since="1.0"> <parameter type="const gchar *" name="string" comment="The string representation of the #ICalParameter"/> <returns type="ICalParameterKind" comment="The #ICalParameterKind converted from @string" /> - <comment xml:space="preserve">Convert a string to the #ICalParameterKind</comment> + <comment xml:space="preserve">Converts a string to the #ICalParameterKind.</comment> </method> <method name="i_cal_parameter_kind_is_valid" corresponds="icalparameter_kind_is_valid" since="3.0.5"> <parameter type="const ICalParameterKind" name="kind" comment="The #ICalPropertyKind"/> <returns type="gboolean" comment="1 if valid, 0 if not."/> - <comment xml:space="preserve">Check whether #ICalParameterKind is valid.</comment> + <comment xml:space="preserve">Checks whether #ICalParameterKind is valid.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-parser.xml b/src/libical-glib/api/i-cal-parser.xml index e88cbe2c..7e901de2 100644 --- a/src/libical-glib/api/i-cal-parser.xml +++ b/src/libical-glib/api/i-cal-parser.xml @@ -32,34 +32,34 @@ typedef gchar *(*ICalParserLineGenFunc)(gchar *bytes, size_t size, gpointer user_data);</declaration> <method name="i_cal_parser_new" corresponds="icalparser_new" kind="constructor" since="1.0"> <returns type="ICalParser *" annotation="transfer full" comment="The newly created #ICalParser."/> - <comment xml:space="preserve">Create a default #ICalParser.</comment> + <comment xml:space="preserve">Creates a default #ICalParser.</comment> </method> <method name="i_cal_parser_add_line" corresponds="icalparser_add_line" since="1.0"> - <parameter type="ICalParser *" name="parser" annotation="in, transfer full" comment="The #ICalParser used to parse the string into the #ICalComponent."/> - <parameter type="gchar *" name="str" annotation="allow-none, transfer none" comment="A line of string representation of the #ICalComponent."/> + <parameter type="ICalParser *" name="parser" annotation="in, transfer full" comment="The #ICalParser used to parse the string into the #ICalComponent"/> + <parameter type="gchar *" name="str" annotation="allow-none, transfer none" comment="A line of string representation of the #ICalComponent"/> <returns type="ICalComponent *" annotation="allow-none, transfer full" translator_argus="(gpointer) parser" comment="The complete #ICalComponent."/> <comment xml:space="preserve">Add a line at one time into the #ICalParser until the parsing is complete and #ICalComponent will be returned.</comment> </method> <method name="i_cal_parser_clean" corresponds="icalparser_clean" since="1.0"> - <parameter type="ICalParser *" name="parser" comment="The parser to be cleaned and queried."/> + <parameter type="ICalParser *" name="parser" comment="The parser to be cleaned and queried"/> <returns type="ICalComponent *" annotation="allow-none, transfer full" translator_argus="(gpointer) parser" comment="The root #ICalComponent in @parser."/> - <comment xml:space="preserve">We won't get a clean exit if some components did not have an "END" tag. Clear off any component that may be left in the list</comment> + <comment xml:space="preserve">We won't get a clean exit if some components did not have an "END" tag. Clear off any component that may be left in the list.</comment> </method> <method name="i_cal_parser_get_state" corresponds="icalparser_get_state" kind="get" since="1.0"> - <parameter type="ICalParser *" name="parser" comment="The #ICalParser to be queried."/> + <parameter type="ICalParser *" name="parser" comment="The #ICalParser to be queried"/> <returns type="ICalParserState" comment="The parser state stored in the #ICalParser."/> - <comment xml:space="preserve">Get the state of the target parser.</comment> + <comment xml:space="preserve">Gets the state of the target parser.</comment> </method> <method name="i_cal_parser_free" corresponds="icalparser_free" kind="destructor" since="1.0"> - <parameter type="ICalParser *" name="parser" comment="The #ICalParser to be freed."/> - <comment xml:space="preserve">Free a #ICalParser.</comment> + <parameter type="ICalParser *" name="parser" comment="The #ICalParser to be freed"/> + <comment xml:space="preserve">Frees a #ICalParser.</comment> </method> <method name="i_cal_parser_parse" corresponds="CUSTOM" since="1.0"> - <parameter type="ICalParser *" name="parser" comment="The parser used to parse the string and output the #ICalComponent."/> - <parameter type="ICalParserLineGenFunc" name="func" annotation="scope call" comment="The function used to parse."/> - <parameter type="gpointer" name="user_data" annotation="closure" comment="The data given to @func."/> + <parameter type="ICalParser *" name="parser" comment="The parser used to parse the string and output the #ICalComponent"/> + <parameter type="ICalParserLineGenFunc" name="func" annotation="scope call" comment="The function used to parse"/> + <parameter type="gpointer" name="user_data" annotation="closure" comment="The data given to @func"/> <returns type="ICalComponent *" annotation="transfer full" comment="The component output by the parser."/> - <comment xml:space="preserve">icalparser_parse takes a string that holds the text ( in RFC 2445 format ) and returns a pointer to an #ICalComponent. The caller owns the memory. @func is a pointer to a function that returns one content line per invocation</comment> + <comment xml:space="preserve">icalparser_parse takes a string that holds the text ( in RFC 2445 format ) and returns a pointer to an #ICalComponent. The caller owns the memory. @func is a pointer to a function that returns one content line per invocation.</comment> <custom> g_return_val_if_fail (parser != NULL && func != NULL, NULL); icalparser_set_gen_data ((icalparser *)i_cal_object_get_native ((ICalObject *)parser), user_data); @@ -68,14 +68,14 @@ typedef gchar *(*ICalParserLineGenFunc)(gchar *bytes, size_t size, gpointer user <method name="i_cal_parser_parse_string" corresponds="icalparser_parse_string" since="1.0"> <parameter type="const gchar *" name="str" comment="The string to be parsed"/> <returns type="ICalComponent *" annotation="transfer full" comment="The #ICalComponent parsed from str."/> - <comment xml:space="preserve">Parse the string into a #ICalComponent.</comment> + <comment xml:space="preserve">Parses the string into a #ICalComponent.</comment> </method> <method name="i_cal_parser_get_line" corresponds="CUSTOM" since="1.0"> - <parameter type="ICalParser *" name="parser" comment="The parser to be queried."/> - <parameter type="ICalParserLineGenFunc" name="func" annotation="scope call" comment="A line generator function."/> - <parameter type="gpointer" name="user_data" annotation="closure" comment="The data given to @func."/> + <parameter type="ICalParser *" name="parser" comment="The parser to be queried"/> + <parameter type="ICalParserLineGenFunc" name="func" annotation="scope call" comment="A line generator function"/> + <parameter type="gpointer" name="user_data" annotation="closure" comment="The data given to @func"/> <returns type="gchar *" annotation="transfer full" comment="A single iCal content line."/> - <comment xml:space="preserve">Given a line generator function, return a single iCal content line.</comment> + <comment xml:space="preserve">Given a line generator function, returns a single iCal content line.</comment> <custom> g_return_val_if_fail (parser != NULL && func != NULL, NULL); icalparser_set_gen_data ((icalparser *)i_cal_object_get_native ((ICalObject *)parser), user_data); diff --git a/src/libical-glib/api/i-cal-period.xml b/src/libical-glib/api/i-cal-period.xml index aaa4b6aa..1b02bbc6 100644 --- a/src/libical-glib/api/i-cal-period.xml +++ b/src/libical-glib/api/i-cal-period.xml @@ -15,18 +15,18 @@ --> <structure namespace="ICal" name="Period" native="struct icalperiodtype" is_bare="true" default_native="icalperiodtype_null_period ()"> <method name="i_cal_period_get_start" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried."/> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="The start of @period."/> - <comment>Get the start time from an #ICalPeriod.</comment> + <comment>Gets the start time from an #ICalPeriod.</comment> <custom> g_return_val_if_fail (period != NULL, NULL); g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL); return i_cal_time_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).start);</custom> </method> <method name="i_cal_period_set_start" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set."/> - <parameter type="ICalTime *" name="start" comment="The start of @period."/> - <comment>Set the start time of an #ICalPeriod.</comment> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/> + <parameter type="ICalTime *" name="start" comment="The start of @period"/> + <comment>Sets the start time of an #ICalPeriod.</comment> <custom> struct icalperiodtype *periodtype; g_return_if_fail (period != NULL); g_return_if_fail (I_CAL_IS_PERIOD (period)); @@ -37,18 +37,18 @@ periodtype->start = * (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)start);</custom> </method> <method name="i_cal_period_get_end" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried."/> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/> <returns type="ICalTime *" annotation="transfer full" comment="The end of @period."/> - <comment>Get the end time from an #ICalPeriod.</comment> + <comment>Gets the end time from an #ICalPeriod.</comment> <custom> g_return_val_if_fail (period != NULL, NULL); g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL); return i_cal_time_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).end);</custom> </method> <method name="i_cal_period_set_end" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set."/> - <parameter type="ICalTime *" name="end" comment="The end of @period."/> - <comment>Set the end time of an #ICalPeriod.</comment> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/> + <parameter type="ICalTime *" name="end" comment="The end of @period"/> + <comment>Sets the end time of an #ICalPeriod.</comment> <custom> struct icalperiodtype *periodtype; g_return_if_fail (period != NULL); g_return_if_fail (I_CAL_IS_PERIOD (period)); @@ -59,18 +59,18 @@ periodtype->end = (* (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)end));</custom> </method> <method name="i_cal_period_get_duration" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried."/> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/> <returns type="ICalDuration *" annotation="transfer full" comment="The duration of @period."/> - <comment>Get the duration from an #ICalPeriod.</comment> + <comment>Gets the duration from an #ICalPeriod.</comment> <custom> g_return_val_if_fail (period != NULL, NULL); g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL); return i_cal_duration_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).duration);</custom> </method> <method name="i_cal_period_set_duration" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set."/> - <parameter type="ICalDuration *" name="duration" comment="The duration of @period."/> - <comment>Set the duration of an #ICalPeriod.</comment> + <parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/> + <parameter type="ICalDuration *" name="duration" comment="The duration of @period"/> + <comment>Sets the duration of an #ICalPeriod.</comment> <custom> struct icalperiodtype *periodtype; g_return_if_fail (period != NULL); g_return_if_fail (I_CAL_IS_PERIOD (period)); @@ -83,25 +83,25 @@ <method name="i_cal_period_new_from_string" corresponds="icalperiodtype_from_string" kind="constructor" since="1.0"> <parameter type="const gchar *" name="str" comment="The string used to create the #ICalPeriod"/> <returns type="ICalPeriod *" annotation="transfer full" comment="The newly created #ICalPeriod"/> - <comment xml:space="preserve">Create a #ICalPeriod from a string.</comment> + <comment xml:space="preserve">Creates a #ICalPeriod from a string.</comment> </method> <method name="i_cal_period_as_ical_string" corresponds="icalperiodtype_as_ical_string_r" since="1.0"> - <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be translated."/> + <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be translated"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of #ICalPeriod."/> - <comment xml:space="preserve">Translate #ICalPeriod to string.</comment> + <comment xml:space="preserve">Translates #ICalPeriod to string.</comment> </method> <method name="i_cal_period_new_null_period" corresponds="icalperiodtype_null_period" kind="constructor" since="1.0"> <returns type="ICalPeriod *" annotation="transfer full" comment="The newly created default #ICalPeriod"/> - <comment xml:space="preserve">Create a default #ICalPeriod.</comment> + <comment xml:space="preserve">Creates a default #ICalPeriod.</comment> </method> <method name="i_cal_period_is_null_period" corresponds="icalperiodtype_is_null_period" since="1.0"> - <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked."/> + <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check the #ICalPeriod is null_period.</comment> + <comment xml:space="preserve">Checks the #ICalPeriod is null_period.</comment> </method> <method name="i_cal_period_is_valid_period" corresponds="icalperiodtype_is_valid_period" since="1.0"> - <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked."/> + <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check the #ICalPeriod is valid_period.</comment> + <comment xml:space="preserve">Checks the #ICalPeriod is valid_period.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-property.xml b/src/libical-glib/api/i-cal-property.xml index 6caa7eb2..028a39d3 100644 --- a/src/libical-glib/api/i-cal-property.xml +++ b/src/libical-glib/api/i-cal-property.xml @@ -15,48 +15,48 @@ --> <structure namespace="ICal" name="Property" native="icalproperty" destroy_func="icalproperty_free"> <method name="i_cal_property_new" corresponds="icalproperty_new" kind="constructor" since="1.0"> - <parameter type="ICalPropertyKind" name="kind" comment="The kind of #ICalProperty to be created."/> + <parameter type="ICalPropertyKind" name="kind" comment="The kind of #ICalProperty to be created"/> <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty with the type @kind."/> - <comment xml:space="preserve">Create a #ICalProperty of the target type.</comment> + <comment xml:space="preserve">Creates a #ICalProperty of the target type.</comment> </method> <method name="i_cal_property_clone" corresponds="icalproperty_new_clone" kind="clone" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be cloned."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be cloned"/> <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty deeply cloned from @prop."/> <comment xml:space="preserve">Deeply clone a #ICalProperty.</comment> </method> <method name="i_cal_property_new_from_string" corresponds="icalproperty_new_from_string" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="str" comment="The string used to construct a #ICalProperty."/> + <parameter type="const gchar *" name="str" comment="The string used to construct a #ICalProperty"/> <returns type="ICalProperty *" annotation="transfer full" comment="The newly created #ICalProperty from @str."/> - <comment xml:space="preserve">Create a #ICalProperty from a string.</comment> + <comment xml:space="preserve">Creates a #ICalProperty from a string.</comment> </method> <method name="i_cal_property_as_ical_string" corresponds="icalproperty_as_ical_string_r" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be converted."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of @prop."/> - <comment xml:space="preserve">Convert a #ICalProperty to a string representation.</comment> + <comment xml:space="preserve">Converts a #ICalProperty to a string representation.</comment> </method> <method name="i_cal_property_free" corresponds="icalproperty_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalProperty *" name="prop" annotation="transfer full" comment="The #ICalProperty to be freed."/> - <comment xml:space="preserve">Free a #ICalProperty.</comment> + <parameter type="ICalProperty *" name="prop" annotation="transfer full" comment="The #ICalProperty to be freed"/> + <comment xml:space="preserve">Frees a #ICalProperty.</comment> </method> <method name="i_cal_property_isa" corresponds="icalproperty_isa" since="1.0"> - <parameter type="ICalProperty *" name="property" comment="The #ICalProperty which type is to be determined."/> + <parameter type="ICalProperty *" name="property" comment="The #ICalProperty which type is to be determined"/> <returns type="ICalPropertyKind" comment="The type of #ICalProperty."/> - <comment xml:space="preserve">Get the kind of #ICalProperty.</comment> + <comment xml:space="preserve">Gets the kind of #ICalProperty.</comment> </method> <method name="i_cal_property_isa_property" corresponds="icalproperty_isa_property" since="1.0"> - <parameter type="ICalProperty *" name="property" comment="The object whose native part to be checked."/> + <parameter type="ICalProperty *" name="property" comment="The object whose native part to be checked"/> <returns type="gint" comment="1 if the native part of @property is of the type icalproperty, 0 if not."/> - <comment xml:space="preserve">Check whether the native part of #ICalProperty is of the type icalproperty.</comment> + <comment xml:space="preserve">Checks whether the native part of #ICalProperty is of the type icalproperty.</comment> </method> <method name="i_cal_property_add_parameter" corresponds="icalproperty_add_parameter" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set."/> - <parameter type="ICalParameter *" name="parameter" annotation="transfer none" owner_op="prop" comment="The parameter to be added into @prop."/> - <comment xml:space="preserve">Add a #ICalParameter into the #ICalProperty. It behaves like set the copy of the #ICalParameter. Upon completion the native part of #ICalParameter will be set to NULL.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> + <parameter type="ICalParameter *" name="parameter" annotation="transfer none" owner_op="prop" comment="The parameter to be added into @prop"/> + <comment xml:space="preserve">Adds a #ICalParameter into the #ICalProperty. It behaves like set the copy of the #ICalParameter. Upon completion the native part of #ICalParameter will be set to NULL.</comment> </method> <method name="i_cal_property_take_parameter" corresponds="CUSTOM" annotation="skip" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set."/> - <parameter type="ICalParameter *" name="parameter" annotation="transfer full" comment="The parameter to be added into @prop."/> - <comment xml:space="preserve">Add the @parameter into the @prop and free the @parameter.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> + <parameter type="ICalParameter *" name="parameter" annotation="transfer full" comment="The parameter to be added into @prop"/> + <comment xml:space="preserve">Adds the @parameter into the @prop and free the @parameter.</comment> <custom> g_return_if_fail(I_CAL_IS_PROPERTY(prop)); g_return_if_fail(I_CAL_IS_PARAMETER(parameter)); @@ -64,63 +64,63 @@ g_object_unref(parameter);</custom> </method> <method name="i_cal_property_set_parameter" corresponds="icalproperty_set_parameter" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set."/> - <parameter type="ICalParameter *" name="parameter" annotation="transfer none" owner_op="prop" comment="The parameter to be set into @prop."/> - <comment xml:space="preserve">Set a #ICalParameter into the #ICalProperty. It behaves like set the copy of the #ICalParameter. Upon completion the native part of #ICalParameter will be set to NULL.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> + <parameter type="ICalParameter *" name="parameter" annotation="transfer none" owner_op="prop" comment="The parameter to be set into @prop"/> + <comment xml:space="preserve">Sets a #ICalParameter into the #ICalProperty. It behaves like set the copy of the #ICalParameter. Upon completion the native part of #ICalParameter will be set to NULL.</comment> </method> <method name="i_cal_property_set_parameter_from_string" corresponds="icalproperty_set_parameter_from_string" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set."/> - <parameter type="const gchar *" name="name" comment="The name of the parameter."/> - <parameter type="const gchar *" name="value" comment="The value of the parameter."/> - <comment xml:space="preserve">Set the #ICalProperty with the parameter defined by the name and value.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> + <parameter type="const gchar *" name="name" comment="The name of the parameter"/> + <parameter type="const gchar *" name="value" comment="The value of the parameter"/> + <comment xml:space="preserve">Sets the #ICalProperty with the parameter defined by the name and value.</comment> </method> <method name="i_cal_property_get_parameter_as_string" corresponds="icalproperty_get_parameter_as_string_r" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> - <parameter type="const gchar *" name="name" comment="The name of the target parameter."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> + <parameter type="const gchar *" name="name" comment="The name of the target parameter"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of the parameter."/> - <comment xml:space="preserve">Get the string representation of the target parameter in the #ICalProperty.</comment> + <comment xml:space="preserve">Gets the string representation of the target parameter in the #ICalProperty.</comment> </method> <method name="i_cal_property_remove_parameter_by_kind" corresponds="icalproperty_remove_parameter_by_kind" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated."/> - <parameter type="ICalParameterKind" name="kind" comment="The #ICalParameterKind to be removed."/> - <comment xml:space="preserve">Remove the target kind of the parameters in the #ICalProperty.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated"/> + <parameter type="ICalParameterKind" name="kind" comment="The #ICalParameterKind to be removed"/> + <comment xml:space="preserve">Removes the target kind of the parameters in the #ICalProperty.</comment> </method> <method name="i_cal_property_remove_parameter_by_name" corresponds="icalproperty_remove_parameter_by_name" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated."/> - <parameter type="const gchar *" name="name" comment="The name of the parameter to be removed."/> - <comment xml:space="preserve">Remove parameter in the #ICalProperty by name.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated"/> + <parameter type="const gchar *" name="name" comment="The name of the parameter to be removed"/> + <comment xml:space="preserve">Removes parameter in the #ICalProperty by name.</comment> </method> <method name="i_cal_property_remove_parameter_by_ref" corresponds="icalproperty_remove_parameter_by_ref" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated."/> - <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be removed."/> - <comment xml:space="preserve">Remove the parameter in the #ICalProperty by ref.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be manipulated"/> + <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be removed"/> + <comment xml:space="preserve">Removes the parameter in the #ICalProperty by ref.</comment> </method> <method name="i_cal_property_count_parameters" corresponds="icalproperty_count_parameters" since="1.0"> - <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be checked."/> + <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be checked"/> <returns type="gint" comment="The count of the parameters in the #ICalProperty."/> - <comment xml:space="preserve">Count the parameters in the #ICalProperty.</comment> + <comment xml:space="preserve">Counts the parameters in the #ICalProperty.</comment> </method> <method name="i_cal_property_get_first_parameter" corresponds="icalproperty_get_first_parameter" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> - <parameter type="ICalParameterKind" name="kind" comment="The target kind of #ICalParameter to be retrieved."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> + <parameter type="ICalParameterKind" name="kind" comment="The target kind of #ICalParameter to be retrieved"/> <returns type="ICalParameter *" annotation="transfer full" translator_argus="(GObject *)prop" comment="The first #ICalParameter of @prop."/> - <comment xml:space="preserve">Get the first #ICalParameter from the parent #ICalProperty.</comment> + <comment xml:space="preserve">Gets the first #ICalParameter from the parent #ICalProperty.</comment> </method> <method name="i_cal_property_get_next_parameter" corresponds="icalproperty_get_next_parameter" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> - <parameter type="ICalParameterKind" name="kind" comment="The target kind of #ICalParameter to be retrieved."/> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> + <parameter type="ICalParameterKind" name="kind" comment="The target kind of #ICalParameter to be retrieved"/> <returns type="ICalParameter *" annotation="transfer full" translator_argus="(GObject *)prop" comment="The next #ICalParameter of @prop."/> - <comment xml:space="preserve">Get the next #ICalParameter from the parent #ICalProperty.</comment> + <comment xml:space="preserve">Gets the next #ICalParameter from the parent #ICalProperty.</comment> </method> <method name="i_cal_property_set_value" corresponds="icalproperty_set_value" since="1.0"> - <parameter type="ICalProperty *" name="prop" translator_argus="value" comment="The target #ICalProperty."/> - <parameter type="ICalValue *" name="value" owner_op="prop" comment="The #ICalValue will be set as the property of @prop."/> - <comment xml:space="preserve">Set the #ICalProperty with the #ICalValue.</comment> + <parameter type="ICalProperty *" name="prop" translator_argus="value" comment="The target #ICalProperty"/> + <parameter type="ICalValue *" name="value" owner_op="prop" comment="The #ICalValue will be set as the property of @prop"/> + <comment xml:space="preserve">Sets the #ICalProperty with the #ICalValue.</comment> </method> <method name="i_cal_property_take_value" corresponds="CUSTOM" annotation="skip" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The target #ICalProperty."/> - <parameter type="ICalValue *" name="value" annotation="transfer full" comment="The #ICalValue will be set as the property of @prop."/> - <comment xml:space="preserve">Set the @prop with the @value and unrefs the @value.</comment> + <parameter type="ICalProperty *" name="prop" comment="The target #ICalProperty"/> + <parameter type="ICalValue *" name="value" annotation="transfer full" comment="The #ICalValue will be set as the property of @prop"/> + <comment xml:space="preserve">Sets the @prop with the @value and unrefs the @value.</comment> <custom> g_return_if_fail(I_CAL_IS_PROPERTY(prop)); g_return_if_fail(I_CAL_IS_VALUE(value)); @@ -128,121 +128,121 @@ g_object_unref(value);</custom> </method> <method name="i_cal_property_set_value_from_string" corresponds="icalproperty_set_value_from_string" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set."/> - <parameter type="const gchar *" name="value" comment="The value used to construct the #ICalValue."/> - <parameter type="const gchar *" name="kind" comment="The kind used to construct the #ICalValue."/> - <comment xml:space="preserve">Set the #ICalProperty with the #ICalValue constructed from string.</comment> + <parameter type="ICalProperty *" name="prop" comment="The #ICalProperty to be set"/> + <parameter type="const gchar *" name="value" comment="The value used to construct the #ICalValue"/> + <parameter type="const gchar *" name="kind" comment="The kind used to construct the #ICalValue"/> + <comment xml:space="preserve">Sets the #ICalProperty with the #ICalValue constructed from string.</comment> </method> <method name="i_cal_property_get_value" corresponds="icalproperty_get_value" since="1.0"> - <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="ICalValue *" annotation="transfer full" translator_argus="(GObject *)prop" comment="The #ICalValue of @prop."/> - <comment xml:space="preserve">Get the #ICalValue of #ICalProperty.</comment> + <comment xml:space="preserve">Gets the #ICalValue of #ICalProperty.</comment> </method> <method name="i_cal_property_get_value_as_string" corresponds="icalproperty_get_value_as_string_r" since="1.0"> - <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be queried."/> + <parameter type="const ICalProperty *" name="prop" comment="The #ICalProperty to be queried"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of the value of the #ICalProperty."/> - <comment xml:space="preserve">Get the string representation of the value in #ICalProperty.</comment> + <comment xml:space="preserve">Gets the string representation of the value in #ICalProperty.</comment> </method> <method name="i_cal_value_set_parent" corresponds="icalvalue_set_parent" since="2.0"> <parameter type="ICalValue *" name="value" comment="The child #ICalValue"/> <parameter type="ICalProperty *" name="property" annotation="nullable" comment="The parent #ICalProperty"/> - <comment xml:space="preserve">Set the parent property of a value.</comment> + <comment xml:space="preserve">Sets the parent property of a value.</comment> </method> <method name="i_cal_value_get_parent" corresponds="icalvalue_get_parent" since="3.0"> <parameter type="ICalValue *" name="value" comment="The child #ICalValue"/> <returns type="ICalProperty *" annotation="transfer full, nullable" comment="The parent #ICalProperty"/> - <comment xml:space="preserve">Get the parent #ICalProperty of the specified #ICalValue.</comment> + <comment xml:space="preserve">Gets the parent #ICalProperty of the specified #ICalValue.</comment> </method> <method name="i_cal_parameter_set_parent" corresponds="icalparameter_set_parent" since="3.0"> <parameter type="ICalParameter *" name="param" comment="The child #ICalParameter"/> <parameter type="ICalProperty *" name="property" annotation="nullable" comment="The parent #ICalProperty"/> - <comment xml:space="preserve">Set the parent #ICalProperty of an #ICalParameter.</comment> + <comment xml:space="preserve">Sets the parent #ICalProperty of an #ICalParameter.</comment> </method> <method name="i_cal_parameter_get_parent" corresponds="icalparameter_get_parent" since="3.0"> <parameter type="ICalParameter *" name="param" comment="The child #ICalParameter"/> <returns type="ICalProperty *" annotation="transfer full, nullable" comment="The parent #ICalProperty"/> - <comment xml:space="preserve">Get the parent #ICalProperty of the specified #ICalParameter.</comment> + <comment xml:space="preserve">Gets the parent #ICalProperty of the specified #ICalParameter.</comment> </method> <method name="i_cal_property_set_x_name" corresponds="icalproperty_set_x_name" since="1.0"> <parameter type="ICalProperty *" name="prop" comment="A #ICalProperty"/> - <parameter type="const gchar *" name="name" comment="The name string."/> - <comment xml:space="preserve">Set the name of x property for the #ICalProperty.</comment> + <parameter type="const gchar *" name="name" comment="The name string"/> + <comment xml:space="preserve">Sets the name of x property for the #ICalProperty.</comment> </method> <method name="i_cal_property_get_x_name" corresponds="icalproperty_get_x_name" since="1.0"> - <parameter type="ICalProperty *" name="prop" comment="A #ICalProperty."/> + <parameter type="ICalProperty *" name="prop" comment="A #ICalProperty"/> <returns type="const gchar *" annotation="nullable" comment="The name of x property."/> - <comment xml:space="preserve">Get the name of x property.</comment> + <comment xml:space="preserve">Gets the name of x property.</comment> </method> <method name="i_cal_property_get_property_name" corresponds="icalproperty_get_property_name_r" since="1.0"> - <parameter type="const ICalProperty *" name="prop" comment="A #ICalProperty."/> + <parameter type="const ICalProperty *" name="prop" comment="A #ICalProperty"/> <returns type="gchar *" annotation="transfer full" comment="Property name of #ICalProperty."/> - <comment xml:space="preserve">Get the property name of #ICalProperty.</comment> + <comment xml:space="preserve">Gets the property name of #ICalProperty.</comment> </method> <method name="i_cal_parameter_value_to_value_kind" corresponds="icalparameter_value_to_value_kind" since="1.0"> - <parameter type="ICalParameterValue" name="value" comment="A #ICalParameterValue."/> + <parameter type="ICalParameterValue" name="value" comment="A #ICalParameterValue"/> <returns type="ICalValueKind" comment="#ICalValueKind"/> - <comment xml:space="preserve">Convert the #ICalParameterValue to #ICalValueKind.</comment> + <comment xml:space="preserve">Converts the #ICalParameterValue to #ICalValueKind.</comment> </method> <method name="i_cal_property_kind_to_value_kind" corresponds="icalproperty_kind_to_value_kind" since="1.0"> - <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind."/> + <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> <returns type="ICalValueKind" comment="The #ICalValueKind"/> - <comment xml:space="preserve">Convert the #ICalPropertyKind to #ICalValueKind.</comment> + <comment xml:space="preserve">Converts the #ICalPropertyKind to #ICalValueKind.</comment> </method> <method name="i_cal_value_kind_to_property_kind" corresponds="icalproperty_value_kind_to_kind" since="1.0"> <parameter type="ICalValueKind" name="kind" comment="A #ICalValueKind"/> <returns type="ICalPropertyKind" comment="The #ICalPropertyKind."/> - <comment xml:space="preserve">Convert a #ICalValueKind to a #ICalPropertyKind.</comment> + <comment xml:space="preserve">Converts a #ICalValueKind to a #ICalPropertyKind.</comment> </method> <method name="i_cal_property_kind_to_string" corresponds="icalproperty_kind_to_string" since="1.0"> - <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind."/> + <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> <returns type="const gchar *" comment="The string representation of @kind."/> - <comment xml:space="preserve">Convert the #ICalPropertyKind to a string.</comment> + <comment xml:space="preserve">Converts the #ICalPropertyKind to a string.</comment> </method> <method name="i_cal_property_kind_from_string" corresponds="icalproperty_string_to_kind" since="1.0"> - <parameter type="const gchar *" name="string" comment="A string representing #ICalPropertyKind."/> + <parameter type="const gchar *" name="string" comment="A string representing #ICalPropertyKind"/> <returns type="ICalPropertyKind" comment="The #ICalPropertyKind."/> - <comment xml:space="preserve">Convert the string to #ICalPropertyKind.</comment> + <comment xml:space="preserve">Converts the string to #ICalPropertyKind.</comment> </method> <method name="i_cal_property_kind_is_valid" corresponds="icalproperty_kind_is_valid" since="1.0"> <parameter type="const ICalPropertyKind" name="kind" comment="The #ICalPropertyKind"/> <returns type="gboolean" comment="1 if valid, 0 if not."/> - <comment xml:space="preserve">Check whether #ICalPropertyKind is valid.</comment> + <comment xml:space="preserve">Checks whether #ICalPropertyKind is valid.</comment> </method> <method name="i_cal_property_method_from_string" corresponds="icalproperty_string_to_method" since="1.0"> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalPropertyMethod" comment="The #ICalPropertyMethod."/> - <comment xml:space="preserve">Convert the string to #ICalPropertyKind.</comment> + <comment xml:space="preserve">Converts the string to #ICalPropertyKind.</comment> </method> <method name="i_cal_property_method_to_string" corresponds="icalproperty_method_to_string" since="1.0"> - <parameter type="ICalPropertyMethod" name="method" comment="The #ICalPropertyMethod."/> + <parameter type="ICalPropertyMethod" name="method" comment="The #ICalPropertyMethod"/> <returns type="const gchar *" comment="The string representation of #ICalPropertyMethod."/> - <comment xml:space="preserve">Convert the #ICalPropertyMethod to string.</comment> + <comment xml:space="preserve">Converts the #ICalPropertyMethod to string.</comment> </method> <method name="i_cal_property_enum_to_string" corresponds="icalproperty_enum_to_string_r" since="1.0"> - <parameter type="gint" name="e" comment="The enum to be converted."/> + <parameter type="gint" name="e" comment="The enum to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of @e."/> - <comment xml:space="preserve">Convert the enum to string.</comment> + <comment xml:space="preserve">Converts the enum to string.</comment> </method> <method name="i_cal_property_kind_and_string_to_enum" corresponds="icalproperty_kind_and_string_to_enum" since="1.0"> - <parameter type="const gint" name="kind" comment="The kind."/> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gint" name="kind" comment="The kind"/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="gint" comment="The enum."/> - <comment xml:space="preserve">Convert a integer and string into an enum.</comment> + <comment xml:space="preserve">Converts a integer and string into an enum.</comment> </method> <method name="i_cal_property_status_from_string" corresponds="icalproperty_string_to_status" since="1.0"> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalPropertyStatus" comment="The #ICalPropertyStatus."/> - <comment xml:space="preserve">Convert the string to #ICalPropertyKind.</comment> + <comment xml:space="preserve">Converts the string to #ICalPropertyKind.</comment> </method> <method name="i_cal_property_status_to_string" corresponds="icalproperty_status_to_string" since="1.0"> - <parameter type="ICalPropertyStatus" name="method" comment="The #ICalPropertyStatus."/> + <parameter type="ICalPropertyStatus" name="method" comment="The #ICalPropertyStatus"/> <returns type="const gchar *" comment="The string representation of #ICalPropertyStatus."/> - <comment xml:space="preserve">Convert the #ICalPropertyStatus to string.</comment> + <comment xml:space="preserve">Converts the #ICalPropertyStatus to string.</comment> </method> <method name="i_cal_property_kind_has_property" corresponds="icalproperty_enum_belongs_to_property" since="1.0"> <parameter type="ICalPropertyKind" name="kind" comment="A #ICalPropertyKind"/> - <parameter type="gint" name="e" comment="The enum to be checked."/> + <parameter type="gint" name="e" comment="The enum to be checked"/> <returns type="gint" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check whether the enum belongs to the #ICalPropertyKind.</comment> + <comment xml:space="preserve">Checks whether the enum belongs to the #ICalPropertyKind.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-recur-iterator.xml b/src/libical-glib/api/i-cal-recur-iterator.xml index ac905632..f5286836 100644 --- a/src/libical-glib/api/i-cal-recur-iterator.xml +++ b/src/libical-glib/api/i-cal-recur-iterator.xml @@ -15,25 +15,25 @@ --> <structure namespace="ICal" name="RecurIterator" native="icalrecur_iterator" destroy_func="icalrecur_iterator_free"> <method name="i_cal_recur_iterator_new" corresponds="icalrecur_iterator_new" kind="constructor" since="1.0"> - <parameter type="ICalRecurrence *" name="rule" comment="The rule applied on the #ICalRecurIterator."/> - <parameter type="ICalTime *" name="dtstart" comment="The start time of the recurrence."/> + <parameter type="ICalRecurrence *" name="rule" comment="The rule applied on the #ICalRecurIterator"/> + <parameter type="ICalTime *" name="dtstart" comment="The start time of the recurrence"/> <returns type="ICalRecurIterator *" annotation="transfer full" comment="The newly created #ICalRecurIterator"/> - <comment xml:space="preserve">Create an #ICalRecurIterator.</comment> + <comment xml:space="preserve">Creates an #ICalRecurIterator.</comment> </method> <method name="i_cal_recur_iterator_next" corresponds="icalrecur_iterator_next" since="1.0"> - <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator."/> + <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator"/> <returns type="ICalTime *" annotation="transfer full" comment="The next occurrence according to this recurrence rule."/> - <comment xml:space="preserve">Get the next occurrence from an iterator.</comment> + <comment xml:space="preserve">Gets the next occurrence from an iterator.</comment> </method> <method name="i_cal_recur_iterator_set_start" corresponds="icalrecur_iterator_set_start" since="3.0"> - <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator."/> - <parameter type="ICalTime *" name="start" comment="The date-time to move the iterator to."/> + <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator"/> + <parameter type="ICalTime *" name="start" comment="The date-time to move the iterator to"/> <returns type="gint" comment="1 if succeeded, 0 if failed, like when the recurrence type is unsupported."/> - <comment xml:space="preserve">Set the date-time at which the iterator will start, where 'start' is a value between DTSTART and UNTIL. + <comment xml:space="preserve">Sets the date-time at which the iterator will start, where 'start' is a value between DTSTART and UNTIL. Note: CAN NOT be used with RRULEs that contain COUNT.</comment> </method> <method name="i_cal_recur_iterator_free" corresponds="icalrecur_iterator_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator to be freed."/> - <comment xml:space="preserve">Free an iterator.</comment> + <parameter type="ICalRecurIterator *" name="iterator" comment="The iterator to be freed"/> + <comment xml:space="preserve">Frees an iterator.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-recur.xml b/src/libical-glib/api/i-cal-recur.xml index 1b3349dc..0edf25bc 100644 --- a/src/libical-glib/api/i-cal-recur.xml +++ b/src/libical-glib/api/i-cal-recur.xml @@ -15,11 +15,11 @@ --> <structure namespace="ICal" name="Recur"> <method name="i_cal_recur_expand_recurrence" corresponds="CUSTOM" since="1.0"> - <parameter type="const gchar *" name="rule" comment="The rule of the recurrence."/> - <parameter type="time_t" name="start" comment="the start seconds past the POSIX epoch."/> - <parameter type="gint" name="count" comment="The number of elements to be filled up in the @array."/> + <parameter type="const gchar *" name="rule" comment="The rule of the recurrence"/> + <parameter type="time_t" name="start" comment="The start seconds past the POSIX epoch"/> + <parameter type="gint" name="count" comment="The number of elements to be filled up in the @array"/> <returns type="GArray *" annotation="array, element-type long, transfer full" comment="If successful, return the array. NULL if failed."/> - <comment xml:space="preserve">Fill an array with the 'count' number of occurrences generated by the rrule. Note that the times are returned in UTC, but the times are calculated in local time. YOu will have to convert the results back into local time before using them.</comment> + <comment xml:space="preserve">Fills an array with the 'count' number of occurrences generated by the rrule. Note that the times are returned in UTC, but the times are calculated in local time. YOu will have to convert the results back into local time before using them.</comment> <custom> time_t *array; GArray *garray; gint result; @@ -37,33 +37,33 @@ }</custom> </method> <method name="i_cal_recurrence_weekday_from_string" corresponds="icalrecur_string_to_weekday" since="1.0"> - <parameter type="const gchar *" name="str" comment="The string representation of the weekday."/> + <parameter type="const gchar *" name="str" comment="The string representation of the weekday"/> <returns type="ICalRecurrenceWeekday" comment="The enum representation of the weekday."/> - <comment xml:space="preserve">Convert a string representation to an enum representation for the weekday.</comment> + <comment xml:space="preserve">Converts a string representation to an enum representation for the weekday.</comment> </method> <method name="i_cal_recurrence_weekday_to_string" corresponds="icalrecur_weekday_to_string" since="2.0"> <parameter type="ICalRecurrenceWeekday" name="kind" comment="The freqeuncy enum"/> <returns type="const gchar *" comment="The string representation of weekday"/> - <comment xml:space="preserve">Convert a enum representation to a string representation for the weekday.</comment> + <comment xml:space="preserve">Converts a enum representation to a string representation for the weekday.</comment> </method> <method name="i_cal_recurrence_frequency_from_string" corresponds="icalrecur_string_to_freq" since="2.0"> - <parameter type="const gchar *" name="str" comment="The string representation of the frequency."/> + <parameter type="const gchar *" name="str" comment="The string representation of the frequency"/> <returns type="ICalRecurrenceFrequency" comment="The enum representation of the frequency."/> - <comment xml:space="preserve">Convert a string representation to an enum representation for the frequency.</comment> + <comment xml:space="preserve">Converts a string representation to an enum representation for the frequency.</comment> </method> <method name="i_cal_recurrence_frequency_to_string" corresponds="icalrecur_freq_to_string" since="2.0"> <parameter type="ICalRecurrenceFrequency" name="kind" comment="The freqeuncy enum"/> <returns type="const gchar *" comment="The string representation of frequency"/> - <comment xml:space="preserve">Convert a enum representation to a string representation for the frequency.</comment> + <comment xml:space="preserve">Converts a enum representation to a string representation for the frequency.</comment> </method> <method name="i_cal_recurrence_skip_from_string" corresponds="icalrecur_string_to_skip" since="2.0"> - <parameter type="const gchar *" name="str" comment="The string representation of the skip."/> + <parameter type="const gchar *" name="str" comment="The string representation of the skip"/> <returns type="ICalRecurrenceSkip" comment="The enum representation of the skip."/> - <comment xml:space="preserve">Convert a string representation to an enum representation for the skip.</comment> + <comment xml:space="preserve">Converts a string representation to an enum representation for the skip.</comment> </method> <method name="i_cal_recurrence_skip_to_string" corresponds="icalrecur_skip_to_string" since="2.0"> <parameter type="ICalRecurrenceSkip" name="kind" comment="The freqeuncy enum"/> <returns type="const gchar *" comment="The string representation of skip"/> - <comment xml:space="preserve">Convert a enum representation to a string representation for the skip.</comment> + <comment xml:space="preserve">Converts a enum representation to a string representation for the skip.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-recurrence.xml b/src/libical-glib/api/i-cal-recurrence.xml index 1d5d71a6..be71e6f8 100644 --- a/src/libical-glib/api/i-cal-recurrence.xml +++ b/src/libical-glib/api/i-cal-recurrence.xml @@ -62,11 +62,11 @@ </enum> <method name="i_cal_recurrence_rscale_is_supported" corresponds="icalrecurrencetype_rscale_is_supported" kind="get" since="2.0"> <returns type="gboolean" comment="Whether rscale is supported"/> - <comment xml:space="preserve">Check whether rscale is supported.</comment> + <comment xml:space="preserve">Checks whether rscale is supported.</comment> </method> <method name="i_cal_recurrence_rscale_supported_calendars" corresponds="icalrecurrencetype_rscale_supported_calendars" kind="other" since="2.0"> <returns type="ICalArray *" annotation="transfer full" translator_argus="NULL, FALSE" comment="Array of calendars. Currently always NULL."/> - <comment xml:space="preserve">Get an array of calendars supporting rscale (currently always return NULL).</comment> + <comment xml:space="preserve">Gets an array of calendars supporting rscale (currently always return NULL).</comment> </method> <method name="i_cal_recurrence_new_default" corresponds="CUSTOM" annotation="skip" kind="private" since="1.0"> <returns type="struct icalrecurrencetype" comment="The default value."/> @@ -76,117 +76,117 @@ </method> <method name="i_cal_recurrence_new" corresponds="CUSTOM" kind="constructor" since="1.0"> <returns type="ICalRecurrence *" annotation="transfer full" comment="The newly created #ICalRecurrence." /> - <comment xml:space="preserve">Create a new #ICalRecurrence.</comment> + <comment xml:space="preserve">Creates a new #ICalRecurrence.</comment> <custom> return i_cal_recurrence_new_full(i_cal_recurrence_new_default());</custom> </method> <method name="i_cal_recurrence_clear" corresponds="icalrecurrencetype_clear" since="1.0"> - <parameter type="ICalRecurrence *" name="r" native_op="POINTER" comment="The #ICalRecurrence to be reset."/> - <comment xml:space="preserve">Reset an #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="r" native_op="POINTER" comment="The #ICalRecurrence to be reset"/> + <comment xml:space="preserve">Resets an #ICalRecurrence.</comment> </method> <method name="i_cal_recurrence_day_day_of_week" corresponds="icalrecurrencetype_day_day_of_week" since="1.0"> - <parameter type="gshort" name="day" comment="The encoded day which represents the day of the week and Nth day of the week."/> + <parameter type="gshort" name="day" comment="The encoded day which represents the day of the week and Nth day of the week"/> <returns type="ICalRecurrenceWeekday" comment="The decoded weekday with Monday to be 1."/> - <comment xml:space="preserve">Decode a day to a weekday in a week.</comment> + <comment xml:space="preserve">Decodes a day to a weekday in a week.</comment> </method> <method name="i_cal_recurrence_day_position" corresponds="icalrecurrencetype_day_position" since="1.0"> - <parameter type="gshort" name="day" comment="The encoded day which represents the day of the week and Nth day of the week."/> + <parameter type="gshort" name="day" comment="The encoded day which represents the day of the week and Nth day of the week"/> <returns type="gint" comment="The decoded day of the week. 0 == any of day of week. 1 == first, 2 = second, -2 == second to last, etc"/> - <comment xml:space="preserve">Decode a day to a position of the weekday.</comment> + <comment xml:space="preserve">Decodes a day to a position of the weekday.</comment> </method> <method name="i_cal_recurrence_month_is_leap" corresponds="icalrecurrencetype_month_is_leap" since="2.0"> - <parameter type="gshort" name="month" comment="The month to be decoded."/> + <parameter type="gshort" name="month" comment="The month to be decoded"/> <returns type="gboolean" comment="Whether this month is a leap month."/> - <comment xml:space="preserve">Decode a month and check whether it is a leap month.</comment> + <comment xml:space="preserve">Decodes a month and check whether it is a leap month.</comment> </method> <method name="i_cal_recurrence_month_month" corresponds="icalrecurrencetype_month_month" since="2.0"> - <parameter type="gshort" name="month" comment="The month to be decoded."/> + <parameter type="gshort" name="month" comment="The month to be decoded"/> <returns type="gint" comment="The actual month number regardless of the leap flag."/> </method> <method name="i_cal_recurrence_new_from_string" corresponds="icalrecurrencetype_from_string" since="1.0"> <parameter type="const gchar *" name="str" comment="The string representation of the #ICalRecurrence"/> <returns type="ICalRecurrence *" annotation="transfer full" comment="The #ICalRecurrence converted from @str."/> - <comment xml:space="preserve">Convert a string to a #ICalRecurrence.</comment> + <comment xml:space="preserve">Converts a string to a #ICalRecurrence.</comment> </method> <method name="i_cal_recurrence_to_string" corresponds="icalrecurrencetype_as_string_r" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" native_op="POINTER" comment="The #ICalRecurrence to be converted."/> + <parameter type="ICalRecurrence *" name="recur" native_op="POINTER" comment="The #ICalRecurrence to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation of @recur."/> - <comment xml:space="preserve">Convert a #ICalRecurrence to a string.</comment> + <comment xml:space="preserve">Converts a #ICalRecurrence to a string.</comment> </method> <method name="i_cal_recurrence_get_until" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="ICalTime *" annotation="transfer full" comment="The until of #ICalRecurrence."/> - <comment>Get the until from #ICalRecurrence.</comment> + <comment>Gets the until from #ICalRecurrence.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); return i_cal_time_new_full (((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->until);</custom> </method> <method name="i_cal_recurrence_set_until" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="ICalTime *" name="until" comment="The until of #ICalRecurrence."/> - <comment>Set the until from #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="ICalTime *" name="until" comment="The until of #ICalRecurrence"/> + <comment>Sets the until from #ICalRecurrence.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (until != NULL && I_CAL_IS_TIME(until)); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->until = *(icaltimetype *)i_cal_object_get_native ((ICalObject *)until);</custom> </method> <method name="i_cal_recurrence_get_freq" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="ICalRecurrenceFrequency" comment="The freq of #ICalRecurrence."/> - <comment>Get the freq from #ICalRecurrence.</comment> + <comment>Gets the freq from #ICalRecurrence.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_NO_RECURRENCE); return (ICalRecurrenceFrequency) (((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->freq);</custom> </method> <method name="i_cal_recurrence_set_freq" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="ICalRecurrenceFrequency" name="freq" comment="The freq of #ICalRecurrence."/> - <comment>Set the freq from #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="ICalRecurrenceFrequency" name="freq" comment="The freq of #ICalRecurrence"/> + <comment>Sets the freq from #ICalRecurrence.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); ((struct icalrecurrencetype *) i_cal_object_get_native ((ICalObject *)recur))->freq = (icalrecurrencetype_frequency) freq;</custom> </method> <method name="i_cal_recurrence_get_count" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="gint" comment="The count of #ICalRecurrence."/> - <comment>Get the count from #ICalRecurrence.</comment> + <comment>Gets the count from #ICalRecurrence.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), 0); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->count;</custom> </method> <method name="i_cal_recurrence_set_count" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="gint" name="count" comment="The count of #ICalRecurrence."/> - <comment>Set the count from #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="gint" name="count" comment="The count of #ICalRecurrence"/> + <comment>Sets the count from #ICalRecurrence.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->count = count;</custom> </method> <method name="i_cal_recurrence_get_interval" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="gshort" comment="The interval of #ICalRecurrence."/> - <comment>Get the interval from #ICalRecurrence.</comment> + <comment>Gets the interval from #ICalRecurrence.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), 0); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->interval;</custom> </method> <method name="i_cal_recurrence_set_interval" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="gshort" name="interval" comment="The interval of #ICalRecurrence."/> - <comment>Set the interval from #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="gshort" name="interval" comment="The interval of #ICalRecurrence"/> + <comment>Sets the interval from #ICalRecurrence.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->interval = interval;</custom> </method> <method name="i_cal_recurrence_get_week_start" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="ICalRecurrenceWeekday" comment="The week_start of #ICalRecurrence."/> - <comment>Get the week_start from #ICalRecurrence.</comment> + <comment>Gets the week_start from #ICalRecurrence.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_NO_WEEKDAY); return (ICalRecurrenceWeekday) (((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->week_start);</custom> </method> <method name="i_cal_recurrence_set_week_start" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="ICalRecurrenceWeekday" name="week_start" comment="The week_start of #ICalRecurrence."/> - <comment>Set the week_start from #ICalRecurrence.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="ICalRecurrenceWeekday" name="week_start" comment="The week_start of #ICalRecurrence"/> + <comment>Sets the week_start from #ICalRecurrence.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->week_start = (icalrecurrencetype_weekday) week_start;</custom> </method> <method name="i_cal_recurrence_get_by_second_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_second of #ICalRecurrence."/> - <comment>Get the by_second array from #ICalRecurrence. The array size if I_CAL_BY_SECOND_SIZE.</comment> + <comment>Gets the by_second array from #ICalRecurrence. The array size if I_CAL_BY_SECOND_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, TRUE, sizeof (gshort)); @@ -194,9 +194,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_second_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_second array in @recur at once. The array size can be less than I_CAL_BY_SECOND_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_second array in @recur at once. The array size can be less than I_CAL_BY_SECOND_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -213,27 +213,27 @@ rt->by_second[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_second" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_second of #ICalRecurrence, less than %I_CAL_BY_SECOND_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_second of #ICalRecurrence, less than %I_CAL_BY_SECOND_SIZE"/> <returns type="gshort" comment="The by_second of #ICalRecurrence at index @index."/> - <comment>Get the by_second value at index @index. The index should be less than %I_CAL_BY_SECOND_SIZE.</comment> + <comment>Gets the by_second value at index @index. The index should be less than %I_CAL_BY_SECOND_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_SECOND_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_second[index];</custom> </method> <method name="i_cal_recurrence_set_by_second" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_second of #ICalRecurrence, less than I_CAL_BY_SECOND_SIZE."/> - <parameter type="gshort" name="value" comment="The value to be set into by_second of #ICalRecurrence."/> - <comment>Set the by_second array from #ICalRecurrence at the given index. The array size is I_CAL_BY_SECOND_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_second of #ICalRecurrence, less than I_CAL_BY_SECOND_SIZE"/> + <parameter type="gshort" name="value" comment="The value to be set into by_second of #ICalRecurrence"/> + <comment>Sets the by_second array from #ICalRecurrence at the given index. The array size is I_CAL_BY_SECOND_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_SECOND_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_second[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_minute_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_minute of #ICalRecurrence."/> - <comment>Get the by_minute array from #ICalRecurrence. The array size is I_CAL_BY_MINUTE_SIZE.</comment> + <comment>Gets the by_minute array from #ICalRecurrence. The array size is I_CAL_BY_MINUTE_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -241,9 +241,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_minute_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_minute array in @recur at once. The array size can be less than I_CAL_BY_MINUTE_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_minute array in @recur at once. The array size can be less than I_CAL_BY_MINUTE_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -260,27 +260,27 @@ rt->by_minute[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_minute" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_minute of #ICalRecurrence, less than %I_CAL_BY_MINUTE_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_minute of #ICalRecurrence, less than %I_CAL_BY_MINUTE_SIZE"/> <returns type="gshort" comment="The by_minute of #ICalRecurrence at index @index."/> - <comment>Get the by_minute value at index @index. The index should be less than %I_CAL_BY_MINUTE_SIZE.</comment> + <comment>Gets the by_minute value at index @index. The index should be less than %I_CAL_BY_MINUTE_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_MINUTE_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_minute[index];</custom> </method> <method name="i_cal_recurrence_set_by_minute" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_minute of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_minute of #ICalRecurrence."/> - <comment>Set the by_minute array from #ICalRecurrence at the given index. The array size is I_CAL_BY_MINUTE_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_minute of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_minute of #ICalRecurrence"/> + <comment>Sets the by_minute array from #ICalRecurrence at the given index. The array size is I_CAL_BY_MINUTE_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_MINUTE_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_minute[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_hour_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_hour of #ICalRecurrence."/> - <comment>Get the by_hour array from #ICalRecurrence. The array size is I_CAL_BY_HOUR_SIZE.</comment> + <comment>Gets the by_hour array from #ICalRecurrence. The array size is I_CAL_BY_HOUR_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -288,9 +288,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_hour_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_hour array in @recur at once. The array size can be less than I_CAL_BY_HOUR_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_hour array in @recur at once. The array size can be less than I_CAL_BY_HOUR_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -307,27 +307,27 @@ rt->by_hour[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_hour" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_hour of #ICalRecurrence, less than %I_CAL_BY_HOUR_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_hour of #ICalRecurrence, less than %I_CAL_BY_HOUR_SIZE"/> <returns type="gshort" comment="The by_hour of #ICalRecurrence at index @index."/> - <comment>Get the by_hour value at index @index. The index should be less than %I_CAL_BY_HOUR_SIZE.</comment> + <comment>Gets the by_hour value at index @index. The index should be less than %I_CAL_BY_HOUR_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_HOUR_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_hour[index];</custom> </method> <method name="i_cal_recurrence_set_by_hour" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_hour of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_hour of #ICalRecurrence."/> - <comment>Set the by_hour array from #ICalRecurrence at the given index. The array size is I_CAL_BY_HOUR_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_hour of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_hour of #ICalRecurrence"/> + <comment>Sets the by_hour array from #ICalRecurrence at the given index. The array size is I_CAL_BY_HOUR_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_HOUR_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_hour[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_day_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_day of #ICalRecurrence."/> - <comment>Get the by_day array from #ICalRecurrence. The array size is I_CAL_BY_DAY_SIZE.</comment> + <comment>Gets the by_day array from #ICalRecurrence. The array size is I_CAL_BY_DAY_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -335,9 +335,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_day_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_day array in @recur at once. The array size can be less than I_CAL_BY_DAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_day array in @recur at once. The array size can be less than I_CAL_BY_DAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -354,27 +354,27 @@ rt->by_day[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_day" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_day of #ICalRecurrence, less than %I_CAL_BY_DAY_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_day of #ICalRecurrence, less than %I_CAL_BY_DAY_SIZE"/> <returns type="gshort" comment="The by_day of #ICalRecurrence at index @index."/> - <comment>Get the by_day value at index @index. The index should be less than %I_CAL_BY_DAY_SIZE.</comment> + <comment>Gets the by_day value at index @index. The index should be less than %I_CAL_BY_DAY_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_DAY_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_day[index];</custom> </method> <method name="i_cal_recurrence_set_by_day" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_day of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_day of #ICalRecurrence."/> - <comment>Set the by_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_DAY_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_day of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_day of #ICalRecurrence"/> + <comment>Sets the by_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_DAY_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_DAY_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_day[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_month_day_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_month_day of #ICalRecurrence."/> - <comment>Get the by_month_day array from #ICalRecurrence. The array size is I_CAL_BY_MONTHDAY_SIZE.</comment> + <comment>Gets the by_month_day array from #ICalRecurrence. The array size is I_CAL_BY_MONTHDAY_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -382,9 +382,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_month_day_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_month_day array in @recur at once. The array size can be less than I_CAL_BY_MONTHDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_month_day array in @recur at once. The array size can be less than I_CAL_BY_MONTHDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -401,27 +401,27 @@ rt->by_month_day[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_month_day" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_month_day of #ICalRecurrence, less than %I_CAL_BY_MONTHDAY_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_month_day of #ICalRecurrence, less than %I_CAL_BY_MONTHDAY_SIZE"/> <returns type="gshort" comment="The by_month_day of #ICalRecurrence at index @index."/> - <comment>Get the by_month_day value at index @index. The index should be less than %I_CAL_BY_MONTHDAY_SIZE.</comment> + <comment>Gets the by_month_day value at index @index. The index should be less than %I_CAL_BY_MONTHDAY_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_MONTHDAY_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_month_day[index];</custom> </method> <method name="i_cal_recurrence_set_by_month_day" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_month_day of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_month_day of #ICalRecurrence."/> - <comment>Set the by_month_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_MONTHDAY_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_month_day of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_month_day of #ICalRecurrence"/> + <comment>Sets the by_month_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_MONTHDAY_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_MONTHDAY_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_month_day[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_year_day_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_year_day of #ICalRecurrence."/> - <comment>Get the by_year_day array from #ICalRecurrence. The array size is I_CAL_BY_YEARDAY_SIZE.</comment> + <comment>Gets the by_year_day array from #ICalRecurrence. The array size is I_CAL_BY_YEARDAY_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -429,9 +429,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_year_day_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_year_day array in @recur at once. The array size can be less than I_CAL_BY_YEARDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_year_day array in @recur at once. The array size can be less than I_CAL_BY_YEARDAY_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -448,27 +448,27 @@ rt->by_year_day[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_year_day" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_year_day of #ICalRecurrence, less than %I_CAL_BY_YEARDAY_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_year_day of #ICalRecurrence, less than %I_CAL_BY_YEARDAY_SIZE"/> <returns type="gshort" comment="The by_year_day of #ICalRecurrence at index @index."/> - <comment>Get the by_year_day value at index @index. The index should be less than %I_CAL_BY_YEARDAY_SIZE.</comment> + <comment>Gets the by_year_day value at index @index. The index should be less than %I_CAL_BY_YEARDAY_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_YEARDAY_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_year_day[index];</custom> </method> <method name="i_cal_recurrence_set_by_year_day" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_year_day of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_year_day of #ICalRecurrence."/> - <comment>Set the by_year_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_YEARDAY_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_year_day of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_year_day of #ICalRecurrence"/> + <comment>Sets the by_year_day array from #ICalRecurrence at the given index. The array size if I_CAL_BY_YEARDAY_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_YEARDAY_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_year_day[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_week_no_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_week_no of #ICalRecurrence."/> - <comment>Get the by_week_no array from #ICalRecurrence. The array size is I_CAL_BY_WEEKNO_SIZE.</comment> + <comment>Gets the by_week_no array from #ICalRecurrence. The array size is I_CAL_BY_WEEKNO_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -476,9 +476,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_week_no_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_week_no array in @recur at once. The array size can be less than I_CAL_BY_WEEKNO_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_week_no array in @recur at once. The array size can be less than I_CAL_BY_WEEKNO_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -495,27 +495,27 @@ rt->by_week_no[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_week_no" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_week_no of #ICalRecurrence, less than %I_CAL_BY_WEEKNO_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_week_no of #ICalRecurrence, less than %I_CAL_BY_WEEKNO_SIZE"/> <returns type="gshort" comment="The by_week_no of #ICalRecurrence at index @index."/> - <comment>Get the by_week_no value at index @index. The index should be less than %I_CAL_BY_WEEKNO_SIZE.</comment> + <comment>Gets the by_week_no value at index @index. The index should be less than %I_CAL_BY_WEEKNO_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_WEEKNO_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_week_no[index];</custom> </method> <method name="i_cal_recurrence_set_by_week_no" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_week_no of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_week_no of #ICalRecurrence."/> - <comment>Set the by_week_no array from #ICalRecurrence at the given index. The array size is I_CAL_BY_WEEKNO_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_week_no of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_week_no of #ICalRecurrence"/> + <comment>Sets the by_week_no array from #ICalRecurrence at the given index. The array size is I_CAL_BY_WEEKNO_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_WEEKNO_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_week_no[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_month_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_month of #ICalRecurrence."/> - <comment>Get the by_month array from #ICalRecurrence. The array size is I_CAL_BY_MONTH_SIZE.</comment> + <comment>Gets the by_month array from #ICalRecurrence. The array size is I_CAL_BY_MONTH_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -523,9 +523,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_month_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_month array in @recur at once. The array size can be less than I_CAL_BY_MONTH_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_month array in @recur at once. The array size can be less than I_CAL_BY_MONTH_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -542,27 +542,27 @@ rt->by_month[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_month" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_month of #ICalRecurrence, less than %I_CAL_BY_MONTH_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_month of #ICalRecurrence, less than %I_CAL_BY_MONTH_SIZE"/> <returns type="gshort" comment="The by_month of #ICalRecurrence at index @index."/> - <comment>Get the by_month value at index @index. The index should be less than %I_CAL_BY_MONTH_SIZE.</comment> + <comment>Gets the by_month value at index @index. The index should be less than %I_CAL_BY_MONTH_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_MONTH_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_month[index];</custom> </method> <method name="i_cal_recurrence_set_by_month" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_month of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_month of #ICalRecurrence."/> - <comment>Set the by_month array from #ICalRecurrence at the given index. The array size is I_CAL_BY_MONTH_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_month of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_month of #ICalRecurrence"/> + <comment>Sets the by_month array from #ICalRecurrence at the given index. The array size is I_CAL_BY_MONTH_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_MONTH_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_month[index] = value;</custom> </method> <method name="i_cal_recurrence_get_by_set_pos_array" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> <returns type="GArray *" annotation="transfer full, element-type gshort" comment="The by_set_pos of #ICalRecurrence."/> - <comment>Get the by_set_pos array from #ICalRecurrence. The array size is I_CAL_BY_SETPOS_SIZE.</comment> + <comment>Gets the by_set_pos array from #ICalRecurrence. The array size is I_CAL_BY_SETPOS_SIZE.</comment> <custom> GArray *array; g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), NULL); array = g_array_new (FALSE, FALSE, sizeof (gshort)); @@ -570,9 +570,9 @@ return array;</custom> </method> <method name="i_cal_recurrence_set_by_set_pos_array" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values."/> - <comment>Set the by_set_pos array in @recur at once. The array size can be less than I_CAL_BY_SETPOS_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="GArray *" name="values" annotation="element-type gshort" comment="The array of values"/> + <comment>Sets the by_set_pos array in @recur at once. The array size can be less than I_CAL_BY_SETPOS_SIZE. Shorter arrays are terminated with I_CAL_RECURRENCE_ARRAY_MAX value, longer arrays are truncated.</comment> <custom> struct icalrecurrencetype *rt; guint ii; @@ -589,19 +589,19 @@ rt->by_set_pos[ii] = I_CAL_RECURRENCE_ARRAY_MAX;</custom> </method> <method name="i_cal_recurrence_get_by_set_pos" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_set_pos of #ICalRecurrence, less than %I_CAL_BY_SETPOS_SIZE."/> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_set_pos of #ICalRecurrence, less than %I_CAL_BY_SETPOS_SIZE"/> <returns type="gshort" comment="The by_week_no of #ICalRecurrence at index @index."/> - <comment>Get the by_set_pos value at index @index. The index should be less than %I_CAL_BY_SETPOS_SIZE.</comment> + <comment>Gets the by_set_pos value at index @index. The index should be less than %I_CAL_BY_SETPOS_SIZE.</comment> <custom> g_return_val_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur), I_CAL_RECURRENCE_ARRAY_MAX); g_return_val_if_fail (index < I_CAL_BY_SETPOS_SIZE, I_CAL_RECURRENCE_ARRAY_MAX); return ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_set_pos[index];</custom> </method> <method name="i_cal_recurrence_set_by_set_pos" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence."/> - <parameter type="guint" name="index" comment="The index in by_set_pos of #ICalRecurrence."/> - <parameter type="gshort" name="value" comment="The value to be set into by_set_pos of #ICalRecurrence."/> - <comment>Set the by_set_pos array from #ICalRecurrence at the given index. The array size is I_CAL_BY_SETPOS_SIZE.</comment> + <parameter type="ICalRecurrence *" name="recur" comment="The #ICalRecurrence"/> + <parameter type="guint" name="index" comment="The index in by_set_pos of #ICalRecurrence"/> + <parameter type="gshort" name="value" comment="The value to be set into by_set_pos of #ICalRecurrence"/> + <comment>Sets the by_set_pos array from #ICalRecurrence at the given index. The array size is I_CAL_BY_SETPOS_SIZE.</comment> <custom> g_return_if_fail (recur != NULL && I_CAL_IS_RECURRENCE (recur)); g_return_if_fail (index < I_CAL_BY_SETPOS_SIZE); ((struct icalrecurrencetype *)i_cal_object_get_native ((ICalObject *)recur))->by_set_pos[index] = value;</custom> diff --git a/src/libical-glib/api/i-cal-reqstat.xml b/src/libical-glib/api/i-cal-reqstat.xml index 4b3f3023..f05b1282 100644 --- a/src/libical-glib/api/i-cal-reqstat.xml +++ b/src/libical-glib/api/i-cal-reqstat.xml @@ -15,18 +15,18 @@ --> <structure namespace="ICal" name="Reqstat" native="struct icalreqstattype" is_bare="true" default_native="i_cal_reqstat_new_default ()"> <method name="i_cal_reqstat_new_from_string" corresponds="icalreqstattype_from_string" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalReqstat *" annotation="transfer full" comment="The newly created #ICalReqstat."/> - <comment xml:space="preserve">Create a #ICalReqstat from string.</comment> + <comment xml:space="preserve">Creates a #ICalReqstat from string.</comment> </method> <method name="i_cal_reqstat_to_string" corresponds="icalreqstattype_as_string_r" since="1.0"> - <parameter type="ICalReqstat *" name="stat" comment="A #ICalReqstat."/> + <parameter type="ICalReqstat *" name="stat" comment="A #ICalReqstat"/> <returns type="gchar *" annotation="transfer full" comment="A string."/> - <comment xml:space="preserve">Convert #ICalReqstat to a string representation.</comment> + <comment xml:space="preserve">Converts #ICalReqstat to a string representation.</comment> </method> <method name="i_cal_reqstat_new_default" corresponds="CUSTOM" kind="private" annotation="skip" since="1.0"> <returns type="struct icalreqstattype" annotation="transfer full" comment="The newly created #ICalReqstat" /> - <comment xml:space="preserve">Create a new default #ICalReqstat</comment> + <comment xml:space="preserve">Creates a new default #ICalReqstat.</comment> <custom> struct icalreqstattype reqstattype; reqstattype.code = ICAL_UNKNOWN_STATUS; reqstattype.desc = NULL; @@ -34,30 +34,30 @@ return reqstattype;</custom> </method> <method name="i_cal_reqstat_get_code" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalReqstat *" name="reqstat" comment="The #ICalReqstat."/> + <parameter type="ICalReqstat *" name="reqstat" comment="The #ICalReqstat"/> <returns type="ICalRequestStatus" comment="The code of @reqstat."/> - <comment>Get the code of #ICalReqstat.</comment> + <comment>Gets the code of #ICalReqstat.</comment> <custom> g_return_val_if_fail (reqstat != NULL && I_CAL_IS_REQSTAT (reqstat), I_CAL_UNKNOWN_STATUS); return (ICalRequestStatus) (((struct icalreqstattype *)i_cal_object_get_native ((ICalObject *)reqstat))->code);</custom> </method> <method name="i_cal_reqstat_set_code" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalReqstat *" name="reqstat" comment="The #ICalReqstat."/> - <parameter type="ICalRequestStatus" name="code" comment="The code of @reqstat."/> - <comment>Set the code of #ICalReqstat.</comment> + <parameter type="ICalReqstat *" name="reqstat" comment="The #ICalReqstat"/> + <parameter type="ICalRequestStatus" name="code" comment="The code of @reqstat"/> + <comment>Sets the code of #ICalReqstat.</comment> <custom> g_return_if_fail (reqstat != NULL && I_CAL_IS_REQSTAT (reqstat)); ((struct icalreqstattype *)i_cal_object_get_native ((ICalObject *)reqstat))->code = (icalrequeststatus) (code);</custom> </method> <method name="i_cal_reqstat_get_desc" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalReqstat *" name="reqstat" comment="The #ICalReqstat."/> + <parameter type="const ICalReqstat *" name="reqstat" comment="The #ICalReqstat"/> <returns type="const gchar *" annotation="transfer none" comment="The desc of @reqstat."/> - <comment>Get the desc of #ICalReqstat.</comment> + <comment>Gets the desc of #ICalReqstat.</comment> <custom> g_return_val_if_fail (reqstat != NULL && I_CAL_IS_REQSTAT (reqstat), NULL); return ((struct icalreqstattype *)i_cal_object_get_native ((ICalObject *)reqstat))->desc;</custom> </method> <method name="i_cal_reqstat_get_debug" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalReqstat *" name="reqstat" comment="The #ICalReqstat."/> + <parameter type="const ICalReqstat *" name="reqstat" comment="The #ICalReqstat"/> <returns type="const gchar *" annotation="transfer none" comment="The debug of @reqstat."/> - <comment>Get the debug of #ICalReqstat.</comment> + <comment>Gets the debug of #ICalReqstat.</comment> <custom> g_return_val_if_fail (reqstat != NULL && I_CAL_IS_REQSTAT (reqstat), NULL); return ((struct icalreqstattype *)i_cal_object_get_native ((ICalObject *)reqstat))->debug;</custom> </method> diff --git a/src/libical-glib/api/i-cal-restriction.xml b/src/libical-glib/api/i-cal-restriction.xml index 90b782b2..5bc4fe40 100644 --- a/src/libical-glib/api/i-cal-restriction.xml +++ b/src/libical-glib/api/i-cal-restriction.xml @@ -29,11 +29,11 @@ <parameter type="ICalRestrictionKind" name="restr" comment="The restriction kind"/> <parameter type="gint" name="count" comment="The number of restrictions"/> <returns type="gint" comment="Whether it is valid or not. -1 indicates invalid or more analysis. 1 indicates pass and 0 or 2+ indicates fail."/> - <comment xml:space="preserve">Compare the kind of restriction and the count to determine whether it is valid.</comment> + <comment xml:space="preserve">Compares the kind of restriction and the count to determine whether it is valid.</comment> </method> <method name="i_cal_restriction_check" corresponds="icalrestriction_check" since="1.0"> - <parameter type="ICalComponent *" name="comp" comment="The component to be checked."/> + <parameter type="ICalComponent *" name="comp" comment="The component to be checked"/> <returns type="gint" comment="Whether the @comp is valid."/> - <comment xml:space="preserve">Check whether the #ICalComponent is valid.</comment> + <comment xml:space="preserve">Checks whether the #ICalComponent is valid.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-time-span.xml b/src/libical-glib/api/i-cal-time-span.xml index 96ae1704..3576b0ef 100644 --- a/src/libical-glib/api/i-cal-time-span.xml +++ b/src/libical-glib/api/i-cal-time-span.xml @@ -15,11 +15,11 @@ --> <structure namespace="ICal" name="TimeSpan" native="struct icaltime_span" is_bare="true" default_native="icaltime_span_new(icaltime_null_time(), icaltime_null_time(), 0)" includes="libical-glib/i-cal-time.h"> <method name="i_cal_time_span_new_timet" corresponds="CUSTOM" kind="constructor" since="3.0.5"> - <parameter type="time_t" name="start" comment="Start of the time span."/> - <parameter type="time_t" name="end" comment="End of the time span."/> - <parameter type="gboolean" name="is_busy" comment="Whether the time span is busy."/> + <parameter type="time_t" name="start" comment="Start of the time span"/> + <parameter type="time_t" name="end" comment="End of the time span"/> + <parameter type="gboolean" name="is_busy" comment="Whether the time span is busy"/> <returns type="ICalTimeSpan *" annotation="transfer full" comment="The newly created #ICalTimeSpan." /> - <comment xml:space="preserve">Create a new #ICalTimeSpan. Free it with g_object_unref(), when no longer needed.</comment> + <comment xml:space="preserve">Creates a new #ICalTimeSpan. Free it with g_object_unref(), when no longer needed.</comment> <custom> struct icaltime_span span; span.start = start; span.end = end; @@ -27,9 +27,9 @@ return i_cal_time_span_new_full(span);</custom> </method> <method name="i_cal_time_span_clone" corresponds="CUSTOM" kind="constructor" since="3.0.5"> - <parameter type="const ICalTimeSpan *" name="src" comment="A time span to clone."/> + <parameter type="const ICalTimeSpan *" name="src" comment="A time span to clone"/> <returns type="ICalTimeSpan *" annotation="transfer full" comment="The newly created #ICalTimeSpan, clone of @src." /> - <comment xml:space="preserve">Create a new #ICalTimeSpan, clone of @src. Free it with g_object_unref(), when no longer needed.</comment> + <comment xml:space="preserve">Creates a new #ICalTimeSpan, clone of @src. Free it with g_object_unref(), when no longer needed.</comment> <custom> struct icaltime_span *span; g_return_val_if_fail(I_CAL_IS_TIME_SPAN(src), NULL); span = ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)src)); @@ -37,44 +37,44 @@ return i_cal_time_span_new_full(*span);</custom> </method> <method name="i_cal_time_span_get_start" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried."/> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried"/> <returns type="time_t" comment="The start." /> - <comment xml:space="preserve">Get the start of #ICalTimeSpan.</comment> + <comment xml:space="preserve">Gets the start of #ICalTimeSpan.</comment> <custom> g_return_val_if_fail (timespan != NULL, 0); return ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->start;</custom> </method> <method name="i_cal_time_span_set_start" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set."/> - <parameter type="time_t" name="start" comment="The start." /> - <comment xml:space="preserve">Set the start of #ICalTimeSpan.</comment> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set"/> + <parameter type="time_t" name="start" comment="The start" /> + <comment xml:space="preserve">Sets the start of #ICalTimeSpan.</comment> <custom> g_return_if_fail (timespan != NULL); ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->start = start;</custom> </method> <method name="i_cal_time_span_get_end" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried."/> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried"/> <returns type="time_t" comment="The end." /> - <comment xml:space="preserve">Get the end of #ICalTimeSpan.</comment> + <comment xml:space="preserve">Gets the end of #ICalTimeSpan.</comment> <custom> g_return_val_if_fail (timespan != NULL, 0); return ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->end;</custom> </method> <method name="i_cal_time_span_set_end" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set."/> - <parameter type="time_t" name="end" comment="The end." /> - <comment xml:space="preserve">Set the end of #ICalTimeSpan.</comment> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set"/> + <parameter type="time_t" name="end" comment="The end" /> + <comment xml:space="preserve">Sets the end of #ICalTimeSpan.</comment> <custom> g_return_if_fail (timespan != NULL); ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->end = end;</custom> </method> <method name="i_cal_time_span_get_is_busy" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried."/> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be queried"/> <returns type="gboolean" comment="The is_busy." /> - <comment xml:space="preserve">Get the is_busy of #ICalTimeSpan.</comment> + <comment xml:space="preserve">Gets the is_busy of #ICalTimeSpan.</comment> <custom> g_return_val_if_fail (timespan != NULL, FALSE); return ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->is_busy != 0;</custom> </method> <method name="i_cal_time_span_set_is_busy" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set."/> - <parameter type="gboolean" name="is_busy" comment="The is_busy." /> - <comment xml:space="preserve">Set the is_busy of #ICalTimeSpan.</comment> + <parameter type="ICalTimeSpan *" name="timespan" comment="The #ICalTimeSpan to be set"/> + <parameter type="gboolean" name="is_busy" comment="The is_busy" /> + <comment xml:space="preserve">Sets the is_busy of #ICalTimeSpan.</comment> <custom> g_return_if_fail (timespan != NULL); ((struct icaltime_span *)i_cal_object_get_native ((ICalObject *)timespan))->is_busy = is_busy ? 1 : 0;</custom> </method> diff --git a/src/libical-glib/api/i-cal-time.xml b/src/libical-glib/api/i-cal-time.xml index 41a725fd..57f35324 100644 --- a/src/libical-glib/api/i-cal-time.xml +++ b/src/libical-glib/api/i-cal-time.xml @@ -16,13 +16,13 @@ <structure namespace="ICal" name="Time" native="struct icaltimetype" is_bare="true" default_native="icaltime_null_time()"> <method name="i_cal_time_new" corresponds="CUSTOM" kind="constructor" since="1.0"> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime. It is a null time" /> - <comment xml:space="preserve">Create a new #ICalTime.</comment> + <comment xml:space="preserve">Creates a new #ICalTime.</comment> <custom> return i_cal_time_new_full(icaltime_null_time());</custom> </method> <method name="i_cal_time_clone" corresponds="CUSTOM" kind="constructor" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to clone."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to clone"/> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime, copy of @timetype." /> - <comment xml:space="preserve">Create a new #ICalTime, copy of @timetype.</comment> + <comment xml:space="preserve">Creates a new #ICalTime, copy of @timetype.</comment> <custom> struct icaltimetype *itt; g_return_val_if_fail(I_CAL_IS_TIME(timetype), NULL); @@ -34,146 +34,146 @@ </method> <method name="i_cal_time_new_null_time" corresponds="icaltime_null_time" kind="constructor" since="1.0"> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Create a default time which is an epoch time</comment> + <comment xml:space="preserve">Creates a default time which is an epoch time.</comment> </method> <method name="i_cal_time_new_null_date" corresponds="icaltime_null_date" kind="constructor" since="1.0"> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Create a null date, which indicates no time has been set</comment> + <comment xml:space="preserve">Creates a null date, which indicates no time has been set.</comment> </method> <method name="i_cal_time_new_current_with_zone" corresponds="icaltime_current_time_with_zone" kind="others" since="1.0"> <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The timezone used to create a #ICalTime according to the current time"/> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Create a #ICalTime according to the timezone and current time</comment> + <comment xml:space="preserve">Creates a #ICalTime according to the timezone and current time.</comment> </method> <method name="i_cal_time_new_today" corresponds="icaltime_today" kind="others" since="1.0"> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Create a #ICalTime representing today</comment> + <comment xml:space="preserve">Creates a #ICalTime representing today.</comment> </method> <method name="i_cal_time_new_from_timet_with_zone" corresponds="icaltime_from_timet_with_zone" kind="others" since="1.0"> <parameter type="const time_t" name="v" comment="The seconds past since epoch time"/> - <parameter type="gint" name="is_date" comment="Whether it is a date type, 1 if yes, 0 if not."/> + <parameter type="gint" name="is_date" comment="Whether it is a date type, 1 if yes, 0 if not"/> <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The timezone, or %NULL"/> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Convert seconds past UNIX epoch to a timetype, using timezones.</comment> + <comment xml:space="preserve">Converts seconds past UNIX epoch to a timetype, using timezones.</comment> </method> <method name="i_cal_time_new_from_string" corresponds="icaltime_from_string" kind="others" since="1.0"> <parameter type="const gchar *" name="str" comment="The ISO format string"/> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">create a time from an ISO format string</comment> + <comment xml:space="preserve">Creates a time from an ISO format string.</comment> </method> <method name="i_cal_time_new_from_day_of_year" corresponds="icaltime_from_day_of_year" kind="constructor" since="1.0"> <parameter type="const gint" name="day" comment="The day of a year"/> <parameter type="const gint" name="year" comment="The year"/> <returns type="ICalTime *" annotation="transfer full" comment="The newly created #ICalTime" /> - <comment xml:space="preserve">Create a new time, given a day of year and a year.</comment> + <comment xml:space="preserve">Creates a new time, given a day of year and a year.</comment> </method> <method name="i_cal_time_as_timet" corresponds="icaltime_as_timet" since="1.0"> <parameter type="const ICalTime *" name="tt" comment="The #ICalTime to be converted"/> - <returns type="time_t" comment="the time as seconds past the UNIX epoch" /> - <comment xml:space="preserve">Return the time as seconds past the UNIX epoch</comment> + <returns type="time_t" comment="The time as seconds past the UNIX epoch" /> + <comment xml:space="preserve">Returns the time as seconds past the UNIX epoch.</comment> </method> <method name="i_cal_time_as_timet_with_zone" corresponds="icaltime_as_timet_with_zone" since="1.0"> <parameter type="const ICalTime *" name="tt" comment="The #ICalTime to be converted"/> <parameter type="const ICalTimezone *" name="zone" annotation="nullable" comment="The timezone"/> - <returns type="time_t" comment="the time as seconds past the UNIX epoch" /> - <comment xml:space="preserve">Return the time as seconds past the UNIX epoch, using timezones.</comment> + <returns type="time_t" comment="The time as seconds past the UNIX epoch" /> + <comment xml:space="preserve">Returns the time as seconds past the UNIX epoch, using timezones.</comment> </method> <method name="i_cal_time_as_ical_string" corresponds="icaltime_as_ical_string_r" since="1.0"> <parameter type="const ICalTime *" name="tt" comment="The #ICalTime to be converted"/> <returns type="gchar *" annotation="transfer full" comment="The string representation" /> - <comment xml:space="preserve">Return a string represention of the time, in RFC2445 format.</comment> + <comment xml:space="preserve">Returns a string represention of the time, in RFC2445 format.</comment> </method> <method name="i_cal_time_get_timezone" corresponds="(void *)icaltime_get_timezone" kind="get" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> <returns type="ICalTimezone *" annotation="transfer none" translator_argus="(GObject *)tt, TRUE" comment="The timezone information" /> - <comment xml:space="preserve">Return the timezone</comment> + <comment xml:space="preserve">Returns the timezone.</comment> </method> <method name="i_cal_time_set_timezone" corresponds="icaltime_set_timezone" kind="set" since="1.0"> <parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The #ICalTime"/> <parameter type="const ICalTimezone *" name="zone" annotation="nullable" comment="The timezone"/> - <comment xml:space="preserve">Set the timezone of the @tt</comment> + <comment xml:space="preserve">Sets the timezone of the @tt.</comment> </method> <method name="i_cal_time_get_tzid" corresponds="icaltime_get_tzid" kind="get" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> <returns type="const gchar *" annotation="allow-none, transfer none" comment="The tzid of #ICalTime, or NULL if floating type" /> - <comment xml:space="preserve">Return the tzid, or NULL for a floating time</comment> + <comment xml:space="preserve">Returns the tzid, or NULL for a floating time.</comment> </method> <method name="i_cal_time_day_of_year" corresponds="icaltime_day_of_year" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> - <returns type="gint" comment="the day of the year of the given time" /> - <comment xml:space="preserve">Return the day of the year of the given time</comment> + <returns type="gint" comment="The day of the year of the given time" /> + <comment xml:space="preserve">Returns the day of the year of the given time.</comment> </method> <method name="i_cal_time_day_of_week" corresponds="icaltime_day_of_week" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> - <returns type="gint" comment="the day of the week of the given time. Sunday is 1." /> - <comment xml:space="preserve">Return the day of the week of the given time. Sunday is 1</comment> + <returns type="gint" comment="The day of the week of the given time. Sunday is 1." /> + <comment xml:space="preserve">Returns the day of the week of the given time. Sunday is 1.</comment> </method> <method name="i_cal_time_start_doy_week" corresponds="icaltime_start_doy_week" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> <parameter type="gint" name="fdow" comment="The first day of the week" /> - <returns type="gint" comment="the day of the year for the Sunday of the week that the given time is within." /> - <comment xml:space="preserve">Return the day of the year for the first day of the week that the given time is within.</comment> + <returns type="gint" comment="The day of the year for the Sunday of the week that the given time is within." /> + <comment xml:space="preserve">Returns the day of the year for the first day of the week that the given time is within.</comment> </method> <method name="i_cal_time_week_number" corresponds="icaltime_week_number" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be queried"/> - <returns type="gint" comment="the week number for the week the given time is within." /> - <comment xml:space="preserve">Return the week number for the week the given time is within.</comment> + <returns type="gint" comment="The week number for the week the given time is within." /> + <comment xml:space="preserve">Returns the week number for the week the given time is within.</comment> </method> <method name="i_cal_time_is_null_time" corresponds="icaltime_is_null_time" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be checked"/> <returns type="gboolean" comment="Whether @tt is null_time. 1 if yes, 0 if not." /> - <comment xml:space="preserve">Return true of the time is null.</comment> + <comment xml:space="preserve">Returns true if the time is null.</comment> </method> <method name="i_cal_time_is_valid_time" corresponds="icaltime_is_valid_time" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be checked"/> <returns type="gboolean" comment="Whether @tt is null_time. 1 if yes, 0 if not." /> - <comment xml:space="preserve">Return true of the time is null.</comment> + <comment xml:space="preserve">Returns true if the time is null.</comment> </method> <method name="i_cal_time_is_date" corresponds="icaltime_is_date" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be checked"/> - <returns type="gboolean" comment="true if time is of DATE type, false if DATE-TIME." /> + <returns type="gboolean" comment="True if time is of DATE type, false if DATE-TIME." /> <comment xml:space="preserve">Returns true if time is of DATE type, false if DATE-TIME.</comment> </method> <method name="i_cal_time_is_utc" corresponds="icaltime_is_utc" since="1.0"> <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be checked"/> - <returns type="gboolean" comment="true if time is relative to UTC zone." /> + <returns type="gboolean" comment="True if time is relative to UTC zone." /> <comment xml:space="preserve">Returns true if time is relative to UTC zone.</comment> </method> <method name="i_cal_time_compare" corresponds="icaltime_compare" since="1.0"> <parameter type="const ICalTime *" name="a" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <parameter type="const ICalTime *" name="b" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <returns type="gint" comment="-1, 0, or 1 to indicate that a less than b, a==b or a larger than b." /> - <comment xml:space="preserve">Return -1, 0, or 1 to indicate that a less than b, a==b or a larger than b.</comment> + <comment xml:space="preserve">Returns -1, 0, or 1 to indicate that a less than b, a==b or a larger than b.</comment> </method> <method name="i_cal_time_compare_date_only" corresponds="icaltime_compare_date_only" since="1.0"> <parameter type="const ICalTime *" name="a" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <parameter type="const ICalTime *" name="b" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <returns type="gint" comment="-1, 0, or 1 to indicate that a less than b, a==b or a larger than b." /> - <comment xml:space="preserve">like i_cal_time_compare, but only use the date parts.</comment> + <comment xml:space="preserve">Like i_cal_time_compare(), but only use the date parts.</comment> </method> <method name="i_cal_time_compare_date_only_tz" corresponds="icaltime_compare_date_only_tz" since="1.0"> <parameter type="const ICalTime *" name="a" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <parameter type="const ICalTime *" name="b" annotation="in, transfer none" comment="The #ICalTime to be compared"/> <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The target timezone"/> <returns type="gint" comment="-1, 0, or 1 to indicate that a less than b, a==b or a larger than b." /> - <comment xml:space="preserve">like i_cal_time_compare_tz, but only use the date parts.</comment> + <comment xml:space="preserve">Like i_cal_time_compare_tz(), but only use the date parts; accepts timezone.</comment> </method> <method name="i_cal_time_adjust" corresponds="icaltime_adjust" since="1.0"> <parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The #ICalTime to be set"/> - <parameter type="const gint" name="days" comment="difference of days adjusted"/> - <parameter type="const gint" name="hours" comment="difference of hours adjusted"/> - <parameter type="const gint" name="minutes" comment="difference of minutes adjusted"/> - <parameter type="const gint" name="seconds" comment="difference of seconds adjusted"/> - <comment xml:space="preserve">like i_cal_time_compare_tz, but only use the date parts.</comment> + <parameter type="const gint" name="days" comment="Difference of days adjusted"/> + <parameter type="const gint" name="hours" comment="Difference of hours adjusted"/> + <parameter type="const gint" name="minutes" comment="Difference of minutes adjusted"/> + <parameter type="const gint" name="seconds" comment="Difference of seconds adjusted"/> + <comment xml:space="preserve">Adds or subtracts a number of days, hours, minutes and seconds from @tt.</comment> </method> <method name="i_cal_time_normalize" corresponds="icaltime_normalize" since="1.0"> <parameter type="const ICalTime *" name="t" annotation="in, transfer none" comment="The #ICalTime to be normalized"/> <returns type="ICalTime *" annotation="transfer full" comment="The #ICalTime normalized"/> - <comment xml:space="preserve">Normalize the icaltime, so that all fields are within the normal range.</comment> + <comment xml:space="preserve">Normalizes the icaltime, so that all fields are within the normal range.</comment> </method> <method name="i_cal_time_normalize_inplace" corresponds="CUSTOM" since="3.0.5"> <parameter type="ICalTime *" name="tt" comment="The #ICalTime to be normalized"/> - <comment xml:space="preserve">Normalize the @tt, so that all fields are within the normal range.</comment> + <comment xml:space="preserve">Normalizes the @tt, so that all fields are within the normal range.</comment> <custom xml:space="preserve"> icaltimetype *itt; g_return_if_fail(I_CAL_IS_TIME (tt)); @@ -187,12 +187,12 @@ <parameter type="const ICalTime *" name="tt" annotation="in, transfer none" comment="The #ICalTime to be converted"/> <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The target timezone"/> <returns type="ICalTime *" annotation="transfer full" comment="The converted #ICalTime" /> - <comment xml:space="preserve">Convert @tt to @zone and return new %ICalTime object.</comment> + <comment xml:space="preserve">Converts @tt to @zone and return new #ICalTime object.</comment> </method> <method name="i_cal_time_convert_to_zone_inplace" corresponds="CUSTOM" since="3.0.5"> <parameter type="ICalTime *" name="tt" comment="The #ICalTime to be converted"/> <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The target timezone"/> - <comment xml:space="preserve">Convert @tt to @zone and store the result into @tt.</comment> + <comment xml:space="preserve">Converts @tt to @zone and store the result into @tt.</comment> <custom xml:space="preserve"> icaltimetype *itt; g_return_if_fail(I_CAL_IS_TIME(tt)); @@ -208,160 +208,160 @@ <parameter type="gint" name="month" comment="The target month"/> <parameter type="gint" name="year" comment="The target year"/> <returns type="gint" comment="The number of days in the target month in the target year." /> - <comment xml:space="preserve">Get the number of days in the target month in the target year.</comment> + <comment xml:space="preserve">Gets the number of days in the target month in the target year.</comment> </method> <method name="i_cal_time_days_is_leap_year" corresponds="icaltime_is_leap_year" since="1.0"> <parameter type="gint" name="year" comment="The target year"/> - <returns type="gboolean" comment="whether the @year is a leap year" /> - <comment xml:space="preserve">Check whether a year is a leap year.</comment> + <returns type="gboolean" comment="Whether the @year is a leap year" /> + <comment xml:space="preserve">Checks whether a year is a leap year.</comment> </method> <method name="i_cal_time_days_in_year" corresponds="icaltime_days_in_year" since="2.0"> <parameter type="gint" name="year" comment="The target year"/> <returns type="gint" comment="Days in this year." /> - <comment xml:space="preserve">Return the number of days in this year.</comment> + <comment xml:space="preserve">Returns the number of days in this year.</comment> </method> <method name="i_cal_time_span_new" corresponds="icaltime_span_new" kind="constructor" since="1.0"> <parameter type="ICalTime *" name="dtstart" comment="The start of #ICalTimeSpan"/> <parameter type="ICalTime *" name="dtend" comment="The end of #ICalTimeSpan"/> <parameter type="gint" name="is_busy" comment="Whether this span is busy"/> - <returns type="ICalTimeSpan *" annotation="transfer full" comment="The newly create #ICalTimeSpan"/> - <comment xml:space="preserve">Create a new #ICalTimeSpan.</comment> + <returns type="ICalTimeSpan *" annotation="transfer full" comment="The newly created #ICalTimeSpan"/> + <comment xml:space="preserve">Creates a new #ICalTimeSpan.</comment> </method> <method name="i_cal_time_span_overlaps" corresponds="icaltime_span_overlaps" kind="other" since="1.0"> <parameter type="ICalTimeSpan *" name="s1" native_op="POINTER" comment="The first #ICalTimeSpan"/> <parameter type="ICalTimeSpan *" name="s2" native_op="POINTER" comment="The second #ICalTimeSpan"/> <returns type="gint" comment="Whether these two span are overlapped."/> - <comment xml:space="preserve">Check whether two spans overlap.</comment> + <comment xml:space="preserve">Checks whether two spans overlap.</comment> </method> <method name="i_cal_time_span_contains" corresponds="icaltime_span_contains" kind="other" since="1.0"> <parameter type="ICalTimeSpan *" name="s" native_op="POINTER" comment="The test #ICalTimeSpan"/> <parameter type="ICalTimeSpan *" name="container" native_op="POINTER" comment="The target container of #ICalTimeSpan"/> <returns type="gint" comment="Whether one #ICalTimeSpan is contained in another #ICalTimeSpan."/> - <comment xml:space="preserve">Check whether one #ICalTimeSpan is contained in another #ICalTimeSpan.</comment> + <comment xml:space="preserve">Checks whether one #ICalTimeSpan is contained in another #ICalTimeSpan.</comment> </method> <method name="i_cal_time_add" corresponds="icaltime_add" kind="other" since="2.0"> - <parameter type="ICalTime *" name="t" comment="A #ICalTime to be operated on."/> - <parameter type="ICalDuration *" name="d" comment="A #ICalDuration as the difference."/> + <parameter type="ICalTime *" name="t" comment="A #ICalTime to be operated on"/> + <parameter type="ICalDuration *" name="d" comment="A #ICalDuration as the difference"/> <returns type="ICalTime *" annotation="transfer full" comment="The #ICalTime results. The native object is the same. But since it is a bare object, so it won't cause segmentation."/> - <comment xml:space="preserve">Add a time duration on the time.</comment> + <comment xml:space="preserve">Adds a time duration on the time.</comment> </method> <method name="i_cal_time_subtract" corresponds="icaltime_subtract" kind="other" since="2.0"> - <parameter type="ICalTime *" name="t1" comment="The subtracted #ICalTime."/> - <parameter type="ICalTime *" name="t2" comment="The subtracting #ICalTime."/> + <parameter type="ICalTime *" name="t1" comment="The subtracted #ICalTime"/> + <parameter type="ICalTime *" name="t2" comment="The subtracting #ICalTime"/> <returns type="ICalDuration *" annotation="transfer full" comment="The #ICalDuration between two #ICalTime."/> - <comment xml:space="preserve">Get the duration between two time.</comment> + <comment xml:space="preserve">Gets the duration between two time.</comment> </method> <method name="i_cal_time_get_year" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The year."/> - <comment xml:space="preserve">Get the year of #ICalTime.</comment> + <comment xml:space="preserve">Gets the year of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->year;</custom> </method> <method name="i_cal_time_set_year" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="year" comment="The year."/> - <comment>Set the year of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="year" comment="The year"/> + <comment>Sets the year of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->year = year;</custom> </method> <method name="i_cal_time_get_month" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The month." /> - <comment xml:space="preserve">Get the month of #ICalTime.</comment> + <comment xml:space="preserve">Gets the month of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->month;</custom> </method> <method name="i_cal_time_set_month" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="month" comment="The month."/> - <comment>Set the month of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="month" comment="The month"/> + <comment>Sets the month of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->month = month;</custom> </method> <method name="i_cal_time_get_day" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The day." /> - <comment xml:space="preserve">Get the day of #ICalTime.</comment> + <comment xml:space="preserve">Gets the day of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->day;</custom> </method> <method name="i_cal_time_set_day" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="day" comment="The day."/> - <comment>Set the day of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="day" comment="The day"/> + <comment>Sets the day of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->day = day;</custom> </method> <method name="i_cal_time_get_hour" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The hour." /> - <comment xml:space="preserve">Get the hour of #ICalTime.</comment> + <comment xml:space="preserve">Gets the hour of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->hour;</custom> </method> <method name="i_cal_time_set_hour" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="hour" comment="The hour."/> - <comment>Set the hour of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="hour" comment="The hour"/> + <comment>Sets the hour of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->hour = hour;</custom> </method> <method name="i_cal_time_get_minute" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The minute." /> - <comment xml:space="preserve">Get the minute of #ICalTime.</comment> + <comment xml:space="preserve">Gets the minute of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->minute;</custom> </method> <method name="i_cal_time_set_minute" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="minute" comment="The minute."/> - <comment>Set the minute of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="minute" comment="The minute"/> + <comment>Sets the minute of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->minute = minute;</custom> </method> <method name="i_cal_time_get_second" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gint" comment="The second." /> - <comment xml:space="preserve">Get the second of #ICalTime.</comment> + <comment xml:space="preserve">Gets the second of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->second;</custom> </method> <method name="i_cal_time_set_second" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gint" name="second" comment="The second."/> - <comment>Set the second of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gint" name="second" comment="The second"/> + <comment>Sets the second of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->second = second;</custom> </method> <method name="i_cal_time_set_is_date" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gboolean" name="is_date" comment="The is_date."/> - <comment>Set the is_date of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gboolean" name="is_date" comment="The is_date"/> + <comment>Sets the is_date of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->is_date = is_date ? 1 : 0;</custom> </method> <method name="i_cal_time_is_daylight" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> <returns type="gboolean" comment="The is_daylight." /> - <comment xml:space="preserve">Get the is_daylight of #ICalTime.</comment> + <comment xml:space="preserve">Gets the is_daylight of #ICalTime.</comment> <custom> g_return_val_if_fail (timetype != NULL, 0); return ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->is_daylight;</custom> </method> <method name="i_cal_time_set_is_daylight" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set."/> - <parameter type="gboolean" name="is_daylight" comment="The is_daylight."/> - <comment>Set the is_daylight of #ICalTime.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set"/> + <parameter type="gboolean" name="is_daylight" comment="The is_daylight"/> + <comment>Sets the is_daylight of #ICalTime.</comment> <custom> g_return_if_fail (timetype != NULL && I_CAL_IS_TIME(timetype)); ((struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype))->is_daylight = is_daylight ? 1 : 0;</custom> </method> <method name="i_cal_time_get_date" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> - <parameter type="gint *" name="year" annotation="out caller-allocates, optional" comment="Out parameter for the 'year' part of the date."/> - <parameter type="gint *" name="month" annotation="out caller-allocates, optional" comment="Out parameter for the 'month' part of the date."/> - <parameter type="gint *" name="day" annotation="out caller-allocates, optional" comment="Out parameter for the 'day' part of the date."/> - <comment xml:space="preserve">Get the year/month/date parts of the @timetype in one call.</comment> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> + <parameter type="gint *" name="year" annotation="out caller-allocates, optional" comment="Out parameter for the 'year' part of the date"/> + <parameter type="gint *" name="month" annotation="out caller-allocates, optional" comment="Out parameter for the 'month' part of the date"/> + <parameter type="gint *" name="day" annotation="out caller-allocates, optional" comment="Out parameter for the 'day' part of the date"/> + <comment xml:space="preserve">Gets the year/month/date parts of the @timetype in one call.</comment> <custom> icaltimetype *itt; g_return_if_fail(timetype != NULL); itt = (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype); @@ -374,11 +374,11 @@ *day = itt->day; </custom> </method> <method name="i_cal_time_set_date" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set to."/> - <parameter type="gint" name="year" comment="The 'year' part of the date." /> - <parameter type="gint" name="month" comment="The 'month' part of the date." /> - <parameter type="gint" name="day" comment="The 'day' part of the date." /> - <comment xml:space="preserve">Set the year/month/date parts of the @timetype in one call. This doesn't verify validity of the given date.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set to"/> + <parameter type="gint" name="year" comment="The 'year' part of the date" /> + <parameter type="gint" name="month" comment="The 'month' part of the date" /> + <parameter type="gint" name="day" comment="The 'day' part of the date" /> + <comment xml:space="preserve">Sets the year/month/date parts of the @timetype in one call. This doesn't verify validity of the given date.</comment> <custom> icaltimetype *itt; g_return_if_fail(timetype != NULL); itt = (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype); @@ -388,11 +388,11 @@ itt->day = day; </custom> </method> <method name="i_cal_time_get_time" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried."/> - <parameter type="gint *" name="hour" annotation="out caller-allocates, optional" comment="Out parameter for the 'hour' part of the time."/> - <parameter type="gint *" name="minute" annotation="out caller-allocates, optional" comment="Out parameter for the 'minute' part of the time."/> - <parameter type="gint *" name="second" annotation="out caller-allocates, optional" comment="Out parameter for the 'second' part of the time."/> - <comment xml:space="preserve">Get the hour/minute/second parts of the @timetype in one call.</comment> + <parameter type="const ICalTime *" name="timetype" comment="The #ICalTime to be queried"/> + <parameter type="gint *" name="hour" annotation="out caller-allocates, optional" comment="Out parameter for the 'hour' part of the time"/> + <parameter type="gint *" name="minute" annotation="out caller-allocates, optional" comment="Out parameter for the 'minute' part of the time"/> + <parameter type="gint *" name="second" annotation="out caller-allocates, optional" comment="Out parameter for the 'second' part of the time"/> + <comment xml:space="preserve">Gets the hour/minute/second parts of the @timetype in one call.</comment> <custom> icaltimetype *itt; g_return_if_fail(timetype != NULL); itt = (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype); @@ -405,11 +405,11 @@ *second = itt->second; </custom> </method> <method name="i_cal_time_set_time" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set to."/> - <parameter type="gint" name="hour" comment="The 'hour' part of the time." /> - <parameter type="gint" name="minute" comment="The 'minute' part of the time." /> - <parameter type="gint" name="second" comment="The 'second' part of the time." /> - <comment xml:space="preserve">Set the hour/minute/second parts of the @timetype in one call. This doesn't verify validity of the given time.</comment> + <parameter type="ICalTime *" name="timetype" comment="The #ICalTime to be set to"/> + <parameter type="gint" name="hour" comment="The 'hour' part of the time" /> + <parameter type="gint" name="minute" comment="The 'minute' part of the time" /> + <parameter type="gint" name="second" comment="The 'second' part of the time" /> + <comment xml:space="preserve">Sets the hour/minute/second parts of the @timetype in one call. This doesn't verify validity of the given time.</comment> <custom> icaltimetype *itt; g_return_if_fail(timetype != NULL); itt = (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)timetype); diff --git a/src/libical-glib/api/i-cal-timezone.xml b/src/libical-glib/api/i-cal-timezone.xml index 476208e3..dfa4140d 100644 --- a/src/libical-glib/api/i-cal-timezone.xml +++ b/src/libical-glib/api/i-cal-timezone.xml @@ -16,7 +16,7 @@ <structure namespace="ICal" name="Timezone" native="icaltimezone" is_possible_global="true" destroy_func="i_cal_timezone_destroy"> <method name="i_cal_timezone_new" corresponds="icaltimezone_new" kind="constructor" since="1.0"> <returns type="ICalTimezone *" annotation="transfer full, allow-none" translator="i_cal_timezone_new_full" translator_argus="NULL, FALSE" comment="The newly created object of the type #ICalTimezone." /> - <comment xml:space="preserve">The constructor of the type #ICalTimezone</comment> + <comment xml:space="preserve">The constructor of the type #ICalTimezone.</comment> </method> <method name="i_cal_timezone_destroy" corresponds="CUSTOM" annotation="skip" kind="private" since="1.0"> <parameter type="icaltimezone *" name="zone" comment="The #ICalTimezone to be freed"/> @@ -24,24 +24,24 @@ <custom> icaltimezone_free (zone, 1);</custom> </method> <method name="i_cal_timezone_copy" corresponds="icaltimezone_copy" kind="clone" since="1.0"> - <parameter type="const ICalTimezone *" name="zone" comment="The #ICalTimezone needs to be cloned."/> + <parameter type="const ICalTimezone *" name="zone" comment="The #ICalTimezone needs to be cloned"/> <returns type="ICalTimezone *" annotation="transfer full" translator="i_cal_timezone_new_full" translator_argus="NULL, FALSE" comment="The newly created #ICalTimezone with the same values as @zone"/> - <comment xml:space="preserve">The clone method for #ICalTimezone</comment> + <comment xml:space="preserve">The clone method for #ICalTimezone.</comment> </method> <method name="i_cal_timezone_free" corresponds="icaltimezone_free" annotation="skip" kind="destructor" since="1.0"> <parameter type="ICalTimezone *" name="zone" comment="The #ICalTimezone to be freed"/> <parameter type="gint" name="free_struct" autofill="1" comment="Whether to free it or reset it. 1 to free and 0 to reset"/> - <comment xml:space="preserve">The destructor of #ICalTimezone</comment> + <comment xml:space="preserve">The destructor of #ICalTimezone.</comment> </method> <method name="i_cal_timezone_set_tzid_prefix" corresponds="icaltimezone_set_tzid_prefix" kind="set" since="1.0"> <parameter type="const gchar *" name="new_prefix" comment="The #ICalTimezone to be set"/> <comment xml:space="preserve">Sets the prefix to be used for tzid's generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this.</comment> </method> <method name="i_cal_timezone_free_builtin_timezones" corresponds="icaltimezone_free_builtin_timezones" kind="others" since="1.0"> - <comment xml:space="preserve">Free any builtin timezone information</comment> + <comment xml:space="preserve">Frees any builtin timezone information.</comment> </method> <method name="i_cal_timezone_get_builtin_timezone" corresponds="icaltimezone_get_builtin_timezone" kind="get" since="1.0"> - <parameter type="const gchar *" name="location" annotation="nullable" comment="The location representing the timezone."/> + <parameter type="const gchar *" name="location" annotation="nullable" comment="The location representing the timezone"/> <returns type="ICalTimezone *" translator="i_cal_timezone_new_full" translator_argus="NULL, TRUE" annotation="transfer none, nullable" comment="The builtin #ICalTimezone with the name of @location"/> <comment xml:space="preserve">Returns a single builtin timezone, given its Olson city name.</comment> </method> @@ -91,15 +91,15 @@ </method> <method name="i_cal_timezone_get_component" corresponds="icaltimezone_get_component" kind="get" since="1.0"> <parameter type="const ICalTimezone *" name="zone" annotation="nullable" comment="The #ICalTimezone to be queried"/> - <returns type="ICalComponent *" annotation="transfer full" translator_argus="(GObject *)zone" comment="the VTIMEZONE component of the @zone."/> + <returns type="ICalComponent *" annotation="transfer full" translator_argus="(GObject *)zone" comment="The VTIMEZONE component of the @zone."/> <comment xml:space="preserve">Returns the VTIMEZONE component of a timezone.</comment> </method> <method name="i_cal_timezone_set_component" corresponds="CUSTOM" kind="set" since="1.0"> <parameter type="ICalTimezone *" name="zone" comment="The #ICalTimezone to be set"/> - <parameter type="ICalComponent *" name="comp" comment="The VTIMEZONE component of an #ICalTimezone, initializing the tzid, location and tzname fields."/> + <parameter type="ICalComponent *" name="comp" comment="The VTIMEZONE component of an #ICalTimezone, initializing the tzid, location and tzname fields"/> <returns type="gint" comment="Whether the action is successful. 1 for success, 0 for failure."/> <comment xml:space="preserve">Sets the VTIMEZONE component of #ICalTimezone, initializing the tzid, location and tzname fields. It returns 1 on success or 0 on failure, i.e. no TZID was found. - * + * * @note The @zone assumes ownership of the @comp, thus make sure you pass an unowned #ICalComponent.</comment> <custom xml:space="preserve"> g_return_val_if_fail(I_CAL_IS_TIMEZONE(zone), 0); g_return_val_if_fail(I_CAL_IS_COMPONENT(comp), 0); @@ -111,31 +111,31 @@ <method name="i_cal_timezone_get_display_name" corresponds="icaltimezone_get_display_name" kind="get" since="1.0"> <parameter type="const ICalTimezone *" name="zone" annotation="nullable" comment="The #ICalTimezone to be queried"/> <returns type="const gchar *" comment="The display name of @zone"/> - <comment xml:space="preserve">Get the display name of the @zone.</comment> + <comment xml:space="preserve">Gets the display name of the @zone.</comment> </method> <method name="i_cal_time_convert_timezone" corresponds="icaltimezone_convert_time" kind="other" since="1.0"> <parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The time to be converted"/> - <parameter type="ICalTimezone *" name="from_zone" annotation="nullable" comment="from timezone"/> - <parameter type="ICalTimezone *" name="to_zone" annotation="nullable" comment="to timezone"/> + <parameter type="ICalTimezone *" name="from_zone" annotation="nullable" comment="From timezone"/> + <parameter type="ICalTimezone *" name="to_zone" annotation="nullable" comment="To timezone"/> <comment>Convert time from one timezone to another.</comment> </method> <method name="i_cal_timezone_get_utc_offset" corresponds="icaltimezone_get_utc_offset" kind="get" since="1.0"> - <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The given #ICalTimezone."/> - <parameter type="ICalTime *" name="tt" annotation="nullable" native_op="POINTER" comment="The local time."/> - <parameter type="gint *" name="is_daylight" annotation="out, optional" comment="whether it is day light."/> + <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The given #ICalTimezone"/> + <parameter type="ICalTime *" name="tt" annotation="nullable" native_op="POINTER" comment="The local time"/> + <parameter type="gint *" name="is_daylight" annotation="out, optional" comment="Whether it is day light"/> <returns type="gint" comment="UTC offset of the @zone"/> <comment>Calculates the UTC offset of a given local time in the given timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.</comment> </method> <method name="i_cal_timezone_get_utc_offset_of_utc_time" corresponds="icaltimezone_get_utc_offset_of_utc_time" kind="get" since="1.0"> - <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The given #ICalTimezone."/> - <parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The local time."/> - <parameter type="gint *" name="is_daylight" annotation="out, optional" comment="whether it is day light, can be %NULL"/> + <parameter type="ICalTimezone *" name="zone" annotation="nullable" comment="The given #ICalTimezone"/> + <parameter type="ICalTime *" name="tt" native_op="POINTER" comment="The local time"/> + <parameter type="gint *" name="is_daylight" annotation="out, optional" comment="Whether it is day light, can be %NULL"/> <returns type="gint" comment="UTC offset of the @zone"/> <comment>Calculates the UTC offset of a given UTC time in the given timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.</comment> </method> <method name="i_cal_timezone_array_new" corresponds="CUSTOM" kind="other" since="1.0"> <returns type="ICalArray *" annotation="transfer full" translator_argus="NULL, FALSE" comment="Create a new array."/> - <comment xml:space="preserve">Create a new array of timezones.</comment> + <comment xml:space="preserve">Creates a new array of timezones.</comment> <custom> ICalArray *zones_array; zones_array = i_cal_array_new_full(icaltimezone_array_new (), NULL, FALSE); @@ -149,9 +149,9 @@ </method> <method name="i_cal_timezone_array_append_from_vtimezone" corresponds="CUSTOM" kind="other" since="1.0"> <parameter type="ICalArray *" name="timezones" comment="The timezones to be populated"/> - <parameter type="ICalComponent *" name="child" comment="The component to be appended to @timezones."/> + <parameter type="ICalComponent *" name="child" comment="The component to be appended to @timezones"/> <comment>Populate the array of timezones with a component. - * + * * @note The @timezones assumes ownership of the @child, thus make sure you pass an unowned #ICalComponent.</comment> <custom xml:space="preserve"> g_return_if_fail(I_CAL_IS_ARRAY(timezones)); g_return_if_fail(I_CAL_IS_COMPONENT(child)); @@ -161,55 +161,55 @@ icaltimezone_array_append_from_vtimezone ((icalarray *)i_cal_object_get_native (I_CAL_OBJECT (timezones)), (icalcomponent *)i_cal_object_get_native (I_CAL_OBJECT (child)));</custom> </method> <method name="i_cal_timezone_array_free" corresponds="icaltimezone_array_free" annotation="skip" kind="other" since="1.0"> - <parameter type="ICalArray *" name="timezones" native_op="STEAL" comment="Free an array."/> - <comment xml:space="preserve">Free an array of timezones.</comment> + <parameter type="ICalArray *" name="timezones" native_op="STEAL" comment="Free an array"/> + <comment xml:space="preserve">Frees an array of timezones.</comment> </method> <method name="i_cal_time_timezone_expand_vtimezone" corresponds="icaltimezone_expand_vtimezone" kind="other" since="2.0"> - <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent."/> - <parameter type="gint" name="end_year" comment="The end year."/> - <parameter type="ICalArray *" name="changes" comment="The changes to be applies."/> - <comment xml:space="preserve">Apply a list of timezone changes on the array of components until the end year.</comment> + <parameter type="ICalComponent *" name="comp" comment="The #ICalComponent"/> + <parameter type="gint" name="end_year" comment="The end year"/> + <parameter type="ICalArray *" name="changes" comment="The changes to be applies"/> + <comment xml:space="preserve">Applies a list of timezone changes on the array of components until the end year.</comment> </method> <method name="i_cal_timezone_get_location_from_vtimezone" corresponds="icaltimezone_get_location_from_vtimezone" kind="get" since="2.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be queried."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be queried"/> <returns type="gchar *" comment="The location of vtimezone."/> - <comment xml:space="preserve">Get the location of the vtimezone in component.</comment> + <comment xml:space="preserve">Gets the location of the vtimezone in component.</comment> </method> <method name="i_cal_timezone_get_tznames_from_vtimezone" corresponds="icaltimezone_get_tznames_from_vtimezone" kind="get" since="2.0"> - <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be queried."/> + <parameter type="ICalComponent *" name="component" comment="The #ICalComponent to be queried"/> <returns type="gchar *" comment="The name of vtimezone."/> - <comment xml:space="preserve">Get the name of the vtimezone in component.</comment> + <comment xml:space="preserve">Gets the name of the vtimezone in component.</comment> </method> <method name="i_cal_timezone_set_zone_directory" corresponds="set_zone_directory" kind="others" since="1.0"> <parameter type="const gchar *" name="path" comment="The path to look for the zonefiles"/> - <comment xml:space="preserve">Set the directory to look for the zonefiles</comment> + <comment xml:space="preserve">Sets the directory to look for the zonefiles.</comment> </method> <method name="i_cal_timezone_free_zone_directory" corresponds="free_zone_directory" kind="others" since="1.0"> - <comment xml:space="preserve">Free memory dedicated to the zonefile directory</comment> + <comment xml:space="preserve">Frees memory dedicated to the zonefile directory.</comment> </method> <method name="i_cal_timezone_release_zone_tab" corresponds="icaltimezone_release_zone_tab" kind="others" since="1.0"> - <comment xml:space="preserve">Free memory dedicated to the zonefile directory</comment> + <comment xml:space="preserve">Frees memory dedicated to the zonefile directory.</comment> </method> <method name="i_cal_timezone_set_builtin_tzdata" corresponds="icaltimezone_set_builtin_tzdata" kind="set" since="2.0"> - <parameter type="gboolean" name="set" comment="Whether to use builtin timezones files."/> - <comment xml:space="preserve">Set whether to use builtin timezones files.</comment> + <parameter type="gboolean" name="set" comment="Whether to use builtin timezones files"/> + <comment xml:space="preserve">Sets whether to use builtin timezones files.</comment> </method> <method name="i_cal_timezone_get_builtin_tzdata" corresponds="icaltimezone_get_builtin_tzdata" kind="get" since="2.0"> <returns type="gboolean" comment="Whether to use builtin timezones files."/> - <comment xml:space="preserve">Get whether to use builtin timezones files.</comment> + <comment xml:space="preserve">Gets whether to use builtin timezones files.</comment> </method> <method name="i_cal_timezone_dump_changes" corresponds="icaltimezone_dump_changes" kind="other" since="1.0"> - <parameter type="ICalTimezone *" name="zone" comment="The timezone to be queried."/> - <parameter type="gint" name="max_year" comment="max year"/> - <parameter type="FILE *" name="fp" comment="The file handle."/> + <parameter type="ICalTimezone *" name="zone" comment="The timezone to be queried"/> + <parameter type="gint" name="max_year" comment="Max year"/> + <parameter type="FILE *" name="fp" comment="The file handle"/> <returns type="gint" comment="1 if success."/> - <comment>This outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given.</comment> + <comment>Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given.</comment> </method> <method name="i_cal_timezone_array_element_at" corresponds="CUSTOM" kind="other" since="1.0"> - <parameter type="ICalArray *" name="timezones" comment="The array to be visited."/> + <parameter type="ICalArray *" name="timezones" comment="The array to be visited"/> <parameter type="guint" name="index" comment="The index"/> <returns type="ICalTimezone *" annotation="transfer full" translator_argus="timezones, FALSE" comment="The #ICalTimezone at the position @index in @timezones."/> - <comment>Get the #ICalTimezone at specified position in array.</comment> + <comment>Gets the #ICalTimezone at specified position in array.</comment> <custom> return i_cal_timezone_new_full ((gpointer)i_cal_array_element_at (timezones, index), (GObject *)timezones, FALSE);</custom> </method> </structure> diff --git a/src/libical-glib/api/i-cal-trigger.xml b/src/libical-glib/api/i-cal-trigger.xml index f5fffec8..6d3d1ffb 100644 --- a/src/libical-glib/api/i-cal-trigger.xml +++ b/src/libical-glib/api/i-cal-trigger.xml @@ -15,51 +15,51 @@ --> <structure namespace="ICal" name="Trigger" native="struct icaltriggertype" is_bare="true" default_native="icaltriggertype_from_int (0)"> <method name="i_cal_trigger_new_from_int" corresponds="icaltriggertype_from_int" kind="constructor" since="1.0"> - <parameter type="const gint" name="reltime" comment="An integer."/> + <parameter type="const gint" name="reltime" comment="An integer"/> <returns type="ICalTrigger *" annotation="transfer full" comment="The newly created #ICalTrigger."/> - <comment xml:space="preserve">Create a #ICalTrigger from integer.</comment> + <comment xml:space="preserve">Creates a #ICalTrigger from integer.</comment> </method> <method name="i_cal_trigger_new_from_string" corresponds="icaltriggertype_from_string" kind="constructor" since="1.0"> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalTrigger *" annotation="transfer full" comment="The newly created #ICalTrigger."/> - <comment xml:space="preserve">Create a #ICalTrigger from a string.</comment> + <comment xml:space="preserve">Creates a #ICalTrigger from a string.</comment> </method> <method name="i_cal_trigger_is_null_trigger" corresponds="icaltriggertype_is_null_trigger" since="1.0"> - <parameter type="ICalTrigger *" name="tr" comment="A #ICalTrigger."/> + <parameter type="ICalTrigger *" name="tr" comment="A #ICalTrigger"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check if a #ICalTrigger is a null trigger.</comment> + <comment xml:space="preserve">Checks if a #ICalTrigger is a null trigger.</comment> </method> <method name="i_cal_trigger_is_bad_trigger" corresponds="icaltriggertype_is_bad_trigger" since="1.0"> - <parameter type="ICalTrigger *" name="tr" comment="A #ICalTrigger."/> + <parameter type="ICalTrigger *" name="tr" comment="A #ICalTrigger"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check if a #ICalTrigger is a bad trigger.</comment> + <comment xml:space="preserve">Checks if a #ICalTrigger is a bad trigger.</comment> </method> <method name="i_cal_trigger_get_time" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger."/> + <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger"/> <returns type="ICalTime *" annotation="transfer full" comment="The time of #ICalTrigger."/> - <comment>Get the time from #ICalTrigger.</comment> + <comment>Gets the time from #ICalTrigger.</comment> <custom> g_return_val_if_fail (trigger != NULL && I_CAL_IS_TRIGGER (trigger), NULL); return i_cal_time_new_full (((struct icaltriggertype *)i_cal_object_get_native ((ICalObject *)trigger))->time);</custom> </method> <method name="i_cal_trigger_set_time" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger."/> - <parameter type="ICalTime *" name="time" comment="The time of #ICalTrigger."/> - <comment>Set the time from #ICalTrigger.</comment> + <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger"/> + <parameter type="ICalTime *" name="time" comment="The time of #ICalTrigger"/> + <comment>Sets the time from #ICalTrigger.</comment> <custom> g_return_if_fail (trigger != NULL && I_CAL_IS_TRIGGER (trigger)); g_return_if_fail (time != NULL && I_CAL_IS_TIME(time)); ((struct icaltriggertype *)i_cal_object_get_native ((ICalObject *)trigger))->time = *(struct icaltimetype *)i_cal_object_get_native ((ICalObject *)time);</custom> </method> <method name="i_cal_trigger_get_duration" corresponds="CUSTOM" kind="get" since="1.0"> - <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger."/> + <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger"/> <returns type="ICalDuration *" annotation="transfer full" comment="The duration of #ICalTrigger."/> - <comment>Get the duration from #ICalTrigger.</comment> + <comment>Gets the duration from #ICalTrigger.</comment> <custom> g_return_val_if_fail (trigger != NULL && I_CAL_IS_TRIGGER (trigger), NULL); return i_cal_duration_new_full (((struct icaltriggertype *)i_cal_object_get_native ((ICalObject *)trigger))->duration);</custom> </method> <method name="i_cal_trigger_set_duration" corresponds="CUSTOM" kind="set" since="1.0"> - <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger."/> - <parameter type="ICalDuration *" name="duration" comment="The duration of #ICalTrigger."/> - <comment>Set the duration from #ICalTrigger.</comment> + <parameter type="ICalTrigger *" name="trigger" comment="The #ICalTrigger"/> + <parameter type="ICalDuration *" name="duration" comment="The duration of #ICalTrigger"/> + <comment>Sets the duration from #ICalTrigger.</comment> <custom> g_return_if_fail (trigger != NULL && I_CAL_IS_TRIGGER (trigger)); g_return_if_fail (duration != NULL && I_CAL_IS_DURATION (duration)); ((struct icaltriggertype *)i_cal_object_get_native ((ICalObject *)trigger))->duration = *(struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration);</custom> diff --git a/src/libical-glib/api/i-cal-unknowntokenhandling.xml b/src/libical-glib/api/i-cal-unknowntokenhandling.xml index 3d1a0671..5c08c7ba 100644 --- a/src/libical-glib/api/i-cal-unknowntokenhandling.xml +++ b/src/libical-glib/api/i-cal-unknowntokenhandling.xml @@ -21,10 +21,10 @@ </enum> <method name="i_cal_get_unknown_token_handling_setting" corresponds="ical_get_unknown_token_handling_setting" kind="get" since="1.0"> <returns type="ICalUnknowntokenhandling" comment="The setting of #ICalUnknowntokenhandling"/> - <comment>Get the setting of #ICalUnknowntokenhandling</comment> + <comment>Gets the setting of #ICalUnknowntokenhandling.</comment> </method> <method name="i_cal_set_unknown_token_handling_setting" corresponds="ical_set_unknown_token_handling_setting" kind="set" since="1.0"> <parameter type="ICalUnknowntokenhandling" name="newSetting" comment="A #ICalUnknowntokenhandling"/> - <comment>Set the setting of #ICalUnknowntokenhandling</comment> + <comment>Sets #ICalUnknowntokenhandling.</comment> </method> </structure> diff --git a/src/libical-glib/api/i-cal-value.xml b/src/libical-glib/api/i-cal-value.xml index a46a51b3..dc8bcf50 100644 --- a/src/libical-glib/api/i-cal-value.xml +++ b/src/libical-glib/api/i-cal-value.xml @@ -17,68 +17,68 @@ <method name="i_cal_value_new" corresponds="icalvalue_new" kind="constructor" since="1.0"> <parameter type="ICalValueKind" name="kind" comment="A #ICalValueKind"/> <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue."/> - <comment xml:space="preserve">Create a new #ICalValue with specific kind.</comment> + <comment xml:space="preserve">Creates a new #ICalValue with specific kind.</comment> </method> <method name="i_cal_value_clone" corresponds="icalvalue_new_clone" kind="clone" since="1.0"> - <parameter type="const ICalValue *" name="value" comment="The #ICalValue to be cloned."/> + <parameter type="const ICalValue *" name="value" comment="The #ICalValue to be cloned"/> <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue with the same property as @value."/> <comment xml:space="preserve">Deeply clone a #ICalValue.</comment> </method> <method name="i_cal_value_new_from_string" corresponds="icalvalue_new_from_string" kind="constructor" since="1.0"> <parameter type="ICalValueKind" name="kind" comment="A #ICalValueKind"/> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalValue *" annotation="transfer full" comment="The newly created #ICalValue based on the @kind and @str."/> - <comment xml:space="preserve">Create a new #ICalValue based on the #ICalValueKind and a string.</comment> + <comment xml:space="preserve">Creates a new #ICalValue based on the #ICalValueKind and a string.</comment> </method> <method name="i_cal_value_free" corresponds="icalvalue_free" annotation="skip" kind="destructor" since="1.0"> - <parameter type="ICalValue *" name="value" comment="The #ICalValue to be freed."/> - <comment xml:space="preserve">Free a #ICalValue.</comment> + <parameter type="ICalValue *" name="value" comment="The #ICalValue to be freed"/> + <comment xml:space="preserve">Frees a #ICalValue.</comment> </method> <method name="i_cal_value_is_valid" corresponds="icalvalue_is_valid" since="1.0"> - <parameter type="const ICalValue *" name="value" comment="The #ICalValue to be checked."/> + <parameter type="const ICalValue *" name="value" comment="The #ICalValue to be checked"/> <returns type="gboolean" comment="1 if valid, 0 if not."/> - <comment xml:space="preserve">Check if #ICalValue is valid.</comment> + <comment xml:space="preserve">Checks if #ICalValue is valid.</comment> </method> <method name="i_cal_value_as_ical_string" corresponds="icalvalue_as_ical_string_r" since="1.0"> - <parameter type="const ICalValue *" name="value" comment="A #ICalValue."/> + <parameter type="const ICalValue *" name="value" comment="A #ICalValue"/> <returns type="gchar *" annotation="transfer full" comment="The string representation."/> - <comment xml:space="preserve">Convert the #ICalValue to a string.</comment> + <comment xml:space="preserve">Converts the #ICalValue to a string.</comment> </method> <method name="i_cal_value_isa" corresponds="icalvalue_isa" since="1.0"> - <parameter type="const ICalValue *" name="value" comment="A #ICalValue."/> + <parameter type="const ICalValue *" name="value" comment="A #ICalValue"/> <returns type="ICalValueKind" comment="The kind of @value."/> - <comment xml:space="preserve">Get the kind of #ICalValue.</comment> + <comment xml:space="preserve">Gets the kind of #ICalValue.</comment> </method> <method name="i_cal_value_isa_value" corresponds="icalvalue_isa_value" since="1.0"> <parameter type="ICalValue *" name="value" comment="A #ICalValue"/> <returns type="gint" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check whether the native part of #ICalValue is an icalvalue</comment> + <comment xml:space="preserve">Checks whether the native part of #ICalValue is an icalvalue.</comment> </method> <method name="i_cal_value_compare" corresponds="icalvalue_compare" since="1.0"> - <parameter type="const ICalValue *" name="a" comment="A #ICalValue."/> - <parameter type="const ICalValue *" name="b" comment="A #ICalValue."/> + <parameter type="const ICalValue *" name="a" comment="A #ICalValue"/> + <parameter type="const ICalValue *" name="b" comment="A #ICalValue"/> <returns type="ICalParameterXliccomparetype" comment="The compare result."/> - <comment xml:space="preserve">Compare two #ICalValue.</comment> + <comment xml:space="preserve">Compares two #ICalValue.</comment> </method> <method name="i_cal_value_kind_from_string" corresponds="icalvalue_string_to_kind" since="1.0"> - <parameter type="const gchar *" name="str" comment="A string."/> + <parameter type="const gchar *" name="str" comment="A string"/> <returns type="ICalValueKind" comment="A #ICalValueKind."/> - <comment xml:space="preserve">Convert a string to #ICalValueKind.</comment> + <comment xml:space="preserve">Converts a string to #ICalValueKind.</comment> </method> <method name="i_cal_value_kind_to_string" corresponds="icalvalue_kind_to_string" since="1.0"> - <parameter type="const ICalValueKind" name="kind" comment="A #ICalValueKind."/> + <parameter type="const ICalValueKind" name="kind" comment="A #ICalValueKind"/> <returns type="const gchar *" comment="The string representation of #ICalValueKind."/> - <comment xml:space="preserve">Convert the #ICalValueKind to a string.</comment> + <comment xml:space="preserve">Converts the #ICalValueKind to a string.</comment> </method> <method name="i_cal_value_kind_is_valid" corresponds="icalvalue_kind_is_valid" since="1.0"> - <parameter type="const ICalValueKind" name="kind" comment="The #ICalValueKind to be checked."/> + <parameter type="const ICalValueKind" name="kind" comment="The #ICalValueKind to be checked"/> <returns type="gboolean" comment="1 if yes, 0 if not."/> - <comment xml:space="preserve">Check whether the #ICalValueKind is valid.</comment> + <comment xml:space="preserve">Checks whether the #ICalValueKind is valid.</comment> </method> <method name="i_cal_value_encode_ical_string" corresponds="CUSTOM" since="1.0"> - <parameter type="const gchar *" name="szText" comment="A string."/> + <parameter type="const gchar *" name="szText" comment="A string"/> <returns type="gchar *" annotation="allow-none, transfer full" comment="The encoded string. NULL if fail."/> - <comment xml:space="preserve">Encode a character string in ical format, escape certain characters, etc.</comment> + <comment xml:space="preserve">Encodes a character string in ical format, escape certain characters, etc.</comment> <custom> gchar *szEncText; gchar *buffer = NULL; gsize bufSize; @@ -97,9 +97,9 @@ return buffer;</custom> </method> <method name="i_cal_value_decode_ical_string" corresponds="CUSTOM" since="1.0"> - <parameter type="const gchar *" name="szText" comment="A string."/> + <parameter type="const gchar *" name="szText" comment="A string"/> <returns type="gchar *" annotation="allow-none, transfer full" comment="The decoded string. NULL if fail."/> - <comment xml:space="preserve">Extract the original character string encoded by the above function</comment> + <comment xml:space="preserve">Extracts the original character string encoded by the above function.</comment> <custom> gchar *szDecText; gchar *buffer = NULL; gsize bufSize; diff --git a/src/libical/astime.h b/src/libical/astime.h index b8710b28..38b12c4f 100644 --- a/src/libical/astime.h +++ b/src/libical/astime.h @@ -46,7 +46,7 @@ typedef struct ut_instant { - double j_date; /**< julian decimal date, 0 = 01 Jan 4713 BC 12 HR UT */ + double j_date; /**< Julian decimal date, 0 = 01 Jan 4713 BC 12 HR UT */ long year; /**< year, valid range [-4,713, +2,147,483,647] */ int month; /**< [1-12] */ int day; /**< [1-31] */ @@ -62,8 +62,10 @@ typedef struct ut_instant /* Functions in caldate.c */ -LIBICAL_ICAL_EXPORT long caldat(UTinstantPtr); /** converts julian date to year,mo,da */ +/** @brief Converts Julian date to year,mo,da. */ +LIBICAL_ICAL_EXPORT long caldat(UTinstantPtr); -LIBICAL_ICAL_EXPORT double juldat(UTinstantPtr); /** returns julian day from year,mo,da */ +/** @brief Returns Julian day from year,mo,da. */ +LIBICAL_ICAL_EXPORT double juldat(UTinstantPtr); #endif diff --git a/src/libical/caldate.c b/src/libical/caldate.c index 086e0591..38891a35 100644 --- a/src/libical/caldate.c +++ b/src/libical/caldate.c @@ -38,15 +38,15 @@ /** * caldat computes the day of the week, the day of the year - * the gregorian (or julian) calendar date and the universal - * time from the julian decimal date. - * for astronomical purposes, The Gregorian calendar reform occurred - * on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar. + * the Gregorian (or Julian) calendar date and the universal + * time from the Julian decimal date. + * For astronomical purposes, The Gregorian calendar reform occurred + * on 15 Oct. 1582. This is 05 Oct 1582 by the Julian calendar. * Input: a ut_instant structure pointer, where the j_date element * has been set. ( = 0 for 01 Jan 4713 B.C. 12 HR UT ) * - * output: will set all the other elements of the structure. + * Output: will set all the other elements of the structure. * As a convienence, the function will also return the year. * * Reference: Astronomial formulae for calculators, meeus, p 23 @@ -67,7 +67,7 @@ struct ut_instant * date; long ke; long ialp; - jd = (long) (date->j_date + 0.5); /* integer julian date */ + jd = (long) (date->j_date + 0.5); /* integer Julian date */ frac = date->j_date + 0.5 - (double) jd + 1.0e-10; /* day fraction */ ka = (long) jd; if ( jd >= 2299161L ) @@ -113,10 +113,10 @@ struct ut_instant * date; } /** - * juldat computes the julian decimal date (j_date) from - * the gregorian (or Julian) calendar date. - * for astronomical purposes, The Gregorian calendar reform occurred - * on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar. + * juldat computes the Julian decimal date (j_date) from + * the Gregorian (or Julian) calendar date. + * For astronomical purposes, The Gregorian calendar reform occurred + * on 15 Oct. 1582. This is 05 Oct 1582 by the Julian calendar. * Input: a ut_instant structure pointer where Day, Month, Year and * i_hour, i_minute, d_second have been set for the date * in question. @@ -159,7 +159,7 @@ struct ut_instant * date; } ia = iy0 / 100L; ib = 2L - ia + (ia >> 2); - /* calculate julian date */ + /* calculate Julian date */ if ( date->year < 0L ) jd = (long) ((365.25 * (double) iy0) - 0.75) + (long) (30.6001 * (im0 + 1L) ) diff --git a/src/libical/icalarray.h b/src/libical/icalarray.h index 708e9fa4..a945be60 100644 --- a/src/libical/icalarray.h +++ b/src/libical/icalarray.h @@ -42,7 +42,7 @@ struct _icalarray }; /** - * @brief Creates new ::icalarray object. + * @brief Creates a new ::icalarray object. * @param element_size The size of the elements to be held by the array * @param increment_size How many extra elements worth of space to allocate on expansion * @return The new ::icalarray object @@ -81,12 +81,12 @@ struct _icalarray LIBICAL_ICAL_EXPORT icalarray *icalarray_new(size_t element_size, size_t increment_size); /** - * @brief Copies an existing ::icalarray and it's elements, creating a new one. + * @brief Copies an existing ::icalarray and its elements, creating a new one. * @param array The array to copy * @return A new array, holding all the elements of @a array * * Creates a new ::icalarray object, copying all the existing elements from - * @a array as well as it's properties (such as @a element_size and + * @a array as well as its properties (such as @a element_size and * @a increment_size) over. * * @par Error handling @@ -166,8 +166,8 @@ LIBICAL_ICAL_EXPORT void icalarray_append(icalarray *array, const void *element) /** * @brief Removes a given element from an array. - * @brief array The array from which to remove the element - * @brief position The position of the element to remove + * @param array The array from which to remove the element + * @param position The position of the element to remove * * Removes the element at the given position from the array. * diff --git a/src/libical/icalattach.h b/src/libical/icalattach.h index 15a09441..9a606773 100644 --- a/src/libical/icalattach.h +++ b/src/libical/icalattach.h @@ -54,7 +54,7 @@ typedef struct icalattach_impl icalattach; typedef void (*icalattach_free_fn_t) (char *data, void *user_data); /** - * @brief Create new ::icalattach object from a URL. + * @brief Creates new ::icalattach object from a URL. * @param url The URL to create the object from * @return An ::icalattach object with the given URL as association * @sa icalattach_unref() @@ -86,7 +86,7 @@ typedef void (*icalattach_free_fn_t) (char *data, void *user_data); LIBICAL_ICAL_EXPORT icalattach *icalattach_new_from_url(const char *url); /** - * @brief Create new ::icalattach object from data. + * @brief Creates new ::icalattach object from data. * @param data The data to create the ::icalattach from * @param free_fn The function to free the data * @param free_fn_data Data to pass to the @a free_fn diff --git a/src/libical/icalcomponent.c b/src/libical/icalcomponent.c index fc0cd3df..421d265d 100644 --- a/src/libical/icalcomponent.c +++ b/src/libical/icalcomponent.c @@ -108,15 +108,11 @@ static icalcomponent *icalcomponent_new_impl(icalcomponent_kind kind) return comp; } -/** @brief Constructor - */ icalcomponent *icalcomponent_new(icalcomponent_kind kind) { return icalcomponent_new_impl(kind); } -/** @brief Constructor - */ #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wvarargs" icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...) @@ -137,15 +133,11 @@ icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...) } #pragma clang diagnostic pop -/** @brief Constructor - */ icalcomponent *icalcomponent_new_from_string(const char *str) { return icalparser_parse_string(str); } -/** @brief Constructor - */ icalcomponent *icalcomponent_new_clone(icalcomponent *old) { icalcomponent *new; @@ -174,8 +166,6 @@ icalcomponent *icalcomponent_new_clone(icalcomponent *old) return new; } -/** @brief Constructor - */ icalcomponent *icalcomponent_new_x(const char *x_name) { icalcomponent *comp = icalcomponent_new_impl(ICAL_X_COMPONENT); @@ -187,8 +177,6 @@ icalcomponent *icalcomponent_new_x(const char *x_name) return comp; } -/*** @brief Destructor - */ void icalcomponent_free(icalcomponent *c) { icalproperty *prop; @@ -614,23 +602,6 @@ icalcomponent *icalcomponent_get_first_real_component(icalcomponent *c) return 0; } -/** @brief Get the timespan covered by this component, in UTC - * - * see icalcomponent_foreach_recurrence() for a better way to - * extract spans from an component. - * - * This method can be called on either a VCALENDAR or any real - * component. If the VCALENDAR contains no real component, but - * contains a VTIMEZONE, we return that span instead. - * This might not be a desirable behavior; we keep it for now - * for backward compatibility, but it might be deprecated at a - * future time. - * - * FIXME this API needs to be clarified. DTEND is defined as the - * first available time after the end of this event, so the span - * should actually end 1 second before DTEND. - */ - icaltime_span icalcomponent_get_span(icalcomponent *comp) { icalcomponent *inner; @@ -709,29 +680,6 @@ or empty VCALENDAR component"); */ return span; } -/** - * Decide if this recurrance is acceptable - * - * @param comp A valid icalcomponent. - * @param dtstart The base dtstart value for this component. - * @param recurtime The time to test against. - * - * @return true if the recurrence value is excluded, false otherwise. - * - * This function decides if a specific recurrence value is - * excluded by EXRULE or EXDATE properties. - * - * It's not the most efficient code. You might get better performance - * if you assume that recurtime is always increasing for each - * call. Then you could: - * - * - sort the EXDATE values - * - save the state of each EXRULE iterator for the next call. - * - * In this case though you don't need to worry how you call this - * function. It will always return the correct result. - */ - int icalproperty_recurrence_is_excluded(icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime) @@ -793,17 +741,16 @@ int icalproperty_recurrence_is_excluded(icalcomponent *comp, } comp->property_iterator = property_iterator; - return 0;/** no matches **/ + return 0; /* no matches */ } /** - * @brief Return the busy status based on the TRANSP property. + * @brief Returns the busy status based on the TRANSP property. * * @param comp A valid icalcomponent. * * @return 1 if the event is a busy item, 0 if it is not. */ - static int icalcomponent_is_busy(icalcomponent *comp) { icalproperty *transp; @@ -848,25 +795,6 @@ static int icalcomponent_is_busy(icalcomponent *comp) return (ret); } -/** - * @brief cycle through all recurrances of an event - * - * @param comp A valid VEVENT component - * @param start Ignore timespans before this - * @param end Ignore timespans after this - * @param callback Function called for each timespan within the range - * @param callback_data Pointer passed back to the callback function - * - * This function will call the specified callback function for once - * for the base value of DTSTART, and foreach recurring date/time - * value. - * - * It will filter out events that are specified as an EXDATE or an EXRULE. - * - * @todo We do not filter out duplicate RRULES/RDATES - * @todo We do not handle RDATEs with explicit periods - */ - void icalcomponent_foreach_recurrence(icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, @@ -911,7 +839,7 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, basespan.is_busy = icalcomponent_is_busy(comp); - /** Calculate the ceiling and floor values.. **/ + /* Calculate the ceiling and floor values.. */ limit_start = icaltime_as_timet_with_zone(start, icaltimezone_get_utc_timezone()); if (!icaltime_is_null_time(end)) { @@ -932,7 +860,7 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, rrule = icalcomponent_get_first_property(comp, ICAL_RRULE_PROPERTY); if ((rrule == NULL) && !icalproperty_recurrence_is_excluded(comp, &dtstart, &dtstart)) { - /** call callback action **/ + /* call callback action */ if (icaltime_span_overlaps(&basespan, &limit_span)) (*callback) (comp, &basespan, callback_data); } @@ -973,12 +901,12 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, icaltimezone_get_utc_timezone()); recurspan.end = recurspan.start + dtduration; - /** save the iterator ICK! **/ + /* save the iterator ICK! */ property_iterator = comp->property_iterator; if (!icalproperty_recurrence_is_excluded(comp, &dtstart, &rrule_time)) { - /** call callback action **/ + /* call callback action */ if (icaltime_span_overlaps(&recurspan, &limit_span)) (*callback) (comp, &recurspan, callback_data); } @@ -988,7 +916,7 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, icalrecur_iterator_free(rrule_itr); } /* end of RRULE loop */ - /** Now process RDATE entries **/ + /* Now process RDATE entries */ for (rdate = icalcomponent_get_first_property(comp, ICAL_RDATE_PROPERTY); rdate != NULL; rdate = icalcomponent_get_next_property(comp, ICAL_RDATE_PROPERTY)) { @@ -996,10 +924,10 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, struct icaldatetimeperiodtype rdate_period = icalproperty_get_rdate(rdate); - /** RDATES can specify raw datetimes, periods, or dates. + /* RDATES can specify raw datetimes, periods, or dates. we only support raw datetimes for now.. - @todo Add support for other types **/ + @todo Add support for other types */ if (icaltime_is_null_time(rdate_period.time)) continue; @@ -1011,12 +939,12 @@ void icalcomponent_foreach_recurrence(icalcomponent *comp, icaltimezone_get_utc_timezone()); recurspan.end = recurspan.start + dtduration; - /** save the iterator ICK! **/ + /* save the iterator ICK! */ property_iterator = comp->property_iterator; if (!icalproperty_recurrence_is_excluded(comp, &dtstart, &rdate_period.time)) { - /** call callback action **/ + /* call callback action */ if (icaltime_span_overlaps(&recurspan, &limit_span)) (*callback) (comp, &recurspan, callback_data); } @@ -1030,12 +958,6 @@ int icalcomponent_check_restrictions(icalcomponent *comp) return icalrestriction_check(comp); } -/** @brief returns the number of errors encountered parsing the data - * - * This function counts the number times the X-LIC-ERROR occurs - * in the data structure. - */ - int icalcomponent_count_errors(icalcomponent *component) { int errors = 0; @@ -1362,9 +1284,6 @@ icalcomponent *icalcomponent_get_inner(icalcomponent *comp) } } -/** @brief sets the METHOD property to the given method - */ - void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method) { icalproperty *prop = icalcomponent_get_first_property(comp, ICAL_METHOD_PROPERTY); @@ -1377,9 +1296,6 @@ void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method) icalproperty_set_method(prop, method); } -/** @brief returns the METHOD property - */ - icalproperty_method icalcomponent_get_method(icalcomponent *comp) { icalproperty *prop = icalcomponent_get_first_property(comp, ICAL_METHOD_PROPERTY); @@ -1402,11 +1318,6 @@ if (inner == 0) { \ } \ prop = icalcomponent_get_first_property(inner, p_kind); -/** @brief Set DTSTART property to given icaltime - * - * This method respects the icaltime type (DATE vs DATE-TIME) and - * timezone (or lack thereof). - */ void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v) { const char *tzid; @@ -1427,15 +1338,6 @@ void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v) } } -/** @brief Get DTSTART property as an icaltime - * - * If DTSTART is a DATE-TIME with a timezone parameter and a - * corresponding VTIMEZONE is present in the component, the - * returned component will already be in the correct timezone; - * otherwise the caller is responsible for converting it. - * - * FIXME this is useless until we can flag the failure - */ struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp) { icalcomponent *inner = icalcomponent_get_inner(comp); @@ -1449,18 +1351,6 @@ struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp) return icalproperty_get_datetime_with_component(prop, comp); } -/** @brief Get DTEND property as an icaltime - * - * If a DTEND property is not present but a DURATION is, we use - * that to determine the proper end. - * - * If DTSTART is a DATE-TIME with a timezone parameter and a - * corresponding VTIMEZONE is present in the component, the - * returned component will already be in the correct timezone; - * otherwise the caller is responsible for converting it. - * - * FIXME this is useless until we can flag the failure - */ struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp) { icalcomponent *inner = icalcomponent_get_inner(comp); @@ -1488,15 +1378,6 @@ struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp) return ret; } -/** @brief Set DTEND property to given icaltime - * - * This method respects the icaltime type (DATE vs DATE-TIME) and - * timezone (or lack thereof). - * - * This also checks that a DURATION property isn't already there, - * and returns an error if it is. It's the caller's responsibility - * to remove it. - */ void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v) { const char *tzid; @@ -1522,15 +1403,6 @@ void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v) } } -/** @brief Set DURATION property to given icalduration - * - * This method respects the icaltime type (DATE vs DATE-TIME) and - * timezone (or lack thereof). - * - * This also checks that a DTEND property isn't already there, - * and returns an error if it is. It's the caller's responsibility - * to remove it. - */ void icalcomponent_set_duration(icalcomponent *comp, struct icaldurationtype v) { ICALSETUPSET(ICAL_DURATION_PROPERTY); @@ -1548,11 +1420,6 @@ void icalcomponent_set_duration(icalcomponent *comp, struct icaldurationtype v) } } -/** @brief Get DURATION property as an icalduration - * - * If a DURATION property is not present but a DTEND is, we use - * that to determine the proper end. - */ struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp) { icalcomponent *inner = icalcomponent_get_inner(comp); @@ -1989,11 +1856,6 @@ icalcomponent *icalcomponent_new_xpatch(void) * Timezone stuff. */ -/** - * This takes 2 VCALENDAR components and merges the second one into the first, - * resolving any problems with conflicting TZIDs. comp_to_merge will no - * longer exist after calling this function. - */ void icalcomponent_merge_component(icalcomponent *comp, icalcomponent *comp_to_merge) { icalcomponent *subcomp, *next_subcomp; @@ -2239,9 +2101,6 @@ static void icalcomponent_rename_tzids_callback(icalparameter *param, void *data } } -/** - * Calls the given function for each TZID parameter found in the component. - */ void icalcomponent_foreach_tzid(icalcomponent *comp, void (*callback) (icalparameter *param, void *data), void *callback_data) @@ -2279,10 +2138,6 @@ void icalcomponent_foreach_tzid(icalcomponent *comp, } } -/** - * Returns the icaltimezone from the component corresponding to the given - * TZID, or NULL if the component does not have a corresponding VTIMEZONE. - */ icaltimezone *icalcomponent_get_timezone(icalcomponent *comp, const char *tzid) { icaltimezone *zone; @@ -2405,7 +2260,7 @@ static int icalcomponent_compare_vtimezones(icalcomponent *vtimezone1, icalcompo } /** - * @brief set the RELCALID property of a component. + * @brief Sets the RELCALID property of a component. * * @param comp Valid calendar component. * @param v Relcalid URL value @@ -2424,7 +2279,7 @@ void icalcomponent_set_relcalid(icalcomponent *comp, const char *v) } /** - * @brief get the RELCALID property of a component. + * @brief Gets the RELCALID property of a component. * * @param comp Valid calendar component. */ @@ -2451,14 +2306,6 @@ const char *icalcomponent_get_relcalid(icalcomponent *comp) return icalproperty_get_relcalid(prop); } -/** @brief Return the time a TODO task is DUE. - * - * @param comp Valid calendar component. - * - * Uses the DUE: property if it exists, otherwise we calculate the DUE - * value by adding the task's duration to the DTSTART time - */ - struct icaltimetype icalcomponent_get_due(icalcomponent *comp) { icalcomponent *inner = icalcomponent_get_inner(comp); @@ -2481,17 +2328,6 @@ struct icaltimetype icalcomponent_get_due(icalcomponent *comp) return icaltime_null_time(); } -/** @brief Set the due date of a VTODO task. - * - * @param comp Valid VTODO component. - * @param v Valid due date time. - * - * - If no duration or due properties then set the DUE property. - * - If a DUE property is already set, then reset it to the value v. - * - If a DURATION property is already set, then calculate the new - * duration based on the supplied value of v. - */ - void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v) { const char *tzid; diff --git a/src/libical/icalcomponent.h b/src/libical/icalcomponent.h index a755a3ab..5e44fe26 100644 --- a/src/libical/icalcomponent.h +++ b/src/libical/icalcomponent.h @@ -16,11 +16,15 @@ the License at https://www.mozilla.org/MPL/ ======================================================================*/ +/** + * @file icalcomponent.h + */ + #ifndef ICALCOMPONENT_H #define ICALCOMPONENT_H #include "libical_ical_export.h" -#include "icalenums.h" /* defines icalcomponent_kind */ +#include "icalenums.h" /* Defines icalcomponent_kind */ #include "icalproperty.h" #include "pvl.h" @@ -35,16 +39,28 @@ typedef struct icalcompiter } icalcompiter; +/** @brief Constructor + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new(icalcomponent_kind kind); +/** @brief Constructor + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_clone(icalcomponent *component); +/** @brief Constructor + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_from_string(const char *str); +/** @brief Constructor + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...); +/** @brief Constructor + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_x(const char *x_name); +/*** @brief Destructor + */ LIBICAL_ICAL_EXPORT void icalcomponent_free(icalcomponent *component); LIBICAL_ICAL_EXPORT char *icalcomponent_as_ical_string(icalcomponent *component); @@ -71,14 +87,14 @@ LIBICAL_ICAL_EXPORT int icalcomponent_count_properties(icalcomponent *component, icalproperty_kind kind); /** - * Sets the parent icalcomponent for the specified icalproperty @p property. + * @brief Sets the parent icalcomponent for the specified icalproperty @p property. * @since 3.0 */ LIBICAL_ICAL_EXPORT void icalproperty_set_parent(icalproperty *property, icalcomponent *component); /** - * Returns the parent @p icalcomponent for the specified @p icalproperty. + * @brief Returns the parent icalcomponent for the specified @p property. */ LIBICAL_ICAL_EXPORT icalcomponent *icalproperty_get_parent(const icalproperty *property); @@ -94,9 +110,8 @@ LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_next_property(icalcomponent * Working with components */ -/* Return the first VEVENT, VTODO or VJOURNAL sub-component of cop, or +/** Return the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types */ - LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_inner(icalcomponent *comp); LIBICAL_ICAL_EXPORT void icalcomponent_add_component(icalcomponent *parent, icalcomponent *child); @@ -108,9 +123,10 @@ LIBICAL_ICAL_EXPORT int icalcomponent_count_components(icalcomponent *component, icalcomponent_kind kind); /** - This takes 2 VCALENDAR components and merges the second one into the first, - resolving any problems with conflicting TZIDs. comp_to_merge will no - longer exist after calling this function. */ + * This takes 2 VCALENDAR components and merges the second one into the first, + * resolving any problems with conflicting TZIDs. comp_to_merge will no + * longer exist after calling this function. + */ LIBICAL_ICAL_EXPORT void icalcomponent_merge_component(icalcomponent *comp, icalcomponent *comp_to_merge); @@ -146,13 +162,17 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_deref(icalcompiter * i); /* Working with embedded error properties */ LIBICAL_ICAL_EXPORT int icalcomponent_check_restrictions(icalcomponent *comp); -/** Count embedded errors. */ +/** @brief Returns the number of errors encountered parsing the data. + * + * This function counts the number times the X-LIC-ERROR occurs + * in the data structure. + */ LIBICAL_ICAL_EXPORT int icalcomponent_count_errors(icalcomponent *component); -/** Remove all X-LIC-ERROR properties*/ +/** @brief Removes all X-LIC-ERROR properties*/ LIBICAL_ICAL_EXPORT void icalcomponent_strip_errors(icalcomponent *component); -/** Convert some X-LIC-ERROR properties into RETURN-STATUS properties*/ +/** @brief Converts some X-LIC-ERROR properties into RETURN-STATUS properties*/ LIBICAL_ICAL_EXPORT void icalcomponent_convert_errors(icalcomponent *component); /* Internal operations. They are private, and you should not be using them. */ @@ -175,17 +195,47 @@ If the code was in an OO language, the remaining routines would be members of classes derived from icalcomponent. Don't call them on the wrong component subtypes. */ -/** For VCOMPONENT: Return a reference to the first VEVENT, VTODO or - VJOURNAL */ +/** @brief Returns a reference to the first VEVENT, VTODO or + * VJOURNAL in the component. + */ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_first_real_component(icalcomponent *c); -/** For VEVENT, VTODO, VJOURNAL and VTIMEZONE: report the start and end - times of an event in UTC */ +/** @brief Gets the timespan covered by this component, in UTC. + * + * See icalcomponent_foreach_recurrence() for a better way to + * extract spans from an component. + * + * This method can be called on either a VCALENDAR or any real + * component. If the VCALENDAR contains no real component, but + * contains a VTIMEZONE, we return that span instead. + * This might not be a desirable behavior; we keep it for now + * for backward compatibility, but it might be deprecated at a + * future time. + * + * FIXME this API needs to be clarified. DTEND is defined as the + * first available time after the end of this event, so the span + * should actually end 1 second before DTEND. + */ LIBICAL_ICAL_EXPORT struct icaltime_span icalcomponent_get_span(icalcomponent *comp); /******************** Convenience routines **********************/ +/** @brief Sets the DTSTART property to the given icaltime, + * + * This method respects the icaltime type (DATE vs DATE-TIME) and + * timezone (or lack thereof). + */ LIBICAL_ICAL_EXPORT void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v); + +/** @brief Gets the DTSTART property as an icaltime + * + * If DTSTART is a DATE-TIME with a timezone parameter and a + * corresponding VTIMEZONE is present in the component, the + * returned component will already be in the correct timezone; + * otherwise the caller is responsible for converting it. + * + * FIXME this is useless until we can flag the failure + */ LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp); /* For the icalcomponent routines only, dtend and duration are tied @@ -197,21 +247,104 @@ LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstart(icalcomponent be set to ICAL_MALFORMEDDATA_ERROR. If you call a set routine and neither exists, the routine will create the appropriate property. */ +/** @brief Gets the DTEND property as an icaltime. + * + * If a DTEND property is not present but a DURATION is, we use + * that to determine the proper end. + * + * If DTSTART is a DATE-TIME with a timezone parameter and a + * corresponding VTIMEZONE is present in the component, the + * returned component will already be in the correct timezone; + * otherwise the caller is responsible for converting it. + * + * For the icalcomponent routines only, dtend and duration are tied + * together. If you call the get routine for one and the other + * exists, the routine will calculate the return value. That is, if + * there is a DTEND and you call get_duration, the routine will + * return the difference between DTEND and DTSTART. + * + * FIXME this is useless until we can flag the failure + */ LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp); +/** @brief Sets the DTEND property to given icaltime. + * + * This method respects the icaltime type (DATE vs DATE-TIME) and + * timezone (or lack thereof). + * + * This also checks that a DURATION property isn't already there, + * and returns an error if it is. It's the caller's responsibility + * to remove it. + * + * For the icalcomponent routines only, DTEND and DURATION are tied + * together. If you call this routine and DURATION exists, no action + * will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. + * If neither exists, the routine will create the appropriate + * property. + */ LIBICAL_ICAL_EXPORT void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v); +/** @brief Returns the time a VTODO task is DUE. + * + * @param comp Valid calendar component. + * + * Uses the DUE: property if it exists, otherwise we calculate the DUE + * value by adding the task's duration to the DTSTART time. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_due(icalcomponent *comp); +/** @brief Sets the due date of a VTODO task. + * + * @param comp Valid VTODO component. + * @param v Valid due date time. + * + * The DUE and DURATION properties are tied together: + * - If no duration or due properties then sets the DUE property. + * - If a DUE property is already set, then resets it to the value v. + * - If a DURATION property is already set, then calculates the new + * duration based on the supplied value of @p v. + */ LIBICAL_ICAL_EXPORT void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v); +/** @brief Sets the DURATION property to given icalduration. + * + * This method respects the icaltime type (DATE vs DATE-TIME) and + * timezone (or lack thereof). + * + * This also checks that a DTEND property isn't already there, + * and returns an error if it is. It's the caller's responsibility + * to remove it. + * + * For the icalcomponent routines only, DTEND and DURATION are tied + * together. If you call this routine and DTEND exists, no action + * will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. + * If neither exists, the routine will create the appropriate + * property. + */ LIBICAL_ICAL_EXPORT void icalcomponent_set_duration(icalcomponent *comp, struct icaldurationtype v); +/** @brief Gets the DURATION property as an icalduration + * + * For the icalcomponent routines only, DTEND and DURATION are tied + * together. + * If a DURATION property is not present but a DTEND is, we use + * that to determine the proper end. + * + * For the icalcomponent routines only, dtend and duration are tied + * together. If you call the get routine for one and the other + * exists, the routine will calculate the return value. That is, if + * there is a DTEND and you call get_duration, the routine will + * return the difference between DTEND and DTSTART. + */ LIBICAL_ICAL_EXPORT struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp); +/** @brief Sets the METHOD property to the given method. + */ LIBICAL_ICAL_EXPORT void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method); +/** @brief Returns the METHOD property. + */ LIBICAL_ICAL_EXPORT icalproperty_method icalcomponent_get_method(icalcomponent *comp); LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstamp(icalcomponent *comp); @@ -255,22 +388,64 @@ LIBICAL_ICAL_EXPORT void icalcomponent_set_status(icalcomponent *comp, enum ical LIBICAL_ICAL_EXPORT enum icalproperty_status icalcomponent_get_status(icalcomponent *comp); -/** Calls the given function for each TZID parameter found in the - component, and any subcomponents. */ +/** @brief Calls the given function for each TZID parameter found in the + * component, and any subcomponents. + */ LIBICAL_ICAL_EXPORT void icalcomponent_foreach_tzid(icalcomponent *comp, void (*callback) (icalparameter *param, void *data), void *callback_data); -/** Returns the icaltimezone in the component corresponding to the - TZID, or NULL if it can't be found. */ +/** @brief Returns the icaltimezone in the component corresponding to the + * TZID, or NULL if it can't be found. + */ LIBICAL_ICAL_EXPORT icaltimezone *icalcomponent_get_timezone(icalcomponent *comp, const char *tzid); +/** + * @brief Decides if a recurrence is acceptable. + * + * @param comp A valid icalcomponent. + * @param dtstart The base dtstart value for this component. + * @param recurtime The time to test against. + * + * @return true if the recurrence value is excluded, false otherwise. + * + * This function decides if a specific recurrence value is + * excluded by EXRULE or EXDATE properties. + * + * It's not the most efficient code. You might get better performance + * if you assume that recurtime is always increasing for each + * call. Then you could: + * + * - sort the EXDATE values + * - save the state of each EXRULE iterator for the next call. + * + * In this case though you don't need to worry how you call this + * function. It will always return the correct result. + */ LIBICAL_ICAL_EXPORT int icalproperty_recurrence_is_excluded(icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime); +/** + * @brief Cycles through all recurrences of an event. + * + * @param comp A valid VEVENT component + * @param start Ignore timespans before this + * @param end Ignore timespans after this + * @param callback Function called for each timespan within the range + * @param callback_data Pointer passed back to the callback function + * + * This function will call the specified callback function for once + * for the base value of DTSTART, and foreach recurring date/time + * value. + * + * It will filter out events that are specified as an EXDATE or an EXRULE. + * + * @todo We do not filter out duplicate RRULES/RDATES + * @todo We do not handle RDATEs with explicit periods + */ LIBICAL_ICAL_EXPORT void icalcomponent_foreach_recurrence(icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, @@ -280,12 +455,12 @@ LIBICAL_ICAL_EXPORT void icalcomponent_foreach_recurrence(icalcomponent *comp, void *callback_data); /** - * Normalizes (reorders and sorts the properties) the specified icalcomponent @p comp. + * @brief Normalizes (reorders and sorts the properties) the specified icalcomponent @p comp. * @since 3.0 */ LIBICAL_ICAL_EXPORT void icalcomponent_normalize(icalcomponent *comp); -/* +/** * Computes the datetime corresponding to the specified @p icalproperty and @p icalcomponent. * If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE * is present in the component, the returned component will already be in the correct diff --git a/src/libical/icalduration.c b/src/libical/icalduration.c index 034e6d0b..d142c0d5 100644 --- a/src/libical/icalduration.c +++ b/src/libical/icalduration.c @@ -294,7 +294,7 @@ int icaldurationtype_is_null_duration(struct icaldurationtype d) } } -/* in icalvalue_new_from_string_with_error, we should not call +/* In icalvalue_new_from_string_with_error, we should not call icaldurationtype_is_null_duration() to see if there is an error condition. Null duration is perfectly valid for an alarm. We cannot depend on the caller to check icalerrno either, diff --git a/src/libical/icalenums.c b/src/libical/icalenums.c index 42ee7fd2..4e184795 100644 --- a/src/libical/icalenums.c +++ b/src/libical/icalenums.c @@ -77,8 +77,6 @@ static const struct {ICAL_UNKNOWN_STATUS, 0, 0, "Error: Unknown request status"} }; -/*** @brief Return the descriptive text for a request status - */ const char *icalenum_reqstat_desc(icalrequeststatus stat) { int i; @@ -101,8 +99,6 @@ char *icalenum_reqstat_code(icalrequeststatus stat) return buf; } -/*** @brief Return the code for a request status - */ char *icalenum_reqstat_code_r(icalrequeststatus stat) { int i, major, minor; @@ -119,8 +115,6 @@ char *icalenum_reqstat_code_r(icalrequeststatus stat) return NULL; } -/*** @brief Return the major number for a request status - */ short icalenum_reqstat_major(icalrequeststatus stat) { int i; @@ -133,8 +127,6 @@ short icalenum_reqstat_major(icalrequeststatus stat) return -1; } -/*** @brief Return the minor number for a request status - */ short icalenum_reqstat_minor(icalrequeststatus stat) { int i; @@ -147,8 +139,6 @@ short icalenum_reqstat_minor(icalrequeststatus stat) return -1; } -/*** @brief Return a request status for major/minor status numbers - */ icalrequeststatus icalenum_num_to_reqstat(short major, short minor) { int i; diff --git a/src/libical/icalenums.h b/src/libical/icalenums.h index 79884e90..6d3ac09e 100644 --- a/src/libical/icalenums.h +++ b/src/libical/icalenums.h @@ -23,6 +23,8 @@ #include "libical_ical_export.h" +/** @file icalenums.h */ + /*********************************************************************** * Component enumerations **********************************************************************/ @@ -54,7 +56,7 @@ typedef enum icalcomponent_kind ICAL_VCAR_COMPONENT, ICAL_VCOMMAND_COMPONENT, ICAL_XLICINVALID_COMPONENT, - ICAL_XLICMIMEPART_COMPONENT, /* a non-stardard component that mirrors + ICAL_XLICMIMEPART_COMPONENT, /* A non-stardard component that mirrors structure of MIME data */ ICAL_VAVAILABILITY_COMPONENT, ICAL_XAVAILABLE_COMPONENT, @@ -112,16 +114,26 @@ typedef enum icalrequeststatus ICAL_9_0_UNRECOGNIZED_COMMAND } icalrequeststatus; +/** @brief Returns the descriptive text for a request status. + */ LIBICAL_ICAL_EXPORT const char *icalenum_reqstat_desc(icalrequeststatus stat); +/** @brief Returns the major number for a request status + */ LIBICAL_ICAL_EXPORT short icalenum_reqstat_major(icalrequeststatus stat); +/** @brief Returns the minor number for a request status + */ LIBICAL_ICAL_EXPORT short icalenum_reqstat_minor(icalrequeststatus stat); +/** @brief Returns a request status for major/minor status numbers + */ LIBICAL_ICAL_EXPORT icalrequeststatus icalenum_num_to_reqstat(short major, short minor); LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code(icalrequeststatus stat); +/** @brief Returns the code for a request status. + */ LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code_r(icalrequeststatus stat); /*********************************************************************** diff --git a/src/libical/icalerror.h b/src/libical/icalerror.h index aaf6ac1c..7fd1253a 100644 --- a/src/libical/icalerror.h +++ b/src/libical/icalerror.h @@ -74,37 +74,37 @@ LIBICAL_ICAL_EXPORT void icalerror_crash_here(void); */ typedef enum icalerrorenum { - /** No error happened */ + /** No error happened. */ ICAL_NO_ERROR = 0, - /** A bad argument was passed to a function */ + /** A bad argument was passed to a function. */ ICAL_BADARG_ERROR, - /** An error occurred while creating a new object with a `*_new()` routine */ + /** An error occurred while creating a new object with a `*_new()` routine. */ ICAL_NEWFAILED_ERROR, - /** An error occurred while allocating some memory */ + /** An error occurred while allocating some memory. */ ICAL_ALLOCATION_ERROR, - /** Malformed data was passed to a function */ + /** Malformed data was passed to a function. */ ICAL_MALFORMEDDATA_ERROR, - /** An error occurred while parsing part of an iCal component */ + /** An error occurred while parsing part of an iCal component. */ ICAL_PARSE_ERROR, - /** An internal error happened in library code */ + /** An internal error happened in library code. */ ICAL_INTERNAL_ERROR, /* Like assert --internal consist. prob */ - /** An error happened while working with a file */ + /** An error happened while working with a file. */ ICAL_FILE_ERROR, - /** Failure to properly sequence calls to a set of interfaces */ + /** Failure to properly sequence calls to a set of interfaces. */ ICAL_USAGE_ERROR, - /** An unimplemented function was called */ + /** An unimplemented function was called. */ ICAL_UNIMPLEMENTED_ERROR, - /** An unknown error occurred */ + /** An unknown error occurred. */ ICAL_UNKNOWN_ERROR /* Used for problems in input to icalerror_strerror() */ } icalerrorenum; #ifndef _MSC_VER @@ -112,7 +112,7 @@ typedef enum icalerrorenum #endif /** - * @brief Return the current ::icalerrno value + * @brief Returns the current ::icalerrno value * @return A pointer to the current ::icalerrno value * * Yields a pointer to the current ::icalerrno value. This can @@ -194,7 +194,7 @@ LIBICAL_ICAL_EXPORT int icalerror_get_errors_are_fatal(void); #endif /* __GNU_C__ */ /** - * @brief Reset icalerrno to ::ICAL_NO_ERROR + * @brief Resets icalerrno to ::ICAL_NO_ERROR * * ### Usage * ```c @@ -213,21 +213,21 @@ LIBICAL_ICAL_EXPORT void icalerror_clear_errno(void); */ typedef enum icalerrorstate { - /** Fatal */ + /** Fatal. */ ICAL_ERROR_FATAL, - /** Non-fatal */ + /** Non-fatal. */ ICAL_ERROR_NONFATAL, /** Fatal if icalerror_errors_are_fatal(), non-fatal otherwise. */ ICAL_ERROR_DEFAULT, - /** Asked state for an unknown error type */ + /** Asked state for an unknown error type. */ ICAL_ERROR_UNKNOWN } icalerrorstate; /** - * @brief Find description string for error + * @brief Finds the description string for error * @param e The type of error that occurred * @return A string describing the error that occurred * @@ -249,7 +249,7 @@ typedef enum icalerrorstate LIBICAL_ICAL_EXPORT const char *icalerror_strerror(icalerrorenum e); /** - * @brief Return the description string for the current error in ::icalerrno + * @brief Returns the description string for the current error in ::icalerrno * * @par Error handling * If the type of error @a e wasn't found, it returns the description @@ -282,7 +282,7 @@ LIBICAL_ICAL_EXPORT const char *icalerror_perror(void); LIBICAL_ICAL_EXPORT void ical_bt(void); /** - * @brief Set the ::icalerrorstate for a given ::icalerrorenum @a error + * @brief Sets the ::icalerrorstate for a given ::icalerrorenum @a error * @param error The error to change * @param state The new error state of the error * @@ -297,14 +297,14 @@ LIBICAL_ICAL_EXPORT void ical_bt(void); LIBICAL_ICAL_EXPORT void icalerror_set_error_state(icalerrorenum error, icalerrorstate state); /** - * @brief Get the error state (severity) for a given error + * @brief Gets the error state (severity) for a given error * @param error The error to examine * @return Returns the severity of the error */ LIBICAL_ICAL_EXPORT icalerrorstate icalerror_get_error_state(icalerrorenum error); /** - * @brief Read an error from a string + * @brief Reads an error from a string * @param str The error name string * @return An ::icalerrorenum representing the error * @@ -569,7 +569,7 @@ if (!(test)) { \ LIBICAL_ICAL_EXPORT icalerrorstate icalerror_supress(const char *error); /** - * Assign the given error the given icalerrorstate (severity) + * Assigns the given error the given icalerrorstate (severity). * @param error The error in question * @param es The icalerrorstate (severity) to set it to * diff --git a/src/libical/icalmemory.c b/src/libical/icalmemory.c index b35632bc..6c1bd9ca 100644 --- a/src/libical/icalmemory.c +++ b/src/libical/icalmemory.c @@ -27,10 +27,6 @@ the License at https://www.mozilla.org/MPL/ ======================================================================*/ -/** - * @file icalmemory.c - */ - #ifdef HAVE_CONFIG_H #include <config.h> #endif diff --git a/src/libical/icalmemory.h b/src/libical/icalmemory.h index 3af7e38d..7eb7e010 100644 --- a/src/libical/icalmemory.h +++ b/src/libical/icalmemory.h @@ -97,7 +97,7 @@ LIBICAL_ICAL_EXPORT void *icalmemory_tmp_buffer(size_t size); LIBICAL_ICAL_EXPORT char *icalmemory_tmp_copy(const char *str); /** - * @brief Add an externally allocated buffer to the ring. + * @brief Adds an externally allocated buffer to the ring. * @param buf The externally allocated buffer to add to the ring * * Adds an externally allocated buffer to the ring. This ensures that libical @@ -123,7 +123,7 @@ LIBICAL_ICAL_EXPORT char *icalmemory_tmp_copy(const char *str); LIBICAL_ICAL_EXPORT void icalmemory_add_tmp_buffer(void *buf); /** - * @brief Free all memory used in the ring + * @brief Frees all memory used in the ring * * Frees all memory used in the ring. Depending on if ::HAVE_PTHREAD is set or * not, the ring buffer is allocated on a per-thread basis, meaning that if all @@ -231,7 +231,7 @@ LIBICAL_ICAL_EXPORT void icalmemory_free_buffer(void *buf); have memory problems. */ /** - * @brief Append a string to a buffer. + * @brief Appends a string to a buffer. * @param buf The buffer to append the string to. * @param pos The position to append the string at. * @param buf_size The size of the buffer (will be changed if buffer is @@ -272,7 +272,7 @@ LIBICAL_ICAL_EXPORT void icalmemory_append_string(char **buf, char **pos, size_t const char *string); /** - * @brief Append a character to a buffer. + * @brief Appends a character to a buffer. * @param buf The buffer to append the character to. * @param pos The position to append the character at. * @param buf_size The size of the buffer (will be changed if buffer is @@ -313,7 +313,7 @@ LIBICAL_ICAL_EXPORT void icalmemory_append_string(char **buf, char **pos, size_t LIBICAL_ICAL_EXPORT void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch); /** - * @brief Create a duplicate of a string. + * @brief Creates a duplicate of a string. * @param s The string to duplicate. * @return A pointer to a string containing the same data as @a s * diff --git a/src/libical/icalparameter.c b/src/libical/icalparameter.c index 28276da2..f27dc8c7 100644 --- a/src/libical/icalparameter.c +++ b/src/libical/icalparameter.c @@ -175,7 +175,7 @@ char *icalparameter_as_ical_string(icalparameter *param) } /* - * checks whether this character is allowed in a (Q)SAFE-CHAR + * Checks whether this character is allowed in a (Q)SAFE-CHAR * * QSAFE-CHAR = WSP / %x21 / %x23-7E / NON-US-ASCII * ; any character except CTLs and DQUOTE @@ -256,16 +256,14 @@ static void icalparameter_append_encoded_value(char **buf, char **buf_ptr, } } -/** - * Return a string representation of the parameter according to RFC5445/RFC6868. - * - * param = param-name "=" param-value - * param-name = iana-token / x-token - * param-value = paramtext /quoted-string - * paramtext = *SAFE-CHAR - * quoted-string= DQUOTE *QSAFE-CHAR DQUOTE - * QSAFE-CHAR = any character except CTLs and DQUOTE - * SAFE-CHAR = any character except CTLs, DQUOTE. ";", ":", "," +/* + * - param = param-name "=" param-value + * - param-name = iana-token / x-token + * - param-value = paramtext /quoted-string + * - paramtext = *SAFE-CHAR + * - quoted-string= DQUOTE *QSAFE-CHAR DQUOTE + * - QSAFE-CHAR = any character except CTLs and DQUOTE + * - SAFE-CHAR = any character except CTLs, DQUOTE. ";", ":", "," */ char *icalparameter_as_ical_string_r(icalparameter *param) { @@ -423,7 +421,6 @@ icalproperty *icalparameter_get_parent(icalparameter *param) return param->parent; } -/* returns 1 if parameters have same name in ICAL, otherwise 0 */ int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2) { icalparameter_kind kind1; diff --git a/src/libical/icalparameter.h b/src/libical/icalparameter.h index 9f8f667d..57630a22 100644 --- a/src/libical/icalparameter.h +++ b/src/libical/icalparameter.h @@ -95,7 +95,7 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind); LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p); /** - * @brief Create ::icalparameter object from string + * @brief Creates new ::icalparameter object from string * @param value The string from which to create the ::icalparameter, in the form `"PARAMNAME=VALUE"` * @return An ::icalparameter that corresponds to the given string. * @@ -123,7 +123,7 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p); LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value); /** - * @brief Create ::icalparameter of a given @a kind with a given @a value + * @brief Creates new ::icalparameter of a given @a kind with a given @a value * @param kind The kind of ::icalparameter to create * @param value The value of the parameter * @return An ::icalparameter with the given kind and value. @@ -176,7 +176,7 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparam LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter); /** - * @brief Convert ::icalparameter into an string representation + * @brief Converts ::icalparameter into a string representation * @param parameter The ::icalparameter to convert * @return A string representing the parameter according to RFC5445/RFC6868. * @sa icalparameter_as_ical_string_r() @@ -208,9 +208,9 @@ LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter); LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter); /** - * @brief Convert ::icalparameter into an string representation + * @brief Converts ::icalparameter into an string representation according to RFC5445/RFC6868. * @param parameter The ::icalparameter to convert - * @return A string representing the parameter according to RFC5445/RFC6868. + * @return A string representing the parameter * @sa icalparameter_as_ical_string() * * @par Error handling @@ -265,12 +265,12 @@ LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *paramete LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(icalparameter *parameter); /** - * Determine if the given param is an icalparameter + * Determines if the given param is an icalparameter * @param param The libical-originated object to check * @return 1 if the object is an icalparameter, 0 otherwise. * @note This function expects to be given an object originating from * libical - if this function is passed anything that is not from - * libical, it's behavior is undefined. + * libical, its behavior is undefined. * * @b Error handling * When given a `NULL` object, it returns 0. @@ -571,7 +571,7 @@ LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, icalp /** * @brief Returns a string representing the given ::icalparameter_kind * @param kind The icalparameter_kind - * @return A string representing kind + * @return A string representing @a kind * * @par Error handling * When passed a non-existing ::icalparameter_kind, it returns `NULL`. @@ -615,7 +615,7 @@ LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char * /** * @brief Checks the validity of a ::icalparameter_kind * @param kind The icalparameter_kind - * @return 1 if if the kind is valid, 0 otherwise + * @return 1 if @a kind is valid, 0 otherwise * * ### Usage * ```c diff --git a/src/libical/icalparser.c b/src/libical/icalparser.c index e84869c8..3bc3d5f6 100644 --- a/src/libical/icalparser.c +++ b/src/libical/icalparser.c @@ -169,7 +169,7 @@ static char *parser_get_next_char(char c, char *str, int qm) return 0; } -/** make a new tmp buffer out of a substring */ +/** Makes a new tmp buffer out of a substring. */ static char *make_segment(char *start, char *end) { char *buf, *tmp; @@ -213,7 +213,7 @@ static char *parser_get_prop_name(char *line, char **end) return str; } -/* Decode parameter value per RFC6868 */ +/** Decode parameter value per RFC6868 */ static void parser_decode_param_value(char *value) { char *in, *out; @@ -473,10 +473,6 @@ static char *parser_get_next_parameter(char *line, char **end) } } -/** - * Get a single property line, from the property name through the - * final new line, and include any continuation lines - */ char *icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func) { diff --git a/src/libical/icalparser.h b/src/libical/icalparser.h index 867fd297..765f7730 100644 --- a/src/libical/icalparser.h +++ b/src/libical/icalparser.h @@ -60,13 +60,13 @@ typedef enum icalparser_state /** Parsing was successful. */ ICALPARSER_SUCCESS, - /** Currently parsing the begin of a component */ + /** Currently parsing the begin of a component. */ ICALPARSER_BEGIN_COMP, - /** Currently parsing the end of the component */ + /** Currently parsing the end of the component. */ ICALPARSER_END_COMP, - /** Parsing is currently in progress */ + /** Parsing is currently in progress. */ ICALPARSER_IN_PROGRESS } icalparser_state; @@ -284,7 +284,7 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse(icalparser *parser, LIBICAL_ICAL_EXPORT void icalparser_set_gen_data(icalparser *parser, void *data); /** - * @brief Parse a string and return the parsed ::icalcomponent. + * @brief Parses a string and returns the parsed ::icalcomponent. * @param str The iCal formatted data to be parsed * @return An ::icalcomponent representing the iCalendar * @@ -317,8 +317,8 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str); ***********************************************************************/ /** - * @brief Given a line generator function, return a single iCal content line. - * @return Aa pointer to a single line of data or `NULL` if it reached + * @brief Given a line generator function, returns a single iCal content line. + * @return A pointer to a single line of data or `NULL` if it reached * end of file reading from the @a line_gen_func. Note that the pointer * returned is owned by libical and must not be `free()`d by the user. * @param parser The parser object to use @@ -326,6 +326,7 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str); * * This function uses the supplied @a line_gen_func to read data in, * until it has read a full line, and returns the full line. + * It includes any continuation lines, which start with a space after a newline. * To supply arbitrary data (as the parameter @a d) to your @a line_gen_func, * call icalparser_set_gen_data(). */ diff --git a/src/libical/icalperiod.h b/src/libical/icalperiod.h index 5c62ebc6..6f2be741 100644 --- a/src/libical/icalperiod.h +++ b/src/libical/icalperiod.h @@ -148,6 +148,7 @@ LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void); /** * Checks if a given ::icalperiodtype is a null period. + * @param p The time period to check * @return 1 if @a p is a null period, 0 otherwise * @sa icalperiodtype_null_period() * @@ -164,6 +165,7 @@ LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p); /** * Checks if a given ::icalperiodtype is a valid period. + * @param p The time period to check * @return 1 if @a p is a valid period, 0 otherwise * * ### Usage diff --git a/src/libical/icalproperty.c b/src/libical/icalproperty.c index d5f0c502..a62dcdf3 100644 --- a/src/libical/icalproperty.c +++ b/src/libical/icalproperty.c @@ -625,16 +625,6 @@ char *icalproperty_get_parameter_as_string_r(icalproperty *prop, const char *nam return str; } -/** @brief Remove all parameters with the specified kind. - * - * @param prop A valid icalproperty. - * @param kind The kind to remove (ex. ICAL_TZID_PARAMETER) - * - * See icalproperty_remove_parameter_by_name() and - * icalproperty_remove_parameter_by_ref() for alternate ways of - * removing parameters - */ - void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kind kind) { pvl_elem p; @@ -652,20 +642,6 @@ void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kin } } -/** @brief Remove all parameters with the specified name. - * - * @param prop A valid icalproperty. - * @param name The name of the parameter to remove - * - * This function removes parameters with the given name. The name - * corresponds to either a built-in name (TZID, etc.) or the name of - * an extended parameter (X-FOO) - * - * See icalproperty_remove_parameter_by_kind() and - * icalproperty_remove_parameter_by_ref() for alternate ways of removing - * parameters - */ - void icalproperty_remove_parameter_by_name(icalproperty *prop, const char *name) { pvl_elem p; @@ -695,15 +671,6 @@ void icalproperty_remove_parameter_by_name(icalproperty *prop, const char *name) } } -/** @brief Remove the specified parameter reference from the property. - * - * @param prop A valid icalproperty. - * @param parameter A reference to a specific icalparameter. - * - * This function removes the specified parameter reference from the - * property. - */ - void icalproperty_remove_parameter_by_ref(icalproperty *prop, icalparameter *parameter) { pvl_elem p; @@ -1072,7 +1039,7 @@ void icalproperty_normalize(icalproperty *prop) prop->parameters = sorted_params; } -/** @brief Get a DATE or DATE-TIME property as an icaltime +/** @brief Gets a DATE or DATE-TIME property as an icaltime * * If the property is a DATE-TIME with a TZID parameter and a * corresponding VTIMEZONE is present in the component, the diff --git a/src/libical/icalproperty.h b/src/libical/icalproperty.h index de81270f..f4411cf6 100644 --- a/src/libical/icalproperty.h +++ b/src/libical/icalproperty.h @@ -24,6 +24,8 @@ #include <stdarg.h> /* for va_... */ +/** @file icalproperty.h */ + LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new(icalproperty_kind kind); LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_impl(icalproperty_kind kind); @@ -57,12 +59,42 @@ LIBICAL_ICAL_EXPORT const char *icalproperty_get_parameter_as_string(icalpropert LIBICAL_ICAL_EXPORT char *icalproperty_get_parameter_as_string_r(icalproperty *prop, const char *name); +/** @brief Removes all parameters with the specified kind. + * + * @param prop A valid icalproperty. + * @param kind The kind to remove (ex. ICAL_TZID_PARAMETER) + * + * See icalproperty_remove_parameter_by_name() and + * icalproperty_remove_parameter_by_ref() for alternate ways of + * removing parameters + */ LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kind kind); +/** @brief Removes all parameters with the specified name. + * + * @param prop A valid icalproperty. + * @param name The name of the parameter to remove + * + * This function removes parameters with the given name. The name + * corresponds to either a built-in name (TZID, etc.) or the name of + * an extended parameter (X-FOO) + * + * See icalproperty_remove_parameter_by_kind() and + * icalproperty_remove_parameter_by_ref() for alternate ways of removing + * parameters + */ LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_name(icalproperty *prop, const char *name); +/** @brief Removes the specified parameter reference from the property. + * + * @param prop A valid icalproperty. + * @param parameter A reference to a specific icalparameter. + * + * This function removes the specified parameter reference from the + * property. + */ LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_ref(icalproperty *prop, icalparameter *param); @@ -98,7 +130,7 @@ LIBICAL_ICAL_EXPORT icalproperty *icalvalue_get_parent(icalvalue *value); LIBICAL_ICAL_EXPORT void icalproperty_set_x_name(icalproperty *prop, const char *name); LIBICAL_ICAL_EXPORT const char *icalproperty_get_x_name(icalproperty *prop); -/** Return the name of the property -- the type name converted to a +/** Returns the name of the property -- the type name converted to a * string, or the value of _get_x_name if the type is and X * property */ diff --git a/src/libical/icalproperty_cxx.cpp b/src/libical/icalproperty_cxx.cpp index b30b54b2..fd2a7e48 100644 --- a/src/libical/icalproperty_cxx.cpp +++ b/src/libical/icalproperty_cxx.cpp @@ -167,7 +167,7 @@ std::string ICalProperty::get_value_as_string() return static_cast<std::string>(icalproperty_get_value_as_string(imp)); } -/** Return the name of the property -- the type name converted to a +/** Returns the name of the property -- the type name converted to a * string, or the value of get_x_name if the type is X property */ std::string ICalProperty::get_name() const diff --git a/src/libical/icalproperty_cxx.h b/src/libical/icalproperty_cxx.h index a13ac14d..e243dd2e 100644 --- a/src/libical/icalproperty_cxx.h +++ b/src/libical/icalproperty_cxx.h @@ -81,7 +81,7 @@ public: ICalValue *get_value(); std::string get_value_as_string(); - /** Return the name of the property -- the type name converted + /** Returns the name of the property -- the type name converted * to a string, or the value of get_x_name if the type is X * property */ diff --git a/src/libical/icalrecur.c b/src/libical/icalrecur.c index 73178450..38ee2bb3 100644 --- a/src/libical/icalrecur.c +++ b/src/libical/icalrecur.c @@ -17,7 +17,7 @@ ========================================================================*/ /** - @file icalrecur.c + icalrecur.c @brief Implementation of routines for dealing with recurring time How this code works: @@ -985,7 +985,7 @@ static void setup_defaults(icalrecur_iterator *impl, } } -/* Calculate the number of Gregorian months between 2 dates */ +/** Calculate the number of Gregorian months between 2 dates */ static int __greg_month_diff(icaltimetype a, icaltimetype b) { return (12 * (b.year - a.year) + (b.month - a.month)); @@ -1464,7 +1464,7 @@ static int initialize_rscale(icalrecur_iterator *impl) return 1; } -/* Set Gregorian date and convert to RSCALE */ +/** Sets the Gregorian date and convert to RSCALE */ static void set_datetime(icalrecur_iterator *impl, icaltimetype date) { UErrorCode status = U_ZERO_ERROR; @@ -1497,7 +1497,7 @@ static void set_datetime(icalrecur_iterator *impl, icaltimetype date) } } -/* Calculate the number of RSCALE months between 2 dates */ +/** Calculate the number of RSCALE months between 2 dates */ static int month_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) { int diff; @@ -1528,7 +1528,7 @@ static int month_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) return diff; } -/* Calculate the number of RSCALE days between 2 dates */ +/** Calculate the number of RSCALE days between 2 dates */ static int day_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) { UErrorCode status = U_ZERO_ERROR; @@ -1613,7 +1613,7 @@ static int get_day_of_week(icalrecur_iterator *impl) return icaltime_day_of_week(impl->last); } -/* Calculate ISO weeks per year +/** Calculate ISO weeks per year https://en.wikipedia.org/wiki/ISO_week_date#Weeks_per_year */ static int weeks_in_year(int year) { @@ -1624,7 +1624,7 @@ static int weeks_in_year(int year) return (52 + is_long); } -/* Calculate ISO week number +/** Calculate ISO week number https://en.wikipedia.org/wiki/ISO_week_date#Calculation */ static int get_week_number(icalrecur_iterator *impl, struct icaltimetype tt) { @@ -1759,7 +1759,7 @@ static int initialize_rscale(icalrecur_iterator *impl) return 1; } -/* Set Gregorian date */ +/** Sets the Gregorian date */ static void set_datetime(icalrecur_iterator *impl, icaltimetype date) { impl->last.year = date.year; @@ -1778,7 +1778,7 @@ static void set_datetime(icalrecur_iterator *impl, icaltimetype date) } } -/* Calculate the number of Gregorian months between 2 dates */ +/** Calculate the number of Gregorian months between 2 dates */ static int month_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) { _unused(impl); @@ -1786,7 +1786,7 @@ static int month_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) return __greg_month_diff(a, b); } -/* Calculate the number of Gregorian days between 2 dates */ +/** Calculate the number of Gregorian days between 2 dates */ static int day_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) { return __day_diff(impl, a, b); @@ -1957,7 +1957,7 @@ void icalrecur_iterator_free(icalrecur_iterator *i) free(i); } -/* Calculate the number of days between 2 dates */ +/** Calculate the number of days between 2 dates */ static int __day_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) { int diff; @@ -1995,7 +1995,7 @@ static int __day_diff(icalrecur_iterator *impl, icaltimetype a, icaltimetype b) return diff; } -/** Increment month is different that the other increment_* routines -- +/** increment_month is different than the other increment_* routines -- it figures out the interval for itself, and uses BYMONTH data if available. */ static void increment_month(icalrecur_iterator *impl) @@ -2220,7 +2220,7 @@ static int check_set_position(icalrecur_iterator *impl, int set_pos) return found; } -/* Add each BYMONTHDAY to the year days bitmask */ +/** Add each BYMONTHDAY to the year days bitmask */ static int expand_bymonth_days(icalrecur_iterator *impl, int year, int month) { int i, set_pos_total = 0; @@ -2276,7 +2276,7 @@ static int expand_bymonth_days(icalrecur_iterator *impl, int year, int month) return set_pos_total; } -/* Expand the BYDAY rule part and apply it to the year days map. */ +/** Expand the BYDAY rule part and apply it to the year days map. */ static int expand_by_day(icalrecur_iterator *impl, int year, int doy_offset, int last_day, int first_dow, int last_dow, @@ -2372,7 +2372,7 @@ static int expand_by_day(icalrecur_iterator *impl, int year, return set_pos_total; } -/* "Filter" the year days bitmask with each BYSETPOS */ +/** "Filter" the year days bitmask with each BYSETPOS */ static void filter_bysetpos(icalrecur_iterator *impl, int pos_total, int start_doy, int end_doy) { @@ -2396,7 +2396,7 @@ static void filter_bysetpos(icalrecur_iterator *impl, int pos_total, } } -/* For INTERVAL=MONTHLY, set up the year days bitmask in the iterator to +/** For INTERVAL=MONTHLY, set up the year days bitmask in the iterator to list all of the days of the current month that are specified in this rule. */ static int expand_month_days(icalrecur_iterator *impl, int year, int month) @@ -2476,7 +2476,7 @@ static int next_weekday_by_week(icalrecur_iterator *impl) end_of_data = 1; /* Signal that we're at the end */ } - /* Add the day of week offset to to the start of this week, and use + /* Add the day of week offset to the start of this week, and use that to get the next day */ /* ignore position of dow ("4FR"), only use dow ("FR") */ dow = icalrecurrencetype_day_day_of_week(BYDAYPTR[BYDAYIDX]); @@ -2522,7 +2522,7 @@ static int next_week(icalrecur_iterator *impl) return end_of_data; } -/* For INTERVAL=YEARLY, set up the year days bitmask in the iterator to +/** For INTERVAL=YEARLY, set up the year days bitmask in the iterator to list all of the days of the current year that are specified in this rule. */ static int expand_year_days(icalrecur_iterator *impl, int year) @@ -3042,17 +3042,6 @@ void icalrecurrencetype_clear(struct icalrecurrencetype *recur) recur->skip = ICAL_SKIP_OMIT; } -/** The 'day' element of icalrecurrencetype_weekday is encoded to - * allow representation of both the day of the week ( Monday, Tuesday), - * but also the Nth day of the week ( First tuesday of the month, last - * thursday of the year) These routines decode the day values. - * - * The day's position in the period ( Nth-ness) and the numerical - * value of the day are encoded together as: pos*7 + dow - * - * A position of 0 means 'any' or 'every' - */ - enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day) { return abs(day) % 8; @@ -3069,12 +3058,12 @@ int icalrecurrencetype_day_position(short day) return pos; } -/** +/* * The 'month' element of the by_month array is encoded to allow * representation of the "L" leap suffix (RFC 7529). * These routines decode the month values. * - * The "L" suffix is encoded by setting a high-order bit + * The "L" suffix is encoded by setting a high-order bit. */ int icalrecurrencetype_month_is_leap(short month) @@ -3087,12 +3076,6 @@ int icalrecurrencetype_month_month(short month) return (month & ~LEAP_MONTH); } -/** Fill an array with the 'count' number of occurrences generated by - * the rrule. Note that the times are returned in UTC, but the times - * are calculated in local time. YOu will have to convert the results - * back into local time before using them. - */ - int icalrecur_expand_recurrence(const char *rule, time_t start, int count, time_t *array) { diff --git a/src/libical/icalrecur.h b/src/libical/icalrecur.h index ae11a9ae..65b50e50 100644 --- a/src/libical/icalrecur.h +++ b/src/libical/icalrecur.h @@ -58,7 +58,7 @@ Or, just make them up: } @endcode -Note that that the time returned by icalrecur_iterator_next is in +Note that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in. */ @@ -172,11 +172,27 @@ struct icalrecurrencetype short by_second[ICAL_BY_SECOND_SIZE]; short by_minute[ICAL_BY_MINUTE_SIZE]; short by_hour[ICAL_BY_HOUR_SIZE]; - short by_day[ICAL_BY_DAY_SIZE]; /* Encoded value, see below */ + short by_day[ICAL_BY_DAY_SIZE]; /**< @brief Encoded value + * + * The 'day' element of the by_day array is encoded to allow + * representation of both the day of the week ( Monday, Tueday), but + * also the Nth day of the week (first Tuesday of the month, last + * Thursday of the year). + * + * These values are decoded by icalrecurrencetype_day_day_of_week() and + * icalrecurrencetype_day_position(). + */ short by_month_day[ICAL_BY_MONTHDAY_SIZE]; short by_year_day[ICAL_BY_YEARDAY_SIZE]; short by_week_no[ICAL_BY_WEEKNO_SIZE]; - short by_month[ICAL_BY_MONTH_SIZE]; + short by_month[ICAL_BY_MONTH_SIZE]; /**< @brief Encoded value + * + * The 'month' element of the by_month array is encoded to allow + * representation of the "L" leap suffix (RFC 7529). + * + * These values are decoded by icalrecurrencetype_month_is_leap() + * and icalrecurrencetype_month_month(). + */ short by_set_pos[ICAL_BY_SETPOS_SIZE]; /* For RSCALE extension (RFC 7529) */ @@ -190,32 +206,44 @@ LIBICAL_ICAL_EXPORT icalarray *icalrecurrencetype_rscale_supported_calendars(voi LIBICAL_ICAL_EXPORT void icalrecurrencetype_clear(struct icalrecurrencetype *r); -/** - * Array Encoding - * - * The 'day' element of the by_day array is encoded to allow - * representation of both the day of the week ( Monday, Tueday), but also - * the Nth day of the week ( First tuesday of the month, last thursday of - * the year) These routines decode the day values +/* + * Routines to decode the day values of the by_day array */ -/** 1 == Monday, etc. */ +/** @brief Decodes a day to a weekday. + * + * @returns The decoded day of the week. 1 is Monday, 2 is Tuesday, etc. + * A position of 0 means 'any' or 'every'. + * + * The 'day' element of icalrecurrencetype_weekday is encoded to + * allow representation of both the day of the week ( Monday, Tuesday), + * but also the Nth day of the week ( First tuesday of the month, last + * thursday of the year) These routines decode the day values. + * + * The day's position in the period ( Nth-ness) and the numerical + * value of the day are encoded together as: pos*7 + dow. + */ LIBICAL_ICAL_EXPORT enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day); -/** 0 == any of day of week. 1 == first, 2 = second, -2 == second to last, etc */ +/** @brief Decodes a day to a position of the weekday. + * + * @returns The position of the day in the week. + * 0 == any of day of week. 1 == first, 2 = second, -2 == second to last, etc. + * 0 means 'any' or 'every'. + */ LIBICAL_ICAL_EXPORT int icalrecurrencetype_day_position(short day); -/** - * The 'month' element of the by_month array is encoded to allow - * representation of the "L" leap suffix (RFC 7529). - * These routines decode the month values. +/* + * Routines to decode the 'month' element of the by_month array */ LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_is_leap(short month); LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_month(short month); -/** Recurrance rule parser */ +/* + * Recurrence rule parser + */ /** Convert between strings and recurrencetype structures. */ LIBICAL_ICAL_EXPORT struct icalrecurrencetype icalrecurrencetype_from_string(const char *str); @@ -224,11 +252,13 @@ LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string(struct icalrecurrencetype LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string_r(struct icalrecurrencetype *recur); -/** Recurrence iteration routines */ +/* + * Recurrence iteration routines + */ typedef struct icalrecur_iterator_impl icalrecur_iterator; -/** Create a new recurrence rule iterator, starting at DTSTART */ +/** Creates a new recurrence rule iterator, starting at DTSTART. */ LIBICAL_ICAL_EXPORT icalrecur_iterator *icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart); @@ -242,15 +272,21 @@ LIBICAL_ICAL_EXPORT icalrecur_iterator *icalrecur_iterator_new(struct icalrecurr LIBICAL_ICAL_EXPORT int icalrecur_iterator_set_start(icalrecur_iterator *impl, struct icaltimetype start); -/** Get the next occurrence from an iterator */ +/** Gets the next occurrence from an iterator. */ LIBICAL_ICAL_EXPORT struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *); -/** Free the iterator */ +/** Frees the iterator. */ LIBICAL_ICAL_EXPORT void icalrecur_iterator_free(icalrecur_iterator *); -/** - * Fills array up with at most 'count' time_t values, each - * representing an occurrence time in seconds past the POSIX epoch +/** @brief Fills an array with the 'count' number of occurrences generated by + * the rrule. + * + * Specifically, this fills @p array up with at most 'count' time_t values, each + * representing an occurrence time in seconds past the POSIX epoch. + * + * Note that the times are returned in UTC, but the times + * are calculated in local time. You will have to convert the results + * back into local time before using them. */ LIBICAL_ICAL_EXPORT int icalrecur_expand_recurrence(const char *rule, time_t start, int count, time_t *array); diff --git a/src/libical/icalrestriction.h b/src/libical/icalrestriction.h index ede9137e..38751efc 100644 --- a/src/libical/icalrestriction.h +++ b/src/libical/icalrestriction.h @@ -41,31 +41,31 @@ */ typedef enum icalrestriction_kind { - /** No restriction */ + /** No restriction. */ ICAL_RESTRICTION_NONE = 0, /* 0 */ - /** Zero */ + /** Zero. */ ICAL_RESTRICTION_ZERO, /* 1 */ - /** One */ + /** One. */ ICAL_RESTRICTION_ONE, /* 2 */ - /** Zero or more */ + /** Zero or more. */ ICAL_RESTRICTION_ZEROPLUS, /* 3 */ - /** One or more */ + /** One or more. */ ICAL_RESTRICTION_ONEPLUS, /* 4 */ - /** Zero or one */ + /** Zero or one. */ ICAL_RESTRICTION_ZEROORONE, /* 5 */ - /** Zero or one, exclusive with another property */ + /** Zero or one, exclusive with another property. */ ICAL_RESTRICTION_ONEEXCLUSIVE, /* 6 */ - /** Zero or one, mutual with another property */ + /** Zero or one, mutual with another property. */ ICAL_RESTRICTION_ONEMUTUAL, /* 7 */ - /** Unknown */ + /** Unknown. */ ICAL_RESTRICTION_UNKNOWN /* 8 */ } icalrestriction_kind; diff --git a/src/libical/icaltime.c b/src/libical/icaltime.c index e5c6284c..aaea998c 100644 --- a/src/libical/icaltime.c +++ b/src/libical/icaltime.c @@ -180,30 +180,6 @@ static time_t make_time(struct tm *tm, int tzm) return (tim); } -/** @brief Constructor. - * - * @param tm The time - * @param is_date Boolean: 1 means we should treat tm as a DATE - * @param zone The timezone tm is in, NULL means to treat tm as a - * floating time - * - * Return a new icaltime instance, initialized to the given time - * expressed as seconds past UNIX epoch, optionally using the given - * timezone. - * - * If the caller specifies the is_date param as TRUE, the returned - * object is of DATE type, otherwise the input is meant to be of - * DATE-TIME type. - * If the zone is not specified (NULL zone param) the time is taken - * to be floating, that is, valid in any timezone. Note that, in - * addition to the uses specified in [RFC5545], this can be used - * when doing simple math on couples of times. - * If the zone is specified (UTC or otherwise), it's stored in the - * object and it's used as the native timezone for this object. - * This means that the caller can convert this time to a different - * target timezone with no need to store the source timezone. - * - */ struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_date, const icaltimezone *zone) { @@ -242,19 +218,11 @@ struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_ return tt; } -/** @brief Convenience constructor. - * - * Returns the current time in the given timezone, as an icaltimetype. - */ struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone) { return icaltime_from_timet_with_zone(time(NULL), 0, zone); } -/** @brief Convenience constructor. - * - * Returns the current day as an icaltimetype, with is_date set. - */ struct icaltimetype icaltime_today(void) { return icaltime_from_timet_with_zone(time(NULL), 1, NULL); @@ -291,14 +259,6 @@ time_t icaltime_as_timet(const struct icaltimetype tt) return t; } -/** Return the time as seconds past the UNIX epoch, using the - * given timezone. - * - * This convenience method combines a call to icaltime_convert_to_zone() - * with a call to icaltime_as_timet(). - * If the input timezone is null, no conversion is done; that is, the - * time is simply returned as time_t in its native timezone. - */ time_t icaltime_as_timet_with_zone(const struct icaltimetype tt, const icaltimezone *zone) { icaltimezone *utc_zone; @@ -337,10 +297,6 @@ time_t icaltime_as_timet_with_zone(const struct icaltimetype tt, const icaltimez return t; } -/** - * Return a string represention of the time, in RFC5545 format. The - * string is owned by libical. - */ const char *icaltime_as_ical_string(const struct icaltimetype tt) { char *buf; @@ -350,10 +306,6 @@ const char *icaltime_as_ical_string(const struct icaltimetype tt) return buf; } -/** - * Return a string represention of the time, in RFC5545 format. The - * string is owned by the caller. - */ char *icaltime_as_ical_string_r(const struct icaltimetype tt) { size_t size = 17; @@ -375,15 +327,7 @@ char *icaltime_as_ical_string_r(const struct icaltimetype tt) return buf; } -/** - * Reset all of the time components to be in their normal ranges. For - * instance, given a time with minutes=70, the minutes will be reduces - * to 10, and the hour incremented. This allows the caller to do - * arithmetic on times without worrying about overflow or - * underflow. - * - * Implementation note: we call icaltime_adjust() with no adjustment. - */ +/* Implementation note: we call icaltime_adjust() with no adjustment. */ struct icaltimetype icaltime_normalize(const struct icaltimetype tt) { struct icaltimetype ret = tt; @@ -392,15 +336,6 @@ struct icaltimetype icaltime_normalize(const struct icaltimetype tt) return ret; } -/** @brief Contructor. - * - * Create a time from an ISO format string. - * - * @todo If the given string specifies a DATE-TIME not in UTC, there - * is no way to know if this is a floating time or really refers to a - * timezone. We should probably add a new constructor: - * icaltime_from_string_with_zone() - */ struct icaltimetype icaltime_from_string(const char *str) { struct icaltimetype tt = icaltime_null_time(); @@ -477,8 +412,6 @@ struct icaltimetype icaltime_from_string(const char *str) return icaltime_null_time(); } -/* Returns whether the specified year is a leap year. Year is the normal year, - e.g. 2001. */ int icaltime_is_leap_year(const int year) { if (year <= 1752) { @@ -541,8 +474,6 @@ int icaltime_day_of_week(const struct icaltimetype t) return jt.weekday + 1; } -/** Day of the year that the first day of the week (Sunday) is on. - */ int icaltime_start_doy_week(const struct icaltimetype t, int fdow) { UTinstant jt; @@ -567,10 +498,6 @@ int icaltime_start_doy_week(const struct icaltimetype t, int fdow) return jt.day_of_year - delta; } -/** - * @todo Doesn't take into account the start day of the - * week. strftime assumes that weeks start on Monday. - */ int icaltime_week_number(const struct icaltimetype ictt) { UTinstant jt; @@ -590,9 +517,6 @@ int icaltime_week_number(const struct icaltimetype ictt) return (jt.day_of_year - jt.weekday) / 7; } -/** - * Returns the day of the year, counting from 1 (Jan 1st). - */ int icaltime_day_of_year(const struct icaltimetype t) { int is_leap = icaltime_is_leap_year(t.year); @@ -600,11 +524,6 @@ int icaltime_day_of_year(const struct icaltimetype t) return days_in_year_passed_month[is_leap][t.month - 1] + t.day; } -/** @brief Contructor. - * - * Create a new time, given a day of year and a year. - */ -/* Jan 1 is day #1, not 0 */ struct icaltimetype icaltime_from_day_of_year(const int _doy, const int _year) { struct icaltimetype tt = icaltime_null_date(); @@ -640,11 +559,6 @@ struct icaltimetype icaltime_from_day_of_year(const int _doy, const int _year) return tt; } -/** @brief Constructor. - * - * Return a null time, which indicates no time has been set. - * This time represents the beginning of the epoch. - */ struct icaltimetype icaltime_null_time(void) { struct icaltimetype t; @@ -654,10 +568,6 @@ struct icaltimetype icaltime_null_time(void) return t; } -/** @brief Constructor. - * - * Return a null date, which indicates no time has been set. - */ struct icaltimetype icaltime_null_date(void) { struct icaltimetype t; @@ -677,11 +587,6 @@ struct icaltimetype icaltime_null_date(void) return t; } -/** - * Returns false if the time is clearly invalid, but is not null. This - * is usually the result of creating a new time type buy not clearing - * it, or setting one of the flags to an illegal value. - */ int icaltime_is_valid_time(const struct icaltimetype t) { if (t.year < 0 || t.year > 3000 || t.is_date > 1 || t.is_date < 0) { @@ -691,25 +596,16 @@ int icaltime_is_valid_time(const struct icaltimetype t) } } -/** @brief Returns true if time is a DATE - */ int icaltime_is_date(const struct icaltimetype t) { return t.is_date; } -/** @brief Returns true if time is relative to UTC zone - * - * @todo We should only check the zone - */ int icaltime_is_utc(const struct icaltimetype t) { return t.zone == icaltimezone_get_utc_timezone(); } -/** - * Return true if the time is null. - */ int icaltime_is_null_time(const struct icaltimetype t) { if (t.second + t.minute + t.hour + t.day + t.month + t.year == 0) { @@ -719,12 +615,6 @@ int icaltime_is_null_time(const struct icaltimetype t) return 0; } -/** - * Return -1, 0, or 1 to indicate that a<b, a==b, or a>b. - * This calls icaltime_compare function after converting them to the utc - * timezone. - */ - int icaltime_compare(const struct icaltimetype a_in, const struct icaltimetype b_in) { struct icaltimetype a, b; @@ -780,10 +670,6 @@ int icaltime_compare(const struct icaltimetype a_in, const struct icaltimetype b return 0; } -/** - * like icaltime_compare, but only use the date parts. - */ - int icaltime_compare_date_only(const struct icaltimetype a_in, const struct icaltimetype b_in) { @@ -814,10 +700,6 @@ int icaltime_compare_date_only(const struct icaltimetype a_in, return 0; } -/** - * like icaltime_compare, but only use the date parts; accepts timezone. - */ - int icaltime_compare_date_only_tz(const struct icaltimetype a_in, const struct icaltimetype b_in, icaltimezone *tz) @@ -855,12 +737,6 @@ struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2) */ -/** @brief Internal, shouldn't be part of the public API - * - * Adds (or subtracts) a time from a icaltimetype. - * NOTE: This function is exactly the same as icaltimezone_adjust_change() - * except for the type of the first parameter. - */ void icaltime_adjust(struct icaltimetype *tt, const int days, const int hours, const int minutes, const int seconds) @@ -946,16 +822,6 @@ void icaltime_adjust(struct icaltimetype *tt, tt->day = day; } -/** @brief Convert time to a given timezone - * - * Convert a time from its native timezone to a given timezone. - * - * If tt is a date, the returned time is an exact - * copy of the input. If it's a floating time, the returned object - * represents the same time translated to the given timezone. - * Otherwise the time will be converted to the new - * time zone, and its native timezone set to the right timezone. - */ struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt, icaltimezone *zone) { struct icaltimetype ret = tt; @@ -999,12 +865,6 @@ const char *icaltime_get_tzid(const struct icaltimetype t) } } -/** @brief Set the timezone - * - * Force the icaltime to be interpreted relative to another timezone. - * If you need to do timezone conversion, applying offset adjustments, - * then you should use icaltime_convert_to_zone instead. - */ struct icaltimetype icaltime_set_timezone(struct icaltimetype *t, const icaltimezone *zone) { /* If it's a date do nothing */ @@ -1021,18 +881,6 @@ struct icaltimetype icaltime_set_timezone(struct icaltimetype *t, const icaltime return *t; } -/** - * @brief builds an icaltimespan given a start time, end time and busy value. - * - * @param dtstart The beginning time of the span, can be a date-time - * or just a date. - * @param dtend The end time of the span. - * @param is_busy A boolean value, 0/1. - * @return A span using the supplied values. - * - * returned span contains times specified in UTC. - */ - icaltime_span icaltime_span_new(struct icaltimetype dtstart, struct icaltimetype dtend, int is_busy) { icaltime_span span; @@ -1065,20 +913,6 @@ icaltime_span icaltime_span_new(struct icaltimetype dtstart, struct icaltimetype return span; } -/** @brief Returns true if the two spans overlap - * - * @param s1 1st span to test - * @param s2 2nd span to test - * @return boolean value - * - * The result is calculated by testing if the start time of s1 is contained - * by the s2 span, or if the end time of s1 is contained by the s2 span. - * - * Also returns true if the spans are equal. - * - * Note, this will return false if the spans are adjacent. - */ - int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2) { /* s1->start in s2 */ @@ -1103,15 +937,6 @@ int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2) return 0; } -/** @brief Returns true if the span is totally within the containing - * span - * - * @param s The span to test for. - * @param container The span to test against. - * @return boolean value. - * - */ - int icaltime_span_contains(icaltime_span *s, icaltime_span *container) { if ((s->start >= container->start && s->start < container->end) && diff --git a/src/libical/icaltime.h b/src/libical/icaltime.h index 5b37e98f..e788e25e 100644 --- a/src/libical/icaltime.h +++ b/src/libical/icaltime.h @@ -119,32 +119,79 @@ struct icaltimetype typedef struct icaltimetype icaltimetype; -/** Return a null time, which indicates no time has been set. - This time represent the beginning of the epoch */ +/** @brief Constructor. + * + * @returns A null time, which indicates no time has been set. + * This time represents the beginning of the epoch. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_time(void); -/** Return a null date */ +/** @brief Constructor. + * + * @returns A null date, which indicates no time has been set. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_date(void); -/** Returns the current time in the given timezone, as an icaltimetype. */ +/** @brief Convenience constructor. + * + * @returns The current time in the given timezone, as an icaltimetype. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone); -/** Returns the current day as an icaltimetype, with is_date set. */ +/** @brief Convenience constructor. + * + * @returns The current day as an icaltimetype, with is_date set. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_today(void); -/** Convert seconds past UNIX epoch to a timetype, using timezones. */ +/** @brief Constructor. + * + * @param tm The time expressed as seconds past UNIX epoch + * @param is_date Boolean: 1 means we should treat tm as a DATE + * @param zone The timezone tm is in, NULL means to treat tm as a + * floating time + * + * Returns a new icaltime instance, initialized to the given time, + * optionally using the given timezone. + * + * If the caller specifies the is_date param as TRUE, the returned + * object is of DATE type, otherwise the input is meant to be of + * DATE-TIME type. + * If the zone is not specified (NULL zone param) the time is taken + * to be floating, that is, valid in any timezone. Note that, in + * addition to the uses specified in [RFC5545], this can be used + * when doing simple math on couples of times. + * If the zone is specified (UTC or otherwise), it's stored in the + * object and it's used as the native timezone for this object. + * This means that the caller can convert this time to a different + * target timezone with no need to store the source timezone. + * + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_date, const icaltimezone *zone); -/** create a time from an ISO format string */ +/** @brief Contructor. + * + * Creates a time from an ISO format string. + * + * @todo If the given string specifies a DATE-TIME not in UTC, there + * is no way to know if this is a floating time or really refers to a + * timezone. We should probably add a new constructor: + * icaltime_from_string_with_zone() + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_string(const char *str); -/** Create a new time, given a day of year and a year. */ +/** @brief Contructor. + * + * Creates a new time, given a day of year and a year. + * + * Note that Jan 1 is day #1, not 0. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_day_of_year(const int doy, const int year); /** - * Returns the time as seconds past the UNIX epoch + * Returns the time as seconds past the UNIX epoch. * * This function probably won't do what you expect. In particular, you should * only pass an icaltime in UTC, since no conversion is done. Even in that case, @@ -152,95 +199,211 @@ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_day_of_year(const int doy, */ LIBICAL_ICAL_EXPORT time_t icaltime_as_timet(const struct icaltimetype); -/** Return the time as seconds past the UNIX epoch, using timezones. */ +/** @brief Returns the time as seconds past the UNIX epoch, using the + * given timezone. + * + * This convenience method combines a call to icaltime_convert_to_zone() + * with a call to icaltime_as_timet(). + * If the input timezone is null, no conversion is done; that is, the + * time is simply returned as time_t in its native timezone. + */ LIBICAL_ICAL_EXPORT time_t icaltime_as_timet_with_zone(const struct icaltimetype tt, const icaltimezone *zone); -/** Return a string represention of the time, in RFC5545 format. */ +/** + * @brief Returns a string represention of the time, in RFC5545 format. + * + * @par Ownership + * The created string is owned by libical. + */ LIBICAL_ICAL_EXPORT const char *icaltime_as_ical_string(const struct icaltimetype tt); +/** + * @brief Returns a string represention of the time, in RFC5545 format. + * + * @par Ownership + * The string is owned by the caller. + */ LIBICAL_ICAL_EXPORT char *icaltime_as_ical_string_r(const struct icaltimetype tt); -/** @brief Return the timezone */ +/** @brief Returns the timezone. */ LIBICAL_ICAL_EXPORT const icaltimezone *icaltime_get_timezone(const struct icaltimetype t); -/** @brief Return the tzid, or NULL for a floating time */ +/** @brief Returns the tzid, or NULL for a floating time. */ LIBICAL_ICAL_EXPORT const char *icaltime_get_tzid(const struct icaltimetype t); -/** @brief Set the timezone */ +/** @brief Sets the timezone. + * + * Forces the icaltime to be interpreted relative to another timezone. + * If you need to do timezone conversion, applying offset adjustments, + * then you should use icaltime_convert_to_zone instead. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_set_timezone(struct icaltimetype *t, const icaltimezone *zone); -/** Return the day of the year of the given time */ +/** + * @brief Returns the day of the year, counting from 1 (Jan 1st). + */ LIBICAL_ICAL_EXPORT int icaltime_day_of_year(const struct icaltimetype t); -/** Return the day of the week of the given time. Sunday is 1 */ +/** @brief Returns the day of the week of the given time. + * + * Sunday is 1, and Saturday is 7. + */ LIBICAL_ICAL_EXPORT int icaltime_day_of_week(const struct icaltimetype t); -/** Return the day of the year for the first day of the week that the - given time is within. */ +/** Returns the day of the year for the first day of the week . */ +/** @brief Returns the day of the year for the first day of the week + * that the given time is within. + * + * This uses the first day of the week that contains the given time, + * which is a Sunday. It returns the day of the year for the resulting + * day. + */ LIBICAL_ICAL_EXPORT int icaltime_start_doy_week(const struct icaltimetype t, int fdow); -/** Return the week number for the week the given time is within */ +/** @brief Returns the week number for the week the given time is within. + * + * @todo Doesn't take into account the start day of the + * week. strftime assumes that weeks start on Monday. + */ LIBICAL_ICAL_EXPORT int icaltime_week_number(const struct icaltimetype t); -/** Return true of the time is null. */ +/** @brief Returns true if the time is null. */ LIBICAL_ICAL_EXPORT int icaltime_is_null_time(const struct icaltimetype t); -/** Returns false if the time is clearly invalid, but is not null. This - is usually the result of creating a new time type buy not clearing - it, or setting one of the flags to an illegal value. */ +/** + * @brief Returns false if the time is clearly invalid, but is not null. + * + * This is usually the result of creating a new time type but not + * clearing it, or setting one of the flags to an illegal value. + */ LIBICAL_ICAL_EXPORT int icaltime_is_valid_time(const struct icaltimetype t); -/** @brief Returns true if time is of DATE type, false if DATE-TIME */ +/** @brief Returns true if time is a DATE. + * + * The options are DATE type, which returns true, or DATE-TIME, which + * returns false. + */ LIBICAL_ICAL_EXPORT int icaltime_is_date(const struct icaltimetype t); -/** @brief Returns true if time is relative to UTC zone */ +/** @brief Returns true if the time is relative to UTC zone. + * + * @todo We should only check the zone. + */ LIBICAL_ICAL_EXPORT int icaltime_is_utc(const struct icaltimetype t); -/** Return -1, 0, or 1 to indicate that a is less than b, a equals b, or a is greater than b */ +/** + * @brief Returns -1, 0, or 1 to indicate that a is less than b, a + * equals b, or a is greater than b. + * + * This converts both times to the UTC timezone and compares them. + */ LIBICAL_ICAL_EXPORT int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b); -/** like icaltime_compare, but only use the date parts. */ +/** @brief Like icaltime_compare, but only use the date parts. + * + * This converts both times to the UTC timezone and compares their date + * components. + */ LIBICAL_ICAL_EXPORT int icaltime_compare_date_only(const struct icaltimetype a, const struct icaltimetype b); -/** like icaltime_compare, but only use the date parts. */ +/** @brief Like icaltime_compare, but only use the date parts; accepts + * timezone. + * + * This converts both times to the given timezone and compares their date + * components. + */ LIBICAL_ICAL_EXPORT int icaltime_compare_date_only_tz(const struct icaltimetype a, const struct icaltimetype b, icaltimezone *tz); /** Adds or subtracts a number of days, hours, minutes and seconds. */ +/** @brief Internal, shouldn't be part of the public API + * + * Adds or subtracts a time from a icaltimetype. This time is given + * as a number of days, hours, minutes and seconds. + * + * @note This function is exactly the same as + * icaltimezone_adjust_change() except for the type of the first + * parameter. + */ LIBICAL_ICAL_EXPORT void icaltime_adjust(struct icaltimetype *tt, const int days, const int hours, const int minutes, const int seconds); -/** Normalize the icaltime, so that all fields are within the normal range. */ +/** + * @brief Normalizes the icaltime, so all of the time components + * are in their normal ranges. + * + * For instance, given a time with minutes=70, the minutes will be + * reduces to 10, and the hour incremented. This allows the caller + * to do arithmetic on times without worrying about overflow or + * underflow. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_normalize(const struct icaltimetype t); -/** convert tt, of timezone tzid, into a utc time. Does nothing if the - time is already UTC. */ +/** @brief Converts time to a given timezone. + * + * Converts a time from its native timezone to a given timezone. + * + * If tt is a date, the returned time is an exact + * copy of the input. If it's a floating time, the returned object + * represents the same time translated to the given timezone. + * Otherwise the time will be converted to the new + * time zone, and its native timezone set to the right timezone. + */ LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt, icaltimezone *zone); -/** Return the number of days in the given month */ +/** Returns the number of days in the given month. */ LIBICAL_ICAL_EXPORT int icaltime_days_in_month(const int month, const int year); -/** Return whether you've specified a leapyear or not. */ +/** + * @brief Returns whether the specified year is a leap year. + * + * Year is the normal year, e.g. 2001. + */ LIBICAL_ICAL_EXPORT int icaltime_is_leap_year(const int year); -/** Return the number of days in this year */ +/** Returns the number of days in this year. */ LIBICAL_ICAL_EXPORT int icaltime_days_in_year(const int year); -/** @brief calculate an icaltimespan given a start and end time. */ +/** + * @brief Builds an icaltimespan given a start time, end time and busy value. + * + * @param dtstart The beginning time of the span, can be a date-time + * or just a date. + * @param dtend The end time of the span. + * @param is_busy A boolean value, 0/1. + * @returns A span using the supplied values. The times are specified in UTC. + */ LIBICAL_ICAL_EXPORT struct icaltime_span icaltime_span_new(struct icaltimetype dtstart, struct icaltimetype dtend, int is_busy); -/** @brief Returns true if the two spans overlap **/ +/** @brief Returns true if the two spans overlap. + * + * @param s1 First span to test + * @param s2 Second span to test + * @return boolean value + * + * The result is calculated by testing if the start time of s1 is contained + * by the s2 span, or if the end time of s1 is contained by the s2 span. + * + * Also returns true if the spans are equal. + * + * Note, this will return false if the spans are adjacent. + */ LIBICAL_ICAL_EXPORT int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2); /** @brief Returns true if the span is totally within the containing - * span + * span. + * + * @param s The span to test for. + * @param container The span to test against. + * @return boolean value. + * */ LIBICAL_ICAL_EXPORT int icaltime_span_contains(icaltime_span *s, icaltime_span *container); diff --git a/src/libical/icaltimezone.c b/src/libical/icaltimezone.c index c5e94a1f..9a1c641c 100644 --- a/src/libical/icaltimezone.c +++ b/src/libical/icaltimezone.c @@ -17,10 +17,6 @@ ======================================================================*/ //krazy:excludeall=cpp -/** @file icaltimezone.c - * @brief implementation of timezone handling routines - **/ - #ifdef HAVE_CONFIG_H #include <config.h> #endif @@ -137,9 +133,11 @@ static void icaltimezone_adjust_change(icaltimezonechange *tt, static void icaltimezone_init(icaltimezone *zone); -/** Gets the TZID, LOCATION/X-LIC-LOCATION, and TZNAME properties from the - VTIMEZONE component and places them in the icaltimezone. It returns 1 on - success, or 0 if the TZID can't be found. */ +/** @brief Gets the TZID, LOCATION/X-LIC-LOCATION, and TZNAME properties from + * the VTIMEZONE component and places them in the icaltimezone. + * + * @returns 1 on success, or 0 if the TZID can't be found. + */ static int icaltimezone_get_vtimezone_properties(icaltimezone *zone, icalcomponent *component); static void icaltimezone_load_builtin_timezone(icaltimezone *zone); @@ -191,7 +189,6 @@ const char *icaltimezone_tzid_prefix(void) return s_ical_tzid_prefix; } -/** Creates a new icaltimezone. */ icaltimezone *icaltimezone_new(void) { icaltimezone *zone; @@ -241,7 +238,6 @@ icaltimezone *icaltimezone_copy(icaltimezone *originalzone) return zone; } -/** Frees all memory used for the icaltimezone. */ void icaltimezone_free(icaltimezone *zone, int free_struct) { icaltimezone_reset(zone); @@ -249,7 +245,9 @@ void icaltimezone_free(icaltimezone *zone, int free_struct) free(zone); } -/** Resets the icaltimezone to the initial state, freeing most of the fields. */ +/** @brief Resets the icaltimezone to the initial state, freeing most of the + * fields. + */ static void icaltimezone_reset(icaltimezone *zone) { if (zone->tzid) @@ -274,7 +272,7 @@ static void icaltimezone_reset(icaltimezone *zone) icaltimezone_init(zone); } -/** Initializes an icaltimezone. */ +/** @brief Initializes an icaltimezone. */ static void icaltimezone_init(icaltimezone *zone) { zone->tzid = NULL; @@ -288,11 +286,14 @@ static void icaltimezone_init(icaltimezone *zone) zone->changes = NULL; } -/** Gets the TZID, LOCATION/X-LIC-LOCATION and TZNAME properties of - the VTIMEZONE component and stores them in the icaltimezone. It - returns 1 on success, or 0 if the TZID can't be found. Note that - it expects the zone to be initialized or reset - it doesn't free - any old values. */ +/** @brief Gets the TZID, LOCATION/X-LIC-LOCATION and TZNAME properties of + * the VTIMEZONE component and stores them in the icaltimezone. + * + * @returns 1 on success, or 0 if the TZID can't be found. + * + * Note that it expects the zone to be initialized or reset - it doesn't free + * any old values. + */ static int icaltimezone_get_vtimezone_properties(icaltimezone *zone, icalcomponent *component) { icalproperty *prop; @@ -331,7 +332,6 @@ static int icaltimezone_get_vtimezone_properties(icaltimezone *zone, icalcompone return 1; } -/** Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE. */ char *icaltimezone_get_location_from_vtimezone(icalcomponent *component) { icalproperty *prop; @@ -359,11 +359,6 @@ char *icaltimezone_get_location_from_vtimezone(icalcomponent *component) return NULL; } -/** Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components - in a VTIMEZONE. If both STANDARD and DAYLIGHT components use the - same TZNAME, it returns that. If they use different TZNAMEs, it - formats them like "EST/EDT". The returned string should be freed by - the caller. */ char *icaltimezone_get_tznames_from_vtimezone(icalcomponent *component) { icalcomponent *comp; @@ -738,7 +733,9 @@ void icaltimezone_expand_vtimezone(icalcomponent *comp, int end_year, icalarray } } -/** A function to compare 2 icaltimezonechange elements, used for qsort(). */ +/** @brief A function to compare 2 icaltimezonechange elements, used for + * qsort(). + */ static int icaltimezone_compare_change_fn(const void *elem1, const void *elem2) { const icaltimezonechange *change1, *change2; @@ -799,10 +796,6 @@ void icaltimezone_convert_time(struct icaltimetype *tt, icaltime_adjust(tt, 0, 0, 0, utc_offset); } -/* Calculates the UTC offset of a given local time in the given - timezone. It is the number of seconds to add to UTC to get local - time. The is_daylight flag is set to 1 if the time is in - daylight-savings time. */ int icaltimezone_get_utc_offset(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight) { icaltimezonechange *zone_change, *prev_zone_change, tt_change, tmp_change; @@ -960,10 +953,6 @@ int icaltimezone_get_utc_offset(icaltimezone *zone, struct icaltimetype *tt, int return utc_offset_change; } -/** Calculates the UTC offset of a given UTC time in the given - timezone. It is the number of seconds to add to UTC to get local - time. The is_daylight flag is set to 1 if the time is in - daylight-savings time. */ int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight) { @@ -1070,9 +1059,11 @@ int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone, return utc_offset; } -/* Hold icaltimezone_changes_lock(); before calling this function */ -/** Returns the index of a timezone change which is close to the time - given in change. */ +/** @brief Returns the index of a timezone change which is close to the time + * given in change. + * + * Hold icaltimezone_changes_lock(); before calling this function. +*/ static size_t icaltimezone_find_nearby_change(icaltimezone *zone, icaltimezonechange * change) { icaltimezonechange *zone_change; @@ -1099,9 +1090,11 @@ static size_t icaltimezone_find_nearby_change(icaltimezone *zone, icaltimezonech return middle; } -/** Adds (or subtracts) a time from a icaltimezonechange. NOTE: This - function is exactly the same as icaltime_adjust() except for the - type of the first parameter. */ +/** @brief Adds (or subtracts) a time from a icaltimezonechange. + * + * NOTE: This function is exactly the same as icaltime_adjust() except + * for the type of the first parameter. + */ static void icaltimezone_adjust_change(icaltimezonechange *tt, int days, int hours, int minutes, int seconds) { @@ -1200,7 +1193,6 @@ const char *icaltimezone_get_tznames(icaltimezone *zone) return zone->tznames; } -/** Returns the latitude of a builtin timezone. */ double icaltimezone_get_latitude(icaltimezone *zone) { /* If this is a floating time, without a timezone, return 0. */ @@ -1212,7 +1204,6 @@ double icaltimezone_get_latitude(icaltimezone *zone) return zone->latitude; } -/** Returns the longitude of a builtin timezone. */ double icaltimezone_get_longitude(icaltimezone *zone) { /* If this is a floating time, without a timezone, return 0. */ @@ -1224,7 +1215,6 @@ double icaltimezone_get_longitude(icaltimezone *zone) return zone->longitude; } -/** Returns the VTIMEZONE component of a timezone. */ icalcomponent *icaltimezone_get_component(icaltimezone *zone) { /* If this is a floating time, without a timezone, return NULL. */ @@ -1236,19 +1226,12 @@ icalcomponent *icaltimezone_get_component(icaltimezone *zone) return zone->component; } -/** Sets the VTIMEZONE component of an icaltimezone, initializing the - tzid, location & tzname fields. It returns 1 on success or 0 on - failure, i.e. no TZID was found. */ int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp) { icaltimezone_reset(zone); return icaltimezone_get_vtimezone_properties(zone, comp); } -/* Returns the timezone name to display to the user. We prefer to use the - Olson city name, but fall back on the TZNAME, or finally the TZID. We don't - want to use "" as it may be wrongly interpreted as a floating time. - Do not free the returned string. */ const char *icaltimezone_get_display_name(icaltimezone *zone) { const char *display_name; @@ -1324,10 +1307,6 @@ void icaltimezone_array_free(icalarray *timezones) * BUILTIN TIMEZONE HANDLING */ -/** Returns an icalarray of icaltimezone structs, one for each builtin - timezone. This will load and parse the zones.tab file to get the - timezone names and their coordinates. It will not load the - VTIMEZONE data for any timezones. */ icalarray *icaltimezone_get_builtin_timezones(void) { if (!builtin_timezones) @@ -1336,14 +1315,12 @@ icalarray *icaltimezone_get_builtin_timezones(void) return builtin_timezones; } -/** Release builtin timezone memory */ void icaltimezone_free_builtin_timezones(void) { icaltimezone_array_free(builtin_timezones); builtin_timezones = 0; } -/** Returns a single builtin timezone, given its Olson city name. */ icaltimezone *icaltimezone_get_builtin_timezone(const char *location) { icalcomponent *comp; @@ -1442,7 +1419,6 @@ static int get_offset(icaltimezone *zone) return offset; } -/** Returns a single builtin timezone, given its offset from UTC */ icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset, const char *tzname) { icaltimezone *zone = NULL; @@ -1474,7 +1450,6 @@ icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset, const ch return NULL; } -/** Returns a single builtin timezone, given its TZID. */ icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid) { #if defined(USE_BUILTIN_TZDATA) @@ -1532,7 +1507,6 @@ icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid) } } -/** Returns the special UTC timezone. */ icaltimezone *icaltimezone_get_utc_timezone(void) { if (!builtin_timezones) @@ -1541,9 +1515,11 @@ icaltimezone *icaltimezone_get_utc_timezone(void) return &utc_timezone; } -/** This initializes the builtin timezone data, i.e. the - builtin_timezones array and the special UTC timezone. It should be - called before any code that uses the timezone functions. */ +/** @brief Initializes the builtin timezone data, i.e. the + * builtin_timezones array and the special UTC timezone. + * + * It should be called before any code that uses the timezone functions. + */ static void icaltimezone_init_builtin_timezones(void) { /* Initialize the special UTC timezone. */ @@ -1648,13 +1624,16 @@ static int fetch_lat_long_from_string(const char *str, return 0; } -/** This parses the zones.tab file containing the names and locations - of the builtin timezones. It creates the builtin_timezones array - which is an icalarray of icaltimezone structs. It only fills in the - location, latitude and longtude fields; the rest are left - blank. The VTIMEZONE component is loaded later if it is needed. The - timezones in the zones.tab file are sorted by their name, which is - useful for binary searches. */ +/** @brief Parses the zones.tab file containing the names and locations + * of the builtin timezones. + * + * It creates the builtin_timezones array + * which is an icalarray of icaltimezone structs. It only fills in the + * location, latitude and longtude fields; the rest are left + * blank. The VTIMEZONE component is loaded later if it is needed. The + * timezones in the zones.tab file are sorted by their name, which is + * useful for binary searches. + */ static void icaltimezone_parse_zone_tab(void) { const char *zonedir, *zonetab; @@ -1797,7 +1776,7 @@ void icaltimezone_release_zone_tab(void) icalarray_free(mybuiltin_timezones); } -/** Loads the builtin VTIMEZONE data for the given timezone. */ +/** @brief Loads the builtin VTIMEZONE data for the given timezone. */ static void icaltimezone_load_builtin_timezone(icaltimezone *zone) { icalcomponent *comp = 0, *subcomp; @@ -1872,7 +1851,7 @@ static void icaltimezone_load_builtin_timezone(icaltimezone *zone) return; } -/** Callback used from icalparser_parse() */ +/** @brief Callback used from icalparser_parse() */ static char *icaltimezone_load_get_line_fn(char *s, size_t size, void *data) { return fgets(s, (int)size, (FILE *) data); @@ -1882,21 +1861,6 @@ static char *icaltimezone_load_get_line_fn(char *s, size_t size, void *data) * DEBUGGING */ -/** - * This outputs a list of timezone changes for the given timezone to the - * given file, up to the maximum year given. We compare this output with the - * output from 'vzic --dump-changes' to make sure that we are consistent. - * (vzic is the Olson timezone database to VTIMEZONE converter.) - * - * The output format is: - * - * Zone-Name [tab] Date [tab] Time [tab] UTC-Offset - * - * The Date and Time fields specify the time change in UTC. - * - * The UTC Offset is for local (wall-clock) time. It is the amount of time - * to add to UTC to get local time. - */ int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp) { static const char *months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", @@ -1938,8 +1902,9 @@ int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp) return 1; } -/** This formats a UTC offset as "+HHMM" or "+HHMMSS". - buffer should have space for 8 characters. */ +/** @brief Formats a UTC offset as "+HHMM" or "+HHMMSS". + * + * @p buffer should have space for 8 characters. */ static void format_utc_offset(int utc_offset, char *buffer, size_t buffer_size) { const char *sign = "+"; diff --git a/src/libical/icaltimezone.h b/src/libical/icaltimezone.h index d31a415a..241e5b42 100644 --- a/src/libical/icaltimezone.h +++ b/src/libical/icaltimezone.h @@ -17,7 +17,7 @@ ======================================================================*/ /** * @file icaltimezone.h - * @brief timezone handling routines + * @brief Timezone handling routines */ #ifndef ICALTIMEZONE_H @@ -36,17 +36,19 @@ typedef struct _icaltimezone icaltimezone; #endif -/** - * @par Creating/Destroying individual icaltimezones. +/* + * Creating/Destroying individual icaltimezones. */ -/** Creates a new icaltimezone. */ +/** @brief Creates a new icaltimezone. */ LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_new(void); LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_copy(icaltimezone *originalzone); -/** Frees all memory used for the icaltimezone. Set free_struct to free the - icaltimezone struct as well. */ +/** @brief Frees all memory used for the icaltimezone. + * @param zone The icaltimezone to be freed + * @param free_struct Whether to free the icaltimezone struct as well + */ LIBICAL_ICAL_EXPORT void icaltimezone_free(icaltimezone *zone, int free_struct); /** Sets the prefix to be used for tzid's generated from system tzdata. @@ -56,27 +58,33 @@ LIBICAL_ICAL_EXPORT void icaltimezone_free(icaltimezone *zone, int free_struct); */ LIBICAL_ICAL_EXPORT void icaltimezone_set_tzid_prefix(const char *new_prefix); -/** - * @par Accessing timezones. +/* + * Accessing timezones. */ -/** Free any builtin timezone information **/ +/** @brief Releases builtin timezone memory. */ LIBICAL_ICAL_EXPORT void icaltimezone_free_builtin_timezones(void); -/** Returns the array of builtin icaltimezones. */ +/** @brief Returns an icalarray of icaltimezone structs, one for each builtin + timezone. + * + * This will load and parse the zones.tab file to get the + * timezone names and their coordinates. It will not load the + * VTIMEZONE data for any timezones. + */ LIBICAL_ICAL_EXPORT icalarray *icaltimezone_get_builtin_timezones(void); -/** Returns a single builtin timezone, given its Olson city name. */ +/** @brief Returns a single builtin timezone, given its Olson city name. */ LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone(const char *location); -/** Returns a single builtin timezone, given its offset. */ +/** @brief Returns a single builtin timezone, given its offset from UTC. */ LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset, const char *tzname); -/** Returns a single builtin timezone, given its TZID. */ +/** @brief Returns a single builtin timezone, given its TZID. */ LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid); -/** Returns the UTC timezone. */ +/** @brief Returns the UTC timezone. */ LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_utc_timezone(void); /** Returns the TZID of a timezone. */ @@ -91,45 +99,58 @@ LIBICAL_ICAL_EXPORT const char *icaltimezone_get_location(icaltimezone *zone); may also return NULL. */ LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tznames(icaltimezone *zone); -/** Returns the latitude of a builtin timezone. */ +/** @brief Returns the latitude of a builtin timezone. */ LIBICAL_ICAL_EXPORT double icaltimezone_get_latitude(icaltimezone *zone); -/** Returns the longitude of a builtin timezone. */ +/** @brief Returns the longitude of a builtin timezone. */ LIBICAL_ICAL_EXPORT double icaltimezone_get_longitude(icaltimezone *zone); -/** Returns the VTIMEZONE component of a timezone. */ +/** @brief Returns the VTIMEZONE component of a timezone. */ LIBICAL_ICAL_EXPORT icalcomponent *icaltimezone_get_component(icaltimezone *zone); -/** Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, - location & tzname fields. It returns 1 on success or 0 on failure, i.e. - no TZID was found. */ +/** @brief Sets the VTIMEZONE component of an icaltimezone, initializing the + * tzid, location & tzname fields. + * + * @returns 1 on success or 0 on failure, i.e. no TZID was found. + */ LIBICAL_ICAL_EXPORT int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp); +/** @brief Returns the timezone name to display to the user. + * + * We prefer to use the Olson city name, but fall back on the TZNAME, or finally + * the TZID. We don't want to use "" as it may be wrongly interpreted as a + * floating time. Do not free the returned string. + */ LIBICAL_ICAL_EXPORT const char *icaltimezone_get_display_name(icaltimezone *zone); -/** - * @par Converting times between timezones. +/* + * Converting times between timezones. */ LIBICAL_ICAL_EXPORT void icaltimezone_convert_time(struct icaltimetype *tt, icaltimezone *from_zone, icaltimezone *to_zone); -/** - * @par Getting offsets from UTC. +/* + * Getting offsets from UTC. */ -/** Calculates the UTC offset of a given local time in the given - timezone. It is the number of seconds to add to UTC to get local - time. The is_daylight flag is set to 1 if the time is in - daylight-savings time. */ +/** @brief Calculates the UTC offset of a given local time in the given + * timezone. + * + * It is the number of seconds to add to UTC to get local + * time. The is_daylight flag is set to 1 if the time is in + * daylight-savings time. + */ LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight); -/** Calculates the UTC offset of a given UTC time in the given - timezone. It is the number of seconds to add to UTC to get local - time. The is_daylight flag is set to 1 if the time is in - daylight-savings time. */ +/** @brief Calculates the UTC offset of a given UTC time in the given timezone. + * + * It is the number of seconds to add to UTC to get local + * time. The @p is_daylight flag is set to 1 if the time is in + * daylight-savings time. + */ LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight); @@ -150,8 +171,15 @@ LIBICAL_ICAL_EXPORT void icaltimezone_array_free(icalarray *timezones); LIBICAL_ICAL_EXPORT void icaltimezone_expand_vtimezone(icalcomponent *comp, int end_year, icalarray *changes); +/** @brief Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE. */ LIBICAL_ICAL_EXPORT char *icaltimezone_get_location_from_vtimezone(icalcomponent *component); +/** @brief Gets the TZNAMEs used for the last STANDARD & DAYLIGHT + * components in a VTIMEZONE. + * + * If both STANDARD and DAYLIGHT components use the same TZNAME, it + * returns that. If they use different TZNAMEs, it formats them like + * "EST/EDT". The returned string should be freed by the caller. */ LIBICAL_ICAL_EXPORT char *icaltimezone_get_tznames_from_vtimezone(icalcomponent *component); /* @@ -171,10 +199,10 @@ LIBICAL_ICAL_EXPORT void icaltimezone_truncate_vtimezone(icalcomponent *vtz, * @par Handling the default location the timezone files */ -/** Set the directory to look for the zonefiles */ +/** Sets the directory to look for the zonefiles */ LIBICAL_ICAL_EXPORT void set_zone_directory(const char *path); -/** Free memory dedicated to the zonefile directory */ +/** Frees the memory dedicated to the zonefile directory */ LIBICAL_ICAL_EXPORT void free_zone_directory(void); LIBICAL_ICAL_EXPORT void icaltimezone_release_zone_tab(void); @@ -187,11 +215,26 @@ LIBICAL_ICAL_EXPORT void icaltimezone_set_builtin_tzdata(int set); LIBICAL_ICAL_EXPORT int icaltimezone_get_builtin_tzdata(void); /* - * @par Debugging Output. + * Debugging Output. */ -/** Dumps information about changes in the timezone up to and including - max_year. */ +/** + * @brief Outputs a list of timezone changes for the given timezone to the + * given file, up to the maximum year given. + * + * We compare this output with the output from 'vzic --dump-changes' to + * make sure that we are consistent. (vzic is the Olson timezone + * database to VTIMEZONE converter.) + * + * The output format is: + * + * Zone-Name [tab] Date [tab] Time [tab] UTC-Offset + * + * The Date and Time fields specify the time change in UTC. + * + * The UTC Offset is for local (wall-clock) time. It is the amount of time + * to add to UTC to get local time. + */ LIBICAL_ICAL_EXPORT int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp); /* For the library only -- do not make visible */ diff --git a/src/libical/icalvalue.c b/src/libical/icalvalue.c index c752774f..7a3c48e9 100644 --- a/src/libical/icalvalue.c +++ b/src/libical/icalvalue.c @@ -364,7 +364,7 @@ static icalvalue *icalvalue_new_enum(icalvalue_kind kind, int x_type, const char * The decimal separator (if any) of the double has to be '.' * The code is locale *independent* and does *not* change the locale. * It should be thread safe. - * If you want a code that that does the same job with a decimal separator + * If you want a code that does the same job with a decimal separator * dependent on the current locale, then use strtof() from libc. */ static int simple_str_to_double(const char *from, double *result, char **to) @@ -542,7 +542,7 @@ static icalvalue *icalvalue_new_from_string_with_error(icalvalue_kind kind, { int t, utcoffset, hours, minutes, seconds; - /* treat the UTCOFSET string a a decimal number, disassemble its digits + /* treat the UTCOFSET string as a decimal number, disassemble its digits and reconstruct it as sections */ t = strtol(str, 0, 10); /* add phantom seconds field */ diff --git a/src/libical/icalvalue.h b/src/libical/icalvalue.h index 102b855c..69dce8f1 100644 --- a/src/libical/icalvalue.h +++ b/src/libical/icalvalue.h @@ -22,6 +22,8 @@ #include "libical_ical_export.h" #include "icalvalueimpl.h" +/** @file icalvalue.h */ + #define ICAL_BOOLEAN_TRUE 1 #define ICAL_BOOLEAN_FALSE 0 @@ -80,7 +82,9 @@ LIBICAL_ICAL_EXPORT int icalvalue_decode_ical_string(const char *szText, char *szDecText, int nMaxBufferLen); /* For the library only -- do not make visible */ +/// @cond extern void print_date_to_string(char *str, const struct icaltimetype *data); extern void print_datetime_to_string(char *str, const struct icaltimetype *data); +/// @endcond #endif /*ICALVALUE_H */ diff --git a/src/libical/icptrholder_cxx.h b/src/libical/icptrholder_cxx.h index 8bc59cbf..23805bcd 100644 --- a/src/libical/icptrholder_cxx.h +++ b/src/libical/icptrholder_cxx.h @@ -19,7 +19,7 @@ * stack based object. The class holds a pointer to the C++ Wrapper. * The destructor set the imp to null before deleting the pointer. * - * Each C++ Wrapper instantiates a template class in it's corresponding .h file. + * Each C++ Wrapper instantiates a template class in its corresponding .h file. * * Usage example: * VComponentTmpPtr p;// VComponentTmpPtr is an instantiation of this template diff --git a/src/libical/pvl.c b/src/libical/pvl.c index 6199499e..5d3f01fb 100644 --- a/src/libical/pvl.c +++ b/src/libical/pvl.c @@ -146,7 +146,7 @@ void pvl_unshift(pvl_list L, void *d) } /** - * @brief Remove an element from the front of the list + * @brief Removes an element from the front of the list * * @param L The list to operate on * @@ -193,7 +193,7 @@ void pvl_push(pvl_list L, void *d) } /** - * @brief Remove an element from the tail of the list + * @brief Removes an element from the tail of the list * * @param L The list to operate on */ @@ -317,7 +317,7 @@ void pvl_insert_before(pvl_list L, pvl_elem P, void *d) } /** - * @brief Remove the referenced item from the list. + * @brief Removes the referenced item from the list. * * This routine will free the element, but not the data item that the * element contains. @@ -423,7 +423,7 @@ pvl_elem pvl_find_next(pvl_list l, pvl_findf f, void *v) } /** - * @brief Remove the all the elements in the list. The does not free + * @brief Removes the all the elements in the list. The does not free * the data items the elements hold. */ diff --git a/src/libical/vcomponent_cxx.cpp b/src/libical/vcomponent_cxx.cpp index f71e9df3..23c90b5c 100644 --- a/src/libical/vcomponent_cxx.cpp +++ b/src/libical/vcomponent_cxx.cpp @@ -207,7 +207,7 @@ ICalProperty *VComponent::get_next_property(const icalproperty_kind &kind) } /* Working with components */ -/* Return the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types */ +/* Returns the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types */ VComponent *VComponent::get_inner() { return new VComponent(icalcomponent_get_inner(imp)); diff --git a/src/libicalss/icalbdbset.c b/src/libicalss/icalbdbset.c index 0294e0fe..c77e9a14 100644 --- a/src/libicalss/icalbdbset.c +++ b/src/libicalss/icalbdbset.c @@ -678,7 +678,7 @@ int icalbdbset_get(DB *dbp, DB_TXN *tid, DBT *key, DBT *data, u_int32_t flags) return dbp->get(dbp, tid, key, data, flags); } -/** Return the path of the database file **/ +/** Returns the path of the database file **/ const char *icalbdbset_path(icalset *set) { @@ -982,7 +982,7 @@ int icalbdbset_count_components(icalset *set, icalcomponent_kind kind) return icalcomponent_count_components(bset->cluster, kind); } -/** Set the gauge **/ +/** Sets the gauge **/ icalerrorenum icalbdbset_select(icalset *set, icalgauge *gauge) { diff --git a/src/libicalss/icalbdbset.h b/src/libicalss/icalbdbset.h index f7e3b880..1fe2e2cf 100644 --- a/src/libicalss/icalbdbset.h +++ b/src/libicalss/icalbdbset.h @@ -107,7 +107,7 @@ LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_select(icalset *store, icalgauge LIBICAL_ICALSS_EXPORT void icalbdbset_clear(icalset *store); -/* Get and search for a component by uid */ +/* Gets and searches for a component by uid */ LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_fetch(icalset *set, icalcomponent_kind kind, const char *uid); diff --git a/src/libicalss/icalcalendar.h b/src/libicalss/icalcalendar.h index 4ea0a7c6..ac424be0 100644 --- a/src/libicalss/icalcalendar.h +++ b/src/libicalss/icalcalendar.h @@ -25,11 +25,14 @@ #include "libical_icalss_export.h" #include "icalset.h" -/* icalcalendar - * Routines for storing calendar data in a file system. The calendar - * has two icaldirsets, one for incoming components and one for booked - * components. It also has interfaces to access the free/busy list - * and a list of calendar properties */ +/** @file icalcalendar.h + * + * @brief Routines for storing calendar data in a file system. + * + * The calendar has two icaldirsets, one for incoming components and one for + * booked components. It also has interfaces to access the free/busy list and a + * list of calendar properties + */ typedef struct icalcalendar_impl icalcalendar; diff --git a/src/libicalss/icalclassify.c b/src/libicalss/icalclassify.c index c5b54b1e..55f28a11 100644 --- a/src/libicalss/icalclassify.c +++ b/src/libicalss/icalclassify.c @@ -57,7 +57,7 @@ char *icalclassify_lowercase(const char *str) return xnew; } -/* Return a set of components that intersect in time with comp. For +/** Returns a set of components that intersect in time with comp. For component X and Y to intersect: X.DTSTART < Y.DTEND && X.DTEND > Y.DTSTART */ diff --git a/src/libicalss/icalcluster.c b/src/libicalss/icalcluster.c index 9fa0d00b..06597fbb 100644 --- a/src/libicalss/icalcluster.c +++ b/src/libicalss/icalcluster.c @@ -52,7 +52,7 @@ static icalcluster *icalcluster_new_impl(void) } /** - * Create a cluster with a key/value pair. + * @brief Create a cluster with a key/value pair. * * @todo Always do a deep copy. */ @@ -82,7 +82,7 @@ icalcluster *icalcluster_new(const char *key, icalcomponent *data) } /** - * Deep clone an icalcluster to a new one + * @brief Deep clone an icalcluster to a new one */ icalcluster *icalcluster_new_clone(const icalcluster *data) @@ -188,7 +188,8 @@ int icalcluster_count_components(icalcluster *impl, icalcomponent_kind kind) return icalcomponent_count_components(impl->data, kind); } -/** Iterate through components **/ +/** @brief Iterate through components + */ icalcomponent *icalcluster_get_current_component(icalcluster *impl) { icalerror_check_arg_rz((impl != 0), "cluster"); diff --git a/src/libicalss/icaldirset.c b/src/libicalss/icaldirset.c index dcadc0e1..cb55814c 100644 --- a/src/libicalss/icaldirset.c +++ b/src/libicalss/icaldirset.c @@ -20,31 +20,6 @@ Code is Eric Busboom ======================================================================*/ -/** - @file icaldirset.c - - @brief icaldirset manages a database of ical components and offers - interfaces for reading, writing and searching for components. - - icaldirset groups components in to clusters based on their DTSTAMP - time -- all components that start in the same month are grouped - together in a single file. All files in a sotre are kept in a single - directory. - - The primary interfaces are icaldirset__get_first_component and - icaldirset_get_next_component. These routine iterate through all of - the components in the store, subject to the current gauge. A gauge - is an icalcomponent that is tested against other componets for a - match. If a gauge has been set with icaldirset_select, - icaldirset_first and icaldirset_next will only return componentes - that match the gauge. - - The Store generated UIDs for all objects that are stored if they do - not already have a UID. The UID is the name of the cluster (month & - year as MMYYYY) plus a unique serial number. The serial number is - stored as a property of the cluster. - -*/ #ifdef HAVE_CONFIG_H #include <config.h> @@ -320,12 +295,6 @@ static void icaldirset_add_uid(icalcomponent *comp) } } -/** - This assumes that the top level component is a VCALENDAR, and there - is an inner component of type VEVENT, VTODO or VJOURNAL. The inner - component must have a DSTAMP property -*/ - icalerrorenum icaldirset_add_component(icalset *set, icalcomponent *comp) { char clustername[MAXPATHLEN] = { 0 }; diff --git a/src/libicalss/icaldirset.h b/src/libicalss/icaldirset.h index 053e11b9..ca7f0f24 100644 --- a/src/libicalss/icaldirset.h +++ b/src/libicalss/icaldirset.h @@ -19,6 +19,32 @@ Code is Eric Busboom ======================================================================*/ +/** + @file icaldirset.h + + @brief icaldirset manages a database of ical components and offers + interfaces for reading, writing and searching for components. + + icaldirset groups components in to clusters based on their DTSTAMP + time -- all components that start in the same month are grouped + together in a single file. All files in a sotre are kept in a single + directory. + + The primary interfaces are icaldirset__get_first_component and + icaldirset_get_next_component. These routine iterate through all of + the components in the store, subject to the current gauge. A gauge + is an icalcomponent that is tested against other componets for a + match. If a gauge has been set with icaldirset_select, + icaldirset_first and icaldirset_next will only return componentes + that match the gauge. + + The Store generated UIDs for all objects that are stored if they do + not already have a UID. The UID is the name of the cluster (month & + year as MMYYYY) plus a unique serial number. The serial number is + stored as a property of the cluster. + +*/ + #ifndef ICALDIRSET_H #define ICALDIRSET_H @@ -42,25 +68,30 @@ LIBICAL_ICALSS_EXPORT void icaldirset_free(icalset *set); LIBICAL_ICALSS_EXPORT const char *icaldirset_path(icalset *set); -/* Mark the cluster as changed, so it will be written to disk when it +/* Marks the cluster as changed, so it will be written to disk when it is freed. Commit writes to disk immediately*/ LIBICAL_ICALSS_EXPORT void icaldirset_mark(icalset *set); LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_commit(icalset *set); +/** + This assumes that the top level component is a VCALENDAR, and there + is an inner component of type VEVENT, VTODO or VJOURNAL. The inner + component must have a DSTAMP property +*/ LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp); LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp); LIBICAL_ICALSS_EXPORT int icaldirset_count_components(icalset *store, icalcomponent_kind kind); -/* Restrict the component returned by icaldirset_first, _next to those +/* Restricts the component returned by icaldirset_first, _next to those that pass the gauge. _clear removes the gauge. */ LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_select(icalset *store, icalgauge *gauge); LIBICAL_ICALSS_EXPORT void icaldirset_clear(icalset *store); -/* Get a component by uid */ +/* Gets a component by uid */ LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch(icalset *store, icalcomponent_kind kind, const char *uid); @@ -68,12 +99,12 @@ LIBICAL_ICALSS_EXPORT int icaldirset_has_uid(icalset *store, const char *uid); LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch_match(icalset *set, icalcomponent *c); -/* Modify components according to the MODIFY method of CAP. Works on +/* Modifies components according to the MODIFY method of CAP. Works on the currently selected components. */ LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_modify(icalset *store, icalcomponent *oldc, icalcomponent *newc); -/* Iterate through the components. If a gauge has been defined, these +/* Iterates through the components. If a gauge has been defined, these will skip over components that do not pass the gauge */ LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_current_component(icalset *store); diff --git a/src/libicalss/icalfileset.c b/src/libicalss/icalfileset.c index 4f43f3f7..3b52bc31 100644 --- a/src/libicalss/icalfileset.c +++ b/src/libicalss/icalfileset.c @@ -225,7 +225,7 @@ long icalfileset_filesize(icalfileset *fset) icalerror_set_errno(ICAL_FILE_ERROR); return -1; } else { - /* Lets assume that it is a file of the right type */ + /* Let's assume that it is a file of the right type */ return (long)sbuf.st_size; } } diff --git a/src/libicalss/icalfileset.h b/src/libicalss/icalfileset.h index 50af6d76..23060e34 100644 --- a/src/libicalss/icalfileset.h +++ b/src/libicalss/icalfileset.h @@ -56,15 +56,15 @@ LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_remove_component(icalset *set, LIBICAL_ICALSS_EXPORT int icalfileset_count_components(icalset *set, icalcomponent_kind kind); /** - * Restrict the component returned by icalfileset_first, _next to those - * that pass the gauge. _clear removes the gauge + * Restricts the component returned by icalfileset_first, _next to those + * that pass the gauge. _clear removes the gauge. */ LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_select(icalset *set, icalgauge *gauge); -/** clear the gauge **/ +/** @brief Clears the gauge **/ LIBICAL_ICALSS_EXPORT void icalfileset_clear(icalset *set); -/** Get and search for a component by uid **/ +/** @brief Gets and searches for a component by uid **/ LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch(icalset *set, icalcomponent_kind kind, const char *uid); @@ -73,14 +73,15 @@ LIBICAL_ICALSS_EXPORT int icalfileset_has_uid(icalset *set, const char *uid); LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch_match(icalset *set, icalcomponent *c); /** - * Modify components according to the MODIFY method of CAP. Works on the - * currently selected components. + * @brief Modifies components according to the MODIFY method of CAP. + * + * Works on the currently selected components. */ LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_modify(icalset *set, icalcomponent *oldcomp, icalcomponent *newcomp); -/* Iterate through components. If a gauge has been defined, these +/* Iterates through components. If a gauge has been defined, these will skip over components that do not pass the gauge */ LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_current_component(icalset *cluster); @@ -99,13 +100,13 @@ LIBICAL_ICALSS_EXPORT icalcomponent *icalfilesetiter_to_next(icalset *set, icals LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_form_a_matched_recurrence_component(icalsetiter * itr); -/** Return a reference to the internal component. You probably should - not be using this. */ +/** Returns a reference to the internal component. **You probably should + not be using this.** */ LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_component(icalset *cluster); /** - * @brief options for opening an icalfileset. + * @brief Options for opening an icalfileset. * * These options should be passed to the icalset_new() function */ diff --git a/src/libicalss/icalgauge.c b/src/libicalss/icalgauge.c index e874873b..f056ce3d 100644 --- a/src/libicalss/icalgauge.c +++ b/src/libicalss/icalgauge.c @@ -112,7 +112,7 @@ void icalgauge_free(icalgauge *gauge) free(gauge); } -/** Convert a VQUERY component into a gauge */ +/** Converts a VQUERY component into a gauge */ icalcomponent *icalgauge_make_gauge(icalcomponent *query); /** @@ -427,10 +427,6 @@ int icalgauge_compare(icalgauge *gauge, icalcomponent *comp) return last_clause; } -/** @brief Debug - * Print gauge information to stdout. - */ - void icalgauge_dump(icalgauge *gauge) { pvl_elem p; diff --git a/src/libicalss/icalgauge.h b/src/libicalss/icalgauge.h index 3f750126..3de1f92c 100644 --- a/src/libicalss/icalgauge.h +++ b/src/libicalss/icalgauge.h @@ -41,9 +41,13 @@ LIBICAL_ICALSS_EXPORT int icalgauge_get_expand(icalgauge *gauge); LIBICAL_ICALSS_EXPORT void icalgauge_free(icalgauge *gauge); +/** @brief Debug + * + * Prints gauge information to STDOUT. + */ LIBICAL_ICALSS_EXPORT void icalgauge_dump(icalgauge *gauge); -/** @brief Return true if comp matches the gauge. +/** @brief Returns true if comp matches the gauge. * * The component must be in * cannonical form -- a VCALENDAR with one VEVENT, VTODO or VJOURNAL diff --git a/src/libicalss/icalset.c b/src/libicalss/icalset.c index 0c7f30c3..674e05b4 100644 --- a/src/libicalss/icalset.c +++ b/src/libicalss/icalset.c @@ -368,11 +368,6 @@ icalset *icalset_new_dir_reader(const char *path) /* Functions for built-in methods */ -/** - * free memory associated with this icalset - * automatically calls the implementation specific free routine - */ - void icalset_free(icalset *set) { if (set->free) { @@ -508,7 +503,7 @@ icalcomponent *icalsetiter_deref(icalsetiter *i) return (icalcompiter_deref(&(i->iter))); } -/* for subclasses that use multiple clusters that require specialized cluster traversal */ +/* For subclasses that use multiple clusters that require specialized cluster traversal */ icalcomponent *icalsetiter_to_next(icalset *set, icalsetiter *i) { return set->icalsetiter_to_next(set, i); diff --git a/src/libicalss/icalset.h b/src/libicalss/icalset.h index 978c76d2..07875273 100644 --- a/src/libicalss/icalset.h +++ b/src/libicalss/icalset.h @@ -86,7 +86,7 @@ struct icalset_impl icalcomponent *(*icalsetiter_to_prior) (icalset *set, icalsetiter *i); }; -/** @brief Register a new derived class */ +/** @brief Registers a new derived class */ LIBICAL_ICALSS_EXPORT int icalset_register_class(icalset *set); /** @brief Generic icalset constructor @@ -110,15 +110,19 @@ LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_writer(const char *path); LIBICAL_ICALSS_EXPORT icalset *icalset_new_dir(const char *path); +/** + * Frees the memory associated with this icalset + * automatically calls the implementation specific free routine + */ LIBICAL_ICALSS_EXPORT void icalset_free(icalset *set); LIBICAL_ICALSS_EXPORT const char *icalset_path(icalset *set); -/** Mark the cluster as changed, so it will be written to disk when it +/** Marks the cluster as changed, so it will be written to disk when it is freed. **/ LIBICAL_ICALSS_EXPORT void icalset_mark(icalset *set); -/** Write changes to disk immediately */ +/** Writes changes to disk immediately */ LIBICAL_ICALSS_EXPORT icalerrorenum icalset_commit(icalset *set); LIBICAL_ICALSS_EXPORT icalerrorenum icalset_add_component(icalset *set, icalcomponent *comp); @@ -127,23 +131,23 @@ LIBICAL_ICALSS_EXPORT icalerrorenum icalset_remove_component(icalset *set, icalc LIBICAL_ICALSS_EXPORT int icalset_count_components(icalset *set, icalcomponent_kind kind); -/** Restrict the component returned by icalset_first, _next to those +/** Restricts the component returned by icalset_first, _next to those that pass the gauge. */ LIBICAL_ICALSS_EXPORT icalerrorenum icalset_select(icalset *set, icalgauge *gauge); -/** Get a component by uid */ +/** Gets a component by uid */ LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch(icalset *set, const char *uid); LIBICAL_ICALSS_EXPORT int icalset_has_uid(icalset *set, const char *uid); LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch_match(icalset *set, icalcomponent *c); -/** Modify components according to the MODIFY method of CAP. Works on +/** Modifies components according to the MODIFY method of CAP. Works on the currently selected components. */ LIBICAL_ICALSS_EXPORT icalerrorenum icalset_modify(icalset *set, icalcomponent *oldc, icalcomponent *newc); -/** Iterate through the components. If a guage has been defined, these +/** Iterates through the components. If a guage has been defined, these will skip over components that do not pass the gauge */ LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_current_component(icalset *set); diff --git a/src/libicalss/icalspanlist.c b/src/libicalss/icalspanlist.c index de3326c1..b43bd686 100644 --- a/src/libicalss/icalspanlist.c +++ b/src/libicalss/icalspanlist.c @@ -82,23 +82,11 @@ static void icalspanlist_new_callback(icalcomponent *comp, struct icaltime_span return; } - /** copy span data into allocated memory.. **/ + /* copy span data into allocated memory.. **/ *s = *span; pvl_insert_ordered(sl->spans, compare_span, (void *)s); } -/** @brief Make a free list from a set of VEVENT components. - * - * @param set A valid icalset containing VEVENTS - * @param start The free list starts at this date/time - * @param end The free list ends at this date/time - * - * @return A spanlist corresponding to the VEVENTS - * - * Given a set of components, a start time and an end time - * return a spanlist that contains the free/busy times. - */ - icalspanlist *icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end) { struct icaltime_span range; @@ -120,7 +108,7 @@ icalspanlist *icalspanlist_new(icalset *set, struct icaltimetype start, struct i range.start = icaltime_as_timet(start); range.end = icaltime_as_timet(end); - /* Get a list of spans of busy time from the events in the set + /* Gets a list of spans of busy time from the events in the set and order the spans based on the start time */ for (c = icalset_get_first_component(set); @@ -201,12 +189,6 @@ icalspanlist *icalspanlist_new(icalset *set, struct icaltimetype start, struct i return sl; } -/** @brief Destructor. - * @param s A valid icalspanlist - * - * Free memory associated with the spanlist - */ - void icalspanlist_free(icalspanlist *s) { struct icaltime_span *span; @@ -225,10 +207,6 @@ void icalspanlist_free(icalspanlist *s) free(s); } -/** @brief (Debug) print out spanlist to stdout. - * @param sl A valid icalspanlist. - */ - void icalspanlist_dump(icalspanlist *sl) { int i = 0; @@ -245,15 +223,6 @@ void icalspanlist_dump(icalspanlist *sl) icalcomponent *icalspanlist_make_busy_list(icalspanlist *sl); -/** @brief Find next free time span in a spanlist. - * - * @param sl The spanlist to search. - * @param t The time to start looking. - * - * Given a spanlist and a time, find the next period of time - * that is free - */ - struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icaltimetype t) { pvl_elem itr; @@ -317,26 +286,6 @@ struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icalt return period; } -/** @brief Returns an hour-by-hour array of free/busy times over a - * given period. - * - * @param sl A valid icalspanlist - * @param delta_t The time slice to divide by, in seconds. Default 3600. - * - * @return A pointer to an array of integers containing the number of - * busy events in each delta_t time period. The final entry - * contains the value -1. - * - * This calculation is somewhat tricky. This is due to the fact that - * the time range contains the start time, but does not contain the - * end time. To perform a proper calculation we subtract one second - * off the end times to get a true containing time. - * - * Also note that if you supplying a spanlist that does not start or - * end on a time boundary divisible by delta_t you may get results - * that are not quite what you expect. - */ - int *icalspanlist_as_freebusy_matrix(icalspanlist *sl, int delta_t) { pvl_elem itr; @@ -350,11 +299,11 @@ int *icalspanlist_as_freebusy_matrix(icalspanlist *sl, int delta_t) if (!delta_t) delta_t = 3600; - /** calculate the start and end time as time_t **/ + /* calculate the start and end time as time_t **/ sl_start = icaltime_as_timet_with_zone(sl->start, icaltimezone_get_utc_timezone()); sl_end = icaltime_as_timet_with_zone(sl->end, icaltimezone_get_utc_timezone()); - /** insure that the time period falls on a time boundary divisable + /* insure that the time period falls on a time boundary divisable by delta_t */ sl_start /= delta_t; @@ -363,10 +312,10 @@ int *icalspanlist_as_freebusy_matrix(icalspanlist *sl, int delta_t) sl_end /= delta_t; sl_end *= delta_t; - /** find the duration of this spanlist **/ + /* find the duration of this spanlist **/ spanduration_secs = sl_end - sl_start; - /** malloc our matrix, add one extra slot for a final -1 **/ + /* malloc our matrix, add one extra slot for a final -1 **/ matrix_slots = spanduration_secs / delta_t + 1; matrix = (int *)malloc((size_t)(sizeof(int) * matrix_slots)); @@ -398,21 +347,6 @@ int *icalspanlist_as_freebusy_matrix(icalspanlist *sl, int delta_t) return matrix; } -/** @brief Return a VFREEBUSY component for the corresponding spanlist - * - * @param sl A valid icalspanlist, from icalspanlist_new() - * @param organizer The organizer specified as "MAILTO:user@domain" - * @param attendee The attendee specified as "MAILTO:user@domain" - * - * @return A valid icalcomponent or NULL. - * - * This function returns a VFREEBUSY component for the given spanlist. - * The start time is mapped to DTSTART, the end time to DTEND. - * Each busy span is represented as a separate FREEBUSY entry. - * An attendee parameter is required, and organizer parameter is - * optional. - */ - icalcomponent *icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee) { @@ -464,15 +398,6 @@ icalcomponent *icalspanlist_as_vfreebusy(icalspanlist *sl, return comp; } -/** @brief Return a spanlist corresponding to the VFREEBUSY portion of - * an icalcomponent. - * - * @param comp A valid icalcomponent. - * - * @return A valid icalspanlist or NULL if no VFREEBUSY section. - * - */ - icalspanlist *icalspanlist_from_vfreebusy(icalcomponent *comp) { icalcomponent *inner; diff --git a/src/libicalss/icalspanlist.h b/src/libicalss/icalspanlist.h index 260f84a6..c5b44cd1 100644 --- a/src/libicalss/icalspanlist.h +++ b/src/libicalss/icalspanlist.h @@ -27,33 +27,93 @@ typedef struct icalspanlist_impl icalspanlist; -/** @brief Constructor - * Make a free list from a set of component. Start and end should be in UTC +/** @brief Makes a free list from a set of VEVENT components. + * + * @param set A valid icalset containing VEVENTS + * @param start The free list starts at this date/time + * @param end The free list ends at this date/time + * + * @return A spanlist corresponding to the VEVENTS + * + * Given a set of components, a start time and an end time + * return a spanlist that contains the free/busy times. + * @p Start and @p end should be in UTC. */ - LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end); -/** @brief Destructor +/** @brief Destructor. + * @param s A valid icalspanlist + * + * Frees the memory associated with the spanlist. */ LIBICAL_ICALSS_EXPORT void icalspanlist_free(icalspanlist *spl); -/** Get first next free time after time t. all times are in UTC. */ +/** @brief Finds the next free time span in a spanlist. + * + * @param sl The spanlist to search. + * @param t The time to start looking. + * + * Given a spanlist and a time, finds the next period of time + * that is free. + */ LIBICAL_ICALSS_EXPORT struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icaltimetype t); +/** @brief (Debug) print out spanlist to STDOUT. + * @param sl A valid icalspanlist. + */ LIBICAL_ICALSS_EXPORT void icalspanlist_dump(icalspanlist *s); -/** @brief Return a valid VFREEBUSY component for this span */ +/** @brief Returns a VFREEBUSY component for a spanlist. + * + * @param sl A valid icalspanlist, from icalspanlist_new() + * @param organizer The organizer specified as "MAILTO:user@domain" + * @param attendee The attendee specified as "MAILTO:user@domain" + * + * @return A valid icalcomponent or NULL. + * + * This function returns a VFREEBUSY component for the given spanlist. + * The start time is mapped to DTSTART, the end time to DTEND. + * Each busy span is represented as a separate FREEBUSY entry. + * An attendee parameter is required, and organizer parameter is + * optional. + */ LIBICAL_ICALSS_EXPORT icalcomponent *icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee); -/** @brief Return an integer matrix of total events per delta_t timespan */ +/** @brief Returns an hour-by-hour array of free/busy times over a + * given period. + * + * @param sl A valid icalspanlist + * @param delta_t The time slice to divide by, in seconds. Default 3600. + * + * @return A pointer to an array of integers containing the number of + * busy events in each delta_t time period. The final entry + * contains the value -1. + * + * This calculation is somewhat tricky. This is due to the fact that + * the time range contains the start time, but does not contain the + * end time. To perform a proper calculation we subtract one second + * off the end times to get a true containing time. + * + * Also note that if you supplying a spanlist that does not start or + * end on a time boundary divisible by delta_t you may get results + * that are not quite what you expect. + */ LIBICAL_ICALSS_EXPORT int *icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t); -/** @brief Construct an icalspanlist from a VFREEBUSY component */ +/** @brief Constructs an icalspanlist from a VFREEBUSY component */ +/** @brief Constructs an icalspanlist from the VFREEBUSY component of + * an icalcomponent. + * + * @param comp A valid icalcomponent. + * + * @return A valid icalspanlist or NULL if no VFREEBUSY section. + * + */ LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_from_vfreebusy(icalcomponent *comp); #endif diff --git a/src/libicalss/icalspanlist_cxx.h b/src/libicalss/icalspanlist_cxx.h index 70706c65..1698133e 100644 --- a/src/libicalss/icalspanlist_cxx.h +++ b/src/libicalss/icalspanlist_cxx.h @@ -49,33 +49,33 @@ public: ICalSpanList(); ICalSpanList(const ICalSpanList &v); - /** Construct an ICalSpanList from an icalset */ + /** Constructs an ICalSpanList from an icalset */ ICalSpanList(icalset *set, icaltimetype start, icaltimetype end); - /** Construct an ICalSpanList from the VFREEBUSY chunk of a icalcomponent */ + /** Constructs an ICalSpanList from the VFREEBUSY chunk of a icalcomponent */ explicit ICalSpanList(icalcomponent *comp); - /** Construct an ICalSpanList from the VFREEBUSY chunk of a vcomponent */ + /** Constructs an ICalSpanList from the VFREEBUSY chunk of a vcomponent */ explicit ICalSpanList(VComponent &comp); /** Destructor */ ~ICalSpanList(); - /** Return a VFREEBUSY icalcomponent */ + /** Returns a VFREEBUSY icalcomponent */ VComponent *get_vfreebusy(const char *organizer, const char *attendee); ICalSpanList &operator=(const ICalSpanList &); - /** Return the base data when casting */ + /** Returns the base data when casting */ operator icalspanlist *() { return data; } - /** Return a vector of the number of events over delta t */ + /** Returns a vector of the number of events over delta t */ std::vector < int >as_vector(int delta_t); - /** Dump the spanlist to stdout */ + /** Dumps the spanlist to STDOUT */ void dump(); private: diff --git a/src/libicalvcal/README.TXT b/src/libicalvcal/README.TXT index 01b65498..aeaa18fc 100644 --- a/src/libicalvcal/README.TXT +++ b/src/libicalvcal/README.TXT @@ -5,7 +5,7 @@ the differences between the old API and this one. ----------------------------------------------------------------
-The vCard/vCalendar C interface is implemented in the set
+The vCard/vCalendar C interface is implemented in the set
of files as follows:
vcc.y, yacc source, and vcc.c, the yacc output you will use
@@ -25,15 +25,15 @@ test.c is a standalone test driver that exercises some of the features of the APIs provided. Invoke test.exe on a
VCARD/VCALENDAR input text file and you will see the pretty
print output of the internal representation (this pretty print
-output should give you a good idea of how the internal
-representation looks like -- there is one such output in the
-following too). Also, a file with the .out suffix is generated
-to show that the internal representation can be written back
+output should give you a good idea of how the internal
+representation looks like -- there is one such output in the
+following too). Also, a file with the .out suffix is generated
+to show that the internal representation can be written back
in the original text format.
-----------------------------------------------------------------
-
-
+
+
VObject for VCard/VCalendar
Table of Contents
@@ -68,7 +68,7 @@ Since a property is represented as a VObject, each of these properties can have a name, a list of properties, and a value.
For example, the input file "vobject.vcf":
-
+
BEGIN:VCARD
N:Alden;Roland
FN:Roland H. Alden
@@ -146,14 +146,14 @@ END:VCALENDAR END:VCARD
-will conceptually be be represented as
+will conceptually be represented as
vcard
VCNameProp
VCFamilyNameProp=Alden
VCGivenNameProp=Roland
VCFullNameProp=Roland H.Alden
....
-
+
note that
EMAIL;WORK;PREF;INTERNET:sf!rincon!ralden@alden.attmail.com
will be represented as:
@@ -206,7 +206,7 @@ all properties of a vobject, o: initPropIterator(&i,o);
while (moreIteration(&i)) {
VObject *each = nextVObject(&i);
- // ... do something with "each" property
+ // ... do something with "each" property
}
Use the API vObjectName() to access a VObject's name.
@@ -448,7 +448,7 @@ d. properties name (id) are case incensitive. used externally, its use is mainly limited to the
construction of top level object (e.g. an object
with VCCardProp or VCCalendarProp id).
-
+
void deleteVObject(VObject *p);
-- to deallocate single VObject, for most user, use
cleanVObject(VObject *o) instead for freeing all
@@ -456,7 +456,7 @@ d. properties name (id) are case incensitive. char* dupStr(const char *s, unsigned int size);
-- duplicate a string s. If size is 0, the string is
- assume to be a null-terminated.
+ assume to be a null-terminated.
void deleteStr(const char *p);
-- used to deallocate a string allocated by dupStr();
@@ -492,7 +492,7 @@ d. properties name (id) are case incensitive. i.e. the value val will be attached to the VObject prop
and a property of VCDataSize whose value is size
is also added to the object.
-
+
void setVObjectVObjectValue(VObject *o, VObject *p);
-- set a VObject as the value of another VObject.
@@ -548,7 +548,7 @@ d. properties name (id) are case incensitive. VCGroupingProp=b
VCGroupingProp=a
and the object c is returned.
-
+
VObject* isAPropertyOf(VObject *o, const char *id);
-- query if a property by the name id is in o and
return the VObject that represent that property.
@@ -635,7 +635,7 @@ of Example.vcf and its VObject Representation to do with a VCard or a VCalendar, a recursive walk
of the VObject tree may or may not be desirable. An example
template of a non-recursive walk is shown below:
-
+
void processVCardVCalendar(char *inputFile)
{
VObject *t, *v;
@@ -711,7 +711,7 @@ of Example.vcf and its VObject Representation void do_Event(VObject *vevent) { ... }
...
-
+
* Property's Values and Properties
The VObject APIs do not attempt to check for the
correctness of the values of a property. Nor do they
@@ -720,7 +720,7 @@ of Example.vcf and its VObject Representation the example of line [11] of the example, "O.K" is not
a valid value of VCStatusProp. It is up to the application
to accept or reject the value of a property.
-
+
* Output of printVObject
PrintVObject pretty prints a VObject tree in human
readable form. See the listing at the end of the file
@@ -748,20 +748,20 @@ of Example.vcf and its VObject Representation VObject *p2 = addProp(p1,VCDataSizeProp);
(void) setVObjectLongValue(p2,1482);
setVObjectAnyValue(vcard,...pointer to binary data);
-
+
Note the presence of VCBase64Prop will cause the
writeVObject API to output the binary data as BASE64 text.
For VCard/VCalendar application, having the VCBase64Prop
property is practically always necessary for property with
binary data as its value.
-
+
* Note on Quoted-Printable String
String value with embedded newline are written out as
quoted-prinatable string. It is therefore important
to mark a property with a string value that has
one or more embedded newlines, with the VCQutedPrintableProp
property. e.g.
-
+
// VObject *root;
char *msg="To be\nor\nnot to be";
VObject *p = addPropValue(root,VCDescriptionProp,msg);
@@ -805,7 +805,7 @@ of Example.vcf and its VObject Representation in the textual representation of VCard/VCalendar. So, there
is no version of writeVObject and the parser to output and
input Unicode textual representation of VCard/VCalendar.
-
+
Example.vcf
-----------
diff --git a/src/libicalvcal/icalvcal.c b/src/libicalvcal/icalvcal.c index 19fc184a..cfe3d79a 100644 --- a/src/libicalvcal/icalvcal.c +++ b/src/libicalvcal/icalvcal.c @@ -18,7 +18,7 @@ The original code is icalvcal.c The icalvcal_convert routine calls icalvcal_traverse_objects to do - its work.s his routine steps through through all of the properties + its work.s his routine steps through all of the properties and components of a VObject. For each name of a property or a component, icalvcal_traverse_objects looks up the name in conversion_table[]. This table indicates whether the name is of a diff --git a/src/python/Attendee.py b/src/python/Attendee.py index 247adc4f..ed6fde46 100644 --- a/src/python/Attendee.py +++ b/src/python/Attendee.py @@ -105,11 +105,11 @@ class Organizer(Property): return self[parameter] def name(self): - "Return the name of the property." + "Returns the name of the property." return Property.name(self) def value_type(self): - "Return the value type of the property." + "Returns the value type of the property." return self._desc['value_type'] # Methods for accessing enumerated parameters diff --git a/src/python/Component.py b/src/python/Component.py index 5a31d7d9..598e4977 100644 --- a/src/python/Component.py +++ b/src/python/Component.py @@ -129,7 +129,7 @@ class Component(object): def properties(self,type='ANY'): """ - Return a list of Property instances, each representing a + Returns a list of Property instances, each representing a property of the type 'type.' """ @@ -232,7 +232,7 @@ class Component(object): return icalcomponent_kind_to_string(k) def ref(self): - """ Return the internal reference to the libical icalproperty """ + """ Returns the internal reference to the libical icalproperty """ return self._ref def CloneComponent(c): diff --git a/src/python/Duration.py b/src/python/Duration.py index 40f7508e..8997f59d 100644 --- a/src/python/Duration.py +++ b/src/python/Duration.py @@ -73,7 +73,7 @@ class Duration(Property): self.value(icaldurationtype_as_ical_string(self.dur),"DURATION") def valid(self): - "Return true if this is a valid duration" + "Returns true if this is a valid duration" return not icaldurationtype_is_null_duration(self.dur) diff --git a/src/python/LibicalWrap_icaltime.i b/src/python/LibicalWrap_icaltime.i index f917f248..062c7746 100644 --- a/src/python/LibicalWrap_icaltime.i +++ b/src/python/LibicalWrap_icaltime.i @@ -18,7 +18,7 @@ Contributions from: - ======================================================================*/ + ======================================================================*/ // Add some methods to the icaltimetype struct %extend icaltimetype { @@ -26,32 +26,32 @@ /* ***** Special methods ***** */ int __cmp__(const icaltimetype b) { return icaltime_compare(*($self), b); } - + /* ***** Conversion methods ***** */ const char* as_ical_string() { return icaltime_as_ical_string(*($self)); } time_t as_timet(const icaltimezone *zone=NULL) { return icaltime_as_timet_with_zone(*($self), zone); } - + /* ***** Accessor methods ***** */ - + const char *get_tzid() { return icaltime_get_tzid(*($self)); } int day_of_year() { return icaltime_day_of_year(*($self)); } int day_of_week() { return icaltime_day_of_week(*($self)); } - /** Return the day of the year for the first day of the week that the + /** Returns the day of the year for the first day of the week that the given time is within. */ int start_doy_week(int fdow) { return icaltime_start_doy_week(*($self), fdow); } - /** Return the week number for the week the given time is within */ + /** Returns the week number for the week the given time is within */ int week_number() { return icaltime_week_number(*($self)); } - - + + /* ***** Query methods ***** */ - + int is_null_time() { return icaltime_is_null_time(*($self)); } /** Returns false if the time is clearly invalid, but is not null. This @@ -63,10 +63,10 @@ but they do the same thing. */ int is_date() { return icaltime_is_date(*($self)); } int is_utc() { return icaltime_is_utc(*($self)); } - + /* ***** Modify, compare and utility methods ***** */ - - /** Return -1, 0, or 1 to indicate that a<b, a==b or a>b */ + + /** Returns -1, 0, or 1 to indicate that a<b, a==b or a>b */ int compare(const icaltimetype b) { return icaltime_compare(*($self), b); } /** like icaltime_compare, but only use the date parts. */ @@ -81,7 +81,7 @@ return icaltime_adjust($self, days, hours, minutes, seconds); } - /** Normalize the icaltime, so that all fields are within the normal range. */ + /** Normalizes the icaltime, so that all fields are within the normal range. */ icaltimetype normalize() { return icaltime_normalize(*($self)); } icaltimetype convert_to_zone(icaltimezone *zone) { @@ -89,12 +89,12 @@ } /* ***** Static methods ***** */ - + static icaltimetype from_timet(const time_t tm, const int is_date=0, const icaltimezone *zone=NULL) { return icaltime_from_timet_with_zone(tm, is_date, zone); } - + static icaltimetype null_time(void) { return icaltime_null_time(); } static icaltimetype null_date(void) { return icaltime_null_date(); } @@ -117,18 +117,18 @@ return icaltime_from_string(str); } #endif - - /** Return the number of days in the given month */ + + /** Returns the number of days in the given month */ static int days_in_month(const int month, const int year) { return icaltime_days_in_month(month, year); } - /** Return whether you've specified a leapyear or not. */ + /** Returns whether you've specified a leapyear or not. */ static int is_leap_year (const int year) { return icaltime_is_leap_year(year); } - /** Return the number of days in this year */ + /** Returns the number of days in this year */ /* static int days_in_year (const int year) { return icaltime_days_in_year(year); } */ } @@ -154,7 +154,7 @@ icaltimetype.as_datetime = icaltimetype_as_datetime def icaltimetype_from_datetime(dt): "from_datetime() -> returns icaltimetype object" tt = icaltimetype() - + tt.year = dt.year tt.month = dt.month tt.day = dt.day @@ -166,7 +166,7 @@ def icaltimetype_from_datetime(dt): tt.zone = 0 tt.is_date = False tt.isdaylight = False - + return tt icaltimetype.from_datetime = staticmethod(icaltimetype_from_datetime) diff --git a/src/python/LibicalWrap_icaltimezone.i b/src/python/LibicalWrap_icaltimezone.i index 75c80860..320369cd 100644 --- a/src/python/LibicalWrap_icaltimezone.i +++ b/src/python/LibicalWrap_icaltimezone.i @@ -78,7 +78,7 @@ void icaltimezone_set_tzid_prefix(const char *new_prefix); * @par Accessing timezones. */ -/** Free any builtin timezone information **/ +/** Frees any builtin timezone information **/ void icaltimezone_free_builtin_timezones(void); /** Returns the array of builtin icaltimezones. */ @@ -118,10 +118,10 @@ int icaltimezone_get_utc_offset_of_utc_time (icaltimezone *zone, * @par Handling the default location the timezone files */ -/** Set the directory to look for the zonefiles */ +/** Sets the directory to look for the zonefiles */ void set_zone_directory(const char *path); -/** Free memory dedicated to the zonefile directory */ +/** Frees the memory dedicated to the zonefile directory */ void free_zone_directory(void); void icaltimezone_release_zone_tab(void); diff --git a/src/python/Period.py b/src/python/Period.py index 450ed598..6c95edee 100644 --- a/src/python/Period.py +++ b/src/python/Period.py @@ -82,7 +82,7 @@ class Period(Property): def valid(self): - "Return true if this is a valid period" + "Returns true if this is a valid period" return not icalperiodtype_is_null_period(self.dur) diff --git a/src/python/Property.py b/src/python/Property.py index 24e39f9e..430b37aa 100644 --- a/src/python/Property.py +++ b/src/python/Property.py @@ -95,11 +95,11 @@ class Property(object): icalproperty_free(self.ref()) def name(self,v=None): - """ Return the name of the property """ + """ Returns the name of the property """ return icalproperty_get_property_name(self._ref) def ref(self,v=None): - """ Return the internal reference to the libical icalproperty """ + """ Returns the internal reference to the libical icalproperty """ if(v != None): if not self._deleted and self._ref and \ @@ -113,7 +113,7 @@ class Property(object): def value(self,v=None, kind = None): - """ Return the RFC2445 representation of the value """ + """ Returns the RFC2445 representation of the value """ if(v != None): @@ -154,7 +154,7 @@ class Property(object): def parameters(self): """ - Return a list of parameters + Returns a list of parameters """ params = [] @@ -169,11 +169,11 @@ class Property(object): return params def as_ical_string(self): - "Return the property in iCalendar text format." + "Returns the property in iCalendar text format." return icalproperty_as_ical_string(self._ref) def __getitem__(self,key): - """ Return property values by name """ + """ Returns property values by name """ key = upper(key) str = icalproperty_get_parameter_as_string(self._ref,key) @@ -251,6 +251,6 @@ class RecurrenceSet: def occurrences(self, count=None): """ - Return 'count' occurrences as a tuple of Time instances. + Returns 'count' occurrences as a tuple of Time instances. """ pass diff --git a/src/python/Time.py b/src/python/Time.py index f3731e6d..f94770ce 100644 --- a/src/python/Time.py +++ b/src/python/Time.py @@ -78,11 +78,11 @@ class Time(Property): self.value(icaltime_as_ical_string(self.tt),"DATE-TIME") def valid(self): - " Return true if this is a valid time " + " Returns true if this is a valid time " return not icaltime_is_null_time(self.tt) def utc_seconds(self,v=None): - """ Return or set time in seconds past POSIX epoch""" + """ Returns or sets time in seconds past POSIX epoch""" tz = icaltimezone_get_builtin_timezone(self.timezone()) if (v!=None): self.tt = icaltime_from_timet_with_zone(v,0,tz) @@ -91,15 +91,15 @@ class Time(Property): return icaltime_as_timet_with_zone(self.tt, tz) def is_utc(self): - """ Return a boolean indicating if time is in UTC """ + """ Returns a boolean indicating if time is in UTC """ return icaltime_is_utc(self.tt) def is_date(self): - """ Return a boolean indicating if time is actually a date """ + """ Returns a boolean indicating if time is actually a date """ return icaltime_is_date(self.tt) def timezone(self,v=None): - """ Return, set (if none) or alter the timezone for this time """ + """ Returns, set (if none) or alter the timezone for this time """ origtz = icaltime_get_tzid(self.tt) diff --git a/src/python/python-binding.txt b/src/python/python-binding.txt index 7f925e24..613022a6 100644 --- a/src/python/python-binding.txt +++ b/src/python/python-binding.txt @@ -41,7 +41,7 @@ Component is the central class in the design. The component can be though of as a container for child components and properties, or as representation of a specific kind of iCal object. The first interface offers general property and component accessors, and the -second treats some types of objects in a special way. +second treats some types of objects in a special way. The general interface offers simple manipulators for child property and components, and it only works with immediate children. So, given @@ -57,57 +57,57 @@ the Component: END:VCALENDAR A caller would have to descend three levels to access the COMMENT -property in the alarm, but only one to access the METHOD property. +property in the alarm, but only one to access the METHOD property. Libical is almost entirely dedicated to the general interface; it includes all of the *get_first_*, *_next_next_*, *_add_* and *_remove_* -routines. +routines. The specific interface works with derived classes of Property and Component. In this interface, the caller could get the COMMENT in the alarm in the example in two steps. First the caller would ask the -Event object for its alarms, then then the caller would ask the first -Alarm object for its comment. +Event object for its alarms, then the caller would ask the first +Alarm object for its comment. The Specific interface is part of the -derived classes of Component. This interface names all of the types of +derived classes of Component. This interface names all of the types of properties and components that can be accessed from the derived -component type. +component type. In libical, the specific interface is primarily the "convenience -routines in icalcomponent.h, such as: +routines in icalcomponent.h, such as: struct icaltimetype icalcomponent_get_dtend(icalcomponent* comp); void icalcomponent_set_dtend(icalcomponent* comp, struct icaltimetype v); - void icalcomponent_set_duration(icalcomponent* comp, + void icalcomponent_set_duration(icalcomponent* comp, struct icaldurationtype v); struct icaldurationtype icalcomponent_get_duration(icalcomponent* comp); These routines are smarter and do more work than the general interface. From the general interface, you can set the DTEND property of a component by creating the property and adding it to a -component. But, if the component already has a DURATION property, then -this is an error -- a component can't have both. +component. But, if the component already has a DURATION property, then +this is an error -- a component can't have both. icalcomponent_set_dtend determines if the component already has a DURATION. If it does, it substracts the dtstart time from the new dtend time and sets the duration to that. Otherwise, it creates aor -changes the DTEND. +changes the DTEND. Also, icalcomponent_set_duration works the same regardless if the component is a VCALENDAR or a VEVENT. If it is a VCALENDAR, the routine descends into the VEVENT before making any changes. If it is allready a VEVENT ( or VTODO or VJOURNAL ) the routine just makes the changes. With icalcomponent_add_property, you need to do this check -yourself. +yourself. ( There should probably be a class between Component and Event ,JournalEntry and Todo that names all of the properties and components. Then Event, JournalEntry and Todo would remove the accessors that did not apply to them. ) - + Parameters are accessed as dictionaries from Property or as attributes of a derived class of Property. Both the names and the values of the parameters are strings. @@ -122,11 +122,11 @@ libical module: CAPStore Access components in a CAP server HeapStore Components stored in memory MySQLStore Components stored in a MySQL - database. + database. -The only iCal value objects that will be implemented as Python classes +The only iCal value objects that will be implemented as Python classes are Time, Duration and Period. RecurrenceSet handles recurrence -rules. It replaces the properties RRULE, RDATE, EXRULE and EXDATE. +rules. It replaces the properties RRULE, RDATE, EXRULE and EXDATE. (Not all of the libical modules are implemented ) @@ -134,33 +134,33 @@ rules. It replaces the properties RRULE, RDATE, EXRULE and EXDATE. How to Use the library ---------------------- -The most common usecases will be something like this: +The most common usecases will be something like this: 1)Caller opens a Store object on a file, server or database. The -caller retrieves one or more component. Some of the components will be +caller retrieves one or more component. Some of the components will be booked on the user's calendar. Other components will be messages that -other users have sent, like requests for meetings. +other users have sent, like requests for meetings. -2) The caller will use the Specific interface ( using methods specific -to each property ) to example the component and decide what to do with -it. +2) The caller will use the Specific interface ( using methods specific +to each property ) to example the component and decide what to do with +it. 3) Rarely, the caller will access the general interface to do things that the specific interface has not implemented or cannot manage -well. +well. 4) Caller may create a new component, using a combination of the general and specific interfaces. The caller may send the message to another user via mail, or may submit it to the user's CAP server with -the CAPStore class. +the CAPStore class. + - -Following are the methods in each of the classes. +Following are the methods in each of the classes. Component Construct from string Output string in ical form - + Get a Property by type Get a set of Properties by type Remove a Property by reference @@ -175,7 +175,7 @@ Component Convert error properties into REQUEST-STATUS properties Event, JournalEntry, Todo - + Construct from string Output string in ical form @@ -186,7 +186,7 @@ Event, JournalEntry, Todo FreeBusy Construct from string - Construct from arguments + Construct from arguments Output string in ical form Accessors for the following properties. See below for return @@ -210,7 +210,7 @@ FreeBusy TimezonePhase Construct from string - Construct from arguments + Construct from arguments Output string in ical form Accessors for the following properties. See below for return @@ -226,7 +226,7 @@ TimezonePhase TimeZone Construct from string - Construct from arguments + Construct from arguments Output string in ical form Accessors for the following properties. See below for return @@ -240,7 +240,7 @@ TimeZone Property - + Construct from string Construct from arguments Output string in ical form @@ -281,13 +281,13 @@ Time Date Period - Same interfaces as libical modules. + Same interfaces as libical modules. RecurenceSet - I don't know -- need to think about it more. + I don't know -- need to think about it more. Store - Similar methods to the icalset modules. + Similar methods to the icalset modules. RFC2445 Properties @@ -298,7 +298,7 @@ VALUE type. Property Value ---------------------------- -CALSCALE TEXT +CALSCALE TEXT METHOD TEXT PRODID TEXT VERSION TEXT @@ -335,7 +335,7 @@ DTSTAMP DATE-TIME LAST-MODIFIED DATE-TIME SEQUENCE INTEGER X TEXT -REQUEST-STATUS STRING +REQUEST-STATUS STRING ATTACH URL, BINARY GEO FLOAT DTEND DATE-TIME @@ -345,14 +345,14 @@ RECURRENCE-ID DATE-TIME EXDATE DATE-TIME RDATE DATE-TIME, PERIOD TRIGGER DATE-TIME, DURATION -DURATION DURATION +DURATION DURATION -Some of the properties can appear multiple times in a component, other +Some of the properties can appear multiple times in a component, other can appear only once. For a particular component, the number of times a property can apper may also change with the METHOD property associated with the component. This list shows which properties can appear multiple times for some ( but not all ) combinations of -component type and METHOD value: +component type and METHOD value: ATTACH ATTENDEE @@ -370,7 +370,7 @@ RESOURCES RRULE TZNAME TZURL -X +X This is a list of the value types and their associated python return @@ -404,7 +404,7 @@ I suspect that the Component class should use the three previous tables to create the property accessor methods on the fly. If the method generation system is general enough, we could also use it for other classes, such as Alarm, Timezone, Attendee, Organizer and -Freebusy. +Freebusy. Memory Handling @@ -423,12 +423,12 @@ libical tries to reference freed memory. The situation is actually a little better than that, because libical will throw an error when you try to free a component that is still -attached to a parent. +attached to a parent. So, the perl library has to be able to determine when the destructor should free a libical component or not. The perl library calls icalcomponent_get_parent(), and if is it non-zero, it does not free the component. -It is not hard, just more code, and something to watch out for. +It is not hard, just more code, and something to watch out for. diff --git a/src/test/regression-classify.c b/src/test/regression-classify.c index 24480c7c..38cacfee 100644 --- a/src/test/regression-classify.c +++ b/src/test/regression-classify.c @@ -27,7 +27,7 @@ #include <libicalss/icalss.h> #include "regression.h" -/* Get a note about the purpose of the property*/ +/* Gets a note about the purpose of the property*/ static const char *get_note(icalcomponent *c) { icalproperty *p; @@ -49,7 +49,7 @@ static const char *get_note(icalcomponent *c) return note; } -/* Get the expected result about the purpose of the property*/ +/* Gets the expected result about the purpose of the property*/ static const char *get_expect(icalcomponent *c) { diff --git a/src/test/regression-recur.c b/src/test/regression-recur.c index 91dd1a7d..e11112e6 100644 --- a/src/test/regression-recur.c +++ b/src/test/regression-recur.c @@ -38,7 +38,7 @@ static void sig_alrm(int i) #endif -/* Get the expected result about the purpose of the property*/ +/* Gets the expected result about the purpose of the property*/ static int get_expected_numevents(icalcomponent *c) { diff --git a/src/test/regression.c b/src/test/regression.c index ef4717ac..8b802e09 100644 --- a/src/test/regression.c +++ b/src/test/regression.c @@ -90,7 +90,7 @@ END:BOOGA\ END:VCALENDAR"; */ -/* Return a list of all attendees who are required. */ +/* Returns a list of all attendees who are required. */ /* static char** get_required_attendees(icalcomponent* event) { |