Document SplFileInfo::getPath

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269047 c90b9560-bf6c-de11-be94-00142212c4b1

reference/spl/splfileinfo/getpath.xml

@@ -1,20 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="splfileinfo.getpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SplFileInfo::getPath</refname>
-  <refpurpose>The getPath purpose</refpurpose>
+  <refpurpose>Get the path to the file</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getPath</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>SplFileInfo::getPath</methodname>
    <void />
   </methodsynopsis>
   <para>
-   The method description goes here.
+   Returns the path to the file, omitting the filename and any trailing slash.
   </para>
  </refsect1>
 
@@ -26,7 +26,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   Returns the path to the file.
   </para>
  </refsect1>
 
@@ -38,14 +38,19 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-/* ... */
-?>
+$info = new SplFileInfo('/usr/bin/php');
+var_dump($info->getPath());
+
+
+$info = new SplFileInfo('/usr/');
+var_dump($info->getPath());?>
 ]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
 <![CDATA[
-...
+string(8) "/usr/bin"
+string(4) "/usr"
 ]]>
     </screen>
    </example>
@@ -56,7 +61,9 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>SplFileInfo::getRealPath</methodname></member>
+    <member><methodname>SplFileInfo::getFilename</methodname></member>
+    <member><methodname>SplFileInfo::getPathInfo</methodname></member>
    </simplelist>
   </para>
  </refsect1>