From f1ffd33240b982ec2ed80231a3a10f14cf5e3fc9 Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Sun, 18 Nov 2012 20:14:34 +0100
Subject: Add reference pages diameter_codec(3) and diameter_make(3)

Not yet any content to speak of.
---
 lib/diameter/doc/src/diameter_codec.xml | 98 +++++++++++++++++++++++++++++++++
 lib/diameter/doc/src/diameter_make.xml  | 83 ++++++++++++++++++++++++++++
 lib/diameter/doc/src/files.mk           |  2 +
 lib/diameter/doc/src/ref_man.xml        |  3 +
 4 files changed, 186 insertions(+)
 create mode 100644 lib/diameter/doc/src/diameter_codec.xml
 create mode 100644 lib/diameter/doc/src/diameter_make.xml

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

diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
new file mode 100644
index 0000000000..041616e54b
--- /dev/null
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd" [
+  <!ENTITY % also SYSTEM "seealso.ent" >
+  <!ENTITY % here SYSTEM "seehere.ent" >
+  %also;
+  %here;
+]>
+
+<erlref>
+<header>
+<copyright>
+<year>2012</year>
+<holder>Ericsson AB. All Rights Reserved.</holder>
+</copyright>
+<legalnotice>
+The contents of this file are subject to the Erlang Public License,
+Version 1.1, (the "License"); you may not use this file except in
+compliance with the License. You should have received a copy of the
+Erlang Public License along with this software. If not, it can be
+retrieved online at http://www.erlang.org/.
+
+Software distributed under the License is distributed on an "AS IS"
+basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+the License for the specific language governing rights and limitations
+under the License.
+
+</legalnotice>
+
+<title>diameter_codec(3)</title>
+<prepared>Anders Svensson</prepared>
+<responsible></responsible>
+<docno></docno>
+<approved></approved>
+<checked></checked>
+<date></date>
+<rev></rev>
+<file>diameter_codec.xml</file>
+</header>
+
+<module>diameter_codec</module>
+<modulesummary>Diameter encode/decode.</modulesummary>
+
+<description>
+
+<p>
+</p>
+
+</description>
+
+<!-- ===================================================================== -->
+
+<funcs>
+
+<func>
+<name>decode(Mod, Bin) -> #diameter_packet{}</name>
+<fsummary>Decode an incoming Diameter message.</fsummary>
+<type>
+<v></v>
+<v></v>
+</type>
+<desc>
+
+<p>
+</p>
+
+</desc>
+</func>
+
+<func>
+<name>encode(Mod, Msg) -> binary()</name>
+<fsummary>Encode an outgoing Diameter message.</fsummary>
+<type>
+<v></v>
+<v></v>
+</type>
+<desc>
+
+<p>
+</p>
+
+</desc>
+</func>
+
+</funcs>
+
+<!-- ===================================================================== -->
+<!-- ===================================================================== -->
+
+<section>
+<title>SEE ALSO</title>
+
+<p>
+&man_main;,
+&man_dict;</p>
+
+</section>
+
+</erlref>
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
new file mode 100644
index 0000000000..aee98d62d2
--- /dev/null
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd" [
+  <!ENTITY % also SYSTEM "seealso.ent" >
+  <!ENTITY % here SYSTEM "seehere.ent" >
+  %also;
+  %here;
+]>
+
+<erlref>
+<header>
+<copyright>
+<year>2012</year>
+<holder>Ericsson AB. All Rights Reserved.</holder>
+</copyright>
+<legalnotice>
+The contents of this file are subject to the Erlang Public License,
+Version 1.1, (the "License"); you may not use this file except in
+compliance with the License. You should have received a copy of the
+Erlang Public License along with this software. If not, it can be
+retrieved online at http://www.erlang.org/.
+
+Software distributed under the License is distributed on an "AS IS"
+basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+the License for the specific language governing rights and limitations
+under the License.
+
+</legalnotice>
+
+<title>diameter_make(3)</title>
+<prepared>Anders Svensson</prepared>
+<responsible></responsible>
+<docno></docno>
+<approved></approved>
+<checked></checked>
+<date></date>
+<rev></rev>
+<file>diameter_make.xml</file>
+</header>
+
+<module>diameter_make</module>
+<modulesummary>Diameter dictionary compilation.</modulesummary>
+
+<description>
+
+<p>
+</p>
+
+</description>
+
+<!-- ===================================================================== -->
+
+<funcs>
+
+<func>
+<name>codec(Name) -> ok</name>
+<fsummary>Compile a dictionary into a codec module.</fsummary>
+<type>
+<v></v>
+<v></v>
+</type>
+<desc>
+
+<p>
+</p>
+
+</desc>
+</func>
+
+</funcs>
+
+<!-- ===================================================================== -->
+<!-- ===================================================================== -->
+
+<section>
+<title>SEE ALSO</title>
+
+<p>
+&man_main;,
+&man_dict;</p>
+
+</section>
+
+</erlref>
diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk
index 89ec1031e6..00ced3d91e 100644
--- a/lib/diameter/doc/src/files.mk
+++ b/lib/diameter/doc/src/files.mk
@@ -26,6 +26,8 @@ XML_REF1_FILES = \
 XML_REF3_FILES = \
 	diameter.xml \
 	diameter_app.xml \
+	diameter_codec.xml \
+	diameter_make.xml \
 	diameter_transport.xml \
 	diameter_tcp.xml \
 	diameter_sctp.xml
diff --git a/lib/diameter/doc/src/ref_man.xml b/lib/diameter/doc/src/ref_man.xml
index 137ce79094..4b99fe716d 100644
--- a/lib/diameter/doc/src/ref_man.xml
+++ b/lib/diameter/doc/src/ref_man.xml
@@ -6,6 +6,7 @@
 <header>
 <copyright>
 <year>2011</year>
+<year>2012</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -40,7 +41,9 @@ applications on top of the Diameter protocol. </p>
 <xi:include href="diameter.xml"/>
 <xi:include href="diameter_compile.xml"/>
 <xi:include href="diameter_app.xml"/>
+<xi:include href="diameter_codec.xml"/>
 <xi:include href="diameter_dict.xml"/>
+<xi:include href="diameter_make.xml"/>
 <xi:include href="diameter_transport.xml"/>
 <xi:include href="diameter_tcp.xml"/>
 <xi:include href="diameter_sctp.xml"/>
-- 
cgit v1.2.3