Misc fixes/code cleanups

[core.git] / inc / classes / main / io / class_FrameworkDirectoryPointer.php

diff --git a/inc/classes/main/io/class_FrameworkDirectoryPointer.php b/inc/classes/main/io/class_FrameworkDirectoryPointer.php
index e0a0c4e5bfcae51f016229ba1e1d758302787ad7..d6249dbb72c1585c2ef33f0030273123a3e2daa2 100644 (file)
--- a/inc/classes/main/io/class_FrameworkDirectoryPointer.php
+++ b/inc/classes/main/io/class_FrameworkDirectoryPointer.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -62,22 +62,21 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
         * Create a directory pointer based on the given path. The path will also
         * be verified here.
         *
-        * @param               $pathName                                       The path name we shall pass
-        *                                                                      to opendir()
-        * @param               $inConstructor                          If we are in de/con-structor
-        *                                                                      or from somewhere else
-        * @throws      PathIsEmptyException            If the provided path name
+        * @param       $pathName               The path name we shall pass to opendir()
+        * @param       $inConstructor  If we are in de/con-structor or from somewhere
+        *                                                      else
+        * @return      $pointerInstance        A prepared instance of
+        *                                                              FrameworkDirectoryPointer
+        * @throws      PathIsEmptyException    If the provided path name
         *                                                                      is empty
         * @throws      InvalidPathStringException      If the provided path name is
-        *                                                                      not a string
+        *                                                                              not a string
         * @throws      PathIsNoDirectoryException      If the provided path name is
-        *                                                                      not valid
+        *                                                                              not valid
         * @throws      PathReadProtectedException      If the provided path name is
-        *                                                                      read-protected
+        *                                                                              read-protected
         * @throws      DirPointerNotOpened                     If opendir() returns not a
-        *                                                                      directory resource
-        * @return      $pointerInstance                        A prepared instance of
-        *                                                                      FrameworkDirectoryPointer
+        *                                                                              directory resource
         */
        public final static function createFrameworkDirectoryPointer ($pathName, $inConstructor = false) {
                // Some pre-sanity checks...