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

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

diff --git a/application/ship-simu/main/constructions/class_BaseConstruction.php b/application/ship-simu/main/constructions/class_BaseConstruction.php
index 014d27853b91989848a845a65fbe04847fdf491b..287430201e4a2276ac03676e04100045bda86959 100644 (file)
--- a/application/ship-simu/main/constructions/class_BaseConstruction.php
+++ b/application/ship-simu/main/constructions/class_BaseConstruction.php
@@ -1,5 +1,26 @@
 <?php
-// Die abstrakte Bauten-Klasse
+/**
+ * A general construction (land) 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 BaseConstruction extends BaseSimulator {
        // Tiefgang fuer z.B. Trockdocks
        private $draught = 0;
@@ -17,11 +38,16 @@ class BaseConstruction extends BaseSimulator {
                // Set description
                $this->setPartDescr("Namenlose Landkonstruktion");
 
-               // Etwas aufraeumen (brauchen wir hier nicht)
+               // Clean up a little
                $this->removeNumberFormaters();
        }
 
-       // Konstruktor aufrufen
+       /**
+        * Calls the private constructor
+        *
+        * @param       $class  The class' name
+        * @return      void
+        */
        public function constructor ($class) {
                $this->__construct($class);
        }