UpdateDocumentation::handle() - Code Metrics - Inspection of "Updated README, added update documentation command" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5399be...8c507d )

by Marcel

created 2016-05-11 22:01 UTC

UpdateDocumentation::handle() A

↳ Parent: UpdateDocumentation

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	16
rs	9.4285
cc	2
eloc	9
nc	2
nop	0

<?php

namespace Mpociot\ApiDoc\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Route;
use Mpociot\ApiDoc\ApiDocGenerator;
use Mpociot\Documentarian\Documentarian;
use phpDocumentor\Reflection\DocBlock;
use Symfony\Component\Process\Process;

class UpdateDocumentation extends Command
{

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'api:update 
                            {--location=public/docs : The documentation location}
    ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Update and rebuild your API documentation from your markdown file.';

    /**
     * Create a new command instance.
     *
     * @return void

     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $outputPath = $this->option('location');

        $documentarian = new Documentarian();

        if (!is_dir($outputPath)) {
            $this->error('There is no generated documentation available at '.$outputPath.'.');
            return false;
        }
        $this->info('Updating API HTML code');

        $documentarian->generate($outputPath);

        $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
    }

}


1			<?php
2
3			namespace Mpociot\ApiDoc\Commands;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Support\Facades\Route;
7			use Mpociot\ApiDoc\ApiDocGenerator;
8			use Mpociot\Documentarian\Documentarian;
9			use phpDocumentor\Reflection\DocBlock;
10			use Symfony\Component\Process\Process;
11
12			class UpdateDocumentation extends Command
13			{
14
15			/**
16			* The name and signature of the console command.
17			*
18			* @var string
19			*/
20			protected $signature = 'api:update
21			{--location=public/docs : The documentation location}
22			';
23
24			/**
25			* The console command description.
26			*
27			* @var string
28			*/
29			protected $description = 'Update and rebuild your API documentation from your markdown file.';
30
31			/**
32			* Create a new command instance.
33			*
34			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-05-11 22:03 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
35			*/
36			public function __construct()
37			{
38			parent::__construct();
39			}
40
41			/**
42			* Execute the console command.
43			*
44			* @return mixed
45			*/
46			public function handle()
47			{
48			$outputPath = $this->option('location');
49
50			$documentarian = new Documentarian();
51
52			if (!is_dir($outputPath)) {
53			$this->error('There is no generated documentation available at '.$outputPath.'.');
54			return false;
55			}
56			$this->info('Updating API HTML code');
57
58			$documentarian->generate($outputPath);
59
60			$this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
61			}
62
63			}
64

mpociot / laravel-apidoc-generator

Push — master ( 5399be...8c507d )

UpdateDocumentation::handle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like