aboutsummaryrefslogtreecommitdiffstats
path: root/lib/erl_interface/doc
diff options
context:
space:
mode:
authorHenrik Nord <[email protected]>2011-09-20 10:44:10 +0200
committerHenrik Nord <[email protected]>2011-09-20 10:44:13 +0200
commit53cf0b70c705e0bf6c09f83f2ce2709d79593ce6 (patch)
tree4e08825f6914845d15aef25b6291431b14b8e095 /lib/erl_interface/doc
parent0309869320ec4dd7dc48827b9ec730ffccc3122e (diff)
parentff9a8a6340908344b0a06cf96f93180ec9479d3a (diff)
downloadotp-53cf0b70c705e0bf6c09f83f2ce2709d79593ce6.tar.gz
otp-53cf0b70c705e0bf6c09f83f2ce2709d79593ce6.tar.bz2
otp-53cf0b70c705e0bf6c09f83f2ce2709d79593ce6.zip
Merge branch 'ac/fix-erl_interface-docs' into dev
* ac/fix-erl_interface-docs: Make comment reflect code in erl_interface/src/misc/ei_decode_term.c ei_decode_ei_term() returns 1 if index is incremented OTP-9559
Diffstat (limited to 'lib/erl_interface/doc')
-rw-r--r--lib/erl_interface/doc/src/ei.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index de4e4b4301..76e02a6858 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -581,9 +581,9 @@ ei_x_encode_empty_list(&amp;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 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>
+ <p>The function returns 1 on successful decoding, -1 on error,
+ and 0 if the term seems alright, but does not fit in the
+ <c><![CDATA[term]]></c> structure. If it returns 1, the <c><![CDATA[index]]></c>
will be incremented, and the <c><![CDATA[term]]></c> contains the
decoded term.</p>
<p>The <c><![CDATA[term]]></c> structure will contain the arity for a tuple