From 68d53c01b0b8e9a007a6a30158c19e34b2d2a34e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Wed, 18 May 2016 15:53:35 +0200
Subject: Update STDLIB documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Language cleaned up by the technical writers xsipewe and tmanevik
from Combitech. Proofreading and corrections by Björn Gustavsson
and Hans Bolinder.
---
 lib/stdlib/doc/src/base64.xml | 49 ++++++++++++++++++++++++-------------------
 1 file changed, 28 insertions(+), 21 deletions(-)

(limited to 'lib/stdlib/doc/src/base64.xml')

diff --git a/lib/stdlib/doc/src/base64.xml b/lib/stdlib/doc/src/base64.xml
index 7b82d7dd3d..cfa1ecc006 100644
--- a/lib/stdlib/doc/src/base64.xml
+++ b/lib/stdlib/doc/src/base64.xml
@@ -27,50 +27,57 @@
     <docno></docno>
     <date>2007-02-22</date>
     <rev></rev>
-    <file>base64.sgml</file>
+    <file>base64.xml</file>
   </header>
   <module>base64</module>
-  <modulesummary>Implements base 64 encode and decode, see RFC2045.</modulesummary>
+  <modulesummary>Provides base64 encode and decode, see
+    RFC 2045.</modulesummary>
   <description>
-    <p>Implements base 64 encode and decode, see RFC2045. </p>
+    <p>Provides base64 encode and decode, see
+      <url href="https://www.ietf.org/rfc/rfc2045.txt">RFC 2045</url>.</p>
   </description>
+
   <datatypes>
     <datatype>
       <name name="ascii_string"/>
     </datatype>
     <datatype>
       <name name="ascii_binary"/>
-      <desc><p>A <c>binary()</c> with ASCII characters in the range 1 to 255.</p>
+      <desc><p>A <c>binary()</c> with ASCII characters in the range 1 to
+        255.</p>
       </desc>
     </datatype>
   </datatypes>
+
   <funcs>
-    <func>
-      <name name="encode" arity="1"/>
-      <name name="encode_to_string" arity="1"/>
-      <fsummary>Encodes data into base64. </fsummary>
-      <type variable="Data"/>
-      <type variable="Base64" name_i="1"/>
-      <type variable="Base64String"/>
-      <desc>
-        <p>Encodes a plain ASCII string into base64. The result will
-          be 33% larger than the data.</p>
-      </desc>
-    </func>
     <func>
       <name name="decode" arity="1"/>
       <name name="decode_to_string" arity="1"/>
       <name name="mime_decode" arity="1"/>
       <name name="mime_decode_to_string" arity="1"/>
-      <fsummary>Decodes a base64 encoded string to data. </fsummary>
+      <fsummary>Decode a base64 encoded string to data.</fsummary>
       <type variable="Base64" name_i="1"/>
       <type variable="Data" name_i="1"/>
       <type variable="DataString" name_i="2"/>
       <desc>
-        <p>Decodes a base64 encoded string to plain ASCII. See RFC4648.
-          <c>mime_decode/1</c> and <c>mime_decode_to_string/1</c>
-          strips away illegal characters, while <c>decode/1</c> and
-          <c>decode_to_string/1</c> only strips away whitespace characters.</p>
+        <p>Decodes a base64-encoded string to plain ASCII. See
+          <url href="https://www.ietf.org/html/rfc4648">RFC 4648</url>.</p>
+        <p><c>mime_decode/1</c> and <c>mime_decode_to_string/1</c> strip away
+          illegal characters, while <c>decode/1</c> and
+          <c>decode_to_string/1</c> only strip away whitespace characters.</p>
+      </desc>
+    </func>
+
+    <func>
+      <name name="encode" arity="1"/>
+      <name name="encode_to_string" arity="1"/>
+      <fsummary>Encode data into base64.</fsummary>
+      <type variable="Data"/>
+      <type variable="Base64" name_i="1"/>
+      <type variable="Base64String"/>
+      <desc>
+        <p>Encodes a plain ASCII string into base64. The result is 33% larger
+          than the data.</p>
       </desc>
     </func>
   </funcs>
-- 
cgit v1.2.3