Browse Source

Merge pull request #26715 from shartte/patch-1

Clarify encoding used for text by the File class
Rémi Verschelde 6 years ago
parent
commit
cc3e660d7e
1 changed files with 8 additions and 0 deletions
  1. 8 0
      doc/classes/File.xml

+ 8 - 0
doc/classes/File.xml

@@ -84,6 +84,7 @@
 			</return>
 			</return>
 			<description>
 			<description>
 				Returns the whole file as a [String].
 				Returns the whole file as a [String].
+				Text is interpreted as being UTF-8 encoded.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_buffer" qualifiers="const">
 		<method name="get_buffer" qualifiers="const">
@@ -102,6 +103,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
 				Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
+				Text is interpreted as being UTF-8 encoded.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_double" qualifiers="const">
 		<method name="get_double" qualifiers="const">
@@ -137,6 +139,7 @@
 			</return>
 			</return>
 			<description>
 			<description>
 				Returns the next line of the file as a [String].
 				Returns the next line of the file as a [String].
+				Text is interpreted as being UTF-8 encoded.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_md5" qualifiers="const">
 		<method name="get_md5" qualifiers="const">
@@ -162,6 +165,7 @@
 			</return>
 			</return>
 			<description>
 			<description>
 				Returns a [String] saved in Pascal format from the file.
 				Returns a [String] saved in Pascal format from the file.
+				Text is interpreted as being UTF-8 encoded.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="get_path" qualifiers="const">
 		<method name="get_path" qualifiers="const">
@@ -340,6 +344,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
 				Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
+				Text will be encoded as UTF-8.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="store_double">
 		<method name="store_double">
@@ -367,6 +372,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Stores the given [String] as a line in the file.
 				Stores the given [String] as a line in the file.
+				Text will be encoded as UTF-8.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="store_pascal_string">
 		<method name="store_pascal_string">
@@ -376,6 +382,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
 				Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
+				Text will be encoded as UTF-8.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="store_real">
 		<method name="store_real">
@@ -394,6 +401,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Stores the given [String] in the file.
 				Stores the given [String] in the file.
+				Text will be encoded as UTF-8.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="store_var">
 		<method name="store_var">