diff options
| author | Björn-Egil Dahlberg <[email protected]> | 2015-03-19 11:38:42 +0100 |
|---|---|---|
| committer | Björn-Egil Dahlberg <[email protected]> | 2015-03-19 11:38:42 +0100 |
| commit | 1c77269abc1a4772c8123470e93e1cd38f316e2f (patch) | |
| tree | 4386f2a0db2ec675adc326e74f10481b1dbfae1e | |
| parent | 372d62d4e1738431d33c1318be1ee4305c74649d (diff) | |
| download | otp-1c77269abc1a4772c8123470e93e1cd38f316e2f.tar.gz otp-1c77269abc1a4772c8123470e93e1cd38f316e2f.tar.bz2 otp-1c77269abc1a4772c8123470e93e1cd38f316e2f.zip | |
erl_interface: Document non finite encoding returns
| -rw-r--r-- | lib/erl_interface/doc/src/ei.xml | 3 | ||||
| -rw-r--r-- | lib/erl_interface/doc/src/erl_eterm.xml | 6 |
2 files changed, 7 insertions, 2 deletions
diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 90495eebd6..32e0e0e2d8 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -202,6 +202,9 @@ typedef enum { <desc> <p>Encodes a double-precision (64 bit) floating point number in the binary format.</p> + <p> + The function returns <c><![CDATA[-1]]></c> if the floating point number is not finite. + </p> </desc> </func> <func> diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml index 429f77501c..2152192696 100644 --- a/lib/erl_interface/doc/src/erl_eterm.xml +++ b/lib/erl_interface/doc/src/erl_eterm.xml @@ -371,9 +371,11 @@ iohead ::= Binary <p><c><![CDATA[f]]></c> is a value to be converted to an Erlang float.</p> <p></p> <p>The function returns an Erlang float object with the value - specified in <c><![CDATA[f]]></c>.</p> + specified in <c><![CDATA[f]]></c> or <c><![CDATA[NULL]]></c> if + <c><![CDATA[f]]></c> is not finite. + </p> <p><c><![CDATA[ERL_FLOAT_VALUE(t)]]></c> can be used to retrieve the - value from an Erlang float.</p> + value from an Erlang float.</p> </desc> </func> <func> |