aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2018-02-23 15:15:43 +0100
committerSverker Eriksson <[email protected]>2018-02-23 15:15:43 +0100
commit9298482871dec324fb757bce52f15474f4525ebe (patch)
tree2a5de936112290c15028b90b8e4b14a5be4c6e05
parente55df241937d62ec15fedac4a9aa4c4c34fddee5 (diff)
downloadotp-9298482871dec324fb757bce52f15474f4525ebe.tar.gz
otp-9298482871dec324fb757bce52f15474f4525ebe.tar.bz2
otp-9298482871dec324fb757bce52f15474f4525ebe.zip
erts: Clarify enif_self docs
-rw-r--r--erts/doc/src/erl_nif.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index ef3cdb89e9..b9c2e70b57 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -3044,9 +3044,10 @@ if (retval &amp; ERL_NIF_SELECT_STOP_CALLED) {
</name>
<fsummary>Get the pid of the calling process.</fsummary>
<desc>
- <p>Initializes the pid variable <c>*pid</c> to represent the
- calling process.</p>
- <p>Returns <c>pid</c>.</p>
+ <p>Initializes the <seealso marker="#ErlNifPid"><c>ErlNifPid</c></seealso>
+ variable at <c>*pid</c> to represent the calling process.</p>
+ <p>Returns <c>pid</c> if successful, or NULL if <c>caller_env</c> is not
+ a <seealso marker="#ErlNifEnv">process-bound environment</seealso>.</p>
</desc>
</func>