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_dict.xml | 88 +++++++++++++++++-----------------
 1 file changed, 44 insertions(+), 44 deletions(-)

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

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 98adebf145..9d6a6a8f38 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -125,9 +125,9 @@ is used to identify the relevant dictionary module.

 

 Example:

 
-
+
 @id 16777231
-
+

 
 
 
@@ -146,9 +146,9 @@ with existing modules in the system.

 

 Example:

 
-
+
 @name etsi_e2
-
+

 
 
 
@@ -169,9 +169,9 @@ different Diameter applications.

 

 Example:

 
-
+
 @prefix etsi_e2
-
+

 
 
 
@@ -189,9 +189,9 @@ The section has empty content.

 

 Example:

 
-
+
 @vendor 13019 ETSI
-
+

 
 
 
@@ -205,13 +205,13 @@ The section content consists of AVP names.

 

 Example:

 
-
+
 @avp_vendor_id 2937
 
 WWW-Auth
 Domain-Index
 Region-Set
-
+

 
 
 
@@ -244,9 +244,9 @@ All dictionaries should typically inherit RFC3588 AVPs from
 

 Example:

 
-
+
 @inherits diameter_gen_base_rfc3588
-
+

 
 
 
@@ -268,12 +268,12 @@ none are to be set.

 

 Example:

 
-
+
 @avp_types
 
 Location-Information   350  Grouped     MV
 Requested-Information  353  Enumerated   V
-
+

 
 
 

@@ -298,11 +298,11 @@ encode/decode.

 

 Example:

 
-
+
 @custom_types rfc4005_avps
 
 Framed-IP-Address
-
+

 
 
 @codecs Mod
@@ -315,11 +315,11 @@ Like @custom_types but requires the specified module to export
 

 Example:

 
-
+
 @codecs rfc4005_avps
 
 Framed-IP-Address
-
+

 
 
 @messages
@@ -330,7 +330,7 @@ The section content consists of definitions of the form specified in
 section 3.2 of RFC 3588, "Command Code ABNF specification".

 
 
-
+
 @messages
 
 RTR ::= < Diameter Header: 287, REQ, PXY >
@@ -363,7 +363,7 @@ RTA ::= < Diameter Header: 287, PXY >
       * [ Proxy-Info ]
       * [ Route-Record ]
       * [ AVP ]
-
+

 
 
 
@@ -378,14 +378,14 @@ section 4.4 of RFC 3588, "Grouped AVP Values".

 

 Example:

 
-
+
 @grouped
 
 SIP-Deregistration-Reason ::= < AVP Header: 383 >
                               { SIP-Reason-Code }
                               [ SIP-Reason-Info ]
                             * [ AVP ]
-
+

 
 

 Specifying a Vendor-Id in the definition of a grouped AVP is
@@ -408,14 +408,14 @@ otherwise defined in another dictionary.

 

 Example:

 
-
+
 @enum SIP-Reason-Code
 
 PERMANENT_TERMINATION    0
 NEW_SIP_SERVER_ASSIGNED  1
 SIP_SERVER_CHANGE        2
 REMOVE_SIP_SERVER        3
-
+

 
 
 @end
@@ -450,22 +450,22 @@ contained in the message or grouped AVP in the order specified in the
 definition in question.
 For example, the grouped AVP

 
-
+
 SIP-Deregistration-Reason ::= < AVP Header: 383 >
                               { SIP-Reason-Code }
                               [ SIP-Reason-Info ]
                             * [ AVP ]
-
+

 
 

 will result in the following record definition given an empty
 prefix.

 
-
+
 -record('SIP-Deregistration-Reason' {'SIP-Reason-Code',
                                      'SIP-Reason-Info',
                                      'AVP'}).
-
+

 
 

 The values encoded in the fields of generated records depends on the
@@ -507,7 +507,7 @@ callback upon reception of an incoming request.

 
 
 
-
+
 OctetString() = [0..255]
 Integer32()   = -2147483647..2147483647
 Integer64()   = -9223372036854775807..9223372036854775807
@@ -516,7 +516,7 @@ Unsigned64()  = 0..18446744073709551615
 Float32()     = '-infinity' | float() | infinity
 Float64()     = '-infinity' | float() | infinity
 Grouped()     = record()
-
+

 
 

 On encode, an OctetString() can be specified as an iolist(),
@@ -530,10 +530,10 @@ section.

 Derived AVP Data Formats

 
 
-
+
 Address() = OctetString()
           | tuple()
-
+

 
 

 On encode, an OctetString() IPv4 address is parsed in the usual
@@ -545,7 +545,7 @@ An IPv6 tuple() has length 8 and contains values of type 0..65535.
 The tuple representation is used on decode.

 
 
-
+
 Time() = {date(), time()}
 
 where
@@ -559,7 +559,7 @@ where
   Hour   = 0..23
   Minute = 0..59
   Second = 0..59
-
+

 
 

 Additionally, values that can be encoded are
@@ -569,9 +569,9 @@ In particular, only values between {{1968,1,20},{3,14,8}}
 and {{2104,2,26},{9,42,23}} (both inclusive) can be encoded.

 
 
-
+
 UTF8String() = [integer()]
-
+

 
 

 List elements are the UTF-8 encodings of the individual characters
@@ -579,15 +579,15 @@ in the string.
 Invalid codepoints will result in encode/decode failure.

 
 
-
+
 DiameterIdentity() = OctetString()
-
+

 
 

 A value must have length at least 1.

 
 
-
+
 DiameterURI() = OctetString()
               | #diameter_URI{type = Type,
                               fqdn = FQDN,
@@ -602,7 +602,7 @@ where
   Port = integer()
   Transport = sctp | tcp
   Protocol  = diameter | radius | 'tacacs+'
-
+

 
 

 On encode, fields port, transport and protocol default to 3868, sctp
@@ -612,9 +612,9 @@ section 4.3 of RFC 3588.
 The record representation is used on decode.

 
 
-
+
 Enumerated() = Integer32()
-
+

 
 

 On encode, values can be specified using the macros defined in a
@@ -622,10 +622,10 @@ dictionary's hrl file.

 
 
 
-
+
 IPFilterRule()  = OctetString()
 QoSFilterRule() = OctetString()
-
+

 
 

 Values of these types are not currently parsed by diameter.

-- 
cgit v1.2.3


From 439dd4b95017a9966dd0cf1f090a9b00da831fe4 Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Fri, 16 Nov 2012 00:41:34 +0100
Subject: Use entities for cross references

---
 lib/diameter/doc/src/diameter_dict.xml | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

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

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 9d6a6a8f38..4956ff4be0 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -1,5 +1,8 @@
 
-
+
+  %ents;
+]>
 
 
 

@@ -40,8 +43,7 @@ under the License.
 
 
 

-A diameter service as configured with diameter:start_service/2
+A diameter service as configured with &mod_start_service;
 specifies one or more supported Diameter applications.
 Each Diameter application specifies a dictionary module that knows how
 to encode and decode its messages and AVPs.
@@ -58,8 +60,7 @@ resulting dictionaries modules on a service.

 The codec generation also results in a hrl file that defines records
 for the messages and grouped AVPs defined for the application, these
 records being what a user of the diameter application sends and receives.
-(Modulo other available formats as discussed in diameter_app(3).)
+(Modulo other available formats as discussed in &man_app;.)
 These records and the underlying Erlang data types corresponding to
 Diameter data formats are discussed in MESSAGE RECORDS and 
 The data formats defined in sections 4.2 ("Basic AVP Data
 Formats") and 4.3 ("Derived AVP Data Formats") of RFC 3588 are encoded
 as values of the types defined here.
-Values are passed to diameter:call/4
+Values are passed to &mod_call;
 in a request record when sending a request, returned in a resulting
-answer record and passed to a handle_request
+answer record and passed to a &app_handle_request;
 callback upon reception of an incoming request.

 
 

@@ -639,9 +638,7 @@ Values of these types are not currently parsed by diameter.

 SEE ALSO
 
 

-diameterc(1),
-diameter(3),
-diameter_app(3)

+&man_compile;, &man_main;, &man_app;

 
 
 
-- 
cgit v1.2.3


From 0295e6350bc344ce443c80e7251c6e5fc48159ba Mon Sep 17 00:00:00 2001
From: Anders Svensson 
Date: Fri, 16 Nov 2012 11:12:07 +0100
Subject: Generate intra-document references

---
 lib/diameter/doc/src/diameter_dict.xml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

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

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml
index 4956ff4be0..4a6cccc276 100644
--- a/lib/diameter/doc/src/diameter_dict.xml
+++ b/lib/diameter/doc/src/diameter_dict.xml
@@ -1,7 +1,9 @@
 
 
-  %ents;
+  
+  
+  %also;
+  %here;
 ]>
 
 
-- 
cgit v1.2.3