finish documenting words

FossilOrigin-Name: 5f0f6c0a58eec52b6a65d54d3b9de6b50013bd0de15ef97a2ba032833c6dcc68
This commit is contained in:
crc 2023-03-23 16:52:04 +00:00
parent 2176101b10
commit f5f82c5880
6 changed files with 24 additions and 1 deletions

View file

@ -1213,6 +1213,9 @@ Resize a malloc'd memory area.
mem:store D: xnn- A: - F: -
Store a value into a malloc'd memory region. Uses a double cell pointer for the address.
mem:store-double D: xxnn- A: - F: -
Store a double value into a malloc'd memory region. Uses a double cell pointer for the address.
mod D: nm-o A: - F: -
Divide `n` by `m` and return the remainder.

View file

@ -403,6 +403,7 @@ mem:fetch-double D: nn-n A: - F: -
mem:free D: nn- A: - F: -
mem:resize D: mmn- A: - F: -
mem:store D: xnn- A: - F: -
mem:store-double D: xxnn- A: - F: -
mod D: nm-o A: - F: -
n:-zero? D: n-f A: - F: -
n:MAX D: -n A: - F: -

View file

@ -3003,6 +3003,13 @@
</div>
<p>Store a value into a malloc'd memory region. Uses a double cell pointer for the address.</p>
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
<h2>mem:store-double</h2>
<div style='margin-left: 1em;'><p><b>Data:</b> xxnn-<br>
<b>Addr:</b> -<br>
<b>Float:</b> -</p>
</div>
<p>Store a double value into a malloc'd memory region. Uses a double cell pointer for the address.</p>
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
<h2>mod</h2>
<div style='margin-left: 1em;'><p><b>Data:</b> nm-o<br>
<b>Addr:</b> -<br>

View file

@ -4657,6 +4657,17 @@ Store a value into a malloc'd memory region. Uses a double cell pointer for the
Class: class:word | Namespace: mem | Interface Layer: rre
------------------------------------------------------------------------
mem:store-double
Data: xxnn-
Addr: -
Float: -
Store a double value into a malloc'd memory region. Uses a double cell pointer for the address.
Class: class:word | Namespace: mem | Interface Layer: rre
------------------------------------------------------------------------
mod
Data: nm-o

View file

@ -403,6 +403,7 @@ mem:fetch-double nn-n - - Fetch a double cell value from a malloc memory region.
mem:free nn- - - Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free. class:word {n/a} {n/a} mem rre
mem:resize mmn- - - Resize a malloc'd memory area. class:word {n/a} {n/a} mem rre
mem:store xnn- - - Store a value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
mem:store-double xxnn- - - Store a double value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
mod nm-o - - Divide `n` by `m` and return the remainder. class:word {n/a} {n/a} global all
n:-zero? n-f - - Return `TRUE` if number is not zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all
n:MAX -n - - Return the maximum value that will fit in a cell. class:word {n/a} {n/a} n all

1 $ -c - - Return ASCII:NUL (0). class:macro {n/a} {n/a} global all
403 mem:free nn- - - Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free. class:word {n/a} {n/a} mem rre
404 mem:resize mmn- - - Resize a malloc'd memory area. class:word {n/a} {n/a} mem rre
405 mem:store xnn- - - Store a value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
406 mem:store-double xxnn- - - Store a double value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
407 mod nm-o - - Divide `n` by `m` and return the remainder. class:word {n/a} {n/a} global all
408 n:-zero? n-f - - Return `TRUE` if number is not zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all
409 n:MAX -n - - Return the maximum value that will fit in a cell. class:word {n/a} {n/a} n all

View file

@ -1,3 +1,3 @@
~~~
#13 'BUILD const
#14 'BUILD const
~~~