juliushaertl / phpdoc-to-rst

src/Extension/AddFullElementNameExtension.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
             return;
         }
         if ($type === PhpDomainBuilder::SECTION_BEFORE_DESCRIPTION) {
-            if($element instanceof Class_) {
+            if ($element instanceof Class_) {
                 $modifiers = $element->isAbstract() ? 'abstract' : '';
                 $modifiers = $element->isFinal() ? ' final' : $modifiers;
                 $builder->addLine(':php:`' . $modifiers . ' class ' . RstBuilder::escape($builder->getElement()->getName()) . ' {}`');

src/Extension/TocExtension.php

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
                 /** @var Interface_ $interface */
                 $interface = $builder->getElement();
 
-                if(count($interface->getMethods()) > 0) {
+                if (count($interface->getMethods()) > 0) {
                     $builder->addH3('Methods');
                     foreach ($interface->getMethods() as $method) {
                         $args = '';

src/GenerateDocumentationCommand.php

Spacing +4 added lines, -4 removed lines

@@ -71,17 +71,17 @@
             $apiDocBuilder->setVerboseOutput(true);
             $apiDocBuilder->setDebugOutput(true);
         }
-        if($input->getOption('public-only')) {
+        if ($input->getOption('public-only')) {
             $apiDocBuilder->addExtension(PublicOnlyExtension::class);
         }
-        if(!$input->getOption('show-private')) {
+        if (!$input->getOption('show-private')) {
             $apiDocBuilder->addExtension(NoPrivateExtension::class);
         }
-        if($input->getOption('element-toc')) {
+        if ($input->getOption('element-toc')) {
             $apiDocBuilder->addExtension(TocExtension::class);
         }
 
-        if($input->getOption('repo-github') && $input->getOption('repo-base')) {
+        if ($input->getOption('repo-github') && $input->getOption('repo-base')) {
             $apiDocBuilder->addExtension(GithubLocationExtension::class, [
                 $input->getOption('repo-base'),
                 $input->getOption('repo-github')

src/ApiDocBuilder.php

Spacing +2 added lines, -2 removed lines

@@ -202,7 +202,7 @@ 
      * @param string $class name of the extension class
      * @throws \Exception
      */
-    public function addExtension($class, $arguments=[]) {
+    public function addExtension($class, $arguments = []) {
         $this->extensionNames[] = $class;
         $this->extensionArguments[$class] = $arguments;
 
@@ -302,7 +302,7 @@ 
         $this->log('Build indexes.');
         $namespaces = $this->project->getNamespaces();
         $namespaces['\\'] = $this->project->getRootNamespace();
-        usort($namespaces, function (Namespace_ $a, Namespace_ $b) {
+        usort($namespaces, function(Namespace_ $a, Namespace_ $b) {
             return strcmp($a->getFqsen(), $b->getFqsen());
         });
         /** @var Namespace_ $namespace */

src/Extension/Extension.php

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /** @var array */
     protected $arguments;
 
-    public function __construct(Project $project, $arguments=[]) {
+    public function __construct(Project $project, $arguments = []) {
         $this->project = $project;
         $this->arguments = $arguments;
     }

src/Builder/PhpDomainBuilder.php

Spacing +6 added lines, -6 removed lines

@@ -70,7 +70,7 @@ 
      * @return mixed
      */
     public static function getNamespace(Element $element) {
-        return substr($element->getFqsen(), 0, strlen($element->getFqsen())-strlen('\\'. $element->getName()));
+        return substr($element->getFqsen(), 0, strlen($element->getFqsen()) - strlen('\\' . $element->getName()));
         //return str_replace('\\' . $element->getName(), '', $element->getFqsen());
     }
 
@@ -164,7 +164,7 @@ 
      * @param Property $property
      */
     private function addProperty(Property $property) {
-        $modifiers = $property->isStatic() ? '' : ' static' ;
+        $modifiers = $property->isStatic() ? '' : ' static';
         $this->beginPhpDomain('attr', $property->getVisibility() . $modifiers . ' ' . $property->getName());
         $docBlock = $property->getDocBlock();
         $this->addDocBlockDescription($property);
@@ -239,10 +239,10 @@ 
                 $args .= self::escape($type) . '|';
             }
             $args = substr($args, 0, -1) . ' ';
-            if($argument->isVariadic()) {
+            if ($argument->isVariadic()) {
                 $args .= '...';
             }
-            if($argument->isByReference()) {
+            if ($argument->isByReference()) {
                 $args .= '&';
             }
             $args .= '$' . $argument->getName();
@@ -292,8 +292,8 @@ 
      * @param $fqsen string
      * @return string
      */
-    public static function getLink($type, $fqsen, $description='') {
-        if($description !== '') {
+    public static function getLink($type, $fqsen, $description = '') {
+        if ($description !== '') {
             return ':php:' . $type . ':`' . RstBuilder::escape($description) . '<' . RstBuilder::escape(substr($fqsen, 1)) . '>`';
         }
         return ':php:' . $type . ':`' . RstBuilder::escape(substr($fqsen, 1)) . '`';

Braces +24 added lines, -9 removed lines

@@ -350,44 +350,58 @@ 
         $tags = $docBlock->getTagsByName($tagName);
         switch ($tagName) {
             case 'return':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Return_ $return */
                 $return = $tags[0];
                 $this->addMultiline(':Returns: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'var':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var DocBlock\Tags\Var_ $return */
                 $return = $tags[0];
                 $this->addMultiline(':Type: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'throws':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Throws $tag */
                 foreach ($tags as $tag) {
                     $this->addMultiline(':Throws: ' . self::typesToRst($tag->getType()) . ' ' . RstBuilder::escape($tag->getDescription()), true);
                 }
                 break;
             case 'since':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Since $return */
                 $return = $tags[0];
                 $this->addMultiline(':Since: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'deprecated':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Deprecated $return */
                 $return = $tags[0];
                 $this->addMultiline(':Deprecated: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'see':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var See $return */
                 $return = $tags[0];
                 $this->addMultiline(':See: ' . self::typesToRst($return->getReference()) . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'license':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var DocBlock\Tags\BaseTag $return */
                 $return = $tags[0];
                 $this->addMultiline(':License: ' . RstBuilder::escape($return->getDescription()), true);
@@ -421,8 +435,9 @@ 
                 $result .= $typeFull . ' | ';
                 continue;
             }
-            if (0 === strpos($type, '\\'))
-                $type = substr($type, 1);
+            if (0 === strpos($type, '\\')) {
+                            $type = substr($type, 1);
+            }
             $result .= ':any:`' . RstBuilder::escape($typeFull) . ' <' . RstBuilder::escape($type) . '>` | ';
         }
         return substr($result, 0, -3);

src/Extension/GithubLocationExtension.php

Spacing +3 added lines, -3 removed lines

@@ -71,12 +71,12 @@
             $filePath = preg_replace('/^' . preg_quote($this->basePath, '/') . '/', '', $filePath);
             $lineNumber = $element->getLocation()->getLineNumber();
             $url = $this->getGithubLink($filePath, $lineNumber, $this->branch);
-            $builder->addFieldList('Source', '`' . $filePath. '#' . $lineNumber . ' <'.$url.'>`_');
+            $builder->addFieldList('Source', '`' . $filePath . '#' . $lineNumber . ' <' . $url . '>`_');
         }
     }
 
-    private function getGithubLink($file, $line=1, $branch='master') {
-        return $this->githubRepo . '/blob/'.$branch.'/'.$file.'#L' . $line;
+    private function getGithubLink($file, $line = 1, $branch = 'master') {
+        return $this->githubRepo . '/blob/' . $branch . '/' . $file . '#L' . $line;
     }
 
 }
\ No newline at end of file

src/Builder/RstBuilder.php

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
 
     private $indentLevel = 0;
     /** @var string */
-    protected $content = '.. rst-class:: phpdoctorst' . PHP_EOL . PHP_EOL ;
+    protected $content = '.. rst-class:: phpdoctorst' . PHP_EOL . PHP_EOL;
 
     public function getContent() {
         return $this->content;
@@ -59,7 +59,7 @@ 
     }
 
     public function addFieldList($key, $value) {
-        $this->addLine(':'.self::escape($key).':');
+        $this->addLine(':' . self::escape($key) . ':');
         $this->indent()->addMultiline($value, false)->unindent();
         return $this;
     }