[libgdata] [docs] Added "Since" clauses to all relevant documentation
- From: Philip Withnall <pwithnall src gnome org>
- To: svn-commits-list gnome org
- Subject: [libgdata] [docs] Added "Since" clauses to all relevant documentation
- Date: Fri, 24 Apr 2009 14:16:16 -0400 (EDT)
commit 9c00679859d7f5d865185983f9cc34c142035ff6
Author: Philip Withnall <philip tecnocode co uk>
Date: Fri Apr 24 19:15:32 2009 +0100
[docs] Added "Since" clauses to all relevant documentation
---
gdata/gdata-entry.c | 7 +++
gdata/gdata-feed.c | 8 +++
gdata/gdata-gdata.c | 28 +++++++++++
gdata/gdata-query.c | 12 +++++
gdata/gdata-service.c | 12 ++++-
gdata/services/calendar/gdata-calendar-calendar.c | 12 +++++
gdata/services/calendar/gdata-calendar-event.c | 16 ++++++
gdata/services/calendar/gdata-calendar-query.c | 6 ++
gdata/services/calendar/gdata-calendar-service.c | 2 +
gdata/services/contacts/gdata-contacts-contact.c | 54 +++++++++++++++++++++
gdata/services/contacts/gdata-contacts-query.c | 28 +++++++++++
gdata/services/contacts/gdata-contacts-service.c | 10 +++-
12 files changed, 192 insertions(+), 3 deletions(-)
diff --git a/gdata/gdata-entry.c b/gdata/gdata-entry.c
index 9eef16a..c1cfa22 100644
--- a/gdata/gdata-entry.c
+++ b/gdata/gdata-entry.c
@@ -101,6 +101,7 @@ gdata_entry_class_init (GDataEntryClass *klass)
"ID", "The ID for this entry.",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
+ /* Since: 0.2.0 */
g_object_class_install_property (gobject_class, PROP_ETAG,
g_param_spec_string ("etag",
"ETag", "The ETag for this entry.",
@@ -635,6 +636,8 @@ gdata_entry_get_id (GDataEntry *self)
* <ulink type="http" url="http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning";>online documentation</ulink>.
*
* Return value: the entry's ETag
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_entry_get_etag (GDataEntry *self)
@@ -696,6 +699,8 @@ gdata_entry_add_category (GDataEntry *self, GDataCategory *category)
* Gets a list of the #GDataCategory<!-- -->s containing this entry.
*
* Return value: a #GList of #GDataCategory<!-- -->s
+ *
+ * Since: 0.2.0
**/
GList *
gdata_entry_get_categories (GDataEntry *self)
@@ -767,6 +772,8 @@ link_compare_cb (const GDataLink *link, const gchar *rel)
* Looks up a link by <structfield>rel</structfield> value from the list of links in the entry.
*
* Return value: a #GDataLink, or %NULL if one was not found
+ *
+ * Since: 0.1.1
**/
GDataLink *
gdata_entry_look_up_link (GDataEntry *self, const gchar *rel)
diff --git a/gdata/gdata-feed.c b/gdata/gdata-feed.c
index e990018..2b042df 100644
--- a/gdata/gdata-feed.c
+++ b/gdata/gdata-feed.c
@@ -138,6 +138,8 @@ gdata_feed_class_init (GDataFeedClass *klass)
* The unique ETag for this version of the feed. See the
* <ulink type="http" url="http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning";>online documentation</ulink> for
* more information.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_ETAG,
g_param_spec_string ("etag",
@@ -763,6 +765,8 @@ entry_compare_cb (const GDataEntry *entry, const gchar *id)
* Returns the entry in the feed with the given @id, if found.
*
* Return value: the #GDataEntry, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataEntry *
gdata_feed_look_up_entry (GDataFeed *self, const gchar *id)
@@ -822,6 +826,8 @@ link_compare_cb (const GDataLink *link, const gchar *rel)
* Looks up a link by <structfield>rel</structfield> value from the list of links in the feed.
*
* Return value: a #GDataLink, or %NULL if one was not found
+ *
+ * Since: 0.1.1
**/
GDataLink *
gdata_feed_look_up_link (GDataFeed *self, const gchar *rel)
@@ -904,6 +910,8 @@ gdata_feed_get_id (GDataFeed *self)
* Returns the feed's unique ETag for this version.
*
* Return value: the feed's ETag
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_feed_get_etag (GDataFeed *self)
diff --git a/gdata/gdata-gdata.c b/gdata/gdata-gdata.c
index 8b1b576..53f61a8 100644
--- a/gdata/gdata-gdata.c
+++ b/gdata/gdata-gdata.c
@@ -130,6 +130,8 @@ gdata_gd_feed_link_free (GDataGDFeedLink *self)
* by the caller after a call to gdata_gd_when_new has finished.
*
* Return value: a new #GDataGDWhen, or %NULL; free with gdata_gd_when_free()
+ *
+ * Since: 0.2.0
**/
GDataGDWhen *
gdata_gd_when_new (GTimeVal *start_time, GTimeVal *end_time, gboolean is_date, const gchar *value_string, GList *reminders)
@@ -160,6 +162,8 @@ gdata_gd_when_new (GTimeVal *start_time, GTimeVal *end_time, gboolean is_date, c
* @self: a #GDataGDWhen
*
* Frees a #GDataGDWhen.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_when_free (GDataGDWhen *self)
@@ -266,6 +270,8 @@ gdata_gd_where_free (GDataGDWhere *self)
* url="http://code.google.com/apis/gdata/elements.html#gdEmail";>GData specification</ulink>.
*
* Return value: a new #GDataGDEmailAddress, or %NULL; free with gdata_gd_email_address_free()
+ *
+ * Since: 0.2.0
**/
GDataGDEmailAddress *
gdata_gd_email_address_new (const gchar *address, const gchar *rel, const gchar *label, gboolean primary)
@@ -287,6 +293,8 @@ gdata_gd_email_address_new (const gchar *address, const gchar *rel, const gchar
* @self: a #GDataGDEmailAddress
*
* Frees a #GDataGDEmailAddress.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_email_address_free (GDataGDEmailAddress *self)
@@ -312,6 +320,8 @@ gdata_gd_email_address_free (GDataGDEmailAddress *self)
* url="http://code.google.com/apis/gdata/elements.html#gdIm";>GData specification</ulink>.
*
* Return value: a new #GDataGDIMAddress, or %NULL; free with gdata_gd_im_address_free()
+ *
+ * Since: 0.2.0
**/
GDataGDIMAddress *
gdata_gd_im_address_new (const gchar *address, const gchar *protocol, const gchar *rel, const gchar *label, gboolean primary)
@@ -334,6 +344,8 @@ gdata_gd_im_address_new (const gchar *address, const gchar *protocol, const gcha
* @self: a #GDataGDIMAddress
*
* Frees a #GDataGDIMAddress.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_im_address_free (GDataGDIMAddress *self)
@@ -361,6 +373,8 @@ gdata_gd_im_address_free (GDataGDIMAddress *self)
* url="http://code.google.com/apis/gdata/elements.html#gdPhoneNumber";>GData specification</ulink>.
*
* Return value: a new #GDataGDPhoneNumber, or %NULL; free with gdata_gd_phone_number_free()
+ *
+ * Since: 0.2.0
**/
GDataGDPhoneNumber *
gdata_gd_phone_number_new (const gchar *number, const gchar *rel, const gchar *label, const gchar *uri, gboolean primary)
@@ -383,6 +397,8 @@ gdata_gd_phone_number_new (const gchar *number, const gchar *rel, const gchar *l
* @self: a #GDataGDPhoneNumber
*
* Frees a #GDataGDPhoneNumber.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_phone_number_free (GDataGDPhoneNumber *self)
@@ -408,6 +424,8 @@ gdata_gd_phone_number_free (GDataGDPhoneNumber *self)
* url="http://code.google.com/apis/gdata/elements.html#gdPostalAddress";>GData specification</ulink>.
*
* Return value: a new #GDataGDPostalAddress, or %NULL; free with gdata_gd_postal_address_free()
+ *
+ * Since: 0.2.0
**/
GDataGDPostalAddress *
gdata_gd_postal_address_new (const gchar *address, const gchar *rel, const gchar *label, gboolean primary)
@@ -429,6 +447,8 @@ gdata_gd_postal_address_new (const gchar *address, const gchar *rel, const gchar
* @self: a #GDataGDPostalAddress
*
* Frees a #GDataGDPostalAddress.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_postal_address_free (GDataGDPostalAddress *self)
@@ -454,6 +474,8 @@ gdata_gd_postal_address_free (GDataGDPostalAddress *self)
* url="http://code.google.com/apis/gdata/elements.html#gdOrganization";>GData specification</ulink>.
*
* Return value: a new #GDataGDOrganization, or %NULL; free with gdata_gd_organization_free()
+ *
+ * Since: 0.2.0
**/
GDataGDOrganization *
gdata_gd_organization_new (const gchar *name, const gchar *title, const gchar *rel, const gchar *label, gboolean primary)
@@ -472,6 +494,8 @@ gdata_gd_organization_new (const gchar *name, const gchar *title, const gchar *r
* @self: a #GDataGDOrganization
*
* Frees a #GDataGDOrganization.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_organization_free (GDataGDOrganization *self)
@@ -498,6 +522,8 @@ gdata_gd_organization_free (GDataGDOrganization *self)
* url="http://code.google.com/apis/gdata/elements.html#gdReminder";>GData specification</ulink>.
*
* Return value: a new #GDataGDReminder, or %NULL; free with gdata_gd_reminder_free()
+ *
+ * Since: 0.2.0
**/
GDataGDReminder *
gdata_gd_reminder_new (const gchar *method, GTimeVal *absolute_time, gint days, gint hours, gint minutes)
@@ -531,6 +557,8 @@ gdata_gd_reminder_new (const gchar *method, GTimeVal *absolute_time, gint days,
* @self: a #GDataGDReminder
*
* Frees a #GDataGDReminder.
+ *
+ * Since: 0.2.0
**/
void
gdata_gd_reminder_free (GDataGDReminder *self)
diff --git a/gdata/gdata-query.c b/gdata/gdata-query.c
index f8b6169..114213c 100644
--- a/gdata/gdata-query.c
+++ b/gdata/gdata-query.c
@@ -240,6 +240,8 @@ gdata_query_class_init (GDataQueryClass *klass)
*
* Strict query parameter checking. If this is enabled, an error will be returned by the online service if a parameter is
* not recognised.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_IS_STRICT,
g_param_spec_boolean ("is-strict",
@@ -275,6 +277,8 @@ gdata_query_class_init (GDataQueryClass *klass)
*
* The ETag against which to check for updates. If the server-side ETag matches this one, the requested feed hasn't changed, and is not
* returned unnecessarily.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_ETAG,
g_param_spec_string ("etag",
@@ -930,6 +934,8 @@ gdata_query_set_start_index (GDataQuery *self, gint start_index)
* Gets the #GDataQuery:is-strict property.
*
* Return value: the strict property
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_query_is_strict (GDataQuery *self)
@@ -944,6 +950,8 @@ gdata_query_is_strict (GDataQuery *self)
* @is_strict: the new strict value
*
* Sets the #GDataQuery:is-strict property of the #GDataQuery to the new strict value, @is_strict.
+ *
+ * Since: 0.2.0
**/
void
gdata_query_set_is_strict (GDataQuery *self, gboolean is_strict)
@@ -1047,6 +1055,8 @@ gdata_query_set_entry_id (GDataQuery *self, const gchar *entry_id)
* Gets the #GDataQuery:etag property.
*
* Return value: the ETag property, or %NULL if it is unset
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_query_get_etag (GDataQuery *self)
@@ -1063,6 +1073,8 @@ gdata_query_get_etag (GDataQuery *self)
* Sets the #GDataQuery:etag property of the #GDataQuery to the new ETag, @etag.
*
* Set @etag to %NULL to not check against the server-side ETag.
+ *
+ * Since: 0.2.0
**/
void
gdata_query_set_etag (GDataQuery *self, const gchar *etag)
diff --git a/gdata/gdata-service.c b/gdata/gdata-service.c
index 7f010cd..086f0ab 100644
--- a/gdata/gdata-service.c
+++ b/gdata/gdata-service.c
@@ -160,12 +160,14 @@ gdata_service_class_init (GDataServiceClass *klass)
* GDataService:proxy-uri:
*
* The proxy URI used internally for all Internet requests.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_PROXY_URI,
g_param_spec_boxed ("proxy-uri",
"Proxy URI", "The proxy URI used internally for all Internet requests.",
SOUP_TYPE_URI,
- G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GDataService::captcha-challenge:
@@ -1065,6 +1067,8 @@ gdata_service_insert_entry (GDataService *self, const gchar *upload_uri, GDataEn
* <emphasis>cannot</emphasis> cannot override this or provide more specific errors.
*
* Return value: an updated #GDataEntry, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataEntry *
gdata_service_update_entry (GDataService *self, GDataEntry *entry, GCancellable *cancellable, GError **error)
@@ -1147,6 +1151,8 @@ gdata_service_update_entry (GDataService *self, GDataEntry *entry, GCancellable
* <emphasis>cannot</emphasis> cannot override this or provide more specific errors.
*
* Return value: %TRUE on success, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_service_delete_entry (GDataService *self, GDataEntry *entry, GCancellable *cancellable, GError **error)
@@ -1207,6 +1213,8 @@ notify_proxy_uri_cb (GObject *gobject, GParamSpec *pspec, GObject *self)
* Gets the proxy URI on the #GDataService's #SoupSession.
*
* Return value: the proxy URI, or %NULL
+ *
+ * Since: 0.2.0
**/
SoupURI *
gdata_service_get_proxy (GDataService *self)
@@ -1228,6 +1236,8 @@ gdata_service_get_proxy (GDataService *self)
*
* Sets the proxy URI on the #SoupSession used internally by the given #GDataService.
* This forces all requests through the given proxy.
+ *
+ * Since: 0.2.0
**/
void
gdata_service_set_proxy (GDataService *self, SoupURI *proxy_uri)
diff --git a/gdata/services/calendar/gdata-calendar-calendar.c b/gdata/services/calendar/gdata-calendar-calendar.c
index d8b7ee3..316c2b8 100644
--- a/gdata/services/calendar/gdata-calendar-calendar.c
+++ b/gdata/services/calendar/gdata-calendar-calendar.c
@@ -115,6 +115,8 @@ gdata_calendar_calendar_class_init (GDataCalendarCalendarClass *klass)
* GDataCalendarCalendar:is-hidden:
*
* Indicates whether the calendar is visible.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_IS_HIDDEN,
g_param_spec_boolean ("is-hidden",
@@ -137,6 +139,8 @@ gdata_calendar_calendar_class_init (GDataCalendarCalendarClass *klass)
* GDataCalendarCalendar:is-selected:
*
* Indicates whether the calendar is selected.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_IS_SELECTED,
g_param_spec_boolean ("is-selected",
@@ -447,6 +451,8 @@ gdata_calendar_calendar_get_times_cleaned (GDataCalendarCalendar *self)
* Gets the #GDataCalendarCalendar:is-hidden property.
*
* Return value: %TRUE if the calendar is hidden, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_calendar_calendar_is_hidden (GDataCalendarCalendar *self)
@@ -461,6 +467,8 @@ gdata_calendar_calendar_is_hidden (GDataCalendarCalendar *self)
* @is_hidden: %TRUE to hide the calendar, %FALSE otherwise
*
* Sets the #GDataCalendarCalendar:is-hidden property to @is_hidden.
+ *
+ * Since: 0.2.0
**/
void
gdata_calendar_calendar_set_is_hidden (GDataCalendarCalendar *self, gboolean is_hidden)
@@ -508,6 +516,8 @@ gdata_calendar_calendar_set_color (GDataCalendarCalendar *self, GDataColor *colo
* Gets the #GDataCalendarCalendar:is-selected property.
*
* Return value: %TRUE if the calendar is selected, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_calendar_calendar_is_selected (GDataCalendarCalendar *self)
@@ -522,6 +532,8 @@ gdata_calendar_calendar_is_selected (GDataCalendarCalendar *self)
* @is_selected: %TRUE to select the calendar, %FALSE otherwise
*
* Sets the #GDataCalendarCalendar:is-selected property to @is_selected.
+ *
+ * Since: 0.2.0
**/
void
gdata_calendar_calendar_set_is_selected (GDataCalendarCalendar *self, gboolean is_selected)
diff --git a/gdata/services/calendar/gdata-calendar-event.c b/gdata/services/calendar/gdata-calendar-event.c
index 72c9596..35024b6 100644
--- a/gdata/services/calendar/gdata-calendar-event.c
+++ b/gdata/services/calendar/gdata-calendar-event.c
@@ -119,6 +119,8 @@ gdata_calendar_event_class_init (GDataCalendarEventClass *klass)
*
* For more information, see the <ulink type="http" url="http://code.google.com/apis/gdata/elements.html#gdEventStatus";>
* GData specification</ulink>.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_STATUS,
g_param_spec_string ("status",
@@ -727,6 +729,8 @@ gdata_calendar_event_get_edited (GDataCalendarEvent *self, GTimeVal *edited)
* Gets the #GDataCalendarEvent:status property.
*
* Return value: the event status, or %NULL
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_calendar_event_get_status (GDataCalendarEvent *self)
@@ -743,6 +747,8 @@ gdata_calendar_event_get_status (GDataCalendarEvent *self)
* Sets the #GDataCalendarEvent:status property to the new status, @status.
*
* Set @status to %NULL to unset the property in the event.
+ *
+ * Since: 0.2.0
**/
void
gdata_calendar_event_set_status (GDataCalendarEvent *self, const gchar *status)
@@ -1031,6 +1037,8 @@ gdata_calendar_event_add_person (GDataCalendarEvent *self, GDataGDWho *who)
* Gets a list of the people attending the event.
*
* Return value: a #GList of #GDataGDWho<!-- -->s, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_calendar_event_get_people (GDataCalendarEvent *self)
@@ -1063,6 +1071,8 @@ gdata_calendar_event_add_place (GDataCalendarEvent *self, GDataGDWhere *where)
* Gets a list of the locations associated with the event.
*
* Return value: a #GList of #GDataGDWhere<!-- -->s, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_calendar_event_get_places (GDataCalendarEvent *self)
@@ -1078,6 +1088,8 @@ gdata_calendar_event_get_places (GDataCalendarEvent *self)
*
* Adds @when to the event as a time period when the event happens.
* The #GDataCalendarEvent takes ownership of @when, so it must not be freed after being added.
+ *
+ * Since: 0.2.0
**/
void
gdata_calendar_event_add_time (GDataCalendarEvent *self, GDataGDWhen *when)
@@ -1095,6 +1107,8 @@ gdata_calendar_event_add_time (GDataCalendarEvent *self, GDataGDWhen *when)
* Gets a list of the time periods associated with the event.
*
* Return value: a #GList of #GDataGDWhen<!-- -->s, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_calendar_event_get_times (GDataCalendarEvent *self)
@@ -1117,6 +1131,8 @@ gdata_calendar_event_get_times (GDataCalendarEvent *self)
* be returned, and the parameters will remain unmodified.
*
* Return value: %TRUE if there is only one time period associated with the event, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_calendar_event_get_primary_time (GDataCalendarEvent *self, GTimeVal *start_time, GTimeVal *end_time, GDataGDWhen **when)
diff --git a/gdata/services/calendar/gdata-calendar-query.c b/gdata/services/calendar/gdata-calendar-query.c
index 7a5a29f..99f10e0 100644
--- a/gdata/services/calendar/gdata-calendar-query.c
+++ b/gdata/services/calendar/gdata-calendar-query.c
@@ -190,6 +190,8 @@ gdata_calendar_query_class_init (GDataCalendarQueryClass *klass)
* GDataCalendarQuery:timezone:
*
* The current timezone. If not specified, times are returned in UTC.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_TIMEZONE,
g_param_spec_string ("timezone",
@@ -712,6 +714,8 @@ gdata_calendar_query_set_start_max (GDataCalendarQuery *self, GTimeVal *start_ma
* Gets the #GDataCalendarQuery:timezone property.
*
* Return value: the timezone property, or %NULL if it is unset
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_calendar_query_get_timezone (GDataCalendarQuery *self)
@@ -728,6 +732,8 @@ gdata_calendar_query_get_timezone (GDataCalendarQuery *self)
* Sets the #GDataCalendarQuery:timezone property of the #GDataCalendarQuery to the new timezone string, @timezone.
*
* Set @timezone to %NULL to unset the property in the query URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_calendar_query_set_timezone (GDataCalendarQuery *self, const gchar *_timezone)
diff --git a/gdata/services/calendar/gdata-calendar-service.c b/gdata/services/calendar/gdata-calendar-service.c
index 18b566e..6c720aa 100644
--- a/gdata/services/calendar/gdata-calendar-service.c
+++ b/gdata/services/calendar/gdata-calendar-service.c
@@ -265,6 +265,8 @@ gdata_calendar_service_query_events (GDataCalendarService *self, GDataCalendarCa
* For more details, see gdata_service_insert_entry().
*
* Return value: an updated #GDataCalendarEvent, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataCalendarEvent *
gdata_calendar_service_insert_event (GDataCalendarService *self, GDataCalendarEvent *event, GCancellable *cancellable, GError **error)
diff --git a/gdata/services/contacts/gdata-contacts-contact.c b/gdata/services/contacts/gdata-contacts-contact.c
index f4ea09f..1ed79de 100644
--- a/gdata/services/contacts/gdata-contacts-contact.c
+++ b/gdata/services/contacts/gdata-contacts-contact.c
@@ -95,6 +95,8 @@ gdata_contacts_contact_class_init (GDataContactsContactClass *klass)
*
* For more information, see the <ulink type="http" url="http://www.atomenabled.org/developers/protocol/#appEdited";>
* Atom Publishing Protocol specification</ulink>.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_EDITED,
g_param_spec_boxed ("edited",
@@ -106,6 +108,8 @@ gdata_contacts_contact_class_init (GDataContactsContactClass *klass)
* GDataContactsContact:deleted:
*
* Whether the entry has been deleted.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_DELETED,
g_param_spec_boolean ("deleted",
@@ -170,6 +174,8 @@ gdata_contacts_contact_get_property (GObject *object, guint property_id, GValue
* Creates a new #GDataContactsContact with the given ID and default properties.
*
* Return value: a new #GDataContactsContact; unref with g_object_unref()
+ *
+ * Since: 0.2.0
**/
GDataContactsContact *
gdata_contacts_contact_new (const gchar *id)
@@ -189,6 +195,8 @@ gdata_contacts_contact_new (const gchar *id)
* Errors from #GDataParserError can be returned if problems are found in the XML.
*
* Return value: a new #GDataContactsContact, or %NULL; unref with g_object_unref()
+ *
+ * Since: 0.2.0
**/
GDataContactsContact *
gdata_contacts_contact_new_from_xml (const gchar *xml, gint length, GError **error)
@@ -648,6 +656,8 @@ get_namespaces (GDataEntry *entry, GHashTable *namespaces)
*
* Gets the #GDataContactsContact:edited property and puts it in @edited. If the property is unset,
* both fields in the #GTimeVal will be set to %0.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_get_edited (GDataContactsContact *self, GTimeVal *edited)
@@ -668,6 +678,8 @@ gdata_contacts_contact_get_edited (GDataContactsContact *self, GTimeVal *edited)
* Note that only one e-mail address per contact may be marked as "primary". Insertion and update operations
* (with gdata_contacts_service_insert_contact()) will return an error if more than one e-mail address
* is marked as primary.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_email_address (GDataContactsContact *self, GDataGDEmailAddress *email_address)
@@ -685,6 +697,8 @@ gdata_contacts_contact_add_email_address (GDataContactsContact *self, GDataGDEma
* Gets a list of the e-mail addresses owned by the contact.
*
* Return value: a #GList of #GDataGDEmailAddress<!-- -->es, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_email_addresses (GDataContactsContact *self)
@@ -700,6 +714,8 @@ gdata_contacts_contact_get_email_addresses (GDataContactsContact *self)
* Gets the contact's primary e-mail address, if one exists.
*
* Return value: a #GDataGDEmailAddress, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataGDEmailAddress *
gdata_contacts_contact_get_primary_email_address (GDataContactsContact *self)
@@ -727,6 +743,8 @@ gdata_contacts_contact_get_primary_email_address (GDataContactsContact *self)
* Note that only one IM address per contact may be marked as "primary". Insertion and update operations
* (with gdata_contacts_service_insert_contact()) will return an error if more than one IM address
* is marked as primary.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_im_address (GDataContactsContact *self, GDataGDIMAddress *im_address)
@@ -744,6 +762,8 @@ gdata_contacts_contact_add_im_address (GDataContactsContact *self, GDataGDIMAddr
* Gets a list of the IM addresses owned by the contact.
*
* Return value: a #GList of #GDataGDIMAddress<!-- -->es, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_im_addresses (GDataContactsContact *self)
@@ -759,6 +779,8 @@ gdata_contacts_contact_get_im_addresses (GDataContactsContact *self)
* Gets the contact's primary IM address, if one exists.
*
* Return value: a #GDataGDIMAddress, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataGDIMAddress *
gdata_contacts_contact_get_primary_im_address (GDataContactsContact *self)
@@ -786,6 +808,8 @@ gdata_contacts_contact_get_primary_im_address (GDataContactsContact *self)
* Note that only one phone number per contact may be marked as "primary". Insertion and update operations
* (with gdata_contacts_service_insert_contact()) will return an error if more than one phone number
* is marked as primary.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_phone_number (GDataContactsContact *self, GDataGDPhoneNumber *phone_number)
@@ -803,6 +827,8 @@ gdata_contacts_contact_add_phone_number (GDataContactsContact *self, GDataGDPhon
* Gets a list of the phone numbers owned by the contact.
*
* Return value: a #GList of #GDataGDPhoneNumber<!-- -->s, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_phone_numbers (GDataContactsContact *self)
@@ -818,6 +844,8 @@ gdata_contacts_contact_get_phone_numbers (GDataContactsContact *self)
* Gets the contact's primary phone number, if one exists.
*
* Return value: a #GDataGDPhoneNumber, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataGDPhoneNumber *
gdata_contacts_contact_get_primary_phone_number (GDataContactsContact *self)
@@ -845,6 +873,8 @@ gdata_contacts_contact_get_primary_phone_number (GDataContactsContact *self)
* Note that only one postal address per contact may be marked as "primary". Insertion and update operations
* (with gdata_contacts_service_insert_contact()) will return an error if more than one postal address
* is marked as primary.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_postal_address (GDataContactsContact *self, GDataGDPostalAddress *postal_address)
@@ -862,6 +892,8 @@ gdata_contacts_contact_add_postal_address (GDataContactsContact *self, GDataGDPo
* Gets a list of the postal addresses owned by the contact.
*
* Return value: a #GList of #GDataGDPostalAddress<!-- -->es, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_postal_addresses (GDataContactsContact *self)
@@ -877,6 +909,8 @@ gdata_contacts_contact_get_postal_addresses (GDataContactsContact *self)
* Gets the contact's primary postal address, if one exists.
*
* Return value: a #GDataGDPostalAddress, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataGDPostalAddress *
gdata_contacts_contact_get_primary_postal_address (GDataContactsContact *self)
@@ -904,6 +938,8 @@ gdata_contacts_contact_get_primary_postal_address (GDataContactsContact *self)
* Note that only one organization per contact may be marked as "primary". Insertion and update operations
* (with gdata_contacts_service_insert_contact()) will return an error if more than one organization
* is marked as primary.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_organization (GDataContactsContact *self, GDataGDOrganization *organization)
@@ -921,6 +957,8 @@ gdata_contacts_contact_add_organization (GDataContactsContact *self, GDataGDOrga
* Gets a list of the organizations to which the contact belongs.
*
* Return value: a #GList of #GDataGDOrganization<!-- -->s, or %NULL
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_organizations (GDataContactsContact *self)
@@ -936,6 +974,8 @@ gdata_contacts_contact_get_organizations (GDataContactsContact *self)
* Gets the contact's primary organization, if one exists.
*
* Return value: a #GDataGDOrganization, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataGDOrganization *
gdata_contacts_contact_get_primary_organization (GDataContactsContact *self)
@@ -961,6 +1001,8 @@ gdata_contacts_contact_get_primary_organization (GDataContactsContact *self)
* properties to store data of the client's choosing.
*
* Return value: the property's value, or %NULL
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_contacts_contact_get_extended_property (GDataContactsContact *self, const gchar *name)
@@ -987,6 +1029,8 @@ gdata_contacts_contact_get_extended_property (GDataContactsContact *self, const
* %FALSE will be returned if you attempt to add more than 10 extended properties.
*
* Return value: %TRUE if the property was updated or deleted successfully, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_contacts_contact_set_extended_property (GDataContactsContact *self, const gchar *name, const gchar *value)
@@ -1019,6 +1063,8 @@ gdata_contacts_contact_set_extended_property (GDataContactsContact *self, const
* @href: the group's ID URI
*
* Adds the contact to the given group. @href should be a URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_add_group (GDataContactsContact *self, const gchar *href)
@@ -1034,6 +1080,8 @@ gdata_contacts_contact_add_group (GDataContactsContact *self, const gchar *href)
* @href: the group's ID URI
*
* Removes the contact from the given group. @href should be a URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_contact_remove_group (GDataContactsContact *self, const gchar *href)
@@ -1053,6 +1101,8 @@ gdata_contacts_contact_remove_group (GDataContactsContact *self, const gchar *hr
* %TRUE for the query which returned the contact.
*
* Return value: %TRUE if the contact has recently been removed from the group, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_contacts_contact_is_group_deleted (GDataContactsContact *self, const gchar *href)
@@ -1075,6 +1125,8 @@ get_groups_cb (const gchar *href, gpointer deleted, GList **groups)
* Gets a list of the groups to which the contact belongs.
*
* Return value: a #GList of constant group ID URIs, or %NULL; free with g_list_free()
+ *
+ * Since: 0.2.0
**/
GList *
gdata_contacts_contact_get_groups (GDataContactsContact *self)
@@ -1102,6 +1154,8 @@ gdata_contacts_contact_get_groups (GDataContactsContact *self)
* #GDataContactsQuery:show-deleted).
*
* Return value: %TRUE if the contact has been deleted, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_contacts_contact_is_deleted (GDataContactsContact *self)
diff --git a/gdata/services/contacts/gdata-contacts-query.c b/gdata/services/contacts/gdata-contacts-query.c
index b7d800d..5e421d0 100644
--- a/gdata/services/contacts/gdata-contacts-query.c
+++ b/gdata/services/contacts/gdata-contacts-query.c
@@ -78,6 +78,8 @@ gdata_contacts_query_class_init (GDataContactsQueryClass *klass)
* GDataContactsQuery:order-by:
*
* Sorting criterion. The only supported value is <literal>lastmodified</literal>.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_ORDER_BY,
g_param_spec_string ("order-by",
@@ -91,6 +93,8 @@ gdata_contacts_query_class_init (GDataContactsQueryClass *klass)
* Whether to include deleted contacts in the query feed. Deleted contacts return %TRUE
* from gdata_contacts_contact_is_deleted(), and have no other information. They do not
* normally appear in query results.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_SHOW_DELETED,
g_param_spec_boolean ("show-deleted",
@@ -102,6 +106,8 @@ gdata_contacts_query_class_init (GDataContactsQueryClass *klass)
* GDataContactsQuery:sort-order:
*
* Sorting order direction. Can be either <literal>ascending</literal> or <literal>descending</literal>.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_SORT_ORDER,
g_param_spec_string ("sort-order",
@@ -114,6 +120,8 @@ gdata_contacts_query_class_init (GDataContactsQueryClass *klass)
*
* Constrains the results to only the contacts belonging to the group specified. The value of this parameter
* should be a group ID URI.
+ *
+ * Since: 0.2.0
**/
g_object_class_install_property (gobject_class, PROP_GROUP,
g_param_spec_string ("group",
@@ -233,6 +241,8 @@ get_query_uri (GDataQuery *self, const gchar *feed_uri, GString *query_uri, gboo
* Creates a new #GDataContactsQuery with its #GDataQuery:q property set to @q.
*
* Return value: a new #GDataContactsQuery
+ *
+ * Since: 0.2.0
**/
GDataContactsQuery *
gdata_contacts_query_new (const gchar *q)
@@ -250,6 +260,8 @@ gdata_contacts_query_new (const gchar *q)
* applied.
*
* Return value: a new #GDataContactsQuery
+ *
+ * Since: 0.2.0
**/
GDataContactsQuery *
gdata_contacts_query_new_with_limits (const gchar *q, gint start_index, gint max_results)
@@ -268,6 +280,8 @@ gdata_contacts_query_new_with_limits (const gchar *q, gint start_index, gint max
* Gets the #GDataContactsQuery:order-by property.
*
* Return value: the order by property, or %NULL if it is unset
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_contacts_query_get_order_by (GDataContactsQuery *self)
@@ -284,6 +298,8 @@ gdata_contacts_query_get_order_by (GDataContactsQuery *self)
* Sets the #GDataContactsQuery:order-by property of the #GDataContactsQuery to the new order by string, @order_by.
*
* Set @order_by to %NULL to unset the property in the query URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_query_set_order_by (GDataContactsQuery *self, const gchar *order_by)
@@ -302,6 +318,8 @@ gdata_contacts_query_set_order_by (GDataContactsQuery *self, const gchar *order_
* Gets the #GDataContactsQuery:show-deleted property.
*
* Return value: %TRUE if deleted contacts should be shown, %FALSE otherwise
+ *
+ * Since: 0.2.0
**/
gboolean
gdata_contacts_query_show_deleted (GDataContactsQuery *self)
@@ -316,6 +334,8 @@ gdata_contacts_query_show_deleted (GDataContactsQuery *self)
* @show_deleted: %TRUE to show deleted contacts, %FALSE otherwise
*
* Sets the #GDataContactsQuery:show-deleted property of the #GDataContactsQuery.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_query_set_show_deleted (GDataContactsQuery *self, gboolean show_deleted)
@@ -332,6 +352,8 @@ gdata_contacts_query_set_show_deleted (GDataContactsQuery *self, gboolean show_d
* Gets the #GDataContactsQuery:sort-order property.
*
* Return value: the sort order property, or %NULL if it is unset
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_contacts_query_get_sort_order (GDataContactsQuery *self)
@@ -348,6 +370,8 @@ gdata_contacts_query_get_sort_order (GDataContactsQuery *self)
* Sets the #GDataContactsQuery:sort-order property of the #GDataContactsQuery to the new sort order string, @sort_order.
*
* Set @sort_order to %NULL to unset the property in the query URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_query_set_sort_order (GDataContactsQuery *self, const gchar *sort_order)
@@ -366,6 +390,8 @@ gdata_contacts_query_set_sort_order (GDataContactsQuery *self, const gchar *sort
* Gets the #GDataContactsQuery:group property.
*
* Return value: the group property, or %NULL if it is unset
+ *
+ * Since: 0.2.0
**/
const gchar *
gdata_contacts_query_get_group (GDataContactsQuery *self)
@@ -382,6 +408,8 @@ gdata_contacts_query_get_group (GDataContactsQuery *self)
* Sets the #GDataContactsQuery:group property of the #GDataContactsQuery to the new group ID URI, @group.
*
* Set @group to %NULL to unset the property in the query URI.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_query_set_group (GDataContactsQuery *self, const gchar *group)
diff --git a/gdata/services/contacts/gdata-contacts-service.c b/gdata/services/contacts/gdata-contacts-service.c
index f48d8db..49aa79e 100644
--- a/gdata/services/contacts/gdata-contacts-service.c
+++ b/gdata/services/contacts/gdata-contacts-service.c
@@ -41,8 +41,6 @@
#include "gdata-private.h"
#include "gdata-contacts-query.h"
-/* Standards reference here: http://code.google.com/apis/contacts/docs/2.0/reference.html */
-
G_DEFINE_TYPE (GDataContactsService, gdata_contacts_service, GDATA_TYPE_SERVICE)
#define GDATA_CONTACTS_SERVICE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GDATA_TYPE_CONTACTS_SERVICE, GDataContactsServicePrivate))
@@ -66,6 +64,8 @@ gdata_contacts_service_init (GDataContactsService *self)
* Creates a new #GDataContactsService. The @client_id must be unique for your application, and as registered with Google.
*
* Return value: a new #GDataContactsService, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataContactsService *
gdata_contacts_service_new (const gchar *client_id)
@@ -91,6 +91,8 @@ gdata_contacts_service_new (const gchar *client_id)
* For more details, see gdata_service_query().
*
* Return value: a #GDataFeed of query results; unref with g_object_unref()
+ *
+ * Since: 0.2.0
**/
GDataFeed *
gdata_contacts_service_query_contacts (GDataContactsService *self, GDataContactsQuery *query, GCancellable *cancellable,
@@ -122,6 +124,8 @@ gdata_contacts_service_query_contacts (GDataContactsService *self, GDataContacts
*
* For more details, see gdata_contacts_service_query_contacts(), which is the synchronous version of this function,
* and gdata_service_query_async(), which is the base asynchronous query function.
+ *
+ * Since: 0.2.0
**/
void
gdata_contacts_service_query_contacts_async (GDataContactsService *self, GDataContactsQuery *query, GCancellable *cancellable,
@@ -152,6 +156,8 @@ gdata_contacts_service_query_contacts_async (GDataContactsService *self, GDataCo
* For more details, see gdata_service_insert_entry().
*
* Return value: an updated #GDataContactsContact, or %NULL
+ *
+ * Since: 0.2.0
**/
GDataContactsContact *
gdata_contacts_service_insert_contact (GDataContactsService *self, GDataContactsContact *contact, GCancellable *cancellable, GError **error)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
