doc update + marked some classes as @api

michael-donat · May 12, 2014 · 5748e91 · 5748e91
1 parent 64cec4d
commit 5748e91
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/src/VirtualFileSystem/Container.php b/src/VirtualFileSystem/Container.php
@@ -23,6 +23,7 @@
  *
  * @author Michael Donat <michael.donat@me.com>
  * @package php-vfs
+ * @api
  */
 class Container
 {

diff --git 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
@@ -24,6 +24,7 @@
  *
  * @author Michael Donat <michael.donat@me.com>
  * @package php-vfs
+ * @api
  */
 class Wrapper
 {

diff --git a/src/VirtualFileSystem/Wrapper/PermissionHelper.php b/src/VirtualFileSystem/Wrapper/PermissionHelper.php
@@ -1,9 +1,24 @@
 <?php
+/*
+ * This file is part of the php-vfs package.
+ *
+ * (c) Michael Donat <michael.donat@me.com>
+ *
+ * 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 <michael.donat@me.com>
+ * @package php-vfs
+ * @api
+ */
 class PermissionHelper
 {
     const MODE_USER_READ = 0400;