juliushaertl / phpdoc-to-rst

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;
@@ -58,7 +58,7 @@ 
     }
 
     public function addFieldList($key, $value) {
-        $this->addLine(':'.self::escape($key).':');
+        $this->addLine(':' . self::escape($key) . ':');
         $this->indent()->addMultiline($value, true)->unindent();
         return $this;
     }

src/Builder/PhpDomainBuilder.php

Spacing +4 added lines, -4 removed lines

@@ -24,7 +24,7 @@ 
         $docBlock = $constant->getDocBlock();
         if ($docBlock) {
             foreach ($docBlock->getTags() as $tag) {
-                $this->addDocblockTag( $tag->getName(), $docBlock);
+                $this->addDocblockTag($tag->getName(), $docBlock);
             }
         }
         $this->endPhpDomain();
@@ -38,15 +38,15 @@ 
         return ':php:' . $type . ':`' . RstBuilder::escape(substr($fqsen, 1)) . '`';
     }
 
-    public function beginPhpDomain($type, $name, $indent=true) {
+    public function beginPhpDomain($type, $name, $indent = true) {
         // FIXME: Add checks if it is properly ended
-        $this->addLine('.. php:' . $type . ':: '. $name)->addLine();
+        $this->addLine('.. php:' . $type . ':: ' . $name)->addLine();
         if ($indent === true) {
             $this->indent();
         }
     }
 
-    public function endPhpDomain($type='') {
+    public function endPhpDomain($type = '') {
         $this->unindent();
         $this->addLine();
     }

Braces +18 added lines, -6 removed lines

@@ -59,37 +59,49 @@
         $tags = $docBlock->getTagsByName($tag);
         switch ($tag) {
             case 'return':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Return_ $return */
                 $return = $tags[0];
                 $this->addMultiline(':returns: ' . $return->getType() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'throws':
-                if (count($tags) === 0) continue;
+                if (count($tags) === 0) {
+                    continue;
+                }
                 /** @var Throws $return */
                 $return = $tags[0];
                 $this->addMultiline(':throws: ' . $return->getType() . ' ' . RstBuilder::escape($return->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: ' . $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);

src/Builder/InterfaceBuilder.php

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 
         $docBlock = $interface->getDocBlock();
         $this->addH1(self::escape($interface->getFqsen()))->addLine();
-        if($namespace !== '') {
+        if ($namespace !== '') {
             $this->beginPhpDomain('namespace', substr($namespace, 1), false);
         }
         $this->beginPhpDomain('interface', $interface->getName(), false);

Braces +3 added lines, -1 removed lines

@@ -97,7 +97,9 @@
                 foreach ($method->getArguments() as $argument) {
                     /** @var Param $param */
                     $param = $params[$argument->getName()];
-                    if ($param !== null) $this->addMultiline(':param ' . RstBuilder::escape($param->getType()) . ' $' . $argument->getName() . ': ' . RstBuilder::escape($param->getDescription()), true);
+                    if ($param !== null) {
+                        $this->addMultiline(':param ' . RstBuilder::escape($param->getType()) . ' $' . $argument->getName() . ': ' . RstBuilder::escape($param->getDescription()), true);
+                    }
                 }
                 foreach ($docBlock->getTags() as $tag) {
                     $this->addDocblockTag($tag->getName(), $docBlock);

src/Builder/ClassBuilder.php

Spacing +5 added lines, -5 removed lines

@@ -38,7 +38,7 @@ 
         $this->addH1(self::escape($class->getFqsen()));
 
         $namespace = str_replace('\\' . $class->getName(), '', $class->getFqsen());
-        if($namespace !== '') {
+        if ($namespace !== '') {
             $this->beginPhpDomain('namespace', substr($namespace, 1), false);
         }
 
@@ -56,7 +56,7 @@ 
                 ->addLine();
         }
 
-        if($class instanceof Class_) {
+        if ($class instanceof Class_) {
             // Add class details
             $parent = $class->getParent();
             $this->addFieldList('Extends', $parent !== null ? $this->getLink('class', $parent) : '');
@@ -93,7 +93,7 @@ 
         foreach ($class->getMethods() as $method) {
             $docBlock = $method->getDocBlock();
             $params = [];
-            if($docBlock !== null) {
+            if ($docBlock !== null) {
                 /** @var Param $param */
                 foreach ($docBlock->getTagsByName('param') as $param) {
                     $params[$param->getVariableName()] = $param;
@@ -103,7 +103,7 @@ 
             /** @var Argument $argument */
             foreach ($method->getArguments() as $argument) {
                 // TODO: defaults, types
-                $args .=  ' $' . $argument->getName() . ', ';
+                $args .= ' $' . $argument->getName() . ', ';
             }
             $args = substr($args, 0, -2);
 
@@ -113,7 +113,7 @@ 
             $modifiers .= $method->isStatic() ? ' static' : '';
             $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             $this->indent();
-            $this->beginPhpDomain('method', $method->getName().'('.$args.')');
+            $this->beginPhpDomain('method', $method->getName() . '(' . $args . ')');
             if ($docBlock)
                 $this->addMultiline($docBlock->getDescription());
             $this->addLine();

Braces +6 added lines, -4 removed lines

@@ -114,15 +114,17 @@
             $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             $this->indent();
             $this->beginPhpDomain('method', $method->getName().'('.$args.')');
-            if ($docBlock)
-                $this->addMultiline($docBlock->getDescription());
+            if ($docBlock) {
+                            $this->addMultiline($docBlock->getDescription());
+            }
             $this->addLine();
             if (!empty($params)) {
                 foreach ($method->getArguments() as $argument) {
                     /** @var Param $param */
                     $param = $params[$argument->getName()];
-                    if ($param !== null)
-                        $this->addMultiline(':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription(), true);
+                    if ($param !== null) {
+                                            $this->addMultiline(':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription(), true);
+                    }
                 }
             }
             $this->endPhpDomain('method');

src/Builder/TraitBuilder.php

Spacing +4 added lines, -4 removed lines

@@ -39,7 +39,7 @@ 
         $this->addH1(self::escape($trait->getFqsen()));
 
         $namespace = str_replace('\\' . $trait->getName(), '', $trait->getFqsen());
-        if($namespace !== '') {
+        if ($namespace !== '') {
             $this->beginPhpDomain('namespace', substr($namespace, 1), false);
         }
 
@@ -72,7 +72,7 @@ 
         foreach ($trait->getMethods() as $method) {
             $docBlock = $method->getDocBlock();
             $params = [];
-            if($docBlock !== null) {
+            if ($docBlock !== null) {
                 /** @var Param $param */
                 foreach ($docBlock->getTagsByName('param') as $param) {
                     $params[$param->getVariableName()] = $param;
@@ -82,7 +82,7 @@ 
             /** @var Argument $argument */
             foreach ($method->getArguments() as $argument) {
                 // TODO: defaults, types
-                $args .=  ' $' . $argument->getName() . ', ';
+                $args .= ' $' . $argument->getName() . ', ';
             }
             $args = substr($args, 0, -2);
 
@@ -92,7 +92,7 @@ 
             $modifiers .= $method->isStatic() ? ' static' : '';
             $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             $this->indent();
-            $this->beginPhpDomain('method', $method->getName().'('.$args.')');
+            $this->beginPhpDomain('method', $method->getName() . '(' . $args . ')');
             if ($docBlock)
                 $this->addMultiline($docBlock->getDescription());
             $this->addLine();

Braces +6 added lines, -4 removed lines

@@ -93,15 +93,17 @@
             $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             $this->indent();
             $this->beginPhpDomain('method', $method->getName().'('.$args.')');
-            if ($docBlock)
-                $this->addMultiline($docBlock->getDescription());
+            if ($docBlock) {
+                            $this->addMultiline($docBlock->getDescription());
+            }
             $this->addLine();
             if (!empty($params)) {
                 foreach ($method->getArguments() as $argument) {
                     /** @var Param $param */
                     $param = $params[$argument->getName()];
-                    if ($param !== null)
-                        $this->addMultiline(':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription(), true);
+                    if ($param !== null) {
+                                            $this->addMultiline(':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription(), true);
+                    }
                 }
             }
             $this->endPhpDomain('method');

src/Builder/NamespaceIndexBuilder.php

Spacing +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
                 && (string)$namespace->getFqsen() !== (string)$currentNamespaceFqsen
             ) {
                 // only keep first level children
-                $childrenPath = substr((string)$namespace->getFqsen(), strlen((string)$this->currentNamespace->getFqsen())+1);
+                $childrenPath = substr((string)$namespace->getFqsen(), strlen((string)$this->currentNamespace->getFqsen()) + 1);
                 if (strpos($childrenPath, '\\') === false) {
                     $childNamespaces[] = $namespace;
                 }
@@ -104,7 +104,7 @@ 
 
         $this->addH2('Functions');
         foreach ($this->currentNamespace->getFunctions() as $function) {
-            $this->beginPhpDomain('function', $function->getName(). '()');
+            $this->beginPhpDomain('function', $function->getName() . '()');
             $this->endPhpDomain('function');
         }
 

src/ApiDocBuilder.php

Spacing +1 added lines, -1 removed lines

@@ -209,7 +209,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 */