From 22436f6bf147bb479162a878d92de98ba42898cc Mon Sep 17 00:00:00 2001 From: brunosxs Date: Sun, 8 Oct 2017 08:28:52 -0300 Subject: [PATCH] [DOCS] File Class method description --- doc/classes/File.xml | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/classes/File.xml b/doc/classes/File.xml index e1a024270e6..fd71f42a046 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -37,7 +37,7 @@ - Return whether the file cursor reached the end of the file. + Returns [code]true[/code] if the file cursor reached the end of the file. @@ -46,7 +46,7 @@ - Get whether or not the file in the specified path exists. + Returns [code]true[/code] if the file in the specified path exists. @@ -113,7 +113,7 @@ - Get whether endian swap is enabled for this file. + Returns [code]true[/code] if endian swap is enabled for this file. @@ -134,7 +134,7 @@ - Return the size of the file in bytes. + Returns the size of the file in bytes. @@ -150,7 +150,7 @@ - Return a md5 String representing the file at the given path or an empty [String] on failure. + Returns a MD5 String representing the file at the given path or an empty [String] on failure. @@ -159,6 +159,7 @@ + Returns the modified time in unix timestamp of the [code]file[/code] or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time]. @@ -172,7 +173,7 @@ - Return the file cursor position. + Returns the file cursor position. @@ -188,7 +189,7 @@ - Return a sha256 String representing the file at the given path or an empty [String] on failure. + Returns a SHA-256 String representing the file at the given path or an empty [String] on failure. @@ -202,7 +203,7 @@ - Return whether the file is currently opened. + Returns [code]true[/code] if the file is currently opened. @@ -279,7 +280,7 @@ - Set whether to swap the endianness of the file. Enable this if you're dealing with files written in big endian machines. + If [code]true[/code] the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. @@ -394,16 +395,16 @@ - Open the file for reading. + Open the file for read operations. - Open the file for writing. Create it if the file not exists and truncate if it exists. + Open the file for write operations. Create it if the file does not exist and truncate if it exists. - Open the file for reading and writing, without truncating the file. + Open the file for read and write operations. Does not truncate the file. - Open the file for reading and writing. Create it if the file not exists and truncate if it exists. + Open the file for read and write operations. Create it if the file does not exist and truncate if it exists. Use the FastLZ compression method. @@ -415,6 +416,7 @@ Use the Zstd compression method. + Use the GZip compression method.