From 5748e91dacb2affaa0845da6e30f73729e50ed06 Mon Sep 17 00:00:00 2001 From: Michael Donat Date: Mon, 12 May 2014 10:59:13 +0100 Subject: [PATCH] doc update + marked some classes as @api --- src/VirtualFileSystem/Container.php | 1 + src/VirtualFileSystem/Loader.php | 5 +++++ src/VirtualFileSystem/Wrapper.php | 1 + .../Wrapper/PermissionHelper.php | 15 +++++++++++++++ 4 files changed, 22 insertions(+) diff --git a/src/VirtualFileSystem/Container.php b/src/VirtualFileSystem/Container.php index 803714a..cb7c743 100644 --- a/src/VirtualFileSystem/Container.php +++ b/src/VirtualFileSystem/Container.php @@ -23,6 +23,7 @@ * * @author Michael Donat * @package php-vfs + * @api */ class Container { diff --git a/src/VirtualFileSystem/Loader.php b/src/VirtualFileSystem/Loader.php index e48c45e..1444c29 100644 --- a/src/VirtualFileSystem/Loader.php +++ b/src/VirtualFileSystem/Loader.php @@ -19,6 +19,11 @@ namespace VirtualFileSystem; +/** + * Class Loader to use with PEAR installation + * + * @package VirtualFileSystem + */ class Loader { private $fileExtension = '.php'; diff --git a/src/VirtualFileSystem/Wrapper.php b/src/VirtualFileSystem/Wrapper.php index 09e7e1f..7f372c1 100644 --- a/src/VirtualFileSystem/Wrapper.php +++ b/src/VirtualFileSystem/Wrapper.php @@ -24,6 +24,7 @@ * * @author Michael Donat * @package php-vfs + * @api */ class Wrapper { diff --git a/src/VirtualFileSystem/Wrapper/PermissionHelper.php b/src/VirtualFileSystem/Wrapper/PermissionHelper.php index d68e7a3..9ccace0 100644 --- a/src/VirtualFileSystem/Wrapper/PermissionHelper.php +++ b/src/VirtualFileSystem/Wrapper/PermissionHelper.php @@ -1,9 +1,24 @@ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ namespace VirtualFileSystem\Wrapper; use VirtualFileSystem\Structure\Node; +/** + * Class to encapsulate permission checks + * + * @author Michael Donat + * @package php-vfs + * @api + */ class PermissionHelper { const MODE_USER_READ = 0400;