summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorshartte <shartte@users.noreply.github.com>2019-03-06 18:26:32 +0100
committerRĂ©mi Verschelde <rverschelde@gmail.com>2019-04-06 12:39:58 +0200
commitd1c095b30adc324889a9222ee4933ef922ae925e (patch)
treef048ae2de537b4b9f0b98127a6f0685cebfcce7a /doc/classes
parent506ff1f065936153efef0ace24e0d922b999b9e6 (diff)
Clarify encoding used for text by the File class
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/File.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index 533a6d6399..8a785ab263 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -84,6 +84,7 @@
</return>
<description>
Returns the whole file as a [String].
+ Text is interpreted as being UTF-8 encoded.
</description>
</method>
<method name="get_buffer" qualifiers="const">
@@ -102,6 +103,7 @@
</argument>
<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.
+ Text is interpreted as being UTF-8 encoded.
</description>
</method>
<method name="get_double" qualifiers="const">
@@ -137,6 +139,7 @@
</return>
<description>
Returns the next line of the file as a [String].
+ Text is interpreted as being UTF-8 encoded.
</description>
</method>
<method name="get_md5" qualifiers="const">
@@ -162,6 +165,7 @@
</return>
<description>
Returns a [String] saved in Pascal format from the file.
+ Text is interpreted as being UTF-8 encoded.
</description>
</method>
<method name="get_path" qualifiers="const">
@@ -340,6 +344,7 @@
</argument>
<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.
+ Text will be encoded as UTF-8.
</description>
</method>
<method name="store_double">
@@ -367,6 +372,7 @@
</argument>
<description>
Stores the given [String] as a line in the file.
+ Text will be encoded as UTF-8.
</description>
</method>
<method name="store_pascal_string">
@@ -376,6 +382,7 @@
</argument>
<description>
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>
</method>
<method name="store_real">
@@ -394,6 +401,7 @@
</argument>
<description>
Stores the given [String] in the file.
+ Text will be encoded as UTF-8.
</description>
</method>
<method name="store_var">