Todo tags added to documentation

diff --git a/application/ship-simu/main/commands/web/class_WebMoneyRefillFormCommand.php b/application/ship-simu/main/commands/web/class_WebMoneyRefillFormCommand.php
index dc25f257a1195263cda459fb994fdb541e4b0289..9039d56e8718b2f9241d564f62c0ef543c84f8a7 100644 (file)
--- a/application/ship-simu/main/commands/web/class_WebMoneyRefillFormCommand.php
+++ b/application/ship-simu/main/commands/web/class_WebMoneyRefillFormCommand.php
@@ -59,6 +59,7 @@ class WebMoneyRefillFormCommand extends BaseCommand implements Commandable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void

+        * @todo        0% done

         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");

diff --git a/application/ship-simu/main/companies/class_ShippingCompany.php b/application/ship-simu/main/companies/class_ShippingCompany.php
index 7a00527ffa33504c8600a871aca9d3e59df05ea1..362a801bb51ad331d397b84e2c671d62c3b6cfb9 100644 (file)
--- a/application/ship-simu/main/companies/class_ShippingCompany.php
+++ b/application/ship-simu/main/companies/class_ShippingCompany.php
@@ -81,6 +81,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         *
         * @param       $userInstance           A user class
         * @return      $companyInstance        Prepared company instance
         *
         * @param       $userInstance           A user class
         * @return      $companyInstance        Prepared company instance

+        * @todo        Add functionality if user participates in a company

         */
        public final static function createShippingCompany (ManageableAccount $userInstance) {
                // Get new instance
         */
        public final static function createShippingCompany (ManageableAccount $userInstance) {
                // Get new instance


@@ -133,6 +134,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * Checks wether the current user in registry is the company founder
         *
         * @return      $isFounder      Wether the current user is the company founder
         * Checks wether the current user in registry is the company founder
         *
         * @return      $isFounder      Wether the current user is the company founder

+        * @todo        Check if user is company founder

         */
        public function ifUserIsFounder () {
                // Default is not the founder
         */
        public function ifUserIsFounder () {
                // Default is not the founder


@@ -155,6 +157,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * Checks wether the current user in registry is the company owner
         *
         * @return      $isOwner        Wether the current user is the company owner
         * Checks wether the current user in registry is the company owner
         *
         * @return      $isOwner        Wether the current user is the company owner

+        * @todo        Check if user is company owner

         */
        public function ifUserIsOwner () {
                // Default is not the owner
         */
        public function ifUserIsOwner () {
                // Default is not the owner

diff --git a/application/ship-simu/main/filter/class_MoneyRefillRequestValidatorFilter.php b/application/ship-simu/main/filter/class_MoneyRefillRequestValidatorFilter.php
index cea1ba66cab27aacb063a7e0cc68fcb27dcda4c0..38309383a9b05e71033748a6d67f06d6e6f6cd3b 100644 (file)
--- a/application/ship-simu/main/filter/class_MoneyRefillRequestValidatorFilter.php
+++ b/application/ship-simu/main/filter/class_MoneyRefillRequestValidatorFilter.php
@@ -55,6 +55,7 @@ class MoneyRefillRequestValidatorFilter extends BaseFrameworkSystem implements F
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void

+        * @todo        0% done

         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");

diff --git a/application/ship-simu/main/personell/class_SimulatorPersonell.php b/application/ship-simu/main/personell/class_SimulatorPersonell.php
index 1569708a897b6e3dd97bb4bf5b4ba71fc0a5c606..6c1e08407835b26f42d0a0f8a83356dcd2499706 100644 (file)
--- a/application/ship-simu/main/personell/class_SimulatorPersonell.php
+++ b/application/ship-simu/main/personell/class_SimulatorPersonell.php
@@ -365,6 +365,7 @@ class SimulatorPersonell extends BasePersonell {
         * @throws      ContainerMaybeDamagedException  If the container item
         *                                                                                      is missing the indexes
         *                                                                                      'name' and/or 'value'
         * @throws      ContainerMaybeDamagedException  If the container item
         *                                                                                      is missing the indexes
         *                                                                                      'name' and/or 'value'

+        * @deprecated

         */
        public function loadPersonellList ($idNumber) {
                // Cleared because old code
         */
        public function loadPersonellList ($idNumber) {
                // Cleared because old code

diff --git a/application/ship-simu/main/user/extended/class_ShipSimuMember.php b/application/ship-simu/main/user/extended/class_ShipSimuMember.php
index a44718c393345b6146ba0bc85ff8e8dac76d88dd..acbdb62e70dea3479889e584256ba22dd740fd8e 100644 (file)
--- a/application/ship-simu/main/user/extended/class_ShipSimuMember.php
+++ b/application/ship-simu/main/user/extended/class_ShipSimuMember.php
@@ -95,6 +95,7 @@ class ShipSimuMember extends ShipSimuBaseUser implements ManageableMember {
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class

+        * @todo        Add more ways of creating user instances

         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username
         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username

diff --git a/inc/classes/main/actions/class_ b/inc/classes/main/actions/class_
index a34ccda2683cb856efe69cc1758a1251c78cce17..90ff323406172d5a1bc43376612b7721af007153 100644 (file)
--- a/inc/classes/main/actions/class_
+++ b/inc/classes/main/actions/class_
@@ -51,6 +51,7 @@ class ???Action extends BaseAction implements Commandable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void

+        * @todo        0% done

         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("You have to implement me.");
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("You have to implement me.");

diff --git a/inc/classes/main/filter/class_ b/inc/classes/main/filter/class_
index 9027c5d1858caef511146b44342092b26c8d8e69..4aff5132a1362edf52e2e151f0fd68a69f8bbd4b 100644 (file)
--- a/inc/classes/main/filter/class_
+++ b/inc/classes/main/filter/class_
@@ -55,6 +55,7 @@ class ???Filter extends BaseFrameworkSystem implements Filterable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void

+        * @todo        0% done

         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                // Implement this!
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                // Implement this!

diff --git a/inc/classes/main/helper/captcha/class_ b/inc/classes/main/helper/captcha/class_
index 758b205654be953a29596e013bd46751e9a04c29..5dca7ba2f953b490da07a16c1f720041b7d82fc1 100644 (file)
--- a/inc/classes/main/helper/captcha/class_
+++ b/inc/classes/main/helper/captcha/class_
@@ -57,6 +57,7 @@ class ???Captcha extends BaseCaptcha implements SolveableCaptcha {
         * Initiates the CAPTCHA
         *
         * @return      void
         * Initiates the CAPTCHA
         *
         * @return      void

+        * @todo        0% done

         */
        public function initiateCaptcha () {
                $this->partialStub("Please implement this method.");
         */
        public function initiateCaptcha () {
                $this->partialStub("Please implement this method.");


@@ -66,6 +67,7 @@ class ???Captcha extends BaseCaptcha implements SolveableCaptcha {
         * Render the CAPTCHA code
         *
         * @return      void
         * Render the CAPTCHA code
         *
         * @return      void

+        * @todo        0% done

         */
        public function renderCode () {
                $this->partialStub("Please implement this method.");
         */
        public function renderCode () {
                $this->partialStub("Please implement this method.");

diff --git a/inc/classes/main/helper/class_ b/inc/classes/main/helper/class_
index ba6cb0ee12d297f9b82096d9bb680c7a6c402e59..94f912f8cc0e70b8ac7de8bdcb57769037720920 100644 (file)
--- a/inc/classes/main/helper/class_
+++ b/inc/classes/main/helper/class_
@@ -52,6 +52,7 @@ class ???Helper extends BaseHelper {
         * Flush the content out,e g. to a template variable
         *
         * @return      void
         * Flush the content out,e g. to a template variable
         *
         * @return      void

+        * @todo        0% done

         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");
         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");

diff --git a/inc/classes/main/helper/web/class_ b/inc/classes/main/helper/web/class_
index 7c61ec83221a4dd2724056347c912287dd042da7..635066acfcfeea2fb1dc9d2f404346378d54025e 100644 (file)
--- a/inc/classes/main/helper/web/class_
+++ b/inc/classes/main/helper/web/class_
@@ -65,6 +65,7 @@ class Web???Helper extends BaseWebHelper implements HelpableTemplate {
         * Flush the content out,e g. to a template variable
         *
         * @return      void
         * Flush the content out,e g. to a template variable
         *
         * @return      void

+        * @todo        0% done

         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");
         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");

diff --git a/inc/classes/main/mailer/class_ b/inc/classes/main/mailer/class_
index b3181c54a00df763c9c0a91356bd6bc7b0b2208a..5cf368f875b9e98413cba0964cdb7e6557a35b1c 100644 (file)
--- a/inc/classes/main/mailer/class_
+++ b/inc/classes/main/mailer/class_
@@ -49,6 +49,7 @@ class ???Mailer extends BaseMailer implements DeliverableMail {
         * Deliver email to the recipient(s)
         *
         * @return      void
         * Deliver email to the recipient(s)
         *
         * @return      void

+        * @todo        0% done

         */
        public function deliverEmail() {
                $this->partialStub("You have to implement this method.");
         */
        public function deliverEmail() {
                $this->partialStub("You have to implement this method.");


@@ -58,6 +59,7 @@ class ???Mailer extends BaseMailer implements DeliverableMail {
         * Send notification to the admin
         *
         * @return      void
         * Send notification to the admin
         *
         * @return      void

+        * @todo        0% done

         */
        public function sendAdminNotification() {
                $this->partialStub("You have to implement this method.");
         */
        public function sendAdminNotification() {
                $this->partialStub("You have to implement this method.");

diff --git a/inc/classes/main/points/class_UserPoints.php b/inc/classes/main/points/class_UserPoints.php
index 6a9d88f172e03ff9b98df8b7c989b9833cc22264..17c22e2548842fb4eccf3ee72bafe3b68f04cc87 100644 (file)
--- a/inc/classes/main/points/class_UserPoints.php
+++ b/inc/classes/main/points/class_UserPoints.php
@@ -58,6 +58,7 @@ class UserPoints extends BaseFrameworkSystem implements Registerable {
         *
         * @param       $action                 The action or configuration entry plus prefix the user wants to perform
         * @return      $hasRequired    Wether the user has the required points
         *
         * @param       $action                 The action or configuration entry plus prefix the user wants to perform
         * @return      $hasRequired    Wether the user has the required points

+        * @todo        Finish loading part of points

         */
        public function ifUserHasRequiredPoints ($action) {
                // Default is that everyone is poor... ;-)
         */
        public function ifUserHasRequiredPoints ($action) {
                // Default is that everyone is poor... ;-)

diff --git a/inc/classes/main/response/class_ImageResponse.php b/inc/classes/main/response/class_ImageResponse.php
index 2329af7f3931eb038edc2eee04ddc4fcaa709b41..71acb351dd53803c24d3d6006caaa71f12281abc 100644 (file)
--- a/inc/classes/main/response/class_ImageResponse.php
+++ b/inc/classes/main/response/class_ImageResponse.php
@@ -145,6 +145,7 @@ class ImageResponse extends BaseFrameworkSystem implements Responseable {
         * @param       $force  Wether we shall force the output or abort if headers are
         *                                      already sent with an exception
         * @return      void
         * @param       $force  Wether we shall force the output or abort if headers are
         *                                      already sent with an exception
         * @return      void

+        * @todo        Add support for fatal messages in image response

         * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
         *                                                                                                      already sent
         */
         * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
         *                                                                                                      already sent
         */

diff --git a/inc/classes/main/user/member/class_Member.php b/inc/classes/main/user/member/class_Member.php
index cdb98c1b9220add8880531b429f3375176ab8b01..141f1de389c874dbe39fb034a83b4ca55ed1d351 100644 (file)
--- a/inc/classes/main/user/member/class_Member.php
+++ b/inc/classes/main/user/member/class_Member.php
@@ -94,6 +94,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class

+        * @todo        Add more ways over creating user classes

         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username
         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username