Minor code improvements:

[shipsimu.git] / inc / classes / main / io / class_FrameworkFileInputPointer.php

diff --git a/inc/classes/main/io/class_FrameworkFileInputPointer.php b/inc/classes/main/io/class_FrameworkFileInputPointer.php
index 0e070be17fc46d2e8e5c530706ee6a8a215acc54..4cefaaf34d222bbbdba43e81e885890d14526001 100644 (file)
--- a/inc/classes/main/io/class_FrameworkFileInputPointer.php
+++ b/inc/classes/main/io/class_FrameworkFileInputPointer.php
@@ -34,6 +34,8 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
 
        /**
         * Protected constructor
+        *
+        * @return      void
         */
        protected function __construct () {
                // Call parent constructor
@@ -51,6 +53,8 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
 
        /**
         * Destructor for cleaning purposes, etc
+        *
+        * @return      void
         */
        public final function __destruct() {
                // Is there a resource pointer? Then we have to close the file here!
@@ -67,11 +71,10 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         * Create a file pointer based on the given file. The file will also
         * be verified here.
         *
-        * @param               $fileName                               The file name we shall pass
-        *                                                              to fopen()
+        * @param               $fileName       The file name we shall pass to fopen()
         * @throws      FileIsEmptyException    If the provided file name is empty.
-        * @throws      FilePointerNotOpenedException           If fopen() returns not a
-        *                                                                              file resource
+        * @throws      FilePointerNotOpenedException   If fopen() returns not a
+        *                                                                                      file resource
         * @return      void
         */
        public final static function createFrameworkFileInputPointer ($fileName) {
@@ -110,7 +113,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         *
         * @return      mixed   The result of fread()
         * @throws      NullPointerException    If the file pointer instance
-        *                                                              is not set by setPointer()
+        *                                                                      is not set by setPointer()
         * @throws      InvalidFileResourceException    If there is being set
         *                                                                      an invalid file resource
         */
@@ -132,7 +135,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         *
         * @return      mixed   The result of fread()
         * @throws      NullPointerException    If the file pointer instance
-        *                                                              is not set by setPointer()
+        *                                                                      is not set by setPointer()
         * @throws      InvalidFileResourceException    If there is being set
         *                                                                      an invalid file resource
         */
@@ -155,7 +158,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         *
         * @return      void
         * @throws      NullPointerException    If the file pointer instance
-        *                                                              is not set by setPointer()
+        *                                                                      is not set by setPointer()
         * @throws      InvalidFileResourceException    If there is being set
         */
        public function closeFile () {
@@ -176,7 +179,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
        /**
         * Setter for the file pointer
         *
-        * @param               $filePointer    File resource
+        * @param       $filePointer    File resource
         * @return      void
         */
        public final function setPointer ($filePointer) {
@@ -194,7 +197,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         * Getter for the file pointer
         *
         * @return      $filePointer    The file pointer which shall be a valid
-        *                                              file resource
+        *                                                      file resource
         */
        public final function getPointer () {
                return $this->filePointer;
@@ -203,7 +206,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
        /**
         * Setter for file name
         *
-        * @param               $fileName               The new file name
+        * @param       $fileName       The new file name
         * @return      void
         */
        public final function setFileName ($fileName) {
@@ -214,7 +217,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
        /**
         * Getter for file name
         *
-        * @return      $fileName               The current file name
+        * @return      $fileName       The current file name
         */
        public final function getFileName () {
                return $this->fileName;