diff options
| author | Danil Alexeev <danil@alexeev.xyz> | 2020-03-25 18:02:04 +0300 |
|---|---|---|
| committer | Danil Alexeev <danil@alexeev.xyz> | 2020-03-25 18:02:04 +0300 |
| commit | 97e20b2f30c9a3241c9882a74594db98954becdc (patch) | |
| tree | 5823bf4ba0c4c23aa11c928ba7e42475bdcf0735 /doc/classes/File.xml | |
| parent | 35e700e931f565aa37040055126fa61f02424ae0 (diff) | |
| download | redot-engine-97e20b2f30c9a3241c9882a74594db98954becdc.tar.gz | |
Improve the `File.store_{8,16,32,64}()` documentation
Added information about the intervals of values that the functions
`store_{8,16,32,64}()` can correctly write to the file.
Diffstat (limited to 'doc/classes/File.xml')
| -rw-r--r-- | doc/classes/File.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml index e9477517cf..17c65731ff 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -297,6 +297,7 @@ </argument> <description> Stores an integer as 16 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. </description> </method> <method name="store_32"> @@ -306,6 +307,7 @@ </argument> <description> Stores an integer as 32 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. </description> </method> <method name="store_64"> @@ -315,6 +317,7 @@ </argument> <description> Stores an integer as 64 bits in the file. + [b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value). </description> </method> <method name="store_8"> @@ -324,6 +327,7 @@ </argument> <description> Stores an integer as 8 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. </description> </method> <method name="store_buffer"> |