File 2802-Fix-spec-s-and-doc.patch of Package erlang
From 3a61a73866b50cba046b34bdcc231cfcf5677005 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Wed, 16 Mar 2022 17:22:56 +0100
Subject: [PATCH 2/3] Fix -spec:s and doc
---
lib/stdlib/doc/src/gen_server.xml | 9 +++++++--
lib/stdlib/src/gen_server.erl | 16 ++++++++--------
2 files changed, 15 insertions(+), 10 deletions(-)
diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml
index 8f07adc1ac..f9c7419ade 100644
--- a/lib/stdlib/doc/src/gen_server.xml
+++ b/lib/stdlib/doc/src/gen_server.xml
@@ -637,7 +637,11 @@ gen_server:abcast -----> Module:handle_cast/2
<name name="enter_loop" arity="3" since=""/>
<name name="enter_loop" arity="4" clause_i="1" since=""/>
<name name="enter_loop" arity="4" clause_i="2" since=""/>
- <name name="enter_loop" arity="5" since=""/>
+ <name name="enter_loop" arity="4" clause_i="3" since=""/>
+ <name name="enter_loop" arity="4" clause_i="4" since=""/>
+ <name name="enter_loop" arity="5" clause_i="1" since=""/>
+ <name name="enter_loop" arity="5" clause_i="2" since=""/>
+ <name name="enter_loop" arity="5" clause_i="3" since=""/>
<fsummary>Enter the <c>gen_server</c> receive loop.</fsummary>
<desc>
<p>
@@ -672,7 +676,8 @@ gen_server:abcast -----> Module:handle_cast/2
<em>before</em> this function is called.
</p>
<p>
- <c>State</c> and <c>Timeout</c> have the same meanings as in
+ <c><anno>State</anno></c>, <c><anno>Timeout</anno></c>,
+ <c><anno>Hibernate</anno></c> and <c><anno>Cont</anno></c> have the same meanings as in
the return value of
<seemfa marker="#Module:init/1"><c>Module:init/1</c></seemfa>,
which is <em>not</em> called when <c>enter_loop/3,4,5</c> is used.
diff --git a/lib/stdlib/src/gen_server.erl b/lib/stdlib/src/gen_server.erl
index 509857d775..58bf83fd9e 100644
--- a/lib/stdlib/src/gen_server.erl
+++ b/lib/stdlib/src/gen_server.erl
@@ -580,17 +580,17 @@ enter_loop(Mod, Options, State) when is_atom(Mod) andalso is_list(Options) ->
) ->
no_return();
(
- Module :: module(),
- Options :: [enter_loop_opt()],
- State :: term(),
- Hibernate :: hibernate
+ Module :: module(),
+ Options :: [enter_loop_opt()],
+ State :: term(),
+ Hibernate :: 'hibernate'
) ->
no_return();
(
Module :: module(),
Options :: [enter_loop_opt()],
State :: term(),
- Continue :: {continue, term()}
+ Cont :: {'continue', term()}
) ->
no_return().
%%
@@ -617,7 +617,7 @@ enter_loop(Mod, Options, State, {continue, _}=Continue) when is_atom(Mod) andals
Options :: [enter_loop_opt()],
State :: term(),
ServerName :: server_name() | pid(),
- Timeout :: timeout() | hibernate | {continue, term()}
+ Timeout :: timeout()
) ->
no_return();
(
@@ -625,7 +625,7 @@ enter_loop(Mod, Options, State, {continue, _}=Continue) when is_atom(Mod) andals
Options :: [enter_loop_opt()],
State :: term(),
ServerName :: server_name() | pid(),
- Hibernate :: hibernate
+ Hibernate :: 'hibernate'
) ->
no_return();
(
@@ -633,7 +633,7 @@ enter_loop(Mod, Options, State, {continue, _}=Continue) when is_atom(Mod) andals
Options :: [enter_loop_opt()],
State :: term(),
ServerName :: server_name() | pid(),
- Continue :: {continue, term()}
+ Cont :: {'continue', term()}
) ->
no_return().
%%
--
2.34.1
