/pidgin/main: a06ade737f26: facebook: fixed grammar errors in th...
James Geboski
jgeboski at gmail.com
Wed Dec 16 14:04:36 EST 2015
Changeset: a06ade737f266ee5287b9eab29e32218df2ca558
Author: James Geboski <jgeboski at gmail.com>
Date: 2015-12-16 14:04 -0500
Branch: default
URL: https://hg.pidgin.im/pidgin/main/rev/a06ade737f26
Description:
facebook: fixed grammar errors in the GTK-Doc
diffstat:
libpurple/protocols/facebook/http.h | 12 +++++-----
libpurple/protocols/facebook/json.h | 36 +++++++++++++++++-----------------
libpurple/protocols/facebook/mqtt.h | 8 +++---
libpurple/protocols/facebook/thrift.h | 22 ++++++++++----------
libpurple/protocols/facebook/util.h | 10 ++++----
5 files changed, 44 insertions(+), 44 deletions(-)
diffs (truncated from 394 to 300 lines):
diff --git a/libpurple/protocols/facebook/http.h b/libpurple/protocols/facebook/http.h
--- a/libpurple/protocols/facebook/http.h
+++ b/libpurple/protocols/facebook/http.h
@@ -75,7 +75,7 @@ fb_http_error_quark(void);
/**
* fb_http_error_chk:
* @res: The #PurpleHttpResponse.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Checks a #PurpleHttpResponse for success. This optionally assigns an
* appropriate #GError upon failure.
@@ -142,7 +142,7 @@ fb_http_params_close(FbHttpParams *param
* fb_http_params_get_bool:
* @params: The #FbHttpParams.
* @name: The parameter name.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a boolean value from the #FbHttpParams. This optionally assigns
* an appropriate #GError upon failure.
@@ -157,7 +157,7 @@ fb_http_params_get_bool(FbHttpParams *pa
* fb_http_params_get_dbl:
* @params: The #FbHttpParams.
* @name: The parameter name.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a floating point value from the #FbHttpParams. This optionally
* assigns an appropriate #GError upon failure.
@@ -172,7 +172,7 @@ fb_http_params_get_dbl(FbHttpParams *par
* fb_http_params_get_int:
* @params: The #FbHttpParams.
* @name: The parameter name.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets an integer value from the #FbHttpParams. This optionally
* assigns an appropriate #GError upon failure.
@@ -187,7 +187,7 @@ fb_http_params_get_int(FbHttpParams *par
* fb_http_params_get_str:
* @params: The #FbHttpParams.
* @name: The parameter name.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a string value from the #FbHttpParams. This optionally assigns
* an appropriate #GError upon failure.
@@ -202,7 +202,7 @@ fb_http_params_get_str(FbHttpParams *par
* fb_http_params_dup_str:
* @params: The #FbHttpParams.
* @name: The parameter name.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a duplicated string value from the #FbHttpParams. This
* optionally assigns an appropriate #GError upon failure. The returned
diff --git a/libpurple/protocols/facebook/json.h b/libpurple/protocols/facebook/json.h
--- a/libpurple/protocols/facebook/json.h
+++ b/libpurple/protocols/facebook/json.h
@@ -167,7 +167,7 @@ fb_json_bldr_close(JsonBuilder *bldr, Js
/**
* fb_json_bldr_arr_begin:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
*
* Begins an array member in the #JsonBuilder.
*/
@@ -186,7 +186,7 @@ fb_json_bldr_arr_end(JsonBuilder *bldr);
/**
* fb_json_bldr_obj_begin:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
*
* Begins an object member in the #JsonBuilder.
*/
@@ -205,7 +205,7 @@ fb_json_bldr_obj_end(JsonBuilder *bldr);
/**
* fb_json_bldr_add_bool:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
* @value: The value.
*
* Adds a boolean memeber to the #JsonBuilder.
@@ -216,7 +216,7 @@ fb_json_bldr_add_bool(JsonBuilder *bldr,
/**
* fb_json_bldr_add_dbl:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
* @value: The value.
*
* Adds a floating point memeber to the #JsonBuilder.
@@ -227,7 +227,7 @@ fb_json_bldr_add_dbl(JsonBuilder *bldr,
/**
* fb_json_bldr_add_int:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
* @value: The value.
*
* Adds a integer memeber to the #JsonBuilder.
@@ -238,7 +238,7 @@ fb_json_bldr_add_int(JsonBuilder *bldr,
/**
* fb_json_bldr_add_str:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
* @value: The value.
*
* Adds a string memeber to the #JsonBuilder.
@@ -249,7 +249,7 @@ fb_json_bldr_add_str(JsonBuilder *bldr,
/**
* fb_json_bldr_add_strf:
* @bldr: The #JsonBuilder.
- * @name: The member name, or #NULL.
+ * @name: The member name or #NULL.
* @format: The format string literal.
* @...: The arguments for @format.
*
@@ -263,8 +263,8 @@ fb_json_bldr_add_strf(JsonBuilder *bldr,
/**
* fb_json_node_new:
* @data: The string JSON.
- * @size: The size of @json, or -1 if null-terminated.
- * @error: The return location for the #GError, or #NULL.
+ * @size: The size of @json or -1 if null-terminated.
+ * @error: The return location for the #GError or #NULL.
*
* Creates a new #JsonNode. The returned #JsonBuilder should be freed
* wuth #json_node_free() when no longer needed.
@@ -278,7 +278,7 @@ fb_json_node_new(const gchar *data, gssi
* fb_json_node_get:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a new #JsonNode value from a parent #JsonNode with a #JsonPath
* expression. The returned #JsonNode should be freed with
@@ -306,7 +306,7 @@ fb_json_node_get_nth(JsonNode *root, gui
* fb_json_node_get_arr:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a new #JsonArray value from a parent #JsonNode with a #JsonPath
* expression. The returned #JsonArray should be freed with
@@ -321,7 +321,7 @@ fb_json_node_get_arr(JsonNode *root, con
* fb_json_node_get_bool:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a boolean value from a parent #JsonNode with a #JsonPath
* expression.
@@ -335,7 +335,7 @@ fb_json_node_get_bool(JsonNode *root, co
* fb_json_node_get_dbl:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets a floating point value from a parent #JsonNode with a #JsonPath
* expression.
@@ -349,7 +349,7 @@ fb_json_node_get_dbl(JsonNode *root, con
* fb_json_node_get_int:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets an integer value from a parent #JsonNode with a #JsonPath
* expression.
@@ -363,7 +363,7 @@ fb_json_node_get_int(JsonNode *root, con
* fb_json_node_get_str:
* @root: The root #JsonNode.
* @expr: The #JsonPath expression.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Gets an string value from a parent #JsonNode with a #JsonPath
* expression. The returned string should be freed with #g_free()
@@ -404,8 +404,8 @@ fb_json_values_add(FbJsonValues *values,
* @values: The #FbJsonValues.
*
* Gets the current working root #JsonNode. This is either the current
- * array #JsonNode, or the root #JsonNode. The returned #JsonNode
- * should not be freed.
+ * array #JsonNode or the root #JsonNode. The returned #JsonNode should
+ * not be freed.
*/
JsonNode *
fb_json_values_get_root(FbJsonValues *values);
@@ -425,7 +425,7 @@ fb_json_values_set_array(FbJsonValues *v
/**
* fb_json_values_update:
* @values: The #FbJsonValues.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Updates the current working root. This should be called after all of
* the #FbJsonValue's have been added with #fb_json_values_add(). If an
diff --git a/libpurple/protocols/facebook/mqtt.h b/libpurple/protocols/facebook/mqtt.h
--- a/libpurple/protocols/facebook/mqtt.h
+++ b/libpurple/protocols/facebook/mqtt.h
@@ -521,7 +521,7 @@ fb_mqtt_message_read_r(FbMqttMessage *ms
/**
* fb_mqtt_message_read_byte:
* @msg: The #FbMqttMessage.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads an 8-bit integer value from the #FbMqttMessage. If @value is
* #NULL, this will simply advance the cursor position.
@@ -534,7 +534,7 @@ fb_mqtt_message_read_byte(FbMqttMessage
/**
* fb_mqtt_message_read_mid:
* @msg: The #FbMqttMessage.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a message identifier from the #FbMqttMessage. If @value is
* #NULL, this will simply advance the cursor position.
@@ -547,7 +547,7 @@ fb_mqtt_message_read_mid(FbMqttMessage *
/**
* fb_mqtt_message_read_u16:
* @msg: The #FbMqttMessage.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a 16-bit integer value from the #FbMqttMessage. If @value is
* #NULL, this will simply advance the cursor position.
@@ -560,7 +560,7 @@ fb_mqtt_message_read_u16(FbMqttMessage *
/**
* fb_mqtt_message_read_str:
* @msg: The #FbMqttMessage.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a string value from the #FbMqttMessage. The value returned to
* @value should be freed with #g_free() when no longer needed. If
diff --git a/libpurple/protocols/facebook/thrift.h b/libpurple/protocols/facebook/thrift.h
--- a/libpurple/protocols/facebook/thrift.h
+++ b/libpurple/protocols/facebook/thrift.h
@@ -193,7 +193,7 @@ fb_thrift_read(FbThrift *thft, gpointer
/**
* fb_thrift_read_bool:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a boolean value from the #FbThrift. If @value is #NULL, this
* will simply advance the cursor position.
@@ -206,7 +206,7 @@ fb_thrift_read_bool(FbThrift *thft, gboo
/**
* fb_thrift_read_byte:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads an 8-bit integer value from the #FbThrift. If @value is #NULL,
* this will simply advance the cursor position.
@@ -219,7 +219,7 @@ fb_thrift_read_byte(FbThrift *thft, guin
/**
* fb_thrift_read_dbl:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a 64-bit floating point value from the #FbThrift. If @value
* is #NULL, this will simply advance the cursor position.
@@ -232,7 +232,7 @@ fb_thrift_read_dbl(FbThrift *thft, gdoub
/**
* fb_thrift_read_i16:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a signed 16-bit integer value from the #FbThrift. This will
* convert the integer from the zig-zag format. If @value is #NULL,
@@ -246,7 +246,7 @@ fb_thrift_read_i16(FbThrift *thft, gint1
/**
* fb_thrift_read_vi16:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a 16-bit integer value from the #FbThrift. This reads the raw
* integer value without converting it from the zig-zag format. If
@@ -260,7 +260,7 @@ fb_thrift_read_vi16(FbThrift *thft, guin
/**
* fb_thrift_read_i32:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
More information about the Commits
mailing list