aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2015-09-11 11:41:32 +0200
committerSiri Hansen <[email protected]>2015-09-11 11:41:32 +0200
commitfbf7a72deac2bc69f33bca6384104371ab9fe5be (patch)
tree384e5f423ffb953a8913c2d832ca2d28d03103f1 /lib/stdlib
parent4e253cc3310ad5cdfc6e3f9357bca2f6fa935dc5 (diff)
parent33b2cc1996883569b8afbc7cab8a535aa168ae1b (diff)
downloadotp-fbf7a72deac2bc69f33bca6384104371ab9fe5be.tar.gz
otp-fbf7a72deac2bc69f33bca6384104371ab9fe5be.tar.bz2
otp-fbf7a72deac2bc69f33bca6384104371ab9fe5be.zip
Merge branch 'siri/doc-gen_fsm-reply-return/OTP-12973' into maint
* siri/doc-gen_fsm-reply-return/OTP-12973: Fix doc for return value of gen_fsm:reply/2
Diffstat (limited to 'lib/stdlib')
-rw-r--r--lib/stdlib/doc/src/gen_fsm.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/stdlib/doc/src/gen_fsm.xml b/lib/stdlib/doc/src/gen_fsm.xml
index 5f7b5a3437..a8d7fadeb4 100644
--- a/lib/stdlib/doc/src/gen_fsm.xml
+++ b/lib/stdlib/doc/src/gen_fsm.xml
@@ -339,11 +339,12 @@ gen_fsm:sync_send_all_state_event -----> Module:handle_sync_event/4
</desc>
</func>
<func>
- <name>reply(Caller, Reply) -> true</name>
+ <name>reply(Caller, Reply) -> Result</name>
<fsummary>Send a reply to a caller.</fsummary>
<type>
<v>Caller - see below</v>
<v>Reply = term()</v>
+ <v>Result = term()</v>
</type>
<desc>
<p>This function can be used by a gen_fsm to explicitly send a
@@ -358,6 +359,8 @@ gen_fsm:sync_send_all_state_event -----> Module:handle_sync_event/4
which will be given back to the client as the return value of
<c>sync_send_event/2,3</c> or
<c>sync_send_all_state_event/2,3</c>.</p>
+ <p>The return value <c>Result</c> is not further defined, and
+ should always be ignored.</p>
</desc>
</func>
<func>