cvs: phpdoc /en/functions strings.xml

zak Mon Nov 19 08:46:50 2001 EDT Modified files: /phpdoc/en/functions strings.xml Log: Added terse docs for vprintf()/vsprintf(). Corrected return value for printf() Index: phpdoc/en/functions/strings.xml diff -u phpdoc/en/functions/strings.xml:1.123 phpdoc/en/functions/strings.xml:1.124 --- phpdoc/en/functions/strings.xml:1.123 Mon Nov 12 11:50:43 2001 +++ phpdoc/en/functions/strings.xml Mon Nov 19 08:46:48 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.123 $ --> +<!-- $Revision: 1.124 $ --> <reference id="ref.strings"> <title>String functions</title> <titleabbrev>Strings</titleabbrev> @@ -1682,7 +1682,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>int <function>printf</function></funcdef> + <funcdef>void <function>printf</function></funcdef> <paramdef>string <parameter>format</parameter></paramdef> <paramdef>mixed <parameter><optional>args</optional></parameter>... @@ -3845,6 +3845,69 @@ </refsect1> </refentry> + <refentry id="function.vprintf"> + <refnamediv> + <refname>vprintf</refname> + <refpurpose>Output a formatted string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>vprintf</function></funcdef> + <paramdef>string <parameter>format</parameter></paramdef> + <paramdef>array + <parameter>args</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <simpara> + Display array values as a formatted string according to + <parameter>format</parameter> (which is described in the documentation + for <function>sprintf</function>). + </simpara> + <simpara> + Operates as <function>printf</function> but accepts an array of + arguments, rather than a variable number of arguments. + </simpara> + <simpara> + See also: <function>printf</function>, <function>sprintf</function>, + <function>vsprintf</function> + </simpara> + </refsect1> + </refentry> + + <refentry id="function.vsprintf"> + <refnamediv> + <refname>vsprintf</refname> + <refpurpose>Return a formatted string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>vsprintf</function></funcdef> + <paramdef>string <parameter>format</parameter></paramdef> + <paramdef>array + <parameter>args</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <simpara> + Return array values as a formatted string according to + <parameter>format</parameter> (which is described in the documentation + for <function>sprintf</function>). + </simpara> + <simpara> + Operates as <function>sprintf</function> but accepts an array of + arguments, rather than a variable number of arguments. + </simpara> + <simpara> + See also: <function>sprintf</function>, <function>vsprintf</function>, + <function>vprintf</function> + </simpara> + </refsect1> + </refentry> <refentry id="function.wordwrap"> <refnamediv>