From d10638843fbcea7771761fbf1d382017f44ec5e0 Mon Sep 17 00:00:00 2001
From: Brett Bieber <saltybeagle@php.net>
Date: Sat, 15 Nov 2008 14:08:06 +0000
Subject: [PATCH] Document SplFileInfo::getPathInfo

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269049 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/splfileinfo/getpathinfo.xml | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/reference/spl/splfileinfo/getpathinfo.xml b/reference/spl/splfileinfo/getpathinfo.xml
index f78c8e59be..3369e0fac1 100644
--- a/reference/spl/splfileinfo/getpathinfo.xml
+++ b/reference/spl/splfileinfo/getpathinfo.xml
@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="splfileinfo.getpathinfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SplFileInfo::getPathInfo</refname>
-  <refpurpose>The getPathInfo purpose</refpurpose>
+  <refpurpose>Get an SplFileInfo object for the path</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPathInfo</methodname>
+   <modifier>public</modifier> <type>SplFileInfo</type><methodname>SplFileInfo::getPathInfo</methodname>
    <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
   </methodsynopsis>
   <para>
-   The method description goes here.
+   Gets an <classname>SplFileInfo</classname> object for the parent of the current file.
   </para>
  </refsect1>
 
@@ -26,7 +26,7 @@
      <term><parameter>class_name</parameter></term>
      <listitem>
       <para>
-       Description...
+       Name of an <classname>SplFileInfo</classname> derived class to use.
       </para>
      </listitem>
     </varlistentry>
@@ -38,7 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   Returns an <classname>SplFileInfo</classname> object for the parent path of the file.
   </para>
  </refsect1>
 
@@ -50,14 +50,16 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-/* ... */
+$info = new SplFileInfo('/usr/bin/php');
+$parent_info = $info->getPathInfo();
+var_dump($parent_info->getRealPath());
 ?>
 ]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
 <![CDATA[
-...
+string(8) "/usr/bin"
 ]]>
     </screen>
    </example>
@@ -68,7 +70,7 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>SplFileInfo::setInfoClass</methodname></member>
    </simplelist>
   </para>
  </refsect1>