From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Tue, 11 Dec 2018 17:42:39 +0100
Subject: Add "since" attributes in xml for new functions and modules

introduced after OTP_R13B03.
---
 lib/diameter/doc/src/diameter.xml           | 28 ++++++++++++++--------------
 lib/diameter/doc/src/diameter_app.xml       | 18 +++++++++---------
 lib/diameter/doc/src/diameter_codec.xml     |  6 +++---
 lib/diameter/doc/src/diameter_make.xml      | 10 +++++-----
 lib/diameter/doc/src/diameter_sctp.xml      |  4 ++--
 lib/diameter/doc/src/diameter_tcp.xml       |  4 ++--
 lib/diameter/doc/src/diameter_transport.xml |  4 ++--
 7 files changed, 37 insertions(+), 37 deletions(-)

(limited to 'lib/diameter')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index dfa4c803ed..0a0194af2d 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -55,7 +55,7 @@ limitations under the License.
 <!-- ===================================================================== -->
 <!-- ===================================================================== -->
 
-<module>diameter</module>
+<module since="OTP R14B03">diameter</module>
 <modulesummary>Main API of the diameter application.</modulesummary>
 
 <description>
@@ -1574,7 +1574,7 @@ identifies the configuration.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>add_transport(SvcName, {connect|listen, [Opt]})
+<name since="OTP R14B03">add_transport(SvcName, {connect|listen, [Opt]})
         -> {ok, Ref} | {error, Reason}</name>
 <fsummary>Add transport capability to a service.</fsummary>
 <type>
@@ -1624,7 +1624,7 @@ its transports.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>call(SvcName, App, Request, [Opt]) -> Answer | ok | {error, Reason}</name>
+<name since="OTP R14B03">call(SvcName, App, Request, [Opt]) -> Answer | ok | {error, Reason}</name>
 <fsummary>Send a Diameter request message.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -1730,7 +1730,7 @@ transport connection.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>origin_state_id() -> &dict_Unsigned32;</name>
+<name since="OTP R14B03">origin_state_id() -> &dict_Unsigned32;</name>
 <fsummary>Returns a reasonable Origin-State-Id.</fsummary>
 <desc>
 <p>
@@ -1748,7 +1748,7 @@ at the time the diameter application was started.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>remove_transport(SvcName, Pred) -> ok | {error, Reason}</name>
+<name since="OTP R14B03">remove_transport(SvcName, Pred) -> ok | {error, Reason}</name>
 <fsummary>Remove previously added transports.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -1795,7 +1795,7 @@ configured on the transport.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>service_info(SvcName, Info) -> term()</name>
+<name since="OTP R14B03">service_info(SvcName, Info) -> term()</name>
 <fsummary>Return information about a started service.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -2114,7 +2114,7 @@ For example:</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>services() -> [SvcName]</name>
+<name since="OTP R14B03">services() -> [SvcName]</name>
 <fsummary>Return the list of started services.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -2129,7 +2129,7 @@ Return the list of started services.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>session_id(Ident) -> &dict_OctetString;</name>
+<name since="OTP R14B03">session_id(Ident) -> &dict_OctetString;</name>
 <fsummary>Return a value for a Session-Id AVP.</fsummary>
 <type>
 <v>Ident = &dict_DiameterIdentity;</v>
@@ -2148,7 +2148,7 @@ the message containing the returned value will be sent.</p>
 
 <!-- ===================================================================== -->
 <func>
-<name>start() -> ok | {error, Reason}</name>
+<name since="OTP R14B03">start() -> ok | {error, Reason}</name>
 <fsummary>Start the diameter application.</fsummary>
 <desc>
 <p>
@@ -2164,7 +2164,7 @@ file, not by calling <c>start/0</c> explicitly.</p>
 
 <!-- ===================================================================== -->
 <func>
-<name>start_service(SvcName, Options) -> ok | {error, Reason}</name>
+<name since="OTP R14B03">start_service(SvcName, Options) -> ok | {error, Reason}</name>
 <fsummary>Start a Diameter service.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -2194,7 +2194,7 @@ necessarily the case.</p>
 
 <!-- ===================================================================== -->
 <func>
-<name>stop() -> ok | {error, Reason}</name>
+<name since="OTP R14B03">stop() -> ok | {error, Reason}</name>
 <fsummary>Stop the diameter application.</fsummary>
 <desc>
 <p>
@@ -2208,7 +2208,7 @@ Stop the diameter application.</p>
 
 <!-- ===================================================================== -->
 <func>
-<name>stop_service(SvcName) -> ok | {error, Reason}</name>
+<name since="OTP R14B03">stop_service(SvcName) -> ok | {error, Reason}</name>
 <fsummary>Stop a Diameter service.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -2236,7 +2236,7 @@ be called to remove transport configuration.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>subscribe(SvcName) -> true</name>
+<name since="OTP R14B03">subscribe(SvcName) -> true</name>
 <fsummary>Subscribe to event messages.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
@@ -2258,7 +2258,7 @@ reception of all transport-related events.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>unsubscribe(SvcName) -> true</name>
+<name since="OTP R14B03">unsubscribe(SvcName) -> true</name>
 <fsummary>Unsubscribe to event messages.</fsummary>
 <type>
 <v>SvcName = &service_name;</v>
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index aa334beb21..82e3d449ef 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -44,7 +44,7 @@ limitations under the License.
 
 </header>
 
-<module>diameter_app</module>
+<module since="OTP R14B03">diameter_app</module>
 <modulesummary>
 Callback module of a Diameter application.</modulesummary>
 
@@ -180,7 +180,7 @@ process.</p>
 <funcs>
 
 <func>
-<name>Mod:peer_up(SvcName, Peer, State) -> NewState</name>
+<name since="OTP R14B03">Mod:peer_up(SvcName, Peer, State) -> NewState</name>
 <fsummary>Invoked when a transport connection has been established</fsummary>
 <type>
 <v>SvcName = &mod_service_name;</v>
@@ -215,7 +215,7 @@ handled independently of &peer_up; and &peer_down;.</p>
 </func>
 
 <func>
-<name>Mod:peer_down(SvcName, Peer, State) -> NewState</name>
+<name since="OTP R14B03">Mod:peer_down(SvcName, Peer, State) -> NewState</name>
 <fsummary>Invoked when a transport connection has been lost.</fsummary>
 <type>
 <v>SvcName = &mod_service_name;</v>
@@ -234,7 +234,7 @@ candidate in &pick_peer; callbacks.</p>
 </func>
 
 <func>
-<name>Mod:pick_peer(LocalCandidates, RemoteCandidates, SvcName, State)
+<name since="OTP R14B03">Mod:pick_peer(LocalCandidates, RemoteCandidates, SvcName, State)
       -> Selection | false</name>
 <fsummary>Select a target peer for an outgoing request.</fsummary>
 <type>
@@ -311,7 +311,7 @@ or &peer_down; callback.</p>
 </func>
 
 <func>
-<name>Mod:prepare_request(Packet, SvcName, Peer) -> Action</name>
+<name since="OTP R14B03">Mod:prepare_request(Packet, SvcName, Peer) -> Action</name>
 <fsummary>Return a request for encoding and transport.</fsummary>
 <type>
 <v>Packet = &packet;</v>
@@ -363,7 +363,7 @@ discarded}</c>.</p>
 </func>
 
 <func>
-<name>Mod:prepare_retransmit(Packet, SvcName, Peer) -> Action</name>
+<name since="OTP R14B03">Mod:prepare_retransmit(Packet, SvcName, Peer) -> Action</name>
 <fsummary>Return a request for encoding and retransmission.</fsummary>
 <type>
 <v>Packet  = &packet;</v>
@@ -393,7 +393,7 @@ discarded}</c>.</p>
 </func>
 
 <func>
-<name>Mod:handle_answer(Packet, Request, SvcName, Peer) -> Result</name>
+<name since="OTP R14B03">Mod:handle_answer(Packet, Request, SvcName, Peer) -> Result</name>
 <fsummary>Receive an answer message from a peer.</fsummary>
 <type>
 <v>Packet  = &packet;</v>
@@ -437,7 +437,7 @@ The &mod_application_opt;
 </func>
 
 <func>
-<name>Mod:handle_error(Reason, Request, SvcName, Peer) -> Result</name>
+<name since="OTP R14B03">Mod:handle_error(Reason, Request, SvcName, Peer) -> Result</name>
 <fsummary>Return an error from a outgoing request.</fsummary>
 <type>
 <v>Reason  = timeout | failover | term()</v>
@@ -465,7 +465,7 @@ not selected.</p>
 </func>
 
 <func>
-<name>Mod:handle_request(Packet, SvcName, Peer) -> Action</name>
+<name since="OTP R14B03">Mod:handle_request(Packet, SvcName, Peer) -> Action</name>
 <fsummary>Receive an incoming request.</fsummary>
 <type>
 <v>Packet  = &packet;</v>
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index 0a34dd7ec7..0384ad2913 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -46,7 +46,7 @@ limitations under the License.
 <file>diameter_codec.xml</file>
 </header>
 
-<module>diameter_codec</module>
+<module since="OTP R15B03">diameter_codec</module>
 <modulesummary>Decode and encode of Diameter messages.</modulesummary>
 
 <description>
@@ -346,7 +346,7 @@ question, as documented in &man_transport;.</p>
 <funcs>
 
 <func>
-<name>decode(Mod, Bin) -> Pkt</name>
+<name since="OTP R15B03">decode(Mod, Bin) -> Pkt</name>
 <fsummary>Decode a Diameter message.</fsummary>
 <type>
 <v>Mod = &dictionary;</v>
@@ -362,7 +362,7 @@ Decode a Diameter message.</p>
 </func>
 
 <func>
-<name>encode(Mod, Msg) -> Pkt</name>
+<name since="OTP R15B03">encode(Mod, Msg) -> Pkt</name>
 <fsummary>Encode a Diameter message.</fsummary>
 <type>
 <v>Mod = &dictionary;</v>
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index 112355816f..57e83bbca1 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -45,7 +45,7 @@ limitations under the License.
 <file>diameter_make.xml</file>
 </header>
 
-<module>diameter_make</module>
+<module since="OTP R14B03">diameter_make</module>
 <modulesummary>Diameter dictionary compilation.</modulesummary>
 
 <description>
@@ -67,7 +67,7 @@ interface.</p>
 <funcs>
 
 <func>
-<name>codec(File :: iolist() | binary(), [Opt]) -> ok
+<name since="OTP R15B">codec(File :: iolist() | binary(), [Opt]) -> ok
                                                  | {ok, [Out]}
                                                  | {error, Reason}</name>
 <fsummary>Compile a dictionary file into Erlang source.</fsummary>
@@ -186,7 +186,7 @@ A returned error reason can be converted into a readable string using
 <!-- ===================================================================== -->
 
 <func>
-<name>format(Parsed) -> iolist()</name>
+<name since="OTP R16B03">format(Parsed) -> iolist()</name>
 <fsummary>Format a parsed dictionary.</fsummary>
 <desc>
 <p>
@@ -198,7 +198,7 @@ dictionary format.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>flatten(Parsed) -> term()</name>
+<name since="OTP R16B03">flatten(Parsed) -> term()</name>
 <fsummary>Flatten a parsed dictionary.</fsummary>
 <desc>
 
@@ -214,7 +214,7 @@ The return value is also a parsed dictionary.</p>
 <!-- ===================================================================== -->
 
 <func>
-<name>format_error(Reason) -> string()</name>
+<name since="OTP 17.0">format_error(Reason) -> string()</name>
 <fsummary>Turn an error reason into a readable string.</fsummary>
 <desc>
 
diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml
index 62e958870e..2cf924ee6b 100644
--- a/lib/diameter/doc/src/diameter_sctp.xml
+++ b/lib/diameter/doc/src/diameter_sctp.xml
@@ -47,7 +47,7 @@ limitations under the License.
 <file>diameter_sctp.xml</file>
 </header>
 
-<module>diameter_sctp</module>
+<module since="OTP R14B03">diameter_sctp</module>
 <modulesummary>Diameter transport over SCTP.</modulesummary>
 
 <description>
@@ -67,7 +67,7 @@ and implements the behaviour documented in
 <funcs>
 
 <func>
-<name>start({Type, Ref}, Svc, [Opt])
+<name since="OTP R14B03">start({Type, Ref}, Svc, [Opt])
          -> {ok, Pid, [LAddr]} | {error, Reason}</name>
 <fsummary>Start a transport process.</fsummary>
 <type>
diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml
index 9f84eeb9fd..fe0cb2d067 100644
--- a/lib/diameter/doc/src/diameter_tcp.xml
+++ b/lib/diameter/doc/src/diameter_tcp.xml
@@ -57,7 +57,7 @@ limitations under the License.
 <file>diameter_tcp.xml</file>
 </header>
 
-<module>diameter_tcp</module>
+<module since="OTP R14B03">diameter_tcp</module>
 <modulesummary>Diameter transport over TCP.</modulesummary>
 
 <description>
@@ -83,7 +83,7 @@ before configuring TLS capability on diameter transports.</p>
 <funcs>
 
 <func>
-<name>start({Type, Ref}, Svc, [Opt])
+<name since="OTP R14B03">start({Type, Ref}, Svc, [Opt])
          -> {ok, Pid}
           | {ok, Pid, [LAddr]}
           | {error, Reason}</name>
diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml
index 294e8a8864..67fd54bc56 100644
--- a/lib/diameter/doc/src/diameter_transport.xml
+++ b/lib/diameter/doc/src/diameter_transport.xml
@@ -43,7 +43,7 @@ limitations under the License.
 <file>diameter_transport.xml</file>
 </header>
 
-<module>diameter_transport</module>
+<module since="OTP R14B03">diameter_transport</module>
 <modulesummary>Diameter transport interface.</modulesummary>
 
 <description>
@@ -94,7 +94,7 @@ and has the binary() to send in its <c>bin</c> field.</p>
 <funcs>
 
 <func>
-<name>Mod:start({Type, Ref}, Svc, Config)
+<name since="OTP R14B03">Mod:start({Type, Ref}, Svc, Config)
          -> {ok, Pid}
           | {ok, Pid, LAddrs}
           | {error, Reason}</name>
-- 
cgit v1.2.3