imanghafoori1 / laravel-microscope

src/Refactors/IfElse.php

Doc Comments +4 added lines

@@ -20,6 +20,10 @@
         }
     }
 
+    /**
+     * @param integer $elseCount
+     * @param integer $ifBody
+     */
     private static function shouldBeFlipped($elseCount, $ifBody)
     {
         $ifIsLonger = ($elseCount + 10) < $ifBody;

src/Analyzers/Refactor.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
         return $stringOutput;
     }
 
+    /**
+     * @param \Closure $refactor
+     */
     private static function recursiveRefactor($tokens, $refactor)
     {
         $i = $changes = 0;

src/Refactors/EarlyReturns.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
         return [$tokens, $changes];
     }
 
+    /**
+     * @return string
+     */
     private static function getKeyword($token)
     {
         return self::scopeKeywords[$token];

src/Commands/CheckRoutes.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
         return 'Error on route '.$msg;
     }
 
+    /**
+     * @param ErrorPrinter $errorPrinter
+     */
     private function checkRouteDefinitions($errorPrinter, $routes)
     {
         foreach ($routes as $route) {

src/Commands/CheckEarlyReturns.php

Doc Comments +6 added lines

@@ -56,6 +56,9 @@ 
         return app(ErrorPrinter::class)->hasErrors() ? 1 : 0;
     }
 
+    /**
+     * @param integer $tries
+     */
     private function fix($filePath, $tokens, $tries)
     {
         Refactor::saveTokens($filePath, $tokens, $this->option('test'));
@@ -73,6 +76,9 @@ 
         return [$fixes, $tokens];
     }
 
+    /**
+     * @param integer $fixed
+     */
     private function printFinalMsg($fixed)
     {
         if ($fixed > 0) {

src/SpyClasses/SpyDispatcher.php

Doc Comments +12 added lines

@@ -59,6 +59,9 @@ 
         return class_exists($eventName, false) ? $this->addOriginInterfaceListeners($eventName, $listeners) : $listeners;
     }
 
+    /**
+     * @param string $string
+     */
     private function error($string)
     {
         $len = strlen($string);
@@ -95,6 +98,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     private function stringify($event)
     {
         return is_object($event) ? get_class($event) : $event;
@@ -116,6 +122,9 @@ 
         return 'The method of '.$at.' is not callable as an event listener for "'.$e.'" event';
     }
 
+    /**
+     * @return string
+     */
     protected function getTypeHintedClass($listenerObj, $methodName)
     {
         try {
@@ -141,6 +150,9 @@ 
         return $listeners;
     }
 
+    /**
+     * @param \Closure $listener
+     */
     private function stringifyClosure($listener)
     {
         try {

src/Commands/PrettyPrintRoutes.php

Doc Comments +19 added lines

@@ -35,6 +35,9 @@ 
         }
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     private function writeIt($route, $filename)
     {
         try {
@@ -57,6 +60,9 @@ 
         }
     }
 
+    /**
+     * @param string $value
+     */
     private function deduceRoute($value)
     {
         if (Str::containsAll($value, ['@', '\\'])) {
@@ -68,6 +74,9 @@ 
         return $route;
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     private function printIt($route)
     {
         try {
@@ -80,6 +89,10 @@ 
         }
     }
 
+    /**
+     * @param string $action
+     * @param string $middlewareSection
+     */
     private function getMovableRoute($route, $methods, $action, $middlewareSection)
     {
         if ($action == '\Illuminate\Routing\ViewController::class') {
@@ -117,6 +130,9 @@ 
         return ($middlewares ? '->middleware(['.$middlewares."])" : '');
     }
 
+    /**
+     * @param Exception $e
+     */
     private function handleRouteProblem($e)
     {
         $this->info('The route has some problem.');
@@ -124,6 +140,9 @@ 
         $this->info($e->getFile());
     }
 
+    /**
+     * @param string $middlewares
+     */
     private function prettyPrintInConsole($route, $middlewares)
     {
         $this->getOutput()->writeln('---------------------------------------------------');

src/CheckNamespaces.php

Doc Comments +11 added lines, -2 removed lines

@@ -17,10 +17,10 @@ 
     /**
      * Get all of the listeners and their corresponding events.
      *
-     * @param  iterable  $paths
+     * @param  \Symfony\Component\Finder\Finder  $paths
      * @param  $composerPath
      * @param  $composerNamespace
-     * @param  $command
+     * @param  Commands\CheckPsr4 $command
      *
      * @return void
      */
@@ -83,6 +83,9 @@ 
         app(ErrorPrinter::class)->errorsList['total'] = 0;
     }
 
+    /**
+     * @param string $relativePath
+     */
     private static function warn($currentNamespace, $relativePath)
     {
         /**
@@ -110,6 +113,9 @@ 
         return Str::startsWith($buffer, '<?php');
     }
 
+    /**
+     * @param string $correctNamespace
+     */
     protected static function doNamespaceCorrection($absFilePath, $currentNamespace, $correctNamespace)
     {
         event('laravel_microscope.namespace_fixing', get_defined_vars());
@@ -117,6 +123,9 @@ 
         event('laravel_microscope.namespace_fixed', get_defined_vars());
     }
 
+    /**
+     * @param string $correctNamespace
+     */
     private static function ask($command, $correctNamespace)
     {
         return $command->getOutput()->confirm('Do you want to change it to: '.$correctNamespace, true);

src/Checks/ActionsComments.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
         }
     }
 
+    /**
+     * @param string $fullNamespace
+     */
     protected static function checkActions($tokens, $fullNamespace, $path)
     {
         $class = ClassMethods::read($tokens);
@@ -73,6 +76,9 @@ 
         return $routelessActions;
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     protected static function getMsg($methods, $route)
     {
         $msg = '/**'."\n";