Todo tags added to documentation

[shipsimu.git] / inc / classes / main / helper / class_

diff --git a/inc/classes/main/helper/class_ b/inc/classes/main/helper/class_
index 8a1892b8a0b6badcb43a2e6247ef9045befcbf8c..94f912f8cc0e70b8ac7de8bdcb57769037720920 100644 (file)
--- a/inc/classes/main/helper/class_
+++ b/inc/classes/main/helper/class_
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @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
  *
@@ -21,9 +21,9 @@
  * 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  extends BaseHelper {
+class ???Helper extends BaseHelper {
        /**
-        * Private constructor
+        * Protected constructor
         *
         * @return      void
         */
@@ -38,15 +38,25 @@ class  extends BaseHelper {
        /**
         * Creates the helper class
         *
-        * @return      $helperInstance         A preparedf instance of this class
+        * @return      $helperInstance         A prepared instance of this helper
         */
-       public final static function createHelper () {
+       public final static function create???Helper () {
                // Get new instance
-               $helperInstance = new Helper();
+               $helperInstance = new ???Helper();
 
                // Return the prepared instance
                return $helperInstance;
        }
+
+       /**
+        * Flush the content out,e g. to a template variable
+        *
+        * @return      void
+        * @todo        0% done
+        */
+       public function flushContent () {
+               $this->partialStub("Please implement this method.");
+       }
 }
 
 // [EOF]