juliushaertl / phpdoc-to-rst

src/ApiDocBuilder.php

Spacing +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
             if (is_dir($namespaceDir))
                 continue;
             if (!mkdir($namespaceDir, 0755, true)) {
-                throw new \Exception('Could not create directory '. $namespaceDir);
+                throw new \Exception('Could not create directory ' . $namespaceDir);
             }
         }
     }
@@ -148,7 +148,7 @@ 
     public function buildToc() {
         $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/Builder/InterfaceBuilder.php

Spacing +1 added lines, -1 removed lines

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

Braces +3 added lines, -1 removed lines

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

src/Builder/Builder.php

Spacing +3 added lines, -3 removed lines

@@ -68,15 +68,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

@@ -90,37 +90,49 @@
         $tags = $docBlock->getTagsByName($tag);
         switch ($tag) {
             case 'return':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var Return_ $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':returns: ' . $return->getType() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'throws':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var Throws $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':throws: ' . $return->getType() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'since':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var Since $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':since: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'deprecated':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var Deprecated $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':deprecated: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'see':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var See $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':see: ' . $return->getReference() . ' ' . RstBuilder::escape($return->getDescription()), true);
                 break;
             case 'license':
-                if (sizeof($tags) === 0) continue;
+                if (sizeof($tags) === 0) {
+                    continue;
+                }
                 /** @var DocBlock\Tags\BaseTag $return */
                 $return = $tags[0];
                 $this->addIndentMultiline($indent, ':license: ' . RstBuilder::escape($return->getDescription()), true);

src/Builder/ClassBuilder.php

Spacing +6 added lines, -6 removed lines

@@ -41,7 +41,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);
         }
         $modifiers = $class->isAbstract() ? ' abstract' : '';
@@ -84,7 +84,7 @@ 
             $docBlock = $constant->getDocBlock();
             if ($docBlock) {
                 foreach ($docBlock->getTags() as $tag) {
-                    $this->addDocblockTag( $tag->getName(), $docBlock);
+                    $this->addDocblockTag($tag->getName(), $docBlock);
                 }
             }
             $this->endPhpDomain();
@@ -102,7 +102,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;
@@ -111,10 +111,10 @@ 
             $args = '';
             /** @var Argument $argument */
             foreach ($method->getArguments() as $argument) {
-                if(!empty($argument->getDefault())) {
+                if (!empty($argument->getDefault())) {
                     echo 'ad';
                 }
-                $args .=  ' $' . $argument->getName() . ', ';
+                $args .= ' $' . $argument->getName() . ', ';
             }
             $args = substr($args, 0, -2);
 
@@ -123,7 +123,7 @@ 
             $modifiers .= $method->isFinal() ? ' final' : '';
             $modifiers .= $method->isStatic() ? ' static' : '';
             $this->addIndentLine(1, '.. rst-class:: ' . $modifiers)->addLine();
-            $this->addIndentLine(2, '.. php:method:: '.$method->getName().'('.$args.')');
+            $this->addIndentLine(2, '.. php:method:: ' . $method->getName() . '(' . $args . ')');
             $this->addLine();
             if ($docBlock)
                 $this->addIndentMultiline(3, $docBlock->getDescription());

Braces +6 added lines, -4 removed lines

@@ -125,16 +125,18 @@
             $this->addIndentLine(1, '.. rst-class:: ' . $modifiers)->addLine();
             $this->addIndentLine(2, '.. php:method:: '.$method->getName().'('.$args.')');
             $this->addLine();
-            if ($docBlock)
-                $this->addIndentMultiline(3, $docBlock->getDescription());
+            if ($docBlock) {
+                            $this->addIndentMultiline(3, $docBlock->getDescription());
+            }
             $this->addLine();
 
             if (!empty($params)) {
                 foreach ($method->getArguments() as $argument) {
                     /** @var Param $param */
                     $param = $params[$argument->getName()];
-                    if ($param !== null)
-                        $this->addIndentMultiline(3, ':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription());
+                    if ($param !== null) {
+                                            $this->addIndentMultiline(3, ':param ' . $param->getType() . ' $' . $argument->getName() . ': ' . $param->getDescription());
+                    }
                 }
             }
 

src/Builder/RstBuilder.php

Spacing +3 added lines, -3 removed lines

@@ -30,7 +30,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;
@@ -51,7 +51,7 @@ 
     }
 
     public function addFieldList($key, $value) {
-        $this->addLine(':'.self::escape($key).':');
+        $this->addLine(':' . self::escape($key) . ':');
         $this->addIndentMultiline(1, $value, true);
     }
 
@@ -85,7 +85,7 @@ 
             if ($blockIndent && $i === 1) {
                 $indent++;
             }
-            $this->addIndentLine($this->indentLevel+$indent, $line);
+            $this->addIndentLine($this->indentLevel + $indent, $line);
             $i++;
         }
         return $this;

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;
                 }
@@ -92,7 +92,7 @@ 
                 $subPath = substr($entry, strlen($currentNamespaceFqsen));
             }
             $path = substr(str_replace("\\", "/", $subPath), 1);
-            $this->addIndentLine(1,$entry->getName() . ' <' . $path . '>');
+            $this->addIndentLine(1, $entry->getName() . ' <' . $path . '>');
         }
         $this->addLine()->addLine();