code comments including license information added, type hints added, minor rewrites...

[shipsimu.git] / application / ship-simu / main / constructions / yards / class_Shipyard.php

diff --git a/application/ship-simu/main/constructions/yards/class_Shipyard.php b/application/ship-simu/main/constructions/yards/class_Shipyard.php
index fa2dde0391f2ece5cc163ff6dde1da98f43d942e..050f0d71bdf6a3ca9b1b86ba0413333ef7a373ec 100644 (file)
--- a/application/ship-simu/main/constructions/yards/class_Shipyard.php
+++ b/application/ship-simu/main/constructions/yards/class_Shipyard.php
@@ -1,6 +1,27 @@
 <?php
-
-// Die Werft-Klasse
+/**
+ * A shipyard construction class which can be used for constructing all kinds of
+ * ships.
+ *
+ * @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 Shipyard extends BaseConstruction {
        // Werft-Name
        private $shipyardName    = "Namenlose Werft";
@@ -86,7 +107,7 @@ class Shipyard extends BaseConstruction {
                $shipyardInstance->setHeight(30);
                $shipyardInstance->setLength(100);
 
-               // Etwas aufraeumen
+               // Clean up a little
                $shipyardInstance->removeDraught();
                $shipyardInstance->removeSystemArray();
 
@@ -122,32 +143,32 @@ class Shipyard extends BaseConstruction {
        }
 
        // Setter-Methode fuer Werft-Name
-       public function setShipyardName ($shipyardName) {
+       public final function setShipyardName ($shipyardName) {
                $this->shipyardName = (string) $shipyardName;
        }
 
        // Getter-Methode fuer Werft-Name
-       public function getShipyardName () {
+       public final function getShipyardName () {
                return $this->shipyardName;
        }
 
        // Setter-Methode fuer Hafen-Instanz
-       public function setHarborInstance (Harbor $harborInstance) {
+       public final function setHarborInstance (Harbor $harborInstance) {
                $this->harborInstance = $harborInstance;
        }
 
        // Getter-Methode fuer Hafen-Instanz
-       public function getHarborInstance () {
+       public final function getHarborInstance () {
                return $this->harborInstance;
        }
 
        // Setter fuer Reederei-Instanz
-       public function setCompanyInstance (ShippingCompany $companyInstance) {
+       public final function setCompanyInstance (ShippingCompany $companyInstance) {
                $this->shippingCompany = $companyInstance;
        }
 
        // Getter fuer Reederei-Instanz
-       public function getCompanyInstance () {
+       public final function getCompanyInstance () {
                return $this->shippingCompany;
        }