From 3f79e7bd7e743ffd40b624caf680aef2bdb15dc7 Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Thu, 16 Jan 2014 12:57:43 +0100
Subject: Don't format diameter_make:codec/2 errors

Instead, add diameter_make:format_error/1 to allow the caller to format
if desired, which is what applications like compiler and yecc do. Use
this to check that the expected error is the one actually generated in
the compiler suite.
---
 lib/diameter/doc/src/diameter_make.xml | 18 +++++++++++++++++-
 lib/diameter/doc/src/seealso.ent       |  3 ++-
 2 files changed, 19 insertions(+), 2 deletions(-)

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

diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index 1c1eff6c6a..16ef49d4b2 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -16,7 +16,7 @@
 <header>
 <copyright>
 <year>2012</year>
-<year>2013</year>
+<year>2014</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -175,6 +175,10 @@ Note that a dictionary's <c>&dict_name;</c>, together with the
 The <c>&dict_name;</c> of a literal input dictionary defaults to
 <c>dictionary</c>.</p>
 
+<p>
+A returned error reason can be converted into a readable string using
+&format_error;.</p>
+
 </desc>
 </func>
 
@@ -206,6 +210,18 @@ The return value is also a parsed dictionary.</p>
 </desc>
 </func>
 
+<!-- ===================================================================== -->
+
+<func>
+<name>format_error(Reason) -> string()</name>
+<fsummary>Turn an error reason into a readable string.</fsummary>
+<desc>
+
+<p>
+Turn an error reason returned by &codec; into a readable string.</p>
+</desc>
+</func>
+
 </funcs>
 
 <!-- ===================================================================== -->
diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index 7bf7460351..44541afb9b 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -4,7 +4,7 @@
 
 %CopyrightBegin%
 
-Copyright Ericsson AB 2012-2013. All Rights Reserved.
+Copyright Ericsson AB 2012-2014. All Rights Reserved.
 
 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
@@ -117,6 +117,7 @@ significant.
 <!ENTITY make_codec '<seealso marker="diameter_make#codec-2">diameter_make:codec/2</seealso>'>
 <!ENTITY make_format '<seealso marker="diameter_make#format-1">diameter_make:format/1</seealso>'>
 <!ENTITY make_flatten '<seealso marker="diameter_make#flatten-1">diameter_make:flatten/1</seealso>'>
+<!ENTITY make_format_error '<seealso marker="diameter_make#format_error-1">diameter_make:format_error/1</seealso>'>
 
 <!-- diameter_transport -->
 
-- 
cgit v1.2.3