From 5d1d0d8269d9a1c9fe437d063820b5eb2c9858d5 Mon Sep 17 00:00:00 2001
From: Antony Dovgal <tony2001@php.net>
Date: Thu, 14 Aug 2008 10:42:17 +0000
Subject: [PATCH] add documentation for quoted_printable_encode()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@264836 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/quoted-printable-encode.xml     | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 reference/strings/functions/quoted-printable-encode.xml

diff --git a/reference/strings/functions/quoted-printable-encode.xml b/reference/strings/functions/quoted-printable-encode.xml
new file mode 100644
index 0000000000..aaff52b281
--- /dev/null
+++ b/reference/strings/functions/quoted-printable-encode.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.quoted-printable-encode">
+ <refnamediv>
+  <refname>quoted_printable_encode</refname>
+  <refpurpose>Convert a 8 bit string to a quoted-printable string</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>quoted_printable_encode</methodname>
+   <methodparam><type>string</type><parameter>str</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Returns a quoted printable string created according to <link
+   xlink:href="&url.rfc;2045">RFC2045</link>, section 6.7.
+  </para>
+  <para>
+   This function is similar to <function>imap_8bit</function>, except this
+   one does not require the IMAP module to work.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>str</parameter></term>
+     <listitem>
+      <para>
+       The input string.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the encoded string.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>quoted_printable_decode</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->