File 2045-megaco-Types-and-spec-for-megaco-token_tag... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2045-megaco-Types-and-spec-for-megaco-token_tag2string-1-.patch of Package erlang

From 98465583cdeecf207be5e277aa1634ef15933e7b Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 5 Jan 2024 16:28:56 +0100
Subject: [PATCH 35/46] [megaco] Types and spec for
 megaco:token_tag2string/1,2,3

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 27 +++++++++------------------
 lib/megaco/src/app/megaco.erl | 30 ++++++++++++++++++++++++------
 2 files changed, 33 insertions(+), 24 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index 184057418b..0d42d9b8e9 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -2712,28 +2712,19 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">token_tag2string(Tag) -> Result</name>
- <name since="">token_tag2string(Tag, EncoderMod) -> Result</name>
- <name since="">token_tag2string(Tag, EncoderMod, Version) -> Result</name>
+ <name name="token_tag2string" arity="1" clause_i="1" since=""/>
+ <name name="token_tag2string" arity="2" clause_i="1" since=""/>
+ <name name="token_tag2string" arity="3" clause_i="1" since=""/>
 <fsummary>Convert a token tag to a string</fsummary>
- <type>
- <v>Tag = atom()</v>
- <v>EncoderMod = pretty | compact | encoder_module()</v>
- <v>encoder_module() = megaco_pretty_text_encoder | megaco_compact_text_encoder | atom()</v>
- <v>Version = int_version() | atom_version()</v>
- <v>int_version() = 1 | 2 | 3</v>
- <v>atom_version() = v1 | v2 | v3</v>
- <v>Result = string() | {error, Reason}</v>
- <v>Reason = term()</v>
- </type>
 <desc>
 Convert a token tag to a string
 If no encoder module is given, the default is used 
- (which is pretty).
- If no or an unknown version is given, 
- the best version is used (which is v3).
- If no match is found for <c><![CDATA[Tag]]></c>, <c><![CDATA[Result]]></c> will be the 
- empty string (<c><![CDATA[[]]]></c>).
+	(which is pretty).
+	If no or an unknown version is given, 
+	the best version is used (which is v3).
+	If no match is found for
+	<c><![CDATA[Tag]]></c>, <c><![CDATA[Result]]></c> will be the 
+	empty string (<c><![CDATA[[]]]></c>).
 
 <marker id="cancel"></marker>
 </desc>
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index f6ab5bcf43..c83ae7e8c2 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -792,9 +792,20 @@ encode_actions(ConnHandle, ActionRequests, Options) ->
 %% printable string.
 %%-----------------------------------------------------------------
 
+-spec token_tag2string(Tag) -> Result when
+ Tag :: atom(),
+ Result :: string() | {error, Reason},
+ Reason :: term().
+
 token_tag2string(Tag) ->
 token_tag2string(Tag, pretty).
 
+-spec token_tag2string(Tag, EncodingMod) -> Result when
+ Tag :: atom(),
+ EncodingMod :: pretty | compact | module(),
+ Result :: string() | {error, Reason},
+ Reason :: term().
+
 token_tag2string(Tag, pretty) ->
 token_tag2string(Tag, megaco_pretty_text_encoder);
 token_tag2string(Tag, compact) ->
@@ -802,12 +813,19 @@ token_tag2string(Tag, compact) ->
 token_tag2string(Tag, Mod) when is_atom(Tag) and is_atom(Mod) ->
 Mod:token_tag2string(Tag).
 
-token_tag2string(Tag, pretty, V) ->
- token_tag2string(Tag, megaco_pretty_text_encoder, V);
-token_tag2string(Tag, compact, V) ->
- token_tag2string(Tag, megaco_compact_text_encoder, V);
-token_tag2string(Tag, Mod, V) when is_atom(Tag) and is_atom(Mod) ->
- Mod:token_tag2string(Tag, V).
+-spec token_tag2string(Tag, EncodingMod, Version) -> Result when
+ Tag :: atom(),
+ EncodingMod :: pretty | compact | module(),
+ Version :: protocol_version() | v1 | v2 | v3,
+ Result :: string() | {error, Reason},
+ Reason :: term().
+
+token_tag2string(Tag, pretty, Version) ->
+ token_tag2string(Tag, megaco_pretty_text_encoder, Version);
+token_tag2string(Tag, compact, Version) ->
+ token_tag2string(Tag, megaco_compact_text_encoder, Version);
+token_tag2string(Tag, Mod, Version) when is_atom(Tag) andalso is_atom(Mod) ->
+ Mod:token_tag2string(Tag, Version).
 
 
 %%-----------------------------------------------------------------
-- 
2.35.3

Places

File 2045-megaco-Types-and-spec-for-megaco-token_tag2string-1-.patch of Package erlang

Places