3party/tpl
0
0
Fork 0
mirror of https://github.com/troydhanson/tpl.git synced 2024-12-27 16:11:02 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #25 from i-rinat/master

Browse Source 
Fix typos in the documentation
This commit is contained in:
Troy D. Hanson 2018-09-23 21:15:47 -04:00 committed by GitHub
commit 6569fcc176
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/userguide.html
View File

@ -1934,7 +1934,7 @@ characters that are not inside an <tt>A(...)</tt>, such as the <tt>i</tt> in the
<div class="paragraph"><p>For variable-length arrays, each call to <tt>tpl_unpack()</tt> unpacks another element. <div class="paragraph"><p>For variable-length arrays, each call to <tt>tpl_unpack()</tt> unpacks another element.
The return value can be used to tell when you&#8217;re done: if it&#8217;s positive, an The return value can be used to tell when you&#8217;re done: if it&#8217;s positive, an
element was unpacked; if it&#8217;s 0, nothing was unpacked because there are no more element was unpacked; if it&#8217;s 0, nothing was unpacked because there are no more
elements. A negative retun value indicates an error (e.g. invalid index number). elements. A negative return value indicates an error (e.g. invalid index number).
In this document, we usually unpack variable-length arrays using a <tt>while</tt> loop:</p></div> In this document, we usually unpack variable-length arrays using a <tt>while</tt> loop:</p></div>
<div class="literalblock"> <div class="literalblock">
<div class="content"> <div class="content">
@ -1990,7 +1990,7 @@ run, this program prints:</p></div>
<div class="sect2"> <div class="sect2">
<h3 id="tpl_free">tpl_free</h3> <h3 id="tpl_free">tpl_free</h3>
<div class="paragraph"><p>The final step for any tpl is to release it using <tt>tpl_free()</tt>. Its only <div class="paragraph"><p>The final step for any tpl is to release it using <tt>tpl_free()</tt>. Its only
argument is the the <tt>tpl_node*</tt> to free.</p></div> argument is the <tt>tpl_node*</tt> to free.</p></div>
<div class="literalblock"> <div class="literalblock">
<div class="content"> <div class="content">
<pre><tt>tpl_free( tn );</tt></pre> <pre><tt>tpl_free( tn );</tt></pre>
@ -2011,7 +2011,7 @@ current number of elements; it will decrease as elements are unpacked).</p></div
</div> </div>
<div class="sect2"> <div class="sect2">
<h3 id="tpl_peek">tpl_peek</h3> <h3 id="tpl_peek">tpl_peek</h3>
<div class="paragraph"><p>This function peeks into a file or a memory buffer containing a tpl image and <div class="paragraph"><p>This function peeks into a file or a memory buffer containing a tpl image
and returns a copy of its format string. It can also peek at the lengths of and returns a copy of its format string. It can also peek at the lengths of
any fixed-length arrays in the format string, or it can also peek into the data any fixed-length arrays in the format string, or it can also peek into the data
stored in the tpl.</p></div> stored in the tpl.</p></div>

6
doc/userguide.txt
View File

@ -900,7 +900,7 @@ Unpacking elements from an array
For variable-length arrays, each call to `tpl_unpack()` unpacks another element. For variable-length arrays, each call to `tpl_unpack()` unpacks another element.
The return value can be used to tell when you're done: if it's positive, an The return value can be used to tell when you're done: if it's positive, an
element was unpacked; if it's 0, nothing was unpacked because there are no more element was unpacked; if it's 0, nothing was unpacked because there are no more
elements. A negative retun value indicates an error (e.g. invalid index number). elements. A negative return value indicates an error (e.g. invalid index number).
In this document, we usually unpack variable-length arrays using a `while` loop: In this document, we usually unpack variable-length arrays using a `while` loop:
while( tpl_unpack( tn, 1 ) > 0 ) { while( tpl_unpack( tn, 1 ) > 0 ) {
@ -954,7 +954,7 @@ run, this program prints:
tpl_free tpl_free
~~~~~~~~ ~~~~~~~~
The final step for any tpl is to release it using `tpl_free()`. Its only The final step for any tpl is to release it using `tpl_free()`. Its only
argument is the the `tpl_node*` to free. argument is the `tpl_node*` to free.
tpl_free( tn ); tpl_free( tn );
@ -975,7 +975,7 @@ current number of elements; it will decrease as elements are unpacked).
[[tpl_peek]] [[tpl_peek]]
tpl_peek tpl_peek
~~~~~~~~ ~~~~~~~~
This function peeks into a file or a memory buffer containing a tpl image and This function peeks into a file or a memory buffer containing a tpl image
and returns a copy of its format string. It can also peek at the lengths of and returns a copy of its format string. It can also peek at the lengths of
any fixed-length arrays in the format string, or it can also peek into the data any fixed-length arrays in the format string, or it can also peek into the data
stored in the tpl. stored in the tpl.