Skip to content

Commit 28497c8

Browse files
authored
Fix typos in FlValue docs (flutter#21875)
1 parent b457e2d commit 28497c8

File tree

1 file changed

+18
-18
lines changed
  • shell/platform/linux/public/flutter_linux

1 file changed

+18
-18
lines changed

shell/platform/linux/public/flutter_linux/fl_value.h

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ FlValue* fl_value_new_float(double value);
113113

114114
/**
115115
* fl_value_new_string:
116-
* @value: a nul terminated UTF-8 string.
116+
* @value: a %NULL-terminated UTF-8 string.
117117
*
118118
* Creates an #FlValue that contains UTF-8 text. The equivalent Dart type is a
119119
* String.
@@ -123,7 +123,7 @@ FlValue* fl_value_new_float(double value);
123123
FlValue* fl_value_new_string(const gchar* value);
124124

125125
/**
126-
* fl_value_new_string:
126+
* fl_value_new_string_sized:
127127
* @value: a buffer containing UTF-8 text. It does not require a nul terminator.
128128
* @value_length: the number of bytes to use from @value.
129129
*
@@ -136,7 +136,7 @@ FlValue* fl_value_new_string_sized(const gchar* value, size_t value_length);
136136

137137
/**
138138
* fl_value_new_uint8_list:
139-
* @value: an arrary of unsigned 8 bit integers.
139+
* @value: an array of unsigned 8 bit integers.
140140
* @value_length: number of elements in @value.
141141
*
142142
* Creates an ordered list containing 8 bit unsigned integers. The data is
@@ -147,7 +147,7 @@ FlValue* fl_value_new_string_sized(const gchar* value, size_t value_length);
147147
FlValue* fl_value_new_uint8_list(const uint8_t* value, size_t value_length);
148148

149149
/**
150-
* fl_value_new_uint8_list:
150+
* fl_value_new_uint8_list_from_bytes:
151151
* @value: a #GBytes.
152152
*
153153
* Creates an ordered list containing 8 bit unsigned integers. The data is
@@ -159,7 +159,7 @@ FlValue* fl_value_new_uint8_list_from_bytes(GBytes* value);
159159

160160
/**
161161
* fl_value_new_int32_list:
162-
* @value: an arrary of signed 32 bit integers.
162+
* @value: an array of signed 32 bit integers.
163163
* @value_length: number of elements in @value.
164164
*
165165
* Creates an ordered list containing 32 bit integers. The equivalent Dart type
@@ -171,7 +171,7 @@ FlValue* fl_value_new_int32_list(const int32_t* value, size_t value_length);
171171

172172
/**
173173
* fl_value_new_int64_list:
174-
* @value: an arrary of signed 64 bit integers.
174+
* @value: an array of signed 64 bit integers.
175175
* @value_length: number of elements in @value.
176176
*
177177
* Creates an ordered list containing 64 bit integers. The equivalent Dart type
@@ -183,7 +183,7 @@ FlValue* fl_value_new_int64_list(const int64_t* value, size_t value_length);
183183

184184
/**
185185
* fl_value_new_float_list:
186-
* @value: an arrary of floating point numbers.
186+
* @value: an array of floating point numbers.
187187
* @value_length: number of elements in @value.
188188
*
189189
* Creates an ordered list containing floating point numbers. The equivalent
@@ -283,7 +283,7 @@ FlValue* fl_value_ref(FlValue* value);
283283
* fl_value_unref:
284284
* @value: an #FlValue.
285285
*
286-
* Dereases the reference count of an #FlValue. When the refernece count hits
286+
* Decreases the reference count of an #FlValue. When the reference count hits
287287
* zero @value is destroyed and no longer valid.
288288
*/
289289
void fl_value_unref(FlValue* value);
@@ -323,7 +323,7 @@ bool fl_value_equal(FlValue* a, FlValue* b);
323323
void fl_value_append(FlValue* value, FlValue* child);
324324

325325
/**
326-
* fl_value_append:
326+
* fl_value_append_take:
327327
* @value: an #FlValue of type #FL_VALUE_TYPE_LIST.
328328
* @child: (transfer full): an #FlValue.
329329
*
@@ -410,13 +410,13 @@ bool fl_value_get_bool(FlValue* value);
410410
int64_t fl_value_get_int(FlValue* value);
411411

412412
/**
413-
* fl_value_get_double:
413+
* fl_value_get_float:
414414
* @value: an #FlValue of type #FL_VALUE_TYPE_FLOAT.
415415
*
416416
* Gets the floating point number of @value. Calling this with an #FlValue
417417
* that is not of type #FL_VALUE_TYPE_FLOAT is a programming error.
418418
*
419-
* Returns: a UTF-8 encoded string.
419+
* Returns: a floating point number.
420420
*/
421421
double fl_value_get_float(FlValue* value);
422422

@@ -511,7 +511,7 @@ FlValue* fl_value_get_list_value(FlValue* value, size_t index);
511511
* @value: an #FlValue of type #FL_VALUE_TYPE_MAP.
512512
* @index: an index in the map.
513513
*
514-
* Gets an key from the map. It is a programming error to request an index that
514+
* Gets a key from the map. It is a programming error to request an index that
515515
* is outside the size of the list as returned from fl_value_get_length().
516516
* Calling this with an #FlValue that is not of type #FL_VALUE_TYPE_MAP is a
517517
* programming error.
@@ -521,7 +521,7 @@ FlValue* fl_value_get_list_value(FlValue* value, size_t index);
521521
FlValue* fl_value_get_map_key(FlValue* value, size_t index);
522522

523523
/**
524-
* fl_value_get_map_key:
524+
* fl_value_get_map_value:
525525
* @value: an #FlValue of type #FL_VALUE_TYPE_MAP.
526526
* @index: an index in the map.
527527
*
@@ -543,8 +543,8 @@ FlValue* fl_value_get_map_value(FlValue* value, size_t index);
543543
* fl_value_equal(). Calling this with an #FlValue that is not of type
544544
* #FL_VALUE_TYPE_MAP is a programming error.
545545
*
546-
* Map lookups are not optimised for performance - if have a large map or need
547-
* frequent access you should copy the data into another structure, e.g.
546+
* Map lookups are not optimised for performance - if you have a large map or
547+
* need frequent access you should copy the data into another structure, e.g.
548548
* #GHashTable.
549549
*
550550
* Returns: (allow-none): the value with this key or %NULL if not one present.
@@ -560,8 +560,8 @@ FlValue* fl_value_lookup(FlValue* value, FlValue* key);
560560
* fl_value_equal(). Calling this with an #FlValue that is not of type
561561
* #FL_VALUE_TYPE_MAP is a programming error.
562562
*
563-
* Map lookups are not optimised for performance - if have a large map or need
564-
* frequent access you should copy the data into another structure, e.g.
563+
* Map lookups are not optimised for performance - if you have a large map or
564+
* need frequent access you should copy the data into another structure, e.g.
565565
* #GHashTable.
566566
*
567567
* Returns: (allow-none): the value with this key or %NULL if not one present.
@@ -573,7 +573,7 @@ FlValue* fl_value_lookup_string(FlValue* value, const gchar* key);
573573
* @value: an #FlValue.
574574
*
575575
* Converts an #FlValue to a text representation, suitable for logging purposes.
576-
* The text is formatted to be match the equivalent Dart toString() methods.
576+
* The text is formatted to be the equivalent of Dart toString() methods.
577577
*
578578
* Returns: UTF-8 text.
579579
*/

0 commit comments

Comments
 (0)