[evolution-data-server/wip/camel-more-gobject] Rename _length() getters to _get_length(); correct some annotations
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server/wip/camel-more-gobject] Rename _length() getters to _get_length(); correct some annotations
- Date: Mon, 5 Sep 2016 16:46:35 +0000 (UTC)
commit 9ac65436847e92a6da5ec1dbcdcd1ba204eb324b
Author: Milan Crha <mcrha redhat com>
Date: Mon Sep 5 18:46:24 2016 +0200
Rename _length() getters to _get_length(); correct some annotations
camel/camel-message-info.c | 6 ++--
camel/camel-mime-utils.c | 60 ++++++++++++++++++++++----------------------
camel/camel-mime-utils.h | 5 ++-
3 files changed, 36 insertions(+), 35 deletions(-)
---
diff --git a/camel/camel-message-info.c b/camel/camel-message-info.c
index 4988515..bd5110d 100644
--- a/camel/camel-message-info.c
+++ b/camel/camel-message-info.c
@@ -702,7 +702,7 @@ xcamel_message_info_init (xCamelMessageInfo *mi)
*
* Create a new #xCamelMessageInfo object, optionally for given @summary.
*
- * Returns: (transfer-full): a new #xCamelMessageInfo object
+ * Returns: (transfer full): a new #xCamelMessageInfo object
*
* Since: 3.24
**/
@@ -734,7 +734,7 @@ xcamel_message_info_new (CamelFolderSummary *summary)
* a new #CamelFolderSummary to it. If it's not set, then the new
* clone will not have assigned any summary.
*
- * Returns: (transfer-full): a new #xCamelMessageInfo object, clone of the @mi
+ * Returns: (transfer full): a new #xCamelMessageInfo object, clone of the @mi
*
* Since: 3.24
**/
@@ -759,7 +759,7 @@ xcamel_message_info_clone (const xCamelMessageInfo *mi,
* xcamel_message_info_ref_summary:
* @mi: a #xCamelMessageInfo
*
- * Returns: (transfer-full): Referenced #CamelFolderSummary to which the @mi belongs, or %NULL,
+ * Returns: (transfer full): Referenced #CamelFolderSummary to which the @mi belongs, or %NULL,
* if there is none. Use g_object_unref() for non-NULL returned values when done with it.
*
* Since: 3.24
diff --git a/camel/camel-mime-utils.c b/camel/camel-mime-utils.c
index 6d8e668..04e872d 100644
--- a/camel/camel-mime-utils.c
+++ b/camel/camel-mime-utils.c
@@ -135,7 +135,7 @@ free_name_value_content (gpointer ptr)
* Created a new #CamelNameValueArray. The returned pointer should be freed
* with camel_name_value_array_free() when no longer needed.
*
- * Returns: (transfer-full): A new #CamelNameValueArray.
+ * Returns: (transfer full): A new #CamelNameValueArray.
*
* See: camel_name_value_array_new_sized, camel_name_value_array_copy
*
@@ -157,11 +157,11 @@ camel_name_value_array_new (void)
* @reserve_size: an array size to reserve
*
* Created a new #CamelNameValueArray, which has reserved @reserve_size
- * elements. This value doesn't influence the camel_name_value_array_length(),
+ * elements. This value doesn't influence the camel_name_value_array_get_length(),
* which returns zero on the array returned from this function. The returned
* pointer should be freed with camel_name_value_array_free() when no longer needed.
*
- * Returns: (transfer-full): A new #CamelNameValueArray.
+ * Returns: (transfer full): A new #CamelNameValueArray.
*
* See: camel_name_value_array_new, camel_name_value_array_copy
*
@@ -185,7 +185,7 @@ camel_name_value_array_new_sized (guint reserve_size)
* Created a new copy of the @array. The returned pointer should be freed
* with camel_name_value_array_free() when no longer needed.
*
- * Returns: (transfer-full): A new copy of the @array.
+ * Returns: (transfer full): A new copy of the @array.
*
* See: camel_name_value_array_new, camel_name_value_array_new_sized
*
@@ -200,7 +200,7 @@ camel_name_value_array_copy (const CamelNameValueArray *array)
if (!array)
return NULL;
- len = camel_name_value_array_length (array);
+ len = camel_name_value_array_get_length (array);
copy = camel_name_value_array_new_sized (len);
for (ii = 0; ii < len; ii++) {
@@ -231,7 +231,7 @@ camel_name_value_array_free (CamelNameValueArray *array)
}
/**
- * camel_name_value_array_length:
+ * camel_name_value_array_get_length:
* @array: a #CamelNameValueArray
*
* Returns: Length of the @array, aka how many elements are stored in the @array.
@@ -239,7 +239,7 @@ camel_name_value_array_free (CamelNameValueArray *array)
* Since: 3.24
**/
guint
-camel_name_value_array_length (const CamelNameValueArray *array)
+camel_name_value_array_get_length (const CamelNameValueArray *array)
{
GArray *arr = (GArray *) array;
@@ -274,7 +274,7 @@ camel_name_value_array_get (const CamelNameValueArray *array,
CamelNameValuePair *pair;
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
pair = &g_array_index (arr, CamelNameValuePair, index);
@@ -319,7 +319,7 @@ camel_name_value_array_find_named (const CamelNameValueArray *array,
* is no element of such @name in the @array. The @case_sensitive determines
* whether compare names case sensitively (%TRUE) or insensitively (%FALSE).
*
- * Returns: (transfer-none) (nullable): Value of the first element named @name, or %NULL.
+ * Returns: (transfer none) (nullable): Value of the first element named @name, or %NULL.
*
* See: camel_name_value_array_get, camel_name_value_array_get_name
*
@@ -349,7 +349,7 @@ camel_name_value_array_get_named (const CamelNameValueArray *array,
*
* Returns the name of the element at index @index.
*
- * Returns: (transfer-none) (nullable): Name of the element at the given @index,
+ * Returns: (transfer none) (nullable): Name of the element at the given @index,
* or %NULL on error.
*
* See: camel_name_value_array_get, camel_name_value_array_get_value
@@ -363,7 +363,7 @@ camel_name_value_array_get_name (const CamelNameValueArray *array,
const gchar *name = NULL;
g_return_val_if_fail (array != NULL, NULL);
- g_return_val_if_fail (index < camel_name_value_array_length (array), NULL);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), NULL);
if (!camel_name_value_array_get (array, index, &name, NULL))
return NULL;
@@ -378,7 +378,7 @@ camel_name_value_array_get_name (const CamelNameValueArray *array,
*
* Returns the value of the element at index @index.
*
- * Returns: (transfer-none) (nullable): Value of the element at the given @index,
+ * Returns: (transfer none) (nullable): Value of the element at the given @index,
* or %NULL on error.
*
* See: camel_name_value_array_get, camel_name_value_array_get_name
@@ -392,7 +392,7 @@ camel_name_value_array_get_value (const CamelNameValueArray *array,
const gchar *value = NULL;
g_return_val_if_fail (array != NULL, NULL);
- g_return_val_if_fail (index < camel_name_value_array_length (array), NULL);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), NULL);
if (!camel_name_value_array_get (array, index, NULL, &value))
return NULL;
@@ -442,7 +442,7 @@ camel_name_value_array_set_internal (CamelNameValueArray *array,
gboolean changed = FALSE;
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
pair = &g_array_index (arr, CamelNameValuePair, index);
@@ -483,7 +483,7 @@ camel_name_value_array_set (CamelNameValueArray *array,
const gchar *value)
{
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
g_return_val_if_fail (name != NULL, FALSE);
g_return_val_if_fail (value != NULL, FALSE);
@@ -510,7 +510,7 @@ camel_name_value_array_set_name (CamelNameValueArray *array,
const gchar *name)
{
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
g_return_val_if_fail (name != NULL, FALSE);
return camel_name_value_array_set_internal (array, index, name, NULL);
@@ -536,7 +536,7 @@ camel_name_value_array_set_value (CamelNameValueArray *array,
const gchar *value)
{
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
g_return_val_if_fail (value != NULL, FALSE);
return camel_name_value_array_set_internal (array, index, NULL, value);
@@ -601,7 +601,7 @@ camel_name_value_array_remove (CamelNameValueArray *array,
guint index)
{
g_return_val_if_fail (array != NULL, FALSE);
- g_return_val_if_fail (index < camel_name_value_array_length (array), FALSE);
+ g_return_val_if_fail (index < camel_name_value_array_get_length (array), FALSE);
g_array_remove_index ((GArray *) array, index);
@@ -692,8 +692,8 @@ camel_name_value_array_equal (const CamelNameValueArray *array_a,
if (!array_a || !array_b)
return FALSE;
- len = camel_name_value_array_length (array_a);
- if (len != camel_name_value_array_length (array_b))
+ len = camel_name_value_array_get_length (array_a);
+ if (len != camel_name_value_array_get_length (array_b))
return FALSE;
for (ii = 0; ii < len; ii++) {
@@ -722,7 +722,7 @@ G_DEFINE_BOXED_TYPE (CamelNamedFlags,
*
* Creates a new #CamelNamedFlags.
*
- * Returns: (transfer-full): A newly allocated #CamelNamedFlags.
+ * Returns: (transfer full): A newly allocated #CamelNamedFlags.
* Free it with camel_named_flags_free() when done with it.
*
* Since: 3.24
@@ -738,10 +738,10 @@ camel_named_flags_new (void)
* @reserve_size: an array size to reserve
*
* Created a new #CamelNamedFlags, which has reserved @reserve_size
- * elements. This value doesn't influence the camel_named_flags_length(),
+ * elements. This value doesn't influence the camel_named_flags_get_length(),
* which returns zero on the array returned from this function.
*
- * Returns: (transfer-full): A newly allocated #CamelNameValueArray.
+ * Returns: (transfer full): A newly allocated #CamelNameValueArray.
* Free it with camel_named_flags_free() when done with it.
*
* See: camel_name_value_array_new, camel_name_value_array_copy
@@ -760,7 +760,7 @@ camel_named_flags_new_sized (guint reserve_size)
*
* Creates a copy of the @named_flags and returns it.
*
- * Returns: (transfer-full): A newly allocated #CamelNamedFlags.
+ * Returns: (transfer full): A newly allocated #CamelNamedFlags.
* Free it with camel_named_flags_free() when done with it.
*
* Since: 3.24
@@ -928,7 +928,7 @@ camel_named_flags_clear (CamelNamedFlags *named_flags)
}
/**
- * camel_named_flags_length:
+ * camel_named_flags_get_length:
* @named_flags: a #CamelNamedFlags
*
* Returns: Length of the array, aka how many named flags are stored there.
@@ -936,7 +936,7 @@ camel_named_flags_clear (CamelNamedFlags *named_flags)
* Since: 3.24
**/
guint
-camel_named_flags_length (const CamelNamedFlags *named_flags)
+camel_named_flags_get_length (const CamelNamedFlags *named_flags)
{
const GPtrArray *arr = (const GPtrArray *) named_flags;
@@ -950,7 +950,7 @@ camel_named_flags_length (const CamelNamedFlags *named_flags)
* @named_flags: a #CamelNamedFlags
* @index: an index of an element
*
- * Returns: (transfer-none) (nullable): Name of the flag in at the given @index,
+ * Returns: (transfer none) (nullable): Name of the flag in at the given @index,
* or %NULL on error.
*
* Since: 3.24
@@ -962,7 +962,7 @@ camel_named_flags_get (const CamelNamedFlags *named_flags,
const GPtrArray *arr = (const GPtrArray *) named_flags;
g_return_val_if_fail (named_flags != NULL, NULL);
- g_return_val_if_fail (index < camel_named_flags_length (named_flags), NULL);
+ g_return_val_if_fail (index < camel_named_flags_get_length (named_flags), NULL);
return g_ptr_array_index (arr, index);
}
@@ -991,8 +991,8 @@ camel_named_flags_equal (const CamelNamedFlags *named_flags_a,
if (!named_flags_a || !named_flags_b)
return FALSE;
- len = camel_named_flags_length (named_flags_a);
- if (len != camel_named_flags_length (named_flags_b))
+ len = camel_named_flags_get_length (named_flags_a);
+ if (len != camel_named_flags_get_length (named_flags_b))
return FALSE;
for (ii = 0; ii < len; ii++) {
diff --git a/camel/camel-mime-utils.h b/camel/camel-mime-utils.h
index 1714a55..49135e8 100644
--- a/camel/camel-mime-utils.h
+++ b/camel/camel-mime-utils.h
@@ -64,7 +64,8 @@ CamelNameValueArray *
CamelNameValueArray *
camel_name_value_array_copy (const CamelNameValueArray *array);
void camel_name_value_array_free (CamelNameValueArray *array);
-guint camel_name_value_array_length (const CamelNameValueArray *array);
+guint camel_name_value_array_get_length
+ (const CamelNameValueArray *array);
gboolean camel_name_value_array_get (const CamelNameValueArray *array,
guint index,
const gchar **out_name,
@@ -134,7 +135,7 @@ gboolean camel_named_flags_remove (CamelNamedFlags *named_flags,
gboolean camel_named_flags_contains (const CamelNamedFlags *named_flags,
const gchar *name);
void camel_named_flags_clear (CamelNamedFlags *named_flags);
-guint camel_named_flags_length (const CamelNamedFlags *named_flags);
+guint camel_named_flags_get_length (const CamelNamedFlags *named_flags);
const gchar * camel_named_flags_get (const CamelNamedFlags *named_flags,
guint index);
gboolean camel_named_flags_equal (const CamelNamedFlags *named_flags_a,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]