aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjgeboski <jgeboski@gmail.com>2015-12-16 14:11:00 -0500
committerjgeboski <jgeboski@gmail.com>2015-12-20 13:08:39 -0500
commit1c47c7ab4d0b74f67dc11558360d24c746d63186 (patch)
tree9b19e5e556d3366dfe4b188e8be4bf7079f692d9
parent2018aa1a288d5204d5d066bff672df8cb46065b9 (diff)
downloadbitlbee-facebook-1c47c7ab4d0b74f67dc11558360d24c746d63186.tar.gz
bitlbee-facebook-1c47c7ab4d0b74f67dc11558360d24c746d63186.tar.bz2
bitlbee-facebook-1c47c7ab4d0b74f67dc11558360d24c746d63186.tar.xz
Fixed grammar errors in the GTK-Doc
-rw-r--r--facebook/facebook-http.h10
-rw-r--r--facebook/facebook-json.h36
-rw-r--r--facebook/facebook-mqtt.h8
-rw-r--r--facebook/facebook-thrift.h22
-rw-r--r--facebook/facebook-util.h6
5 files changed, 41 insertions, 41 deletions
diff --git a/facebook/facebook-http.h b/facebook/facebook-http.h
index 1c07344..ceccbfc 100644
--- a/facebook/facebook-http.h
+++ b/facebook/facebook-http.h
@@ -417,7 +417,7 @@ fb_http_values_get_keys(FbHttpValues *values);
* fb_http_values_get_bool:
* @values: The #FbHttpValues.
* @name: The value 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 #FbHttpValues. This optionally assigns
* an appropriate #GError upon failure.
@@ -432,7 +432,7 @@ fb_http_values_get_bool(FbHttpValues *values, const gchar *name,
* fb_http_values_get_dbl:
* @values: The #FbHttpValues.
* @name: The value 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 #FbHttpValues. This optionally
* assigns an appropriate #GError upon failure.
@@ -447,7 +447,7 @@ fb_http_values_get_dbl(FbHttpValues *values, const gchar *name,
* fb_http_values_get_int:
* @values: The #FbHttpValues.
* @name: The value 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 #FbHttpValues. This optionally
* assigns an appropriate #GError upon failure.
@@ -462,7 +462,7 @@ fb_http_values_get_int(FbHttpValues *values, const gchar *name,
* fb_http_values_get_str:
* @values: The #FbHttpValues.
* @name: The value 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 #FbHttpValues. This optionally assigns
* an appropriate #GError upon failure.
@@ -477,7 +477,7 @@ fb_http_values_get_str(FbHttpValues *values, const gchar *name,
* fb_http_values_dup_str:
* @values: The #FbHttpValues.
* @name: The value 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 #FbHttpValues. This
* optionally assigns an appropriate #GError upon failure. The returned
diff --git a/facebook/facebook-json.h b/facebook/facebook-json.h
index 4ca5f61..ed74435 100644
--- a/facebook/facebook-json.h
+++ b/facebook/facebook-json.h
@@ -164,7 +164,7 @@ fb_json_bldr_close(JsonBuilder *bldr, JsonNodeType type, gsize *size);
/**
* 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.
*/
@@ -183,7 +183,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.
*/
@@ -202,7 +202,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.
@@ -213,7 +213,7 @@ fb_json_bldr_add_bool(JsonBuilder *bldr, const gchar *name, gboolean value);
/**
* 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.
@@ -224,7 +224,7 @@ fb_json_bldr_add_dbl(JsonBuilder *bldr, const gchar *name, gdouble value);
/**
* 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.
@@ -235,7 +235,7 @@ fb_json_bldr_add_int(JsonBuilder *bldr, const gchar *name, gint64 value);
/**
* 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.
@@ -246,7 +246,7 @@ fb_json_bldr_add_str(JsonBuilder *bldr, const gchar *name, const gchar *value);
/**
* 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.
*
@@ -260,8 +260,8 @@ fb_json_bldr_add_strf(JsonBuilder *bldr, const gchar *name,
/**
* 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.
@@ -275,7 +275,7 @@ fb_json_node_new(const gchar *data, gssize size, GError **error);
* 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
@@ -303,7 +303,7 @@ fb_json_node_get_nth(JsonNode *root, guint n);
* 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
@@ -318,7 +318,7 @@ fb_json_node_get_arr(JsonNode *root, const gchar *expr, GError **error);
* 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.
@@ -332,7 +332,7 @@ fb_json_node_get_bool(JsonNode *root, const gchar *expr, GError **error);
* 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.
@@ -346,7 +346,7 @@ fb_json_node_get_dbl(JsonNode *root, const gchar *expr, GError **error);
* 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.
@@ -360,7 +360,7 @@ fb_json_node_get_int(JsonNode *root, const gchar *expr, GError **error);
* 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()
@@ -401,8 +401,8 @@ fb_json_values_add(FbJsonValues *values, FbJsonType type, gboolean required,
* @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);
@@ -422,7 +422,7 @@ fb_json_values_set_array(FbJsonValues *values, gboolean required,
/**
* 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/facebook/facebook-mqtt.h b/facebook/facebook-mqtt.h
index 9118a6f..ee42aa8 100644
--- a/facebook/facebook-mqtt.h
+++ b/facebook/facebook-mqtt.h
@@ -515,7 +515,7 @@ fb_mqtt_message_read_r(FbMqttMessage *msg, GByteArray *bytes);
/**
* 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.
@@ -528,7 +528,7 @@ fb_mqtt_message_read_byte(FbMqttMessage *msg, guint8 *value);
/**
* 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.
@@ -541,7 +541,7 @@ fb_mqtt_message_read_mid(FbMqttMessage *msg, guint16 *value);
/**
* 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.
@@ -554,7 +554,7 @@ fb_mqtt_message_read_u16(FbMqttMessage *msg, guint16 *value);
/**
* 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/facebook/facebook-thrift.h b/facebook/facebook-thrift.h
index 25b43f5..98893d0 100644
--- a/facebook/facebook-thrift.h
+++ b/facebook/facebook-thrift.h
@@ -189,7 +189,7 @@ fb_thrift_read(FbThrift *thft, gpointer data, guint size);
/**
* 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.
@@ -202,7 +202,7 @@ fb_thrift_read_bool(FbThrift *thft, gboolean *value);
/**
* 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.
@@ -215,7 +215,7 @@ fb_thrift_read_byte(FbThrift *thft, guint8 *value);
/**
* 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.
@@ -228,7 +228,7 @@ fb_thrift_read_dbl(FbThrift *thft, gdouble *value);
/**
* 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,
@@ -242,7 +242,7 @@ fb_thrift_read_i16(FbThrift *thft, gint16 *value);
/**
* 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
@@ -256,7 +256,7 @@ fb_thrift_read_vi16(FbThrift *thft, guint16 *value);
/**
* fb_thrift_read_i32:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a signed 32-bit integer value from the #FbThrift. This will
* convert the integer from the zig-zag format. If @value is #NULL,
@@ -270,7 +270,7 @@ fb_thrift_read_i32(FbThrift *thft, gint32 *value);
/**
* fb_thrift_read_vi32:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a 32-bit integer value from the #FbThrift. This reads the raw
* integer value without converting it from the zig-zag format. If
@@ -284,7 +284,7 @@ fb_thrift_read_vi32(FbThrift *thft, guint32 *value);
/**
* fb_thrift_read_i64:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a signed 64-bit integer value from the #FbThrift. This will
* convert the integer from the zig-zag format. If @value is #NULL,
@@ -298,7 +298,7 @@ fb_thrift_read_i64(FbThrift *thft, gint64 *value);
/**
* fb_thrift_read_vi64:
* @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 integer value from the #FbThrift. This reads the raw
* integer value without converting it from the zig-zag format. If
@@ -312,7 +312,7 @@ fb_thrift_read_vi64(FbThrift *thft, guint64 *value);
/**
* fb_thrift_read_str:
* @thft: The #FbThrift.
- * @value: The return location for the value, or #NULL.
+ * @value: The return location for the value or #NULL.
*
* Reads a string value from the #FbThrift. The value returned to
* @value should be freed with #g_free() when no longer needed. If
@@ -327,7 +327,7 @@ fb_thrift_read_str(FbThrift *thft, gchar **value);
* fb_thrift_read_field:
* @thft: The #FbThrift.
* @type: The return location for the #FbThriftType.
- * @id: The return location for the identifier, or #NULL.
+ * @id: The return location for the identifier or #NULL.
*
* Reads a field header from the #FbThrift.
*
diff --git a/facebook/facebook-util.h b/facebook/facebook-util.h
index 6c71dce..5a0f1f4 100644
--- a/facebook/facebook-util.h
+++ b/facebook/facebook-util.h
@@ -224,7 +224,7 @@ fb_util_zcompressed(const GByteArray *bytes);
/**
* fb_util_zcompress:
* @bytes: The #GByteArray.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Compresses a #GByteArray with zlib. The returned #GByteArray should
* be freed with #g_byte_array_free() when no longer needed.
@@ -237,12 +237,12 @@ fb_util_zcompress(const GByteArray *bytes, GError **error);
/**
* fb_util_zuncompress:
* @bytes: The #GByteArray.
- * @error: The return location for the #GError, or #NULL.
+ * @error: The return location for the #GError or #NULL.
*
* Uncompresses a #GByteArray with zlib. The returned #GByteArray
* should be freed with #g_byte_array_free() when no longer needed.
*
- * Returns: The uncompressed #GByteArray, or #NULL on error.
+ * Returns: The uncompressed #GByteArray or #NULL on error.
*/
GByteArray *
fb_util_zuncompress(const GByteArray *bytes, GError **error);