provide api hints

bovigo · Jan 14, 2012 · 6007e9e · 6007e9e
1 parent 747c36d
commit 6007e9e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 1 deletion.
diff --git a/src/main/php/org/bovigo/vfs/vfsStream.php b/src/main/php/org/bovigo/vfs/vfsStream.php
@@ -11,6 +11,8 @@
 use org\bovigo\vfs\visitor\vfsStreamVisitor;
 /**
  * Some utility methods for vfsStream.
+ *
+ * @api
  */
 class vfsStream
 {
@@ -120,6 +122,7 @@ public static function umask($umask = null)
      * )
      * </code>
      * the resulting directory tree will look like this:
+     * <pre>
      * root
      * \- Core
      *  |- badlocation.php
@@ -128,6 +131,7 @@ public static function umask($umask = null)
      *  | |- other.php
      *  | \- Invalid.csv
      *  \- AnEmptyFolder
+     * </pre>
      * Arrays will become directories with their key as directory name, and
      * strings becomes files with their key as file name and their value as file
      * content.
@@ -161,6 +165,7 @@ public static function setup($rootDirName = 'root', $permissions = null, array $
      * )
      * </code>
      * the resulting directory tree will look like this:
+     * <pre>
      * baseDir
      * \- Core
      *  |- badlocation.php
@@ -169,6 +174,7 @@ public static function setup($rootDirName = 'root', $permissions = null, array $
      *  | |- other.php
      *  | \- Invalid.csv
      *  \- AnEmptyFolder
+     * </pre>
      * Arrays will become directories with their key as directory name, and
      * strings becomes files with their key as file name and their value as file
      * content.

diff --git a/src/main/php/org/bovigo/vfs/vfsStreamDirectory.php b/src/main/php/org/bovigo/vfs/vfsStreamDirectory.php
@@ -10,6 +10,8 @@
 namespace org\bovigo\vfs;
 /**
  * Directory container.
+ *
+ * @api
  */
 class vfsStreamDirectory extends vfsStreamAbstractContent implements vfsStreamContainer
 {

diff --git a/src/main/php/org/bovigo/vfs/vfsStreamException.php b/src/main/php/org/bovigo/vfs/vfsStreamException.php
@@ -9,7 +9,9 @@
  */
 namespace org\bovigo\vfs;
 /**
- * Exception for streamwrapper subpackage.
+ * Exception for vfsStream errors.
+ *
+ * @api
  */
 class vfsStreamException extends \Exception
 {

diff --git a/src/main/php/org/bovigo/vfs/vfsStreamFile.php b/src/main/php/org/bovigo/vfs/vfsStreamFile.php
@@ -10,6 +10,8 @@
 namespace org\bovigo\vfs;
 /**
  * File container.
+ *
+ * @api
  */
 class vfsStreamFile extends vfsStreamAbstractContent
 {