Updated documentation
This commit is contained in:
parent
0184f043f1
commit
1c024baf88
|
|
@ -19,6 +19,7 @@ to being portable by conforming to some specification.
|
||||||
- [Primitives 1](#primitives-1)
|
- [Primitives 1](#primitives-1)
|
||||||
- [Primitives 2](#primitives-2)
|
- [Primitives 2](#primitives-2)
|
||||||
- [c-bytevector](#c-bytevector)
|
- [c-bytevector](#c-bytevector)
|
||||||
|
- [Accessors](#accessors)
|
||||||
- [Environment variables](#environment-variables)
|
- [Environment variables](#environment-variables)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -267,8 +268,6 @@ Example:
|
||||||
|
|
||||||
### c-bytevector
|
### c-bytevector
|
||||||
|
|
||||||
#### Creation and deletion
|
|
||||||
|
|
||||||
(**make-c-null**)
|
(**make-c-null**)
|
||||||
|
|
||||||
Returns a null C pointer.
|
Returns a null C pointer.
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,12 @@ Schemes - 0.10.0</title>
|
||||||
<li><a href="#types">Types</a></li>
|
<li><a href="#types">Types</a></li>
|
||||||
<li><a href="#primitives-1">Primitives 1</a></li>
|
<li><a href="#primitives-1">Primitives 1</a></li>
|
||||||
<li><a href="#primitives-2">Primitives 2</a></li>
|
<li><a href="#primitives-2">Primitives 2</a></li>
|
||||||
<li><a href="#c-bytevector">c-bytevector</a></li>
|
<li><a href="#c-bytevector">c-bytevector</a>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#creation-and-deletion">Creationg and
|
||||||
|
deletion</a></li>
|
||||||
|
<li><a href="#accessors">Accessors</a></li>
|
||||||
|
</ul></li>
|
||||||
<li><a href="#environment-variables">Environment
|
<li><a href="#environment-variables">Environment
|
||||||
variables</a></li>
|
variables</a></li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
|
|
@ -467,6 +472,14 @@ make -C snow/foreign/c SCHEME_IMPLEMENTATION_NAME</code></pre>
|
||||||
(newline)
|
(newline)
|
||||||
;> (1 2 3)</code></pre>
|
;> (1 2 3)</code></pre>
|
||||||
<h3 id="c-bytevector">c-bytevector</h3>
|
<h3 id="c-bytevector">c-bytevector</h3>
|
||||||
|
<h4 id="creation-and-deletion">Creation and deletion</h4>
|
||||||
|
<p>(<strong>make-c-null</strong>)</p>
|
||||||
|
<p>Returns a null C pointer.</p>
|
||||||
|
<p>(<strong>c-null?</strong> <em>obj</em>)</p>
|
||||||
|
<p>Returns <strong>#t</strong> if <em>obj</em> is a null C
|
||||||
|
pointer, otherwise returns <strong>#f</strong>.</p>
|
||||||
|
<p>(<strong>c-free</strong> <em>c-bytevector</em>)</p>
|
||||||
|
<p>Frees <em>c-bytevector</em> from memory.</p>
|
||||||
<p>(<strong>make-c-bytevector</strong> <em>k</em>)
|
<p>(<strong>make-c-bytevector</strong> <em>k</em>)
|
||||||
(<strong>make-c-bytevector</strong> <em>k</em>
|
(<strong>make-c-bytevector</strong> <em>k</em>
|
||||||
<em>fill</em>)</p>
|
<em>fill</em>)</p>
|
||||||
|
|
@ -477,14 +490,9 @@ make -C snow/foreign/c SCHEME_IMPLEMENTATION_NAME</code></pre>
|
||||||
<p>If the <em>fill</em> argument is present, it’s value must
|
<p>If the <em>fill</em> argument is present, it’s value must
|
||||||
confine to C uint8_t values , it specifies the initial value for
|
confine to C uint8_t values , it specifies the initial value for
|
||||||
the bytes of the c-bytevector</p>
|
the bytes of the c-bytevector</p>
|
||||||
<p>(<strong>make-c-null</strong>)</p>
|
<h4 id="accessors">Accessors</h4>
|
||||||
<p>Returns a null C pointer.</p>
|
<p>(<strong>native-endianness</strong>)</p>
|
||||||
<p>(<strong>c-null?</strong> <em>obj</em>)</p>
|
<p>c-bytevector-s8-set! c-bytevector-s8-ref
|
||||||
<p>Returns <strong>#t</strong> if <em>obj</em> is a null C
|
|
||||||
pointer, otherwise returns <strong>#f</strong>.</p>
|
|
||||||
<p>(<strong>c-free</strong> <em>c-bytevector</em>)</p>
|
|
||||||
<p>Frees <em>c-bytevector</em> from memory.</p>
|
|
||||||
<p>native-endianness c-bytevector-s8-set! c-bytevector-s8-ref
|
|
||||||
c-bytevector-s16-set! c-bytevector-s16-ref
|
c-bytevector-s16-set! c-bytevector-s16-ref
|
||||||
c-bytevector-s16-native-set! c-bytevector-s16-native-ref
|
c-bytevector-s16-native-set! c-bytevector-s16-native-ref
|
||||||
c-bytevector-u16-set! c-bytevector-u16-ref
|
c-bytevector-u16-set! c-bytevector-u16-ref
|
||||||
|
|
|
||||||
Binary file not shown.
Loading…
Reference in New Issue