From 94346e89c9c6dbe2014fd5ef4e6d3eb32050991d Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Sun, 23 Mar 2008 22:42:50 +0000
Subject: [PATCH] - Improve/add parameter/returnvalue descriptions - Fix PHP
 coding style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255914 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/strings/functions/crc32.xml                 |  4 ++--
 reference/strings/functions/fprintf.xml               | 11 +++++++----
 .../strings/functions/get-html-translation-table.xml  |  4 ++--
 reference/strings/functions/implode.xml               |  3 ++-
 reference/strings/functions/vprintf.xml               |  4 +++-
 reference/strings/functions/vsprintf.xml              |  4 +++-
 6 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/reference/strings/functions/crc32.xml b/reference/strings/functions/crc32.xml
index fe3c017c66..845800d2cf 100644
--- a/reference/strings/functions/crc32.xml
+++ b/reference/strings/functions/crc32.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.crc32">
  <refnamediv>
   <refname>crc32</refname>
@@ -44,7 +44,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   Returns the crc32 checksum of <parameter>str</parameter> as an integer.
   </para>
  </refsect1>
 
diff --git a/reference/strings/functions/fprintf.xml b/reference/strings/functions/fprintf.xml
index e2150899cb..6bb8db4e6f 100644
--- a/reference/strings/functions/fprintf.xml
+++ b/reference/strings/functions/fprintf.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fprintf">
  <refnamediv>
   <refname>fprintf</refname>
@@ -29,6 +29,7 @@
      <term><parameter>handle</parameter></term>
      <listitem>
       <para>
+       &fs.file.pointer;
       </para>
      </listitem>
     </varlistentry>
@@ -62,7 +63,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the length of the outputted string.
+   Returns the length of the string written.
   </para>
  </refsect1>
 
@@ -74,8 +75,9 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-if (!($fp = fopen('date.txt', 'w')))
+if (!($fp = fopen('date.txt', 'w'))) {
     return;
+}
 
 fprintf($fp, "%04d-%02d-%02d", $year, $month, $day);
 // will write the formatted ISO date to date.txt
@@ -88,8 +90,9 @@ fprintf($fp, "%04d-%02d-%02d", $year, $month, $day);
     <programlisting role="php">
 <![CDATA[
 <?php
-if (!($fp = fopen('currency.txt', 'w')))
+if (!($fp = fopen('currency.txt', 'w'))) {
     return;
+}
 
 $money1 = 68.75;
 $money2 = 54.35;
diff --git a/reference/strings/functions/get-html-translation-table.xml b/reference/strings/functions/get-html-translation-table.xml
index 6bc4d4299d..73268fef16 100644
--- a/reference/strings/functions/get-html-translation-table.xml
+++ b/reference/strings/functions/get-html-translation-table.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.get-html-translation-table">
  <refnamediv>
   <refname>get_html_translation_table</refname>
@@ -49,7 +49,7 @@
      <term><parameter>quote_style</parameter></term>
      <listitem>
       <para>
-       And as in the <function>htmlspecialchars</function> and
+       Like the <function>htmlspecialchars</function> and
        <function>htmlentities</function> functions you can optionally specify
        the <parameter>quote_style</parameter> you are working with.  The
        default is <constant>ENT_COMPAT</constant> mode.  See the description
diff --git a/reference/strings/functions/implode.xml b/reference/strings/functions/implode.xml
index 991058a5a9..2698e80d76 100644
--- a/reference/strings/functions/implode.xml
+++ b/reference/strings/functions/implode.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.implode">
  <refnamediv>
   <refname>implode</refname>
@@ -44,6 +44,7 @@
      <term><parameter>pieces</parameter></term>
      <listitem>
       <para>
+       The array of strings to implode.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/strings/functions/vprintf.xml b/reference/strings/functions/vprintf.xml
index d7aa09b88e..b7ca2b410b 100644
--- a/reference/strings/functions/vprintf.xml
+++ b/reference/strings/functions/vprintf.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.vprintf">
  <refnamediv>
   <refname>vprintf</refname>
@@ -32,6 +32,8 @@
      <term><parameter>format</parameter></term>
      <listitem>
       <para>
+       See <function>sprintf</function> for a description of
+       <parameter>format</parameter>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/strings/functions/vsprintf.xml b/reference/strings/functions/vsprintf.xml
index 96ee046b51..1d78ee6000 100644
--- a/reference/strings/functions/vsprintf.xml
+++ b/reference/strings/functions/vsprintf.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.vsprintf">
  <refnamediv>
   <refname>vsprintf</refname>
@@ -27,6 +27,8 @@
      <term><parameter>format</parameter></term>
      <listitem>
       <para>
+       See <function>sprintf</function> for a description of
+       <parameter>format</parameter>.
       </para>
      </listitem>
     </varlistentry>