cvs: peardoc /en/pecl ps.xml

steinm Thu Apr 22 01:51:57 2004 EDT Modified files: /peardoc/en/pecl ps.xml Log: - fixed doc for ps_hyphenate() http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/pecl/ps.xml diff -u peardoc/en/pecl/ps.xml:1.2 peardoc/en/pecl/ps.xml:1.3 --- peardoc/en/pecl/ps.xml:1.2 Thu Apr 22 01:45:59 2004 +++ peardoc/en/pecl/ps.xml Thu Apr 22 01:51:57 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="pecl.ps"> <title>PostScript document creation</title> @@ -1022,23 +1022,24 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>ps_hyphenate</function></funcdef> + <funcdef>array <function>ps_hyphenate</function></funcdef> <paramdef>resource <parameter>psdoc</parameter></paramdef> <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>string <parameter>*hyphens</parameter></paramdef> </funcprototype> </funcsynopsis> <para>Hyphenates the passed word. <parameter>text</parameter> should not contain any non alpha characters. Possible positions for breaks are - returned in <parameter>hyphens</parameter>.</para> + returned in an array of interger numbers. Each number is the + position of the char in <parameter>text</parameter> after which + a hyphenation can take place.</para> <para>This function requires the locale category LC_CTYPE to be set propperly. This is done when the extension is initialized by using the - enviroment variables. + enviroment variables. On Unix systems read the man page of locale. </para> <para>ps_hyphenate() evaluates the value hyphenminchars and the parameter - hyphendict.</para> + hyphendict. hyphendict must be set before calling this function.</para> </refsect1> <refsect1>