Overhaul some "uncommon" wording in class reference
This commit is contained in:
@ -79,21 +79,21 @@
|
||||
<return type="float" />
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<description>
|
||||
Decodes a 64-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
Decodes a 64-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
</description>
|
||||
</method>
|
||||
<method name="decode_float" qualifiers="const">
|
||||
<return type="float" />
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<description>
|
||||
Decodes a 32-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
Decodes a 32-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
</description>
|
||||
</method>
|
||||
<method name="decode_half" qualifiers="const">
|
||||
<return type="float" />
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<description>
|
||||
Decodes a 16-bit floating point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
Decodes a 16-bit floating-point number from the bytes starting at [param byte_offset]. Fails if the byte count is insufficient. Returns [code]0.0[/code] if a valid number can't be decoded.
|
||||
</description>
|
||||
</method>
|
||||
<method name="decode_s8" qualifiers="const">
|
||||
@ -199,7 +199,7 @@
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<param index="1" name="value" type="float" />
|
||||
<description>
|
||||
Encodes a 64-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of allocated space, starting at the offset.
|
||||
Encodes a 64-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of allocated space, starting at the offset.
|
||||
</description>
|
||||
</method>
|
||||
<method name="encode_float">
|
||||
@ -207,7 +207,7 @@
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<param index="1" name="value" type="float" />
|
||||
<description>
|
||||
Encodes a 32-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset.
|
||||
Encodes a 32-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset.
|
||||
</description>
|
||||
</method>
|
||||
<method name="encode_half">
|
||||
@ -215,7 +215,7 @@
|
||||
<param index="0" name="byte_offset" type="int" />
|
||||
<param index="1" name="value" type="float" />
|
||||
<description>
|
||||
Encodes a 16-bit floating point number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset.
|
||||
Encodes a 16-bit floating-point number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset.
|
||||
</description>
|
||||
</method>
|
||||
<method name="encode_s8">
|
||||
|
||||
Reference in New Issue
Block a user