* 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...