ChapterThree: Add business descriptions

Author: Codeliner

module/Application/src/Application/Domain/Model/Cargo/Itinerary.php

@@ -14,6 +14,10 @@
 
 /**
  *  Itinerary
+ *
+ * The Itinerary is a ValueObject that describes a route of a cargo.
+ * It is composed of one or more Legs.
+ * Each Leg describes a part of the entire route, f.e. from one port to another.
  * 
  * @author Alexander Miertsch <[email protected]>
  */

module/Application/src/Application/Domain/Model/Cargo/Leg.php

@@ -14,6 +14,8 @@
 
 /**
  * Class Leg
+ *
+ * A Leg is part of an Itinerary. It describes a voyage from one location to another, with concrete load und unload times.
  * 
  * @author Alexander Miertsch <[email protected]>
  */
@@ -40,7 +42,7 @@ class Leg implements ValueObjectInterface
     private $unloadTime;
 
     /**
-    * @param string    $aLoadLocation
+     * @param string    $aLoadLocation
      * @param string    $anUnloadLocation
      * @param \DateTime $aLoadTime
      * @param \DateTime $anUnloadTime
@@ -54,7 +56,6 @@ public function __construct($aLoadLocation,
         $this->unloadLocation = $anUnloadLocation;
         $this->loadTime       = $aLoadTime;
         $this->unloadTime     = $anUnloadTime;
-
     }
 
     /**

module/Application/src/Application/Domain/Model/Cargo/RouteSpecification.php

@@ -13,6 +13,8 @@
 
 /**
  *  RouteSpecification
+ *
+ * Describes where a cargo origin and destination is.
  * 
  * @author Alexander Miertsch <[email protected]>
  */

module/Application/src/Application/Service/RoutingService.php

@@ -19,6 +19,9 @@
 /**
  * Class RoutingService
  *
+ * The RoutingService takes a RouteSpecification, that describes the start location and the end location of a cargo
+ * and fetches compatible routes that are described by Itineraries.
+ *
  * @package Application\Service
  * @author Alexander Miertsch <[email protected]>
  */