From 731cee0b06917f7b34b7e75700cb75605d7ebd32 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen
Date: Sun, 23 Oct 2016 20:46:49 +0200
Subject: Fix doc and type for state enter calls
---
lib/stdlib/doc/src/gen_statem.xml | 8 ++++----
lib/stdlib/src/gen_statem.erl | 10 +++++-----
2 files changed, 9 insertions(+), 9 deletions(-)
(limited to 'lib')
diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index 64267c2af5..fb1e4e8da2 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -533,7 +533,7 @@ handle_event(_, _, State, Data) ->
Type info originates from regular process messages sent
to the gen_statem. Also, the state machine
implementation can generate events of types
- timeout, state_timeout, enter,
+ timeout, state_timeout,
and internal to itself.
@@ -1773,7 +1773,7 @@ handle_event(_, _, State, Data) ->
StateFunctionResult
Module:handle_event(enter, OldState, State, Data) ->
- StateEnterResult
+ StateEnterResult(State)
Module:handle_event(EventType, EventContent, State, Data) ->
HandleEventResult
@@ -1802,8 +1802,8 @@ handle_event(_, _, State, Data) ->
event_handler_result(state_name())
- StateEnterResult =
- state_enter_result(state())
+ StateEnterResult(State) =
+ state_enter_result(State)
HandleEventResult =
diff --git a/lib/stdlib/src/gen_statem.erl b/lib/stdlib/src/gen_statem.erl
index 17d1ebecec..a314f43b42 100644
--- a/lib/stdlib/src/gen_statem.erl
+++ b/lib/stdlib/src/gen_statem.erl
@@ -154,12 +154,12 @@
-type handle_event_result() ::
event_handler_result(state()).
%%
--type state_enter_result(StateType) ::
+-type state_enter_result(State) ::
{'next_state', % {next_state,NextState,NewData,[]}
- State :: StateType,
+ State,
NewData :: data()} |
{'next_state', % State transition, maybe to the same state
- State :: StateType,
+ State,
NewData :: data(),
Actions :: [enter_action()] | enter_action()} |
state_callback_result(enter_action()).
@@ -231,9 +231,9 @@
-callback handle_event(
'enter',
OldState :: state(),
- State :: state(), % Current state
+ State, % Current state
Data :: data()) ->
- state_enter_result(state());
+ state_enter_result(State);
(event_type(),
EventContent :: term(),
State :: state(), % Current state
--
cgit v1.2.3