RebuildDocumentation::handle() - Code Metrics - Inspection of "Update documentation" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d8169...2a43e4 )

unknown

created 2019-04-28 23:43 UTC

RebuildDocumentation::handle() A

↳ Parent: RebuildDocumentation

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.7
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace Mpociot\ApiDoc\Commands;

use Illuminate\Console\Command;
use Mpociot\Documentarian\Documentarian;

class RebuildDocumentation extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'apidoc:rebuild';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = '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 false|null
     */
    public function handle()
    {
        $outputPath = config('apidoc.output');

        $documentarian = new Documentarian();

        if (! is_dir($outputPath)) {
            $this->error('There is no existing documentation available at '.$outputPath.'.');

            return false;
        }
        $this->info('Rebuilding API HTML code from '.$outputPath.'/source/index.md');

        $documentarian->generate($outputPath);

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


1			<?php
2
3			namespace Mpociot\ApiDoc\Commands;
4
5			use Illuminate\Console\Command;
6			use Mpociot\Documentarian\Documentarian;
7
8			class RebuildDocumentation extends Command
9			{
10			/**
11			* The name and signature of the console command.
12			*
13			* @var string
14			*/
15			protected $signature = 'apidoc:rebuild';
16
17			/**
18			* The console command description.
19			*
20			* @var string
21			*/
22			protected $description = 'Rebuild your API documentation from your markdown file.';
23
24			/**
25			* Create a new command instance.
26			*
27			* @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...
28			*/
29			public function __construct()
30			{
31			parent::__construct();
32			}
33
34			/**
35			* Execute the console command.
36			*
37			* @return false\|null
38			*/
39			public function handle()
40			{
41			$outputPath = config('apidoc.output');
42
43			$documentarian = new Documentarian();
44
45			if (! is_dir($outputPath)) {
46			$this->error('There is no existing documentation available at '.$outputPath.'.');
47
48			return false;
49			}
50			$this->info('Rebuilding API HTML code from '.$outputPath.'/source/index.md');
51
52			$documentarian->generate($outputPath);
53
54			$this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
55			}
56			}
57

mpociot / laravel-apidoc-generator

Push — master ( 6d8169...2a43e4 )

RebuildDocumentation::handle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like