final added, code clean-ups

[shipsimu.git] / application / ship-simu / main / structures / extended / class_BaseDeckStructure.php

diff --git a/application/ship-simu/main/structures/extended/class_BaseDeckStructure.php b/application/ship-simu/main/structures/extended/class_BaseDeckStructure.php
index 1b225caa08b770f7da99bd735f4375a8eb202d84..e9476731a0248a7e88917e7618dd7e82744e4288 100644 (file)
--- a/application/ship-simu/main/structures/extended/class_BaseDeckStructure.php
+++ b/application/ship-simu/main/structures/extended/class_BaseDeckStructure.php
@@ -1,12 +1,33 @@
 <?php
-// Decks (fuer Cargo) allgemein
+/**
+ * A general deck structure class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 class BaseDeckStructure extends BaseStructure {
        // Anzahl Decks
        private $numDecks = 0;
 
        // Konstruktor
        private function __construct ($class) {
-               // Eltern-Konstruktor aufrufen
+               // Call parent constructor
                parent::constructor($class);
 
                // Debug message
@@ -17,11 +38,16 @@ class BaseDeckStructure extends BaseStructure {
                        ));
                }
 
-               // Beschreibung setzen
+               // Set description
                $this->setPartDescr("Deckstruktur");
        }
 
-       // Konstruktor aufrufen
+       /**
+        * Calls the private constructor
+        *
+        * @param       $class  The class' name
+        * @return      void
+        */
        public function constructor ($class) {
                $this->__construct($class);
        }
@@ -51,7 +77,7 @@ class BaseDeckStructure extends BaseStructure {
        }
 
        // Deckanzahl entfernen
-       public function removeNumDecks() {
+       public final function removeNumDecks() {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Decks wurde gel&ouml;scht.<br />\n",
                        __CLASS__,
                        __LINE__
@@ -60,12 +86,12 @@ class BaseDeckStructure extends BaseStructure {
        }
 
        // Setter-Methode fuer Anzahl Decks
-       public function setNumDecks($numDecks) {
+       public final function setNumDecks($numDecks) {
                $this->numDecks = (int) $numDecks;
        }
 
        // Getter-Methode fuer Anzahl Decks
-       public function getNumDecks() {
+       public final function getNumDecks() {
                return $this->numDecks;
        }
 }