From 2ef1ee9da7e125221ca03d7ac80baf74c4d71edd Mon Sep 17 00:00:00 2001 From: Danil Alexeev Date: Wed, 25 Mar 2020 18:02:04 +0300 Subject: [PATCH] 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. (cherry picked from commit 97e20b2f30c9a3241c9882a74594db98954becdc) --- doc/classes/File.xml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/classes/File.xml b/doc/classes/File.xml index f70e7038c03..735bf69aa0a 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -297,6 +297,7 @@ 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]. @@ -306,6 +307,7 @@ 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]. @@ -315,6 +317,7 @@ 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). @@ -324,6 +327,7 @@ 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].