aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2010-06-08 13:46:42 +0200
committerErlang/OTP <[email protected]>2010-06-08 13:46:42 +0200
commit207dee6794b554af9d78336b1f1b5ccc11ee9ba1 (patch)
tree5b6e8232129cacec742470c145f6e7045388cbe9 /erts/doc/src
parentcc362ea3985f3d5f20d8f5316059c5ede04e6851 (diff)
parent4b928be53fa903f091230f19b1fd7374eb096edf (diff)
downloadotp-207dee6794b554af9d78336b1f1b5ccc11ee9ba1.tar.gz
otp-207dee6794b554af9d78336b1f1b5ccc11ee9ba1.tar.bz2
otp-207dee6794b554af9d78336b1f1b5ccc11ee9ba1.zip
Merge branch 'bg/nif_error' into dev
* commit 'bg/nif_error': crypto: Add type specs for all documented functions crypto: Use erlang:nif_error/1 to squelch false Dialyzer warnings Add erlang:nif_error/1,2
Diffstat (limited to 'erts/doc/src')
-rw-r--r--erts/doc/src/erlang.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 6f30c7fb21..3c64fe2bef 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -2644,6 +2644,37 @@ os_prompt%</pre>
</desc>
</func>
<func>
+ <name>erlang:nif_error(Reason)</name>
+ <fsummary>Stop execution with a given reason</fsummary>
+ <type>
+ <v>Reason = term()</v>
+ </type>
+ <desc>
+ <p>Works exactly like
+ <seealso marker="#error/1">erlang:error/1</seealso>,
+ but Dialyzer thinks that this BIF will return an arbitrary term.
+ When used in a stub function for a NIF to generate an
+ exception when the NIF library is not loaded, Dialyzer
+ will not generate false warnings.</p>
+ </desc>
+ </func>
+ <func>
+ <name>erlang:nif_error(Reason, Args)</name>
+ <fsummary>Stop execution with a given reason</fsummary>
+ <type>
+ <v>Reason = term()</v>
+ <v>Args = [term()]</v>
+ </type>
+ <desc>
+ <p>Works exactly like
+ <seealso marker="#error/2">erlang:error/2</seealso>,
+ but Dialyzer thinks that this BIF will return an arbitrary term.
+ When used in a stub function for a NIF to generate an
+ exception when the NIF library is not loaded, Dialyzer
+ will not generate false warnings.</p>
+ </desc>
+ </func>
+ <func>
<name>node() -> Node</name>
<fsummary>Name of the local node</fsummary>
<type>