浏览代码

Code style fixes

shalvah 6 年之前
父节点
当前提交
5976188829

+ 2 - 2
src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

@@ -2,17 +2,17 @@
 
 namespace Mpociot\ApiDoc\Commands;
 
-use Illuminate\Routing\Route;
 use ReflectionClass;
+use Illuminate\Routing\Route;
 use Illuminate\Console\Command;
 use Mpociot\Reflection\DocBlock;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Route as RouteFacade;
 use Mpociot\Documentarian\Documentarian;
 use Mpociot\ApiDoc\Postman\CollectionWriter;
 use Mpociot\ApiDoc\Generators\DingoGenerator;
 use Mpociot\ApiDoc\Generators\LaravelGenerator;
 use Mpociot\ApiDoc\Generators\AbstractGenerator;
+use Illuminate\Support\Facades\Route as RouteFacade;
 
 class GenerateDocumentation extends Command
 {

+ 7 - 4
src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

@@ -3,15 +3,15 @@
 namespace Mpociot\ApiDoc\Generators;
 
 use Faker\Factory;
-use Illuminate\Routing\Route;
-use League\Fractal\Manager;
-use League\Fractal\Resource\Collection;
-use League\Fractal\Resource\Item;
 use ReflectionClass;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use League\Fractal\Manager;
+use Illuminate\Routing\Route;
 use Mpociot\Reflection\DocBlock;
+use League\Fractal\Resource\Item;
 use Mpociot\Reflection\DocBlock\Tag;
+use League\Fractal\Resource\Collection;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Foundation\Http\FormRequest;
 use Mpociot\ApiDoc\Parsers\RuleDescriptionParser as Description;
@@ -92,6 +92,7 @@ abstract class AbstractGenerator
         }
 
         $content = $this->getResponseContent($response);
+
         return $this->getParameters([
             'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
             'resource' => $routeGroup,
@@ -674,6 +675,7 @@ abstract class AbstractGenerator
 
     /**
      * @param $response
+     *
      * @return mixed
      */
     private function getResponseContent($response)
@@ -686,6 +688,7 @@ abstract class AbstractGenerator
         } else {
             $content = $response->getContent();
         }
+
         return $content;
     }
 

+ 6 - 5
tests/GenerateDocumentationTest.php

@@ -2,6 +2,8 @@
 
 namespace Mpociot\ApiDoc\Tests;
 
+use RecursiveIteratorIterator;
+use RecursiveDirectoryIterator;
 use Orchestra\Testbench\TestCase;
 use Illuminate\Contracts\Console\Kernel;
 use Dingo\Api\Provider\LaravelServiceProvider;
@@ -11,8 +13,6 @@ use Mpociot\ApiDoc\ApiDocGeneratorServiceProvider;
 use Illuminate\Support\Facades\Route as RouteFacade;
 use Mpociot\ApiDoc\Tests\Fixtures\DingoTestController;
 use Mpociot\ApiDoc\Tests\Fixtures\TestResourceController;
-use RecursiveDirectoryIterator;
-use RecursiveIteratorIterator;
 
 class GenerateDocumentationTest extends TestCase
 {
@@ -227,10 +227,11 @@ class GenerateDocumentationTest extends TestCase
     }
 
     /**
-     * get the contents of a file in a cross-platform-compatible way
+     * Get the contents of a file in a cross-platform-compatible way.
      *
      * @param $path
-     * @return mixed
+     *
+     * @return string
      */
     private function getFileContents($path)
     {
@@ -238,7 +239,7 @@ class GenerateDocumentationTest extends TestCase
     }
 
     /**
-     * Assert that a string contains another string, ignoring all whitespace
+     * Assert that a string contains another string, ignoring all whitespace.
      *
      * @param $needle
      * @param $haystack