File 2030-megaco-Types-and-spec-for-megaco-parse_dig... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2030-megaco-Types-and-spec-for-megaco-parse_digit_map-1.patch of Package erlang

From 301b46d4c6faad2e3f334441ea1d77adf9070fa6 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 2 Jan 2024 17:47:47 +0100
Subject: [PATCH 20/46] [megaco] Types and spec for megaco:parse_digit_map/1

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 14 ++++----------
 lib/megaco/src/app/megaco.erl |  6 ++++++
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index ba5bd57356..f420947c92 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -2167,19 +2167,13 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason}</name>
+ <name name="parse_digit_map" arity="1" clause_i="1" since=""/>
 <fsummary>Parses a digit map body</fsummary>
- <type>
- <v>DigitMapBody = string()</v>
- <v>ParsedDigitMap = parsed_digit_map()</v>
- <v>parsed_digit_map() = term()</v>
- <v>Reason = term()</v>
- </type>
 <desc>
 Parses a digit map body
 Parses a digit map body, represented as a list of
- characters, into a list of state transitions suited to
- be evaluated by megaco:eval_digit_map/1,2.
+	characters, into a list of state transitions suited to
+	be evaluated by megaco:eval_digit_map/1,2.
 
 <marker id="eval_digit_map"></marker>
 </desc>
@@ -2254,7 +2248,7 @@ megaco_incr_timer() = #megaco_incr_timer{}
 <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>cancel() = $z | $Z | cancel</v>
 <v>Reason = term()</v>
 </type>
 <desc>
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index c3c146d57f..ed02b8b621 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -667,6 +667,12 @@ token_tag2string(Tag, Mod, V) when is_atom(Tag) and is_atom(Mod) ->
 %% Parses a digit map body
 %%-----------------------------------------------------------------
 
+-spec parse_digit_map(DigitMapBody) ->
+ {ok, ParsedDigitMap} | {error, Reason} when
+ DigitMapBody :: string(),
+ ParsedDigitMap :: term(),
+ Reason :: term().
+
 parse_digit_map(DigitMapBody) ->
 megaco_digit_map:parse(DigitMapBody).
 
-- 
2.35.3

Places

File 2030-megaco-Types-and-spec-for-megaco-parse_digit_map-1.patch of Package erlang

Places