From 8317fec82dc677f299e3772d3d644639f936857a Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 11 Oct 2012 02:17:56 +0200 Subject: -> 
 in documentation

The former doesn't allow seealso content, which erl_docgen doesn't
enforce, resulting in mangled PDF.
---
 lib/diameter/doc/src/diameter.xml | 76 +++++++++++++++++++--------------------
 1 file changed, 38 insertions(+), 38 deletions(-)

(limited to 'lib/diameter/doc/src/diameter.xml')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index c93a7b2c67..ea540562af 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -110,10 +110,10 @@ defined by the application.

                              | [Mod | ExtraArgs]
                              | #diameter_callback{}
 
-
+
 Mod = atom()
 ExtraArgs = list()
-
+

 
 

 A module implementing the callback interface defined in 
 An expression that can be evaluated as a function in the following
 sense.

 
-
+
 eval([{M,F,A} | T]) ->
     apply(M, F, T ++ A);
 eval([[F|A] | T]) ->
@@ -366,7 +366,7 @@ eval([F|A]) ->
     apply(F, A);
 eval(F) ->
     eval([F]).
-
+

 
 

 Applying an evaluable()
@@ -527,12 +527,12 @@ implies the termination of all transport processes.

 {up, Ref, Peer, Config}
 {down, Ref, Peer, Config}
 
-
+
 Ref    = transport_ref()
 Peer   = diameter_app:peer()
 Config = {connect|listen, [transport_opt()]}
 Pkt    = #diameter_packet{}
-
+

 
 

 The RFC 3539 watchdog state machine has
@@ -556,10 +556,10 @@ respect to individual Diameter applications.

 
 {reconnect, Ref, Opts}
 
-
+
 Ref  = transport_ref()
 Opts = [transport_opt()]
-
+

 
 

 A connecting transport is attempting to establish/reestablish a
@@ -571,10 +571,10 @@ expiry.

 
 {closed, Ref, Reason, Config}
 
-
+
 Ref = transport_ref()
 Config = {connect|listen, [transport_opt()]}
-
+

 
 

 Capabilities exchange has failed.
@@ -584,13 +584,13 @@ Capabilities exchange has failed.
 
 {'CER', Result, Caps, Pkt}
 
-
+
 Result = ResultCode | {capabilities_cb, CB, ResultCode|discard}
 Caps = #diameter_caps{}
 Pkt  = #diameter_packet{}
 ResultCode = integer()
 CB = evaluable()
-
+

 
 

 An incoming CER has been answered with the indicated result code or
@@ -604,11 +604,11 @@ contains the rejecting callback.

 
 {'CER', Caps, {ResultCode, Pkt}}
 
-
+
 ResultCode = integer()
 Caps = #diameter_caps{}
 Pkt  = #diameter_packet{}
-
+

 
 

 An incoming CER contained errors and has been answered with the
@@ -627,12 +627,12 @@ connection establishment.

 
 {'CEA', Result, Caps, Pkt}
 
-
+
 Result = integer() | atom() | {capabilities_cb, CB, ResultCode|discard}
 Caps = #diameter_caps{}
 Pkt  = #diameter_packet{}
 ResultCode = integer()
-
+

 
 

 An incoming CEA has been rejected for the indicated reason.
@@ -647,10 +647,10 @@ contains the rejecting callback.

 
 {'CEA', Caps, Pkt}
 
-
+
 Caps = #diameter_caps{}
 Pkt  = #diameter_packet{}
-
+

 
 

 An incoming CEA contained errors and has been rejected.
@@ -671,12 +671,12 @@ of connection establishment.

 
 {watchdog, Ref, PeerRef, {From, To}, Config}
 
-
+
 Ref = transport_ref()
 PeerRef  = diameter_app:peer_ref()
 From, To = initial | okay | suspect | down | reopen
 Config = {connect|listen, [transport_opt()]}
-
+

 
 

 An RFC 3539 watchdog state machine has changed state.

@@ -772,9 +772,9 @@ to be evaluated at start_service/2.
 In particular, an identifier Id is mapped to a new identifier
 as follows.

-
+
 (H bsl N) bor (Id band ((1 bsl N) - 1))
-
+

 

 Note that RFC 3588 requires that End-to-End identifiers remain unique
 for a period of at least 4 minutes and that this and the call rate
@@ -980,9 +980,9 @@ Defaults to a single callback returning dpr.

 
 {reconnect_timer, Tc}
 
-
+
 Tc = Unsigned32()
-
+

 
 

 For a connecting transport, the RFC 3588 Tc timer, in milliseconds.
@@ -1029,12 +1029,12 @@ For example, the following options on a connecting transport
 request a connection with one peer over SCTP or another
 (typically the same) over TCP.

 
-
+
 {transport_module, diameter_sctp}
 {transport_config, SctpOpts, 5000}
 {transport_module, diameter_tcp}
 {transport_config, TcpOpts}
-
+

 
 

 To listen on both SCTP and TCP, define one transport for each.

@@ -1065,10 +1065,10 @@ corresponding timeout (see below) or all fail.

 
 {watchdog_timer, TwInit}
 
-
+
 TwInit = Unsigned32()
        | {M,F,A}
-
+

 
 

 The RFC 3539 watchdog timer.
@@ -1334,7 +1334,7 @@ marker="#add_transport">add_transport/2 and Ref is
 as returned by it.
 The remaining forms are equivalent to an arity-3 fun as follows.

 
-
+
 Pred = fun(transport_ref(), list()):  fun(Ref, _, Opts) -> Pred(Ref, Opts) end
 Pred = fun(list()):                   fun(_, _, Opts) -> Pred(Opts) end
 Pred = transport_ref():               fun(Ref, _, _)  -> Pred == Ref end
@@ -1342,7 +1342,7 @@ Pred = list():                        fun(_, _, Opts) -> [] == Pred -- Opts end
 Pred = true:                          fun(_, _, _) -> true end
 Pred = false:                         fun(_, _, _) -> false end
 Pred = {M,F,A}:  fun(Ref, Type, Opts) -> apply(M, F, [Ref, Type, Opts | A]) end
-
+

 
 

 Removing a transport causes the corresponding transport processes to
@@ -1425,7 +1425,7 @@ An example return value with for a client service with Origin-Host
 "client.example.com" configured with a single transport connected to
 "server.example.com" might look as follows.

 
-
+
 [[{ref,#Ref<0.0.0.93>},
   {type,connect},
   {options,[{transport_module,diameter_tcp},
@@ -1470,7 +1470,7 @@ An example return value with for a client service with Origin-Host
                {{{0,258,0},recv,{'Result-Code',2001}},3},
                {{{0,280,1},recv},2},
                {{{0,280,0},send},2}]}]]
-
+

 
 

 Here ref is a transport_ref().
 The transport info returned by a server with a single client
 connection might look as follows.

 
-
+
 [[{ref,#Ref<0.0.0.61>},
   {type,listen},
   {options,[{transport_module,diameter_tcp},
@@ -1557,7 +1557,7 @@ connection might look as follows.

                {{{0,280,0},send},5},
                {{{0,257,1},recv},1},
                {{{0,257,0},send},1}]}]]
-
+

 
 

 The information presented here is as in the connect case except
@@ -1576,7 +1576,7 @@ connections and for which Diameter-level statistics are accumulated
 only for the lifetime of the transport connection.
 A return value for the server above might look as follows.

 
-
+
 [[{ref,#Ref<0.0.0.61>},
   {type,accept},
   {options,[{transport_module,diameter_tcp},
@@ -1622,7 +1622,7 @@ A return value for the server above might look as follows.

                {{{0,280,0},send},66},
                {{{0,257,1},recv},1},
                {{{0,257,0},send},1}]}]]
-
+

 
 

 Note that there may be multiple entries with the same ref, in
@@ -1655,14 +1655,14 @@ Otherwise it contains the ref, type and options
 tuples as in transport and connections info above.
 For example:

 
-
+
 [{ref,#Ref<0.0.0.61>},
  {type,accept},
  {options,[{transport_module,diameter_tcp},
            {transport_config,[{reuseaddr,true},
                               {ip,{127,0,0,1}},
                               {port,3868}]}]}]
-
+

 
 
 
-- 
cgit v1.2.3