File 2042-megaco-Types-and-spec-for-megaco-test_digi... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2042-megaco-Types-and-spec-for-megaco-test_digit_event-2.patch of Package erlang

From f7a4e3cffafe77f5774f2574c67367e207e821f5 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 5 Jan 2024 14:52:51 +0100
Subject: [PATCH 32/46] [megaco] Types and spec for megaco:test_digit_event/2

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 28 ++++------------------------
 lib/megaco/src/app/megaco.erl |  9 +++++++++
 2 files changed, 13 insertions(+), 24 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index e0377d8c6c..3d38cd52ee 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -2913,34 +2913,14 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason}</name>
+ <name name="test_digit_event" arity="2" clause_i="1" since=""/>
 <fsummary>Feed digit map collector with events and return the result</fsummary>
- <type>
- <v>DigitMap = #'DigitMapValue'{} | parsed_digit_map()</v>
- <v>parsed_digit_map() = term()</v>
- <v>ParsedDigitMap = term()</v>
- <v>Timers = ignore() | reject()</v>
- <v>ignore() = ignore | {ignore, digit_map_value()}</v>
- <v>reject() = reject | {reject, digit_map_value()} | digit_map_value()</v>
- <v>DigitMapEvalPid = pid()</v>
- <v>Events = Event | [Event]</v>
- <v>Event = letter() | pause() | cancel()</v>
- <v>Kind = kind()</v>
- <v>kind() = full | unambiguous</v>
- <v>Letters = [letter()]</v>
- <v>letter() = $0..$9 | $a .. $k | $A .. $K</v>
- <v>pause() = one_second() | ten_seconds()</v>
- <v>one_second() = $s | $S</v>
- <v>ten_seconds() = $l | $L</v>
- <v>cancel() = $z | $Z | cancel</v>
- <v>Reason = term()</v>
- </type>
 <desc>
 Feed digit map collector with events and return the result
 This function starts the evaluation of a digit map with
- megaco:eval_digit_map/1 and sends a sequence of events to it
- megaco:report_digit_event/2 in order to simplify testing of
- digit maps.
+	megaco:eval_digit_map/1 and sends a sequence of events to it with
+	megaco:report_digit_event/2 in order to simplify testing of
+	digit maps.
 
 <marker id="encode_sdp"></marker>
 </desc>
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index 9f7bf4a1d1..42547fb773 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -847,6 +847,15 @@ report_digit_event(DigitMapEvalPid, Event) ->
 %% Feed digit map collector with events and return the result
 %%-----------------------------------------------------------------
 
+-spec test_digit_event(DigitMap, Events) ->
+ {ok, Kind, Letters} | {error, Reason} when
+ DigitMap :: digit_map_value() | ParsedDigitMap,
+ ParsedDigitMap :: term(),
+ Events :: digit_map_event() | [digit_map_event()],
+ Kind :: digit_map_kind(),
+ Letters :: [digit_map_letter()],
+ Reason :: term().
+
 test_digit_event(DigitMap, Events) ->
 megaco_digit_map:test(DigitMap, Events).
 
-- 
2.35.3

Places

File 2042-megaco-Types-and-spec-for-megaco-test_digit_event-2.patch of Package erlang

Places