diff options
| author | Steve Vinoski <[email protected]> | 2010-05-29 20:21:24 -0400 |
|---|---|---|
| committer | Raimo Niskanen <[email protected]> | 2010-06-07 13:22:44 +0200 |
| commit | 1222a9ce643ef287debdb6c76939eceb12ef0c7d (patch) | |
| tree | 15434b57fcefa71c896749f3e86231ce703a0150 /lib/erl_interface/doc | |
| parent | 707c6510597e5eb6e32b88412edd717e0e3c39ba (diff) | |
| download | otp-1222a9ce643ef287debdb6c76939eceb12ef0c7d.tar.gz otp-1222a9ce643ef287debdb6c76939eceb12ef0c7d.tar.bz2 otp-1222a9ce643ef287debdb6c76939eceb12ef0c7d.zip | |
fix typo in ei_decode_ei_term documentation
Change "encoding" to "decoding" where the documentation describes the
return value 0.
Diffstat (limited to 'lib/erl_interface/doc')
| -rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 9083ae02b0..d7af7a1b67 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -581,7 +581,7 @@ ei_x_encode_empty_list(&x); <c><![CDATA[term]]></c> union, it is decoded, and the appropriate field in <c><![CDATA[term->value]]></c> is set, and <c><![CDATA[*index]]></c> is incremented by the term size.</p> - <p>The function returns 0 on successful encoding, -1 on error, + <p>The function returns 0 on successful decoding, -1 on error, and 1 if the term seems alright, but does not fit in the <c><![CDATA[term]]></c> structure. If it returns 0, the <c><![CDATA[index]]></c> will be incremented, and the <c><![CDATA[term]]></c> contains the |