From 627cff89cd6378d549cdc03402d37fb1a5ba9b11 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Tue, 6 Jul 2004 12:32:39 +0000
Subject: [PATCH] adding documentation and examples for strpbrk

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@162746 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/strings/functions/strpbrk.xml | 32 ++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

diff --git a/reference/strings/functions/strpbrk.xml b/reference/strings/functions/strpbrk.xml
index 3d0737372f..9ec4e8aa7f 100755
--- a/reference/strings/functions/strpbrk.xml
+++ b/reference/strings/functions/strpbrk.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
   <refentry id="function.strpbrk">
    <refnamediv>
     <refname>strpbrk</refname>
@@ -10,13 +10,39 @@
    <refsect1>
     <title>Description</title>
     <methodsynopsis>
-     <type>array</type><methodname>strpbrk</methodname>
+     <type>string</type><methodname>strpbrk</methodname>
      <methodparam><type>string</type><parameter>haystack</parameter></methodparam>
      <methodparam><type>string</type><parameter>char_list</parameter></methodparam>
     </methodsynopsis>
+    <para>
+     <function>strpbrk</function> searches the <parameter>haystack</parameter>
+     string for a <parameter>char_list</parameter>, and returns a string
+     starting from the character found (or &false; if it is not found).
+    </para>
+    <note>
+     <para>
+      The <parameter>char_list</parameter> parameter is case sensitive.
+     </para>
+    </note>
+    <para>
+    <example>
+     <title><function>strpbrk</function> example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
 
-    &warn.undocumented.func;
+$text = 'This is a Simple text.';
 
+// this echoes "is is a Simple text." because 'i' is matched first
+echo strpbrk($text, 'mi');
+
+// this echoes "Simple text." because chars are case sensitive
+echo strpbrk($text, 'S');
+?>
+]]>
+     </programlisting>
+    </example>
+    </para>
    </refsect1>
   </refentry>