Переглянути джерело

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)
Danil Alexeev 5 роки тому
батько
коміт
2ef1ee9da7
1 змінених файлів з 4 додано та 0 видалено
  1. 4 0
      doc/classes/File.xml

+ 4 - 0
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">