From f57ff3646c6390b418a694f6aee8337ffee28501 Mon Sep 17 00:00:00 2001
From: Brett Bieber <saltybeagle@php.net>
Date: Sat, 15 Nov 2008 01:02:20 +0000
Subject: [PATCH] Document SplFileInfo::getLinkTarget

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269039 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/splfileinfo/getlinktarget.xml | 35 ++++++++++++++++-----
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/reference/spl/splfileinfo/getlinktarget.xml b/reference/spl/splfileinfo/getlinktarget.xml
index ea93c98630..776a3359c8 100644
--- a/reference/spl/splfileinfo/getlinktarget.xml
+++ b/reference/spl/splfileinfo/getlinktarget.xml
@@ -1,21 +1,27 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="splfileinfo.getlinktarget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SplFileInfo::getLinkTarget</refname>
-  <refpurpose>The getLinkTarget purpose</refpurpose>
+  <refpurpose>Get the target of a link</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>SplFileInfo::getLinkTarget</methodname>
+   <modifier>public</modifier> <type>string</type><methodname>SplFileInfo::getLinkTarget</methodname>
    <void />
   </methodsynopsis>
   <para>
-   The method description goes here.
+   Get the target of a filesystem link.
   </para>
+  <note>
+   <para>
+    The target may not be the real path on the filesystem. Use <methodname>SplFileInfo::getRealPath</methodname>
+    to determine the true path on the filesystem.
+   </para>
+  </note>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -26,7 +32,14 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   Returns the target of the filesystem link.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws RuntimeException on error.
   </para>
  </refsect1>
 
@@ -38,14 +51,19 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-/* ... */
+$info = new SplFileInfo('/Users/bbieber/workspace');
+if ($info->isLink()) {
+    var_dump($info->getLinkTarget());
+    var_dump($info->getRealPath());
+}
 ?>
 ]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
 <![CDATA[
-...
+string(19) "Documents/workspace"
+string(34) "/Users/bbieber/Documents/workspace"
 ]]>
     </screen>
    </example>
@@ -56,7 +74,8 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>SplFileInfo::isLink</methodname></member>
+    <member><methodname>SplFileInfo::getRealPath</methodname></member>
    </simplelist>
   </para>
  </refsect1>