add doc comment

bovigo · Nov 30, 2014 · 22e0444 · 22e0444
1 parent ec24fe6
commit 22e0444
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/main/php/org/bovigo/vfs/vfsStreamWrapper.php b/src/main/php/org/bovigo/vfs/vfsStreamWrapper.php
@@ -978,6 +978,16 @@ public function url_stat($path, $flags)
         return array_merge(array_values($fileStat), $fileStat);
     }
 
+    /**
+     * returns target of a link
+     *
+     * In case the target does not exist an E_USER_WARNING is triggered. Also,
+     * if the target is not a link an E_USER_WARNING is triggered.
+     *
+     * @param   string  $path  path of url to return status for
+     * @return  bool|string
+     * @since   1.?.0
+     */
     public function url_readlink($path)
     {
         $content = $this->getContent($this->resolvePath(vfsStream::path($path)));