abbadon1334 / phpdoc-to-rst

src/Middleware/ErrorHandlingMiddleware.php

Spacing +2 added lines, -2 removed lines

@@ -51,12 +51,12 @@
     public function execute(Command $command, callable $next): object
     {
         $filename = $command->getFile()->path();
-        $this->apiDocBuilder->debug('Starting to parse file: '.$filename);
+        $this->apiDocBuilder->debug('Starting to parse file: ' . $filename);
 
         try {
             return $next($command);
         } catch (Exception $e) {
-            $this->apiDocBuilder->log('Unable to parse file "'.$filename.'", '.$e->getMessage());
+            $this->apiDocBuilder->log('Unable to parse file "' . $filename . '", ' . $e->getMessage());
             //Must Return empty file object
             return new FileElement(
                 $command->getFile()->md5(),

src/Builder/PhpDomainBuilder.php

Spacing +34 added lines, -34 removed lines

@@ -43,10 +43,10 @@ 
  */
 class PhpDomainBuilder extends RstBuilder
 {
-    const SECTION_BEFORE_DESCRIPTION = self::class.'::SECTION_BEFORE_DESCRIPTION';
-    const SECTION_AFTER_DESCRIPTION = self::class.'::SECTION_AFTER_DESCRIPTION';
-    const SECTION_AFTER_TITLE = self::class.'::SECTION_AFTER_TITLE';
-    const SECTION_AFTER_INTRODUCTION = self::class.'::SECTION_AFTER_INTRODUCTION';
+    const SECTION_BEFORE_DESCRIPTION = self::class . '::SECTION_BEFORE_DESCRIPTION';
+    const SECTION_AFTER_DESCRIPTION = self::class . '::SECTION_AFTER_DESCRIPTION';
+    const SECTION_AFTER_TITLE = self::class . '::SECTION_AFTER_TITLE';
+    const SECTION_AFTER_INTRODUCTION = self::class . '::SECTION_AFTER_INTRODUCTION';
 
     use ExtensionBuilder {
         ExtensionBuilder::__construct as private __extensionConstructor;
@@ -55,7 +55,7 @@ 
     public function __construct($extensions)
     {
         $this->__extensionConstructor($extensions);
-        $this->addMultiline('.. role:: php(code)'.PHP_EOL.':language: php', true);
+        $this->addMultiline('.. role:: php(code)' . PHP_EOL . ':language: php', true);
         $this->addLine();
     }
 
@@ -74,7 +74,7 @@ 
             $modifiers = $element->isAbstract() ? ' abstract' : '';
             $modifiers = $element->isFinal() ? ' final' : $modifiers;
             if ($modifiers !== '') {
-                $this->addLine('.. rst-class:: '.$modifiers)->addLine();
+                $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             }
         }
 
@@ -93,7 +93,7 @@ 
      */
     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());
     }
 
@@ -105,7 +105,7 @@ 
     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();
         }
@@ -168,7 +168,7 @@ 
      */
     private function addConstant(Constant $constant)
     {
-        $this->beginPhpDomain('const', $constant->getName().' = '.self::escape($constant->getValue()));
+        $this->beginPhpDomain('const', $constant->getName() . ' = ' . self::escape($constant->getValue()));
         $docBlock = $constant->getDocBlock();
         $this->addDocBlockDescription($constant);
         if ($docBlock) {
@@ -195,7 +195,7 @@ 
             $this->addLine('.. rst-class:: phpdoc-description')->addLine();
             $this->indent();
             $this->addMultilineWithoutRendering(RstBuilder::escape($docBlock->getSummary()))->addLine();
-            if ((string) $docBlock->getDescription() !== '') {
+            if ((string)$docBlock->getDescription() !== '') {
                 $this->addMultilineWithoutRendering(RstBuilder::escape($docBlock->getDescription()))->addLine();
             }
             $this->unindent();
@@ -232,7 +232,7 @@ 
                 /** @var Return_ $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Returns: '.self::typesToRst($return->getType()).' '.RstBuilder::escape($return->getDescription()),
+                    ':Returns: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -240,7 +240,7 @@ 
                 /** @var DocBlock\Tags\Var_ $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Type: '.self::typesToRst($return->getType()).' '.RstBuilder::escape($return->getDescription()),
+                    ':Type: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -248,7 +248,7 @@ 
                 /** @var Throws $tag */
                 foreach ($tags as $tag) {
                     $this->addMultiline(
-                        ':Throws: '.self::typesToRst($tag->getType()).' '.RstBuilder::escape($tag->getDescription()),
+                        ':Throws: ' . self::typesToRst($tag->getType()) . ' ' . RstBuilder::escape($tag->getDescription()),
                         true
                     );
                 }
@@ -257,7 +257,7 @@ 
                 /** @var Since $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Since: '.$return->getVersion().' '.RstBuilder::escape($return->getDescription()),
+                    ':Since: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -265,7 +265,7 @@ 
                 /** @var Deprecated $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Deprecated: '.$return->getVersion().' '.RstBuilder::escape($return->getDescription()),
+                    ':Deprecated: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -273,14 +273,14 @@ 
                 /** @var See $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':See: '.self::typesToRst($return->getReference()).' '.RstBuilder::escape($return->getDescription()),
+                    ':See: ' . self::typesToRst($return->getReference()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
             case 'license':
                 /** @var DocBlock\Tags\BaseTag $return */
                 $return = $tags[0];
-                $this->addMultiline(':License: '.RstBuilder::escape($return->getDescription()), true);
+                $this->addMultiline(':License: ' . RstBuilder::escape($return->getDescription()), true);
                 break;
         }
     }
@@ -319,13 +319,13 @@ 
         foreach ($types as $typeFull) {
             $type = str_replace('[]', '', $typeFull);
             if (in_array($type, $whitelist, true)) {
-                $result .= $typeFull.' | ';
+                $result .= $typeFull . ' | ';
                 continue;
             }
             if (0 === strpos($type, '\\')) {
                 $type = substr($type, 1);
             }
-            $result .= ':any:`'.RstBuilder::escape($typeFull).' <'.RstBuilder::escape($type).'>` | ';
+            $result .= ':any:`' . RstBuilder::escape($typeFull) . ' <' . RstBuilder::escape($type) . '>` | ';
         }
 
         return substr($result, 0, -3);
@@ -363,7 +363,7 @@ 
     private function addProperty(Property $property)
     {
         $modifiers = $property->isStatic() ? '' : ' static';
-        $this->beginPhpDomain('attr', $property->getVisibility().$modifiers.' '.$property->getName());
+        $this->beginPhpDomain('attr', $property->getVisibility() . $modifiers . ' ' . $property->getName());
         $docBlock = $property->getDocBlock();
         $this->addDocBlockDescription($property);
         if ($docBlock) {
@@ -402,13 +402,13 @@ 
     public static function getLink($type, $fqsen, $description = '')
     {
         if ($description !== '') {
-            return ':php:'.$type.':`'.RstBuilder::escape($description).'<'.RstBuilder::escape(substr(
+            return ':php:' . $type . ':`' . RstBuilder::escape($description) . '<' . RstBuilder::escape(substr(
                 $fqsen,
                 1
-            )).'>`';
+            )) . '>`';
         }
 
-        return ':php:'.$type.':`'.RstBuilder::escape(substr($fqsen, 1)).'`';
+        return ':php:' . $type . ':`' . RstBuilder::escape(substr($fqsen, 1)) . '`';
     }
 
     /**
@@ -418,7 +418,7 @@ 
     {
         $usedTraits = '';
         foreach ($element->getUsedTraits() as $trait) {
-            $usedTraits .= $this->getLink('trait', $trait).' ';
+            $usedTraits .= $this->getLink('trait', $trait) . ' ';
         }
         if ($usedTraits !== '') {
             $this->addFieldList('Used traits', $usedTraits);
@@ -461,11 +461,11 @@ 
         $modifiers .= $method->isFinal() ? ' final' : '';
         $modifiers .= $method->isStatic() ? ' static' : '';
         $deprecated = count($deprecated) > 0 ? ' deprecated' : '';
-        $this->addLine('.. rst-class:: '.$modifiers.$deprecated)->addLine();
+        $this->addLine('.. rst-class:: ' . $modifiers . $deprecated)->addLine();
         $this->indent();
 
         $args = $this->processMethodArgumentTypes($method);
-        $this->beginPhpDomain('method', $modifiers.' '.$method->getName().'('.$args.')');
+        $this->beginPhpDomain('method', $modifiers . ' ' . $method->getName() . '(' . $args . ')');
         $this->addDocBlockDescription($method);
         $this->addLine();
         if (!empty($params)) {
@@ -507,12 +507,12 @@ 
                 if ($argument->isVariadic()) {
                     $paramItem .= '...';
                 }
-                $paramItem .= '$'.$argument->getName().'** ';
+                $paramItem .= '$' . $argument->getName() . '** ';
                 if ($typString !== null) {
-                    $paramItem .= '('.self::typesToRst($typString).') ';
+                    $paramItem .= '(' . self::typesToRst($typString) . ') ';
                 }
-                $paramItem .= ' '.$param->getDescription();
-                $parameterDetails .= $paramItem.PHP_EOL;
+                $paramItem .= ' ' . $param->getDescription();
+                $parameterDetails .= $paramItem . PHP_EOL;
             }
         }
 
@@ -544,20 +544,20 @@ 
     private function processMethodArgumentType(Argument $argument, string $args): string
     {
         foreach ($argument->getType() as $type) {
-            $args .= self::escape($type).'|';
+            $args .= self::escape($type) . '|';
         }
-        $args = substr($args, 0, -1).' ';
+        $args = substr($args, 0, -1) . ' ';
         if ($argument->isVariadic()) {
             $args .= '...';
         }
         if ($argument->isByReference()) {
             $args .= '&';
         }
-        $args .= '$'.$argument->getName();
+        $args .= '$' . $argument->getName();
         $default = $argument->getDefault();
         if ($default !== null) {
             $default = $default === '' ? '""' : $default;
-            $args .= '='.self::escape($default);
+            $args .= '=' . self::escape($default);
         }
         $args .= ', ';
 

Indentation +9 added lines, -9 removed lines

@@ -348,15 +348,15 @@
     protected function addProperties($properties)
     {
         //Choose display properties
-		$displayProperties = [];
-		foreach ($properties as $property) {
-			if ($this->shouldRenderElement($property)) {
-				$displayProperties[] = $property;
-			}
-		}
-
-		//Render
-		if (count($displayProperties) > 0) {
+        $displayProperties = [];
+        foreach ($properties as $property) {
+            if ($this->shouldRenderElement($property)) {
+                $displayProperties[] = $property;
+            }
+        }
+
+        //Render
+        if (count($displayProperties) > 0) {
             $this->addH2('Properties');
             foreach ($displayProperties as $property) {
                     $this->addProperty($property);

src/Extension/TocExtension.php

Indentation +4 added lines, -4 removed lines

@@ -50,10 +50,10 @@
                 if (count($interface->getMethods()) > 0) {
                     $builder->addH3('Methods');
                     foreach ($interface->getMethods() as $method) {
-						//We don't want add an no displayed method to Summary
-						if (!$builder->shouldRenderElement($method)) {
-							continue;
-						}
+                        //We don't want add an no displayed method to Summary
+                        if (!$builder->shouldRenderElement($method)) {
+                            continue;
+                        }
 
 
                         $args = '';