diff options
author | Raimo Niskanen <[email protected]> | 2016-02-18 16:06:57 +0100 |
---|---|---|
committer | Raimo Niskanen <[email protected]> | 2016-02-18 16:06:57 +0100 |
commit | 82f34a7a9de85b4afc0dac4c9c426939264c5039 (patch) | |
tree | 84ddd5f36e592d3bd5fba9349e2666cbde1cb2be /lib/stdlib/doc | |
parent | fdd72bc94149c7e279b5c4fd5a040af1886a4c72 (diff) | |
download | otp-82f34a7a9de85b4afc0dac4c9c426939264c5039.tar.gz otp-82f34a7a9de85b4afc0dac4c9c426939264c5039.tar.bz2 otp-82f34a7a9de85b4afc0dac4c9c426939264c5039.zip |
Write some convenience helpers
Diffstat (limited to 'lib/stdlib/doc')
-rw-r--r-- | lib/stdlib/doc/src/gen_statem.xml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml index aeab09615c..5fbedb12f8 100644 --- a/lib/stdlib/doc/src/gen_statem.xml +++ b/lib/stdlib/doc/src/gen_statem.xml @@ -535,6 +535,13 @@ erlang:'!' -----> Module:StateName/5 <desc> <taglist> <tag> + <c>{stop,<anno>Reason</anno>}</c> + </tag> + <item>The same as + <c>{stop,<anno>Reason</anno>,[],StateData}</c> + but keeps the old <c>StateData</c>. + </item> + <tag> <c>{stop,<anno>Reason</anno>,<anno>NewStateData</anno>}</c> </tag> <item>The same as @@ -553,6 +560,19 @@ erlang:'!' -----> Module:StateName/5 </item> <tag> <c> + {next_state,<anno>StateOps</anno>} + </c> + </tag> + <item>The same as + <c> + {next_state,State,StateData,<anno>StateOps</anno>} + </c>but keeps the old <c>State</c> and <c>StateData</c>. + Believe it or not, but this one has actually + been proven useful to <c>throw/1</c> from deep down + in the state logic. + </item> + <tag> + <c> {next_state,<anno>NewState</anno>,<anno>NewStateData</anno>} </c> </tag> @@ -805,6 +825,7 @@ erlang:'!' -----> Module:StateName/5 </func> <func> + <name name="reply" arity="1" /> <name name="reply" arity="2" /> <fsummary>Send a reply to a client</fsummary> <desc> @@ -820,6 +841,8 @@ erlang:'!' -----> Module:StateName/5 <c>{call,<anno>Client</anno>}</c> </seealso> argument to the <seealso marker="#state_function">state function</seealso>. + <c><anno>Client</anno></c> and <c><anno>Reply</anno></c> + an also be specified using <c><anno>ReplyOperation</anno></c>. </p> <note> <p>A reply sent with this function will not be visible |