xoco70 / laravel-tournaments

src/TreeGen/PlayOffTreeGen.php

Doc Comments +4 added lines, -1 removed lines

@@ -29,7 +29,7 @@ 
      *
      * @param $fightersByEntity
      *
-     * @return mixed
+     * @return Collection
      */
     protected function chunk(Collection $fightersByEntity)
     {
@@ -103,6 +103,9 @@ 
         $this->generateGroupsForRound($fighters, 1);
     }
 
+    /**
+     * @param integer $round
+     */
     protected function generateGroupsForRound(Collection $fightersByArea, $round)
     {
         $fightersId = $fightersByArea->pluck('id');

src/TreeGen/SingleEliminationTreeGen.php

Doc Comments +8 added lines, -7 removed lines

@@ -59,7 +59,7 @@ 
     /**
      * Create empty groups after round 1.
      *
-     * @param $numFighters
+     * @param integer $numFighters
      */
     protected function pushEmptyGroupsToTree($numFighters)
     {
@@ -162,7 +162,7 @@ 
 
     /**
      * @param Collection $usersByArea
-     * @param $round
+     * @param integer $round
      */
     public function generateGroupsForRound(Collection $usersByArea, $round)
     {
@@ -249,10 +249,11 @@ 
     }
 
     /**
-     * @param $frequency
+     * @param integer $frequency
      * @param $groupSize
-     * @param $count
-     * @param $byeCount
+     * @param integer $count
+     * @param integer $byeCount
+     * @param integer $numByeTotal
      *
      * @return bool
      */
@@ -293,7 +294,7 @@ 
     /**
      * Get the biggest entity group.
      *
-     * @param $userGroups
+     * @param Collection $userGroups
      *
      * @return int
      */
@@ -311,7 +312,7 @@ 
     /**
      * Repart BYE in the tree,.
      *
-     * @param $fighterGroups
+     * @param Collection $fighterGroups
      * @param int $max
      *
      * @return Collection

src/TournamentsServiceProvider.php

Doc Comments -1 removed lines

@@ -10,7 +10,6 @@
     /**
      * Bootstrap the application services.
      *
-     * @param Router $router
      *
      * @return void
      */

src/TreeGen/TreeGen.php

Doc Comments +5 added lines, -2 removed lines

@@ -21,6 +21,9 @@ 
 
     abstract protected function generateFights();
 
+    /**
+     * @param string|null $fighterToUpdate
+     */
     abstract protected function addFighterToGroup(FightersGroup $group, $fighter, $fighterToUpdate);
 
     abstract protected function getByeGroup($fighters);
@@ -82,7 +85,7 @@ 
      * Get the size the first round will have.
      *
      * @param $fighterCount
-     * @param $groupSize
+     * @param integer $groupSize
      *
      * @return int
      */
@@ -200,7 +203,7 @@ 
     /**
      * Logically build the tree ( attach a parent to every child for nestedSet Navigation ).
      *
-     * @param $numFighters
+     * @param integer $numFighters
      */
     protected function addParentToChildren($numFighters)
     {