diff options
42 files changed, 188 insertions, 146 deletions
@@ -75,7 +75,8 @@ libgdata employs: * @updated_max: the new maximum update time, or %NULL - - If numbers, such as %-1, are mentioned in documentation as values to be passed around in code, they should be prefixed by a '%', just like %NULL. + - If numbers, such as -1, are mentioned in documentation as values to be passed around in code, they should be wrapped in a DocBook "code" tag + (e.g. "<code class="literal">-1</code>"), so that they appear similarly to NULL in the documentation. - The documentation explaining the purpose of a property, its limitations, interpretation, etc., should be given in the gtk-doc comment for the GObject property itself, not in the documentation for its getter or setter. The documentation for the getter and setter should be stubs which diff --git a/gdata/atom/gdata-author.c b/gdata/atom/gdata-author.c index d726cfb2..38c0a4f2 100644 --- a/gdata/atom/gdata-author.c +++ b/gdata/atom/gdata-author.c @@ -252,11 +252,13 @@ gdata_author_new (const gchar *name, const gchar *uri, const gchar *email_addres * @b: another #GDataAuthor, or %NULL * * Compares the two authors in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @name property of the #GDataAuthor<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/atom/gdata-category.c b/gdata/atom/gdata-category.c index 9aafef81..d9ce01c5 100644 --- a/gdata/atom/gdata-category.c +++ b/gdata/atom/gdata-category.c @@ -241,11 +241,13 @@ gdata_category_new (const gchar *term, const gchar *scheme, const gchar *label) * @b: another #GDataCategory, or %NULL * * Compares the two categories in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @term property of the #GDataCategory<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/atom/gdata-generator.c b/gdata/atom/gdata-generator.c index d02360e7..acb0ecec 100644 --- a/gdata/atom/gdata-generator.c +++ b/gdata/atom/gdata-generator.c @@ -193,11 +193,13 @@ parse_xml (GDataParsable *parsable, xmlDoc *doc, xmlNode *node, gpointer user_da * @b: another #GDataGenerator, or %NULL * * Compares the two generators in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @name property of the #GDataGenerator<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/atom/gdata-link.c b/gdata/atom/gdata-link.c index 222b18da..82599fcb 100644 --- a/gdata/atom/gdata-link.c +++ b/gdata/atom/gdata-link.c @@ -163,7 +163,7 @@ gdata_link_class_init (GDataLinkClass *klass) /** * GDataLink:length: * - * Indicates an advisory length of the linked content in octets. %-1 means the length is unspecified. + * Indicates an advisory length of the linked content in octets. <code class="literal">-1</code> means the length is unspecified. * * For more information, see the * <ulink type="http" url="http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.link">Atom specification</ulink>. @@ -360,11 +360,13 @@ gdata_link_new (const gchar *uri, const gchar *relation_type) * @b: another #GDataLink, or %NULL * * Compares the two links in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @uri property of the #GDataLink<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ @@ -597,7 +599,7 @@ gdata_link_set_title (GDataLink *self, const gchar *title) * * Gets the #GDataLink:length property. * - * Return value: the link's length, or %-1 + * Return value: the link's length, or <code class="literal">-1</code> * * Since: 0.4.0 **/ @@ -611,11 +613,11 @@ gdata_link_get_length (GDataLink *self) /** * gdata_link_set_length: * @self: a #GDataLink - * @length: the new length for the link, or %-1 + * @length: the new length for the link, or <code class="literal">-1</code> * * Sets the #GDataLink:length property to @length. * - * Set @length to %-1 to unset the property in the link. + * Set @length to <code class="literal">-1</code> to unset the property in the link. * * Since: 0.4.0 **/ diff --git a/gdata/exif/gdata-exif-tags.c b/gdata/exif/gdata-exif-tags.c index cbf0e8cf..3f51c861 100644 --- a/gdata/exif/gdata-exif-tags.c +++ b/gdata/exif/gdata-exif-tags.c @@ -177,7 +177,7 @@ get_namespaces (GDataParsable *parsable, GHashTable *namespaces) * * Gets the #GDataExifTags:distance property. * - * Return value: the distance value, or %-1 if unknown + * Return value: the distance value, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ @@ -194,7 +194,7 @@ gdata_exif_tags_get_distance (GDataExifTags *self) * * Gets the #GDataExifTags:exposure property. * - * Return value: the exposure value, or %0 if unknown + * Return value: the exposure value, or <code class="literal">0</code> if unknown * * Since: 0.5.0 **/ @@ -228,7 +228,7 @@ gdata_exif_tags_get_flash (GDataExifTags *self) * * Gets the #GDataExifTags:focal-length property. * - * Return value: the focal-length value, or %-1 if unknown + * Return value: the focal-length value, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ @@ -245,7 +245,7 @@ gdata_exif_tags_get_focal_length (GDataExifTags *self) * * Gets the #GDataExifTags:fstop property. * - * Return value: the F-stop value, or %0 if unknown + * Return value: the F-stop value, or <code class="literal">0</code> if unknown * * Since: 0.5.0 **/ @@ -279,7 +279,7 @@ gdata_exif_tags_get_image_unique_id (GDataExifTags *self) * * Gets the #GDataExifTags:iso property. * - * Return value: the ISO speed, or %-1 if unknown + * Return value: the ISO speed, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ @@ -330,7 +330,7 @@ gdata_exif_tags_get_model (GDataExifTags *self) * @_time: a #GTimeVal * * Gets the #GDataExifTags:time property and puts it in @_time. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.5.0 **/ diff --git a/gdata/gcontact/gdata-gcontact-calendar.c b/gdata/gcontact/gdata-gcontact-calendar.c index 4e84c447..b8bb77c8 100644 --- a/gdata/gcontact/gdata-gcontact-calendar.c +++ b/gdata/gcontact/gdata-gcontact-calendar.c @@ -310,11 +310,13 @@ gdata_gcontact_calendar_new (const gchar *uri, const gchar *relation_type, const * @b: another #GDataGContactCalendar, or %NULL * * Compares the two calendars in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @uri, @relation_type and @label properties of the #GDataGContactCalendar<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.7.0 **/ diff --git a/gdata/gcontact/gdata-gcontact-website.c b/gdata/gcontact/gdata-gcontact-website.c index b9182f23..269ef409 100644 --- a/gdata/gcontact/gdata-gcontact-website.c +++ b/gdata/gcontact/gdata-gcontact-website.c @@ -294,11 +294,13 @@ gdata_gcontact_website_new (const gchar *uri, const gchar *relation_type, const * @b: another #GDataGContactWebsite, or %NULL * * Compares the two websites in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @uri, @relation_type and @label properties of the #GDataGContactWebsite<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.7.0 **/ diff --git a/gdata/gd/gdata-gd-email-address.c b/gdata/gd/gdata-gd-email-address.c index 2255be48..d54b8897 100644 --- a/gdata/gd/gdata-gd-email-address.c +++ b/gdata/gd/gdata-gd-email-address.c @@ -323,11 +323,13 @@ gdata_gd_email_address_new (const gchar *address, const gchar *relation_type, co * @b: another #GDataGDEmailAddress, or %NULL * * Compares the two e-mail addresses in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @address property of the #GDataGDEmailAddress<!-- -->es. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-im-address.c b/gdata/gd/gdata-gd-im-address.c index 22c3462d..c234a296 100644 --- a/gdata/gd/gdata-gd-im-address.c +++ b/gdata/gd/gdata-gd-im-address.c @@ -326,11 +326,13 @@ gdata_gd_im_address_new (const gchar *address, const gchar *protocol, const gcha * @b: another #GDataGDIMAddress, or %NULL * * Compares the two IM addresses in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @address and @protocol properties of the #GDataGDIMAddress<!-- -->es. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-name.c b/gdata/gd/gdata-gd-name.c index 57cc5fb7..e32a5b28 100644 --- a/gdata/gd/gdata-gd-name.c +++ b/gdata/gd/gdata-gd-name.c @@ -341,12 +341,14 @@ gdata_gd_name_new (const gchar *given_name, const gchar *family_name) * @b: another #GDataGDName, or %NULL * * Compares the two names in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @given_name, @additional_name and @family_name properties of the * #GDataGDName<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.5.0 **/ diff --git a/gdata/gd/gdata-gd-organization.c b/gdata/gd/gdata-gd-organization.c index 9337a4c9..0c4dad0d 100644 --- a/gdata/gd/gdata-gd-organization.c +++ b/gdata/gd/gdata-gd-organization.c @@ -470,11 +470,13 @@ gdata_gd_organization_new (const gchar *name, const gchar *title, const gchar *r * @b: another #GDataGDOrganization, or %NULL * * Compares the two organizations in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @name property of the #GDataGDOrganization<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-phone-number.c b/gdata/gd/gdata-gd-phone-number.c index fc222329..0f45f6ac 100644 --- a/gdata/gd/gdata-gd-phone-number.c +++ b/gdata/gd/gdata-gd-phone-number.c @@ -346,11 +346,13 @@ gdata_gd_phone_number_new (const gchar *number, const gchar *relation_type, cons * @b: another #GDataGDPhoneNumber, or %NULL * * Compares the two phone numbers in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @number property of the #GDataGDPhoneNumber<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-postal-address.c b/gdata/gd/gdata-gd-postal-address.c index 8185dc50..81a95e30 100644 --- a/gdata/gd/gdata-gd-postal-address.c +++ b/gdata/gd/gdata-gd-postal-address.c @@ -668,12 +668,14 @@ gdata_gd_postal_address_new (const gchar *relation_type, const gchar *label, gbo * @b: another #GDataGDPostalAddress, or %NULL * * Compares the two postal addresses in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @street, @po_box, @city and @postcode properties of * the #GDataGDPostalAddress<!-- -->es. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-reminder.c b/gdata/gd/gdata-gd-reminder.c index d8c98a88..fac79618 100644 --- a/gdata/gd/gdata-gd-reminder.c +++ b/gdata/gd/gdata-gd-reminder.c @@ -284,7 +284,7 @@ get_namespaces (GDataParsable *parsable, GHashTable *namespaces) * gdata_gd_reminder_new: * @method: the notification method the reminder should use, or %NULL * @absolute_time: the absolute time for the reminder, or %NULL - * @relative_time: the relative time for the reminder, in minutes, or %-1 + * @relative_time: the relative time for the reminder, in minutes, or <code class="literal">-1</code> * * Creates a new #GDataGDReminder. More information is available in the <ulink type="http" * url="http://code.google.com/apis/gdata/docs/2.0/elements.html#gdReminder">GData specification</ulink>. @@ -306,11 +306,13 @@ gdata_gd_reminder_new (const gchar *method, const GTimeVal *absolute_time, gint * @b: another #GDataGDReminder, or %NULL * * Compares the two reminders in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis all the properties of the #GDataGDReminder<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ @@ -388,7 +390,7 @@ gdata_gd_reminder_set_method (GDataGDReminder *self, const gchar *method) * @absolute_time: return location for the absolute time * * Gets the #GDataGDReminder:absolute-time property and returns it in @absolute_time. If the - * property is unset, both fields of @start_time are set to %0. + * property is unset, both fields of @start_time are set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -447,7 +449,7 @@ gdata_gd_reminder_is_absolute_time (GDataGDReminder *self) * * Gets the #GDataGDReminder:relative-time property. * - * Return value: the relative time, or %-1 + * Return value: the relative time, or <code class="literal">-1</code> * * Since: 0.4.0 **/ @@ -461,11 +463,11 @@ gdata_gd_reminder_get_relative_time (GDataGDReminder *self) /** * gdata_gd_reminder_set_relative_time: * @self: a #GDataGDReminder - * @relative_time: the new relative time, or %-1 + * @relative_time: the new relative time, or <code class="literal">-1</code> * * Sets the #GDataGDReminder:relative-time property to @relative_time. * - * Set @relative_time to %-1 to unset the property. + * Set @relative_time to <code class="literal">-1</code> to unset the property. * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-when.c b/gdata/gd/gdata-gd-when.c index 487592d4..224b99ff 100644 --- a/gdata/gd/gdata-gd-when.c +++ b/gdata/gd/gdata-gd-when.c @@ -384,11 +384,13 @@ gdata_gd_when_new (const GTimeVal *start_time, const GTimeVal *end_time, gboolea * @b: another #GDataGDWhen, or %NULL * * Compares the two times in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @start_time, @end_time and @is_date properties of the #GDataGDWhen<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ @@ -460,7 +462,7 @@ gdata_gd_when_set_start_time (GDataGDWhen *self, const GTimeVal *start_time) * * Gets the #GDataGDWhen:end-time property and returns it in @end_time. * - * If the end time is unset, both fields of the #GTimeVal will be %0. + * If the end time is unset, both fields of the #GTimeVal will be <code class="literal">0</code>. * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-where.c b/gdata/gd/gdata-gd-where.c index 50ab5056..e3a14983 100644 --- a/gdata/gd/gdata-gd-where.c +++ b/gdata/gd/gdata-gd-where.c @@ -278,11 +278,13 @@ gdata_gd_where_new (const gchar *relation_type, const gchar *value_string, const * @b: another #GDataGDWhere, or %NULL * * Compares the two places in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @label and @value_string properties of the #GDataGDWhere<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gd/gdata-gd-who.c b/gdata/gd/gdata-gd-who.c index ab9dfabc..aa1cc8fe 100644 --- a/gdata/gd/gdata-gd-who.c +++ b/gdata/gd/gdata-gd-who.c @@ -284,11 +284,13 @@ gdata_gd_who_new (const gchar *relation_type, const gchar *value_string, const g * @b: another #GDataGDWho, or %NULL * * Compares the two people in a strcmp() fashion. %NULL values are handled gracefully, with - * %0 returned if both @a and @b are %NULL, %-1 if @a is %NULL and %1 if @b is %NULL. + * <code class="literal">0</code> returned if both @a and @b are %NULL, <code class="literal">-1</code> if @a is %NULL + * and <code class="literal">1</code> if @b is %NULL. * * The comparison of non-%NULL values is done on the basis of the @email and @value_string properties of the #GDataGDWho<!-- -->s. * - * Return value: %0 if @a equals @b, %-1 or %1 as appropriate otherwise + * Return value: <code class="literal">0</code> if @a equals @b, <code class="literal">-1</code> or <code class="literal">1</code> as + * appropriate otherwise * * Since: 0.4.0 **/ diff --git a/gdata/gdata-access-rule.c b/gdata/gdata-access-rule.c index 756680aa..ecaec295 100644 --- a/gdata/gdata-access-rule.c +++ b/gdata/gdata-access-rule.c @@ -417,7 +417,7 @@ gdata_access_rule_get_scope (GDataAccessRule *self, const gchar **type, const gc * @edited: return location for the edited time * * Gets the #GDataAccessRule:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.7.0 **/ diff --git a/gdata/gdata-buffer.c b/gdata/gdata-buffer.c index fd7117b3..0cf47389 100644 --- a/gdata/gdata-buffer.c +++ b/gdata/gdata-buffer.c @@ -91,7 +91,7 @@ gdata_buffer_free (GDataBuffer *self) * @data: the data to push onto the buffer * @length: the length of @data * - * Pushes @length bytes of @data onto the buffer, taking a copy of the data. If @data is %NULL and @length is %0, + * Pushes @length bytes of @data onto the buffer, taking a copy of the data. If @data is %NULL and @length is <code class="literal">0</code>, * the buffer will be marked as having reached the EOF, and subsequent calls to gdata_buffer_push_data() * will fail and return %FALSE. * @@ -305,9 +305,9 @@ gdata_buffer_pop_data (GDataBuffer *self, guint8 *data, gsize length_requested, * Pops as much data as possible off the #GDataBuffer, up to a limit of @maxium_length bytes. If fewer bytes exist * in the buffer, fewer bytes will be returned. If more bytes exist in the buffer, @maximum_length bytes will be returned. * - * If %0 bytes exist in the buffer, this function will block until data is available. Otherwise, it will never block. + * If <code class="literal">0</code> bytes exist in the buffer, this function will block until data is available. Otherwise, it will never block. * - * Return value: the number of bytes returned in @data (guaranteed to be more than %0 and at most @maximum_length) + * Return value: the number of bytes returned in @data (guaranteed to be more than <code class="literal">0</code> and at most @maximum_length) * * Since: 0.5.0 **/ diff --git a/gdata/gdata-download-stream.c b/gdata/gdata-download-stream.c index 377377d3..b604b0dc 100644 --- a/gdata/gdata-download-stream.c +++ b/gdata/gdata-download-stream.c @@ -29,9 +29,10 @@ * the file. Network communication may not actually begin until the first call to g_input_stream_read(), so having a #GDataDownloadStream around is no * guarantee that the file is being downloaded. * - * The content type and length of the file being downloaded are made available through #GDataDownloadStream:content-type and #GDataDownloadStream:content-length - * as soon as the appropriate data is received from the server. Connect to #GDataDownloadStream::notify::content-type and - * #GDataDownloadStream::notify::content-length to be notified as soon as the data is available. + * The content type and length of the file being downloaded are made available through #GDataDownloadStream:content-type and + * #GDataDownloadStream:content-length as soon as the appropriate data is received from the server. Connect to the + * #GObject::notify <code type="literal">content-type</code> and <code type="literal">content-length</code> details to be notified as + * soon as the data is available. * * Since: 0.5.0 **/ @@ -547,9 +548,9 @@ gdata_download_stream_get_content_type (GDataDownloadStream *self) * @self: a #GDataDownloadStream * * Gets the length (in bytes) of the file being downloaded. If the <literal>Content-Length</literal> header has not yet - * been received from the server, %-1 will be returned. + * been received from the server, <code class="literal">-1</code> will be returned. * - * Return value: the content length of the file being downloaded, or %-1 + * Return value: the content length of the file being downloaded, or <code class="literal">-1</code> * * Since: 0.5.0 **/ diff --git a/gdata/gdata-feed.c b/gdata/gdata-feed.c index 40ed6fa6..7c69b465 100644 --- a/gdata/gdata-feed.c +++ b/gdata/gdata-feed.c @@ -803,7 +803,7 @@ gdata_feed_get_generator (GDataFeed *self) * * Returns the number of items per results page feed. * - * Return value: the number of items per results page feed, or %0 + * Return value: the number of items per results page feed, or <code class="literal">0</code> **/ guint gdata_feed_get_items_per_page (GDataFeed *self) @@ -818,7 +818,7 @@ gdata_feed_get_items_per_page (GDataFeed *self) * * Returns the one-based start index of the results feed in the result set. * - * Return value: the one-based start index, or %0 + * Return value: the one-based start index, or <code class="literal">0</code> **/ guint gdata_feed_get_start_index (GDataFeed *self) @@ -834,7 +834,7 @@ gdata_feed_get_start_index (GDataFeed *self) * Returns the total number of results in the result set, including results on other * pages. * - * Return value: the total number of results, or %0 + * Return value: the total number of results, or <code class="literal">0</code> **/ guint gdata_feed_get_total_results (GDataFeed *self) diff --git a/gdata/gdata-parser.c b/gdata/gdata-parser.c index e59a5174..4d6c8b16 100644 --- a/gdata/gdata-parser.c +++ b/gdata/gdata-parser.c @@ -227,7 +227,7 @@ gdata_parser_date_from_time_val (const GTimeVal *_time) tm = gmtime (&secs); /* Note: This doesn't need translating, as it's outputting an ISO 8601 date string */ - return g_strdup_printf ("%4d-%02d-%02d", tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday); + return g_strdup_printf ("%04d-%02d-%02d", tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday); } /* @@ -242,9 +242,9 @@ gdata_parser_date_from_time_val (const GTimeVal *_time) * The boolean value should be of the form: "<element property_name='[true|false]'/>". * A %GDATA_SERVICE_ERROR_PROTOCOL_ERROR error will be returned in @error if parsing fails, and @output will not be set. * - * If no property with the name @property_name exists in @element and @default_output is %0, @output will be set to %FALSE. - * If @default_output is %1, @output will be set to %TRUE. If @default_output is %-1, a %GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be - * returned in @error. + * If no property with the name @property_name exists in @element and @default_output is <code class="literal">0</code>, @output will be set to %FALSE. + * If @default_output is <code class="literal">1</code>, @output will be set to %TRUE. If @default_output is <code class="literal">-1</code>, + * a %GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be returned in @error. * * Return value: %TRUE on successful parsing, %FALSE otherwise * diff --git a/gdata/gdata-query.c b/gdata/gdata-query.c index 65219f4b..58ea7ce2 100644 --- a/gdata/gdata-query.c +++ b/gdata/gdata-query.c @@ -156,7 +156,7 @@ gdata_query_class_init (GDataQueryClass *klass) * of the categories (like using AND between terms). For example: <userinput>Fritz/Laurie</userinput> returns * entries that match both categories ("Fritz" and "Laurie"). * - * To do an OR between terms, use a pipe character (<literal>|</literal>). For example: <userinput>Fritz%%7CLaurie</userinput> returns + * To do an OR between terms, use a pipe character (<literal>|</literal>). For example: <userinput>Fritz\%7CLaurie</userinput> returns * entries that match either category. * * An entry matches a specified category if the entry is in a category that has a matching term or label, as defined in the Atom specification. @@ -742,7 +742,7 @@ gdata_query_set_author (GDataQuery *self, const gchar *author) * @updated_min: a #GTimeVal * * Gets the #GDataQuery:updated-min property and puts it in @updated_min. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_query_get_updated_min (GDataQuery *self, GTimeVal *updated_min) @@ -787,7 +787,7 @@ gdata_query_set_updated_min (GDataQuery *self, const GTimeVal *updated_min) * @updated_max: a #GTimeVal * * Gets the #GDataQuery:updated-max property and puts it in @updated_max. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_query_get_updated_max (GDataQuery *self, GTimeVal *updated_max) @@ -832,7 +832,7 @@ gdata_query_set_updated_max (GDataQuery *self, const GTimeVal *updated_max) * @published_min: a #GTimeVal * * Gets the #GDataQuery:published-min property and puts it in @published_min. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_query_get_published_min (GDataQuery *self, GTimeVal *published_min) @@ -877,7 +877,7 @@ gdata_query_set_published_min (GDataQuery *self, const GTimeVal *published_min) * @published_max: a #GTimeVal * * Gets the #GDataQuery:published-max property and puts it in @published_max. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_query_get_published_max (GDataQuery *self, GTimeVal *published_max) @@ -922,7 +922,7 @@ gdata_query_set_published_max (GDataQuery *self, const GTimeVal *published_max) * * Gets the #GDataQuery:start-index property. * - * Return value: the start index property, or %-1 if it is unset + * Return value: the start index property, or <code class="literal">-1</code> if it is unset **/ gint gdata_query_get_start_index (GDataQuery *self) @@ -938,7 +938,7 @@ gdata_query_get_start_index (GDataQuery *self) * * Sets the #GDataQuery:start-index property of the #GDataQuery to the new one-based start index, @start_index. * - * Set @start_index to %-1 or %0 to unset the property in the query URI. + * Set @start_index to <code class="literal">-1</code> or <code class="literal">0</code> to unset the property in the query URI. **/ void gdata_query_set_start_index (GDataQuery *self, gint start_index) @@ -1013,7 +1013,7 @@ gdata_query_set_is_strict (GDataQuery *self, gboolean is_strict) * * Gets the #GDataQuery:max-results property. * - * Return value: the maximum results property, or %-1 if it is unset + * Return value: the maximum results property, or <code class="literal">-1</code> if it is unset **/ gint gdata_query_get_max_results (GDataQuery *self) @@ -1029,7 +1029,7 @@ gdata_query_get_max_results (GDataQuery *self) * * Sets the #GDataQuery:max-results property of the #GDataQuery to the new maximum results value, @max_results. * - * Set @max_results to %-1 to unset the property in the query URI. + * Set @max_results to <code class="literal">-1</code> to unset the property in the query URI. **/ void gdata_query_set_max_results (GDataQuery *self, gint max_results) diff --git a/gdata/gdata-service.h b/gdata/gdata-service.h index 5f9cc418..35d15f63 100644 --- a/gdata/gdata-service.h +++ b/gdata/gdata-service.h @@ -88,8 +88,9 @@ typedef enum { * @GDATA_AUTHENTICATION_ERROR_ACCOUNT_DISABLED: The user account has been disabled. * @GDATA_AUTHENTICATION_ERROR_SERVICE_DISABLED: The user's access to the specified service has been disabled. (The user account may still be valid.) * - * Error codes for #GDataService authentication operations. See http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Errors for - * the official reference. + * Error codes for #GDataService authentication operations. See the + * <ulink type="http" url="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Errors">Google accounts documentation</ulink> for + * more information. **/ typedef enum { GDATA_AUTHENTICATION_ERROR_BAD_AUTHENTICATION = 1, @@ -143,7 +144,7 @@ typedef struct { * @parent: the parent class * @service_name: the name of the service (for subclasses) as given in the service's GData API documentation * @authentication_uri: the authentication URI (for subclasses) if different from the Google ClientLogin default - * @api_version: the version of the GData API used by the service (typically %2) + * @api_version: the version of the GData API used by the service (typically <code class="literal">2</code>) * @feed_type: the #GType of the feed class (subclass of #GDataFeed) to use for query results from this service * @parse_authentication_response: a function to parse the response from the online service to an authentication request as * issued by gdata_service_authenticate(). It should return %TRUE if authentication was successful, and %FALSE if there was diff --git a/gdata/gdata-upload-stream.c b/gdata/gdata-upload-stream.c index b65abaf0..c8dd1845 100644 --- a/gdata/gdata-upload-stream.c +++ b/gdata/gdata-upload-stream.c @@ -628,9 +628,9 @@ gdata_upload_stream_new (GDataService *service, const gchar *method, const gchar * @length: return location for the length of the response, or %NULL * * Returns the server's response to the upload operation performed by the #GDataUploadStream. If the operation - * is still underway, or the server's response hasn't been received yet, %NULL is returned and @length is set to %-1. + * is still underway, or the server's response hasn't been received yet, %NULL is returned and @length is set to <code class="literal">-1</code>. * - * If there was an error during the upload operation (but it is complete), %NULL is returned, and @length is set to %0. + * If there was an error during the upload operation (but it is complete), %NULL is returned, and @length is set to <code class="literal">0</code>. * * While it is safe to call this function from any thread at any time during the network operation, the only way to * guarantee that the response has been set before calling this function is to have closed the #GDataUploadStream. Once diff --git a/gdata/georss/gdata-georss-where.c b/gdata/georss/gdata-georss-where.c index 15593ec4..57c6496c 100644 --- a/gdata/georss/gdata-georss-where.c +++ b/gdata/georss/gdata-georss-where.c @@ -183,7 +183,7 @@ gdata_georss_where_get_longitude (GDataGeoRSSWhere *self) * * Sets the #GDataGeoRSSWhere:latitude property to @latitude. * - * Valid values range from %-90.0 to %90.0 inclusive. Set @latitude to %G_MAXDOUBLE to unset it. + * Valid values range from <code class="literal">-90.0</code> to <code class="literal">90.0</code> inclusive. Set @latitude to %G_MAXDOUBLE to unset it. * * Since: 0.5.0 **/ @@ -205,7 +205,8 @@ gdata_georss_where_set_latitude (GDataGeoRSSWhere *self, gdouble latitude) * * Sets the #GDataGeoRSSWhere:longitude property to @longitude. * - * Valid values range from %-180.0 to %180.0 inclusive. Set @longitude to %G_MAXDOUBLE to unset it. + * Valid values range from <code class="literal">-180.0</code> to <code class="literal">180.0</code> inclusive. Set @longitude to %G_MAXDOUBLE + * to unset it. * * Since: 0.5.0 **/ diff --git a/gdata/media/gdata-media-content.c b/gdata/media/gdata-media-content.c index 53e34347..1ab00a56 100644 --- a/gdata/media/gdata-media-content.c +++ b/gdata/media/gdata-media-content.c @@ -404,7 +404,7 @@ gdata_media_content_get_uri (GDataMediaContent *self) * * Gets the #GDataMediaContent:filesize property. * - * Return value: the number of bytes in the content, or %0 + * Return value: the number of bytes in the content, or <code class="literal">0</code> * * Since: 0.4.0 **/ @@ -489,7 +489,7 @@ gdata_media_content_get_expression (GDataMediaContent *self) * * Gets the #GDataMediaContent:duration property. * - * Return value: the content's duration in seconds, or %0 + * Return value: the content's duration in seconds, or <code class="literal">0</code> * * Since: 0.4.0 **/ @@ -506,7 +506,7 @@ gdata_media_content_get_duration (GDataMediaContent *self) * * Gets the #GDataMediaContent:height property. * - * Return value: the content's height in pixels, or %0 + * Return value: the content's height in pixels, or <code class="literal">0</code> * * Since: 0.4.0 **/ @@ -523,7 +523,7 @@ gdata_media_content_get_height (GDataMediaContent *self) * * Gets the #GDataMediaContent:width property. * - * Return value: the content's width in pixels, or %0 + * Return value: the content's width in pixels, or <code class="literal">0</code> * * Since: 0.4.0 **/ diff --git a/gdata/media/gdata-media-thumbnail.c b/gdata/media/gdata-media-thumbnail.c index d1b5e1a0..eb98a679 100644 --- a/gdata/media/gdata-media-thumbnail.c +++ b/gdata/media/gdata-media-thumbnail.c @@ -316,7 +316,7 @@ gdata_media_thumbnail_get_uri (GDataMediaThumbnail *self) * * Gets the #GDataMediaThumbnail:height property. * - * Return value: the thumbnail's height in pixels, or %0 + * Return value: the thumbnail's height in pixels, or <code class="literal">0</code> * * Since: 0.4.0 **/ @@ -333,7 +333,7 @@ gdata_media_thumbnail_get_height (GDataMediaThumbnail *self) * * Gets the #GDataMediaThumbnail:width property. * - * Return value: the thumbnail's width in pixels, or %0 + * Return value: the thumbnail's width in pixels, or <code class="literal">0</code> * * Since: 0.4.0 **/ @@ -350,7 +350,7 @@ gdata_media_thumbnail_get_width (GDataMediaThumbnail *self) * * Gets the #GDataMediaThumbnail:time property. * - * Return value: the thumbnail's time offset in the media, or %-1 + * Return value: the thumbnail's time offset in the media, or <code class="literal">-1</code> * * Since: 0.4.0 **/ diff --git a/gdata/services/calendar/gdata-calendar-calendar.c b/gdata/services/calendar/gdata-calendar-calendar.c index 425aeddd..c4f3189a 100644 --- a/gdata/services/calendar/gdata-calendar-calendar.c +++ b/gdata/services/calendar/gdata-calendar-calendar.c @@ -569,7 +569,7 @@ gdata_calendar_calendar_get_access_level (GDataCalendarCalendar *self) * @edited: a #GTimeVal * * Gets the #GDataCalendarCalendar:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_calendar_get_edited (GDataCalendarCalendar *self, GTimeVal *edited) diff --git a/gdata/services/calendar/gdata-calendar-event.c b/gdata/services/calendar/gdata-calendar-event.c index 69b59f6b..8ae00518 100644 --- a/gdata/services/calendar/gdata-calendar-event.c +++ b/gdata/services/calendar/gdata-calendar-event.c @@ -662,7 +662,7 @@ get_namespaces (GDataParsable *parsable, GHashTable *namespaces) * @edited: a #GTimeVal * * Gets the #GDataCalendarEvent:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_event_get_edited (GDataCalendarEvent *self, GTimeVal *edited) diff --git a/gdata/services/calendar/gdata-calendar-query.c b/gdata/services/calendar/gdata-calendar-query.c index 6fa50a79..c9bf1f75 100644 --- a/gdata/services/calendar/gdata-calendar-query.c +++ b/gdata/services/calendar/gdata-calendar-query.c @@ -490,7 +490,7 @@ gdata_calendar_query_set_order_by (GDataCalendarQuery *self, const gchar *order_ * @start: a #GTimeVal * * Gets the #GDataCalendarQuery:recurrence-expansion-start property and puts it - * in @start. If the property is unset, both fields in the #GTimeVal will be set to %0. + * in @start. If the property is unset, both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_query_get_recurrence_expansion_start (GDataCalendarQuery *self, GTimeVal *start) @@ -534,7 +534,7 @@ gdata_calendar_query_set_recurrence_expansion_start (GDataCalendarQuery *self, c * @end: a #GTimeVal * * Gets the #GDataCalendarQuery:recurrence-expansion-end property and puts it - * in @end. If the property is unset, both fields in the #GTimeVal will be set to %0. + * in @end. If the property is unset, both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_query_get_recurrence_expansion_end (GDataCalendarQuery *self, GTimeVal *end) @@ -648,7 +648,7 @@ gdata_calendar_query_set_sort_order (GDataCalendarQuery *self, const gchar *sort * @start_min: a #GTimeVal * * Gets the #GDataCalendarQuery:start-min property and puts it - * in @start_min. If the property is unset, both fields in the #GTimeVal will be set to %0. + * in @start_min. If the property is unset, both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_query_get_start_min (GDataCalendarQuery *self, GTimeVal *start_min) @@ -692,7 +692,7 @@ gdata_calendar_query_set_start_min (GDataCalendarQuery *self, const GTimeVal *st * @start_max: a #GTimeVal * * Gets the #GDataCalendarQuery:start-max property and puts it - * in @start_max. If the property is unset, both fields in the #GTimeVal will be set to %0. + * in @start_max. If the property is unset, both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_calendar_query_get_start_max (GDataCalendarQuery *self, GTimeVal *start_max) diff --git a/gdata/services/contacts/gdata-contacts-contact.c b/gdata/services/contacts/gdata-contacts-contact.c index 631b3160..77c3e299 100644 --- a/gdata/services/contacts/gdata-contacts-contact.c +++ b/gdata/services/contacts/gdata-contacts-contact.c @@ -588,7 +588,7 @@ gdata_contacts_contact_new (const gchar *id) * @edited: a #GTimeVal * * 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. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.2.0 **/ @@ -1834,7 +1834,7 @@ gdata_contacts_contact_get_photo (GDataContactsContact *self, GDataContactsServi * @self: a #GDataContactsContact * @service: a #GDataService * @data: the image data, or %NULL - * @length: the image length, in bytes, or %0 + * @length: the image length, in bytes, or <code class="literal">0</code> * @cancellable: optional #GCancellable object, or %NULL * @error: a #GError, or %NULL * diff --git a/gdata/services/documents/gdata-documents-entry.c b/gdata/services/documents/gdata-documents-entry.c index 6271293b..d7bfdc00 100644 --- a/gdata/services/documents/gdata-documents-entry.c +++ b/gdata/services/documents/gdata-documents-entry.c @@ -375,7 +375,7 @@ get_namespaces (GDataParsable *parsable, GHashTable *namespaces) * @edited: a #GTimeVal * * Gets the #GDataDocumentsEntry:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -393,7 +393,7 @@ gdata_documents_entry_get_edited (GDataDocumentsEntry *self, GTimeVal *edited) * @last_viewed: a #GTimeVal * * Gets the #GDataDocumentsEntry:last-viewed property and puts it in @last_viewed. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ diff --git a/gdata/services/documents/gdata-documents-spreadsheet.c b/gdata/services/documents/gdata-documents-spreadsheet.c index bc070b90..b05b3532 100644 --- a/gdata/services/documents/gdata-documents-spreadsheet.c +++ b/gdata/services/documents/gdata-documents-spreadsheet.c @@ -110,7 +110,7 @@ gdata_documents_spreadsheet_new (const gchar *id) * @service: a #GDataDocumentsService * @content_type: return location for the document's content type, or %NULL; free with g_free() * @export_format: the format in which the spreadsheet should be exported - * @gid: the %0-based sheet ID to download, or %-1 + * @gid: the <code class="literal">0</code>-based sheet ID to download, or <code class="literal">-1</code> * @destination_file: the #GFile into which the spreadsheet file should be saved * @replace_file_if_exists: %TRUE if the file should be replaced if it already exists, %FALSE otherwise * @cancellable: optional #GCancellable object, or %NULL @@ -123,8 +123,8 @@ gdata_documents_spreadsheet_new (const gchar *id) * If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * When requesting a %GDATA_DOCUMENTS_SPREADSHEET_CSV or %GDATA_DOCUMENTS_SPREADSHEET_TSV file you must specify an additional - * parameter called @gid which indicates which grid, or sheet, you wish to get (the index is %0-based, so GID %1 actually refers - * to the second sheet on a given spreadsheet). + * parameter called @gid which indicates which grid, or sheet, you wish to get (the index is <code class="literal">0</code>-based, so + * GID <code class="literal">1</code> actually refers to the second sheet on a given spreadsheet). * * If @destination_file is a directory, then the file will be downloaded in this directory with the #GDataEntry:title with * the apropriate extension as name. @@ -172,15 +172,15 @@ gdata_documents_spreadsheet_download_document (GDataDocumentsSpreadsheet *self, * gdata_documents_spreadsheet_get_download_uri: * @self: a #GDataDocumentsSpreadsheet * @export_format: the format in which the spreadsheet should be exported when downloaded - * @gid: the %0-based sheet ID to download, or %-1 + * @gid: the <code class="literal">0</code>-based sheet ID to download, or <code class="literal">-1</code> * * Builds and returns the download URI for the given #GDataDocumentsSpreadsheet in the desired format. Note that directly downloading * the document using this URI isn't possible, as authentication is required. You should instead use gdata_download_stream_new() with * the URI, and use the resulting #GInputStream. * * When requesting a %GDATA_DOCUMENTS_SPREADSHEET_CSV or %GDATA_DOCUMENTS_SPREADSHEET_TSV file you must specify an additional - * parameter called @gid which indicates which grid, or sheet, you wish to get (the index is %0-based, so GID %1 actually refers - * to the second sheet on a given spreadsheet). + * parameter called @gid which indicates which grid, or sheet, you wish to get (the index is <code class="literal">0</code>-based, so + * GID <code class="literal">1</code> actually refers to the second sheet on a given spreadsheet). * * Return value: the download URI; free with g_free() * diff --git a/gdata/services/picasaweb/gdata-picasaweb-album.c b/gdata/services/picasaweb/gdata-picasaweb-album.c index 32aa4a8a..fcef1793 100644 --- a/gdata/services/picasaweb/gdata-picasaweb-album.c +++ b/gdata/services/picasaweb/gdata-picasaweb-album.c @@ -269,7 +269,7 @@ gdata_picasaweb_album_class_init (GDataPicasaWebAlbumClass *klass) * GDataPicasaWebAlbum:bytes-used: * * The number of bytes consumed by this album and its contents. Note that this is only set if the authenticated user is the owner of the - * album; it's otherwise %-1. + * album; it's otherwise <code class="literal">-1</code>. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/reference.html#gphoto_bytesUsed"> * gphoto specification</ulink>. @@ -330,7 +330,8 @@ gdata_picasaweb_album_class_init (GDataPicasaWebAlbumClass *klass) /** * GDataPicasaWebAlbum:latitude: * - * The location as a latitude coordinate associated with this album. Valid latitudes range from %-90.0 to %90.0 inclusive. + * The location as a latitude coordinate associated with this album. Valid latitudes range from <code class="literal">-90.0</code> + * to <code class="literal">90.0</code> inclusive. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/docs/2.0/reference.html#georss_where"> * GeoRSS specification</ulink>. @@ -346,7 +347,8 @@ gdata_picasaweb_album_class_init (GDataPicasaWebAlbumClass *klass) /** * GDataPicasaWebAlbum:longitude: * - * The location as a longitude coordinate associated with this album. Valid longitudes range from %-180.0 to %180.0 inclusive. + * The location as a longitude coordinate associated with this album. Valid longitudes range from <code class="literal">-180.0</code> + * to <code class="literal">180.0</code> inclusive. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/docs/2.0/reference.html#georss_where"> * GeoRSS specification</ulink>. @@ -851,7 +853,7 @@ gdata_picasaweb_album_get_nickname (GDataPicasaWebAlbum *self) * @edited: a #GTimeVal * * Gets the #GDataPicasaWebAlbum:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -942,7 +944,7 @@ gdata_picasaweb_album_set_visibility (GDataPicasaWebAlbum *self, GDataPicasaWebV * @timestamp: a #GTimeVal * * Gets the #GDataPicasaWebAlbum:timestamp property and puts it in @timestamp. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -1014,10 +1016,10 @@ gdata_picasaweb_album_get_num_photos_remaining (GDataPicasaWebAlbum *self) * gdata_picasaweb_album_get_bytes_used: * @self: a #GDataPicasaWebAlbum * - * Gets the #GDataPicasaWebAlbum:bytes-used property. It will return %-1 if the current authenticated + * Gets the #GDataPicasaWebAlbum:bytes-used property. It will return <code class="literal">-1</code> if the current authenticated * user is not the owner of the album. * - * Return value: the number of bytes used by the album and its contents, or %-1 + * Return value: the number of bytes used by the album and its contents, or <code class="literal">-1</code> * * Since: 0.4.0 **/ diff --git a/gdata/services/picasaweb/gdata-picasaweb-file.c b/gdata/services/picasaweb/gdata-picasaweb-file.c index 30a77b1f..fad748bb 100644 --- a/gdata/services/picasaweb/gdata-picasaweb-file.c +++ b/gdata/services/picasaweb/gdata-picasaweb-file.c @@ -338,7 +338,7 @@ gdata_picasaweb_file_class_init (GDataPicasaWebFileClass *klass) * GDataPicasaWebFile:rotation: * * The rotation of the photo, in degrees. This will only be non-zero for files which are pending rotation, and haven't yet been - * permanently modified. For files which have already been rotated, this will be %0. + * permanently modified. For files which have already been rotated, this will be <code class="literal">0</code>. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/reference.html#gphoto_rotation"> * gphoto specification</ulink>. @@ -555,7 +555,8 @@ gdata_picasaweb_file_class_init (GDataPicasaWebFileClass *klass) /** * GDataPicasaWebFile:latitude: * - * The location as a latitude coordinate associated with this file. Valid latitudes range from %-90.0 to %90.0 inclusive. + * The location as a latitude coordinate associated with this file. Valid latitudes range from <code class="literal">-90.0</code> + * to <code class="literal">90.0</code> inclusive. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/docs/2.0/reference.html#georss_where"> * GeoRSS specification</ulink>. @@ -571,7 +572,8 @@ gdata_picasaweb_file_class_init (GDataPicasaWebFileClass *klass) /** * GDataPicasaWebFile:longitude: * - * The location as a longitude coordinate associated with this file. Valid longitudes range from %-180.0 to %180.0 inclusive. + * The location as a longitude coordinate associated with this file. Valid longitudes range from <code class="literal">-180.0</code> + * to <code class="literal">180.0</code> inclusive. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/docs/2.0/reference.html#georss_where"> * GeoRSS specification</ulink>. @@ -1050,7 +1052,7 @@ gdata_picasaweb_file_get_id (GDataPicasaWebFile *self) * @edited: a #GTimeVal * * Gets the #GDataPicasaWebFile:edited property and puts it in @edited. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -1283,7 +1285,7 @@ gdata_picasaweb_file_set_checksum (GDataPicasaWebFile *self, const gchar *checks * @timestamp: a #GTimeVal * * Gets the #GDataPicasaWebFile:timestamp property and puts it in @timestamp. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.4.0 **/ @@ -1567,7 +1569,7 @@ gdata_picasaweb_file_get_thumbnails (GDataPicasaWebFile *self) * * Gets the #GDataPicasaWebFile:distance property. * - * Return value: the distance recorded in the photo's EXIF, or %-1 if unknown + * Return value: the distance recorded in the photo's EXIF, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ @@ -1584,7 +1586,7 @@ gdata_picasaweb_file_get_distance (GDataPicasaWebFile *self) * * Gets the #GDataPicasaWebFile:exposure property. * - * Return value: the exposure value, or %0 if unknown + * Return value: the exposure value, or <code class="literal">0</code> if unknown * * Since: 0.5.0 **/ @@ -1618,7 +1620,7 @@ gdata_picasaweb_file_get_flash (GDataPicasaWebFile *self) * * Gets the #GDataPicasaWebFile:focal-length property. * - * Return value: the focal-length value, or %-1 if unknown + * Return value: the focal-length value, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ @@ -1635,7 +1637,7 @@ gdata_picasaweb_file_get_focal_length (GDataPicasaWebFile *self) * * Gets the #GDataPicasaWebFile:fstop property. * - * Return value: the F-stop value, or %0 if unknown + * Return value: the F-stop value, or <code class="literal">0</code> if unknown * * Since: 0.5.0 **/ @@ -1669,7 +1671,7 @@ gdata_picasaweb_file_get_image_unique_id (GDataPicasaWebFile *self) * * Gets the #GDataPicasaWebFile:iso property. * - * Return value: the ISO speed, or %-1 if unknown + * Return value: the ISO speed, or <code class="literal">-1</code> if unknown * * Since: 0.5.0 **/ diff --git a/gdata/services/picasaweb/gdata-picasaweb-query.c b/gdata/services/picasaweb/gdata-picasaweb-query.c index 01c72482..2508cf53 100644 --- a/gdata/services/picasaweb/gdata-picasaweb-query.c +++ b/gdata/services/picasaweb/gdata-picasaweb-query.c @@ -91,7 +91,8 @@ gdata_picasaweb_query_class_init (GDataPicasaWebQueryClass *klass) * * Specifies which albums should be listed, in terms of their visibility (#GDataPicasaWebAlbum:visibility). * - * Set the property to %0 to list all albums, regardless of their visibility. Otherwise, use values from #GDataPicasaWebVisibility. + * Set the property to <code class="literal">0</code> to list all albums, regardless of their visibility. Otherwise, use values + * from #GDataPicasaWebVisibility. * * For more information, see the <ulink type="http" url="http://code.google.com/apis/picasaweb/reference.html#Visibility"> * online documentation</ulink>. @@ -350,7 +351,7 @@ gdata_picasaweb_query_new_with_limits (const gchar *q, gint start_index, gint ma * * Gets the #GDataPicasaWebQuery:visibility property. * - * Return value: the visibility of the objects to retrieve, or %0 to retrieve all objects + * Return value: the visibility of the objects to retrieve, or <code class="literal">0</code> to retrieve all objects * * Since: 0.4.0 **/ @@ -364,7 +365,7 @@ gdata_picasaweb_query_get_visibility (GDataPicasaWebQuery *self) /** * gdata_picasaweb_query_set_visibility: * @self: a #GDataPicasaWebQuery - * @visibility: the visibility of the objects to retrieve, or %0 to retrieve all objects + * @visibility: the visibility of the objects to retrieve, or <code class="literal">0</code> to retrieve all objects * * Sets the #GDataPicasaWebQuery:visibility property to @visibility. * @@ -445,8 +446,8 @@ gdata_picasaweb_query_get_image_size (GDataPicasaWebQuery *self) * @image_size: the desired size of the image to be retrieved, or %NULL * * Sets the #GDataPicasaWebQuery:image-size property to @image_size. - * Valid sizes are described here: - * http://code.google.com/apis/picasaweb/docs/2.0/reference.html#Parameters + * Valid sizes are described in the + * <ulink type="http" url="http://code.google.com/apis/picasaweb/docs/2.0/reference.html#Parameters">online documentation</ulink>. * * Set @image_size to %NULL to unset the property. * @@ -543,7 +544,7 @@ gdata_picasaweb_query_get_bounding_box (GDataPicasaWebQuery *self, gdouble *nort * * Sets a bounding box, inside which all the returned results must lie. * - * Set @north, @east, @south and @west to %0 to unset the property. + * Set @north, @east, @south and @west to <code class="literal">0</code> to unset the property. * * Since: 0.4.0 **/ diff --git a/gdata/services/picasaweb/gdata-picasaweb-user.c b/gdata/services/picasaweb/gdata-picasaweb-user.c index 93d03bb9..d42eca2f 100644 --- a/gdata/services/picasaweb/gdata-picasaweb-user.c +++ b/gdata/services/picasaweb/gdata-picasaweb-user.c @@ -302,11 +302,11 @@ gdata_picasaweb_user_get_nickname (GDataPicasaWebUser *self) * gdata_picasaweb_user_get_quota_limit: * @self: a #GDataPicasaWebUser * - * Gets the #GDataPicasaWebUser:quota-limit property. Note that + * Gets the #GDataPicasaWebUser:quota-limit property. Note that * this information is not available when accessing feeds which we - * haven't authenticated, and %0 is returned. + * haven't authenticated, and <code class="literal">0</code> is returned. * - * Return value: the maximum capacity in bytes for this feed's account, or %-1 + * Return value: the maximum capacity in bytes for this feed's account, or <code class="literal">-1</code> * * Since: 0.6.0 **/ @@ -323,9 +323,9 @@ gdata_picasaweb_user_get_quota_limit (GDataPicasaWebUser *self) * * Gets the #GDataPicasaWebUser:quota-current property. Note that * this information is not available when accessing feeds which we - * haven't authenticated, and %0 is returned. + * haven't authenticated, and <code class="literal">0</code> is returned. * - * Return value: the current number of bytes in use by this feed's account, or %-1 + * Return value: the current number of bytes in use by this feed's account, or <code class="literal">-1</code> * * Since: 0.6.0 **/ @@ -342,9 +342,9 @@ gdata_picasaweb_user_get_quota_current (GDataPicasaWebUser *self) * * Gets the #GDataPicasaWebUser:max-photos-per-album property. Note that * this information is not available when accessing feeds which we - * haven't authenticated, and %0 is returned. + * haven't authenticated, and <code class="literal">0</code> is returned. * - * Return value: the maximum number of photos an album for this account can hold, or %-1 + * Return value: the maximum number of photos an album for this account can hold, or <code class="literal">-1</code> * * Since: 0.6.0 **/ diff --git a/gdata/services/youtube/gdata-youtube-group.c b/gdata/services/youtube/gdata-youtube-group.c index ec4e0fef..6e79058c 100644 --- a/gdata/services/youtube/gdata-youtube-group.c +++ b/gdata/services/youtube/gdata-youtube-group.c @@ -161,7 +161,7 @@ get_namespaces (GDataParsable *parsable, GHashTable *namespaces) * * Gets the #GDataYouTubeGroup:duration property. * - * Return value: the video duration in seconds, or %0 if unknown + * Return value: the video duration in seconds, or <code class="literal">0</code> if unknown **/ guint gdata_youtube_group_get_duration (GDataYouTubeGroup *self) @@ -205,7 +205,7 @@ gdata_youtube_group_set_is_private (GDataYouTubeGroup *self, gboolean is_private * @uploaded: a #GTimeVal * * Gets the #GDataYouTubeGroup:uploaded property and puts it in @uploaded. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_youtube_group_get_uploaded (GDataYouTubeGroup *self, GTimeVal *uploaded) diff --git a/gdata/services/youtube/gdata-youtube-query.c b/gdata/services/youtube/gdata-youtube-query.c index 6c5a58ee..0da64c75 100644 --- a/gdata/services/youtube/gdata-youtube-query.c +++ b/gdata/services/youtube/gdata-youtube-query.c @@ -111,10 +111,11 @@ gdata_youtube_query_class_init (GDataYouTubeQueryClass *klass) * * The latitude of a particular location of which videos should be found. This should be used in conjunction with * #GDataYouTubeQuery:longitude; if either property is outside the valid range, neither will be used. Valid latitudes - * are between %-90 and %90 degrees; any values of this property outside that range will unset the property in the - * query URI. + * are between <code class="literal">-90</code> and <code class="literal">90</code>0 degrees; any values of this property outside that range + * will unset the property in the query URI. * - * If #GDataYouTubeQuery:location-radius is a non-%0 value, this will define a circle from which videos should be found. + * If #GDataYouTubeQuery:location-radius is a non-<code class="literal">0</code> value, this will define a circle from which videos should be + * found. * * If #GDataYouTubeQuery:has-location is %TRUE, only videos which are associated with specific coordinates in the search * circle will be returned. Otherwise, videos which have a relevant descriptive address (but no specific coordinates) will @@ -136,8 +137,8 @@ gdata_youtube_query_class_init (GDataYouTubeQueryClass *klass) * * The longitude of a particular location of which videos should be found. This should be used in conjunction with * #GDataYouTubeQuery:latitude; if either property is outside the valid range, neither will be used. Valid longitudes - * are between %-180 and %180 degrees; any values of this property outside that range will unset the property in the - * query URI. + * are between <code class="literal">-180</code> and <code class="literal">180</code> degrees; any values of this property outside that + * range will unset the property in the query URI. * * For more information, see the documentation for #GDataYouTubeQuery:latitude. * @@ -155,7 +156,7 @@ gdata_youtube_query_class_init (GDataYouTubeQueryClass *klass) * The radius, in metres, of a circle from within which videos should be returned. The circle is centred on the latitude and * longitude given in #GDataYouTubeQuery:latitude and #GDataYouTubeQuery:longitude. * - * Set this property to %0 to search for specific coordinates, rather than within a given radius. + * Set this property to <code class="literal">0</code> to search for specific coordinates, rather than within a given radius. * * For more information, see the documentation for #GDataYouTubeQuery:latitude. * @@ -593,7 +594,7 @@ gdata_youtube_query_get_location (GDataYouTubeQuery *self, gdouble *latitude, gd * @self: a #GDataYouTubeQuery * @latitude: the new latitude, or %G_MAXDOUBLE * @longitude: the new longitude, or %G_MAXDOUBLE - * @radius: the new location radius, or %0 + * @radius: the new location radius, or <code class="literal">0</code> * @has_location: %TRUE if the query is for videos with a specific location, %FALSE otherwise * * Sets the location-based properties of the #GDataYouTubeQuery<!-- -->: #GDataYouTubeQuery:latitude, #GDataYouTubeQuery:longitude, diff --git a/gdata/services/youtube/gdata-youtube-video.c b/gdata/services/youtube/gdata-youtube-video.c index c2e568b9..df6f930c 100644 --- a/gdata/services/youtube/gdata-youtube-video.c +++ b/gdata/services/youtube/gdata-youtube-video.c @@ -1192,7 +1192,7 @@ gdata_youtube_video_get_thumbnails (GDataYouTubeVideo *self) * * Gets the #GDataYouTubeVideo:duration property. * - * Return value: the video duration in seconds, or %0 if unknown + * Return value: the video duration in seconds, or <code class="literal">0</code> if unknown **/ guint gdata_youtube_video_get_duration (GDataYouTubeVideo *self) @@ -1237,7 +1237,7 @@ gdata_youtube_video_set_is_private (GDataYouTubeVideo *self, gboolean is_private * @uploaded: a #GTimeVal * * Gets the #GDataYouTubeVideo:uploaded property and puts it in @uploaded. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. **/ void gdata_youtube_video_get_uploaded (GDataYouTubeVideo *self, GTimeVal *uploaded) @@ -1315,7 +1315,7 @@ gdata_youtube_video_get_state (GDataYouTubeVideo *self) * @recorded: a #GTimeVal * * Gets the #GDataYouTubeVideo:recorded property and puts it in @recorded. If the property is unset, - * both fields in the #GTimeVal will be set to %0. + * both fields in the #GTimeVal will be set to <code class="literal">0</code>. * * Since: 0.3.0 **/ |