Fix argument types separator in table for methods

tntrex · tntrex · commit d6bede874658 · 2019-10-14T11:14:31.000+04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,8 @@ All notable changes to `simple-php-apidoc` will be documented in this file.
 
 Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
-## NEXT - YYYY-MM-DD
-
+<!--
+## [X.Y.Z] - YYYY-MM-DD
 ### Added
 - Nothing
 
@@ -20,3 +20,16 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ### Security
 - Nothing
+-->
+
+## [1.0.1] - 2019-10-14
+### Fixed
+- Fix argument types separator in table for methods
+
+## [1.0.0] - 2019-10-13
+### Added
+- Reflection elements decorators
+- Collections for some decorated elements
+- DocBlock resolvers for inherit doc blocks from parent classes, methods and properties
+- Renderer interface and simple markdown renderer
+- CLI tool
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Context.md b/docs/spaceonfire/SimplePhpApiDoc/Context.md
@@ -40,8 +40,8 @@ Decorate phpDocumentor elements with custom element classes
 
 |Param|Type|Description|
 |---|---|---|
-|`$element`|*\phpDocumentor\Reflection\Element|mixed*|Element to decorate|
-|**Return**|*\spaceonfire\SimplePhpApiDoc\Elements\ElementInterface|mixed*|Decorated element or source element if there no mappings for this type|
+|`$element`|*\phpDocumentor\Reflection\Element&#124;mixed*|Element to decorate|
+|**Return**|*\spaceonfire\SimplePhpApiDoc\Elements\ElementInterface&#124;mixed*|Decorated element or source element if there no mappings for this type|
 
 ```php
 public function Context::elementFactory(mixed $element): mixed
@@ -84,7 +84,7 @@ Get element object by name
 |Param|Type|Description|
 |---|---|---|
 |`$fqsen`|*string*|Fully Qualified Structural Element Name|
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function Context::getElement(string $fqsen): mixed
@@ -99,7 +99,7 @@ Get file by element name
 |Param|Type|Description|
 |---|---|---|
 |`$fqsen`|*string*|Fully Qualified Structural Element Name|
-|**Return**|*\phpDocumentor\Reflection\Php\File|null*||
+|**Return**|*\phpDocumentor\Reflection\Php\File&#124;null*||
 
 ```php
 public function Context::getFile(string $fqsen): ?\spaceonfire\SimplePhpApiDoc\phpDocumentor\Reflection\Php\File
@@ -155,7 +155,7 @@ Getter for `project` property
 
 |Param|Type|Description|
 |---|---|---|
-|**Return**|*\phpDocumentor\Reflection\Php\Project|\phpDocumentor\Reflection\Project*||
+|**Return**|*\phpDocumentor\Reflection\Php\Project&#124;\phpDocumentor\Reflection\Project*||
 
 ```php
 public function Context::getProject(): \spaceonfire\SimplePhpApiDoc\phpDocumentor\Reflection\Project
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/ClassElement.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/ClassElement.md
@@ -156,7 +156,7 @@ Returns the superclass this class is extending if available.
 
 |Param|Type|Description|
 |---|---|---|
-|**Return**|*\phpDocumentor\Reflection\Fqsen|null*||
+|**Return**|*\phpDocumentor\Reflection\Fqsen&#124;null*||
 
 ```php
 public function ClassElement::getParentFqsen(): ?\spaceonfire\SimplePhpApiDoc\Elements\phpDocumentor\Reflection\Fqsen
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/MethodsCollection.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/MethodsCollection.md
@@ -49,7 +49,7 @@ TODO: move to BaseCollection
 |Param|Type|Description|
 |---|---|---|
 |`$callback`|*callable*||
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function TypedCollection::find(callable $callback): mixed
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/NamespacesCollection.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/NamespacesCollection.md
@@ -32,7 +32,7 @@ TODO: move to BaseCollection
 |Param|Type|Description|
 |---|---|---|
 |`$callback`|*callable*||
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function TypedCollection::find(callable $callback): mixed
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/PropertiesCollection.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/PropertiesCollection.md
@@ -49,7 +49,7 @@ TODO: move to BaseCollection
 |Param|Type|Description|
 |---|---|---|
 |`$callback`|*callable*||
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function TypedCollection::find(callable $callback): mixed
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/TraitsCollection.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/TraitsCollection.md
@@ -32,7 +32,7 @@ TODO: move to BaseCollection
 |Param|Type|Description|
 |---|---|---|
 |`$callback`|*callable*||
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function TypedCollection::find(callable $callback): mixed
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/TypedCollection.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/Collections/TypedCollection.md
@@ -34,7 +34,7 @@ TODO: move to BaseCollection
 |Param|Type|Description|
 |---|---|---|
 |`$callback`|*callable*||
-|**Return**|*mixed|null*||
+|**Return**|*mixed&#124;null*||
 
 ```php
 public function TypedCollection::find(callable $callback): mixed
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/ElementVisibilityInterface.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/ElementVisibilityInterface.md
@@ -10,7 +10,7 @@ Returns the Visibility of this method.
 
 |Param|Type|Description|
 |---|---|---|
-|**Return**|*\phpDocumentor\Reflection\Php\Visibility|null*||
+|**Return**|*\phpDocumentor\Reflection\Php\Visibility&#124;null*||
 
 ```php
 public function ElementVisibilityInterface::getVisibility(): ?\spaceonfire\SimplePhpApiDoc\Elements\phpDocumentor\Reflection\Php\Visibility
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/MethodElement.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/MethodElement.md
@@ -184,7 +184,7 @@ Returns the Visibility of this method.
 
 |Param|Type|Description|
 |---|---|---|
-|**Return**|*\phpDocumentor\Reflection\Php\Visibility|null*||
+|**Return**|*\phpDocumentor\Reflection\Php\Visibility&#124;null*||
 
 ```php
 public function MethodElement::getVisibility(): ?\spaceonfire\SimplePhpApiDoc\Elements\phpDocumentor\Reflection\Php\Visibility
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Elements/PropertyElement.md b/docs/spaceonfire/SimplePhpApiDoc/Elements/PropertyElement.md
@@ -167,7 +167,7 @@ Returns the Visibility of this method.
 
 |Param|Type|Description|
 |---|---|---|
-|**Return**|*\phpDocumentor\Reflection\Php\Visibility|null*||
+|**Return**|*\phpDocumentor\Reflection\Php\Visibility&#124;null*||
 
 ```php
 public function PropertyElement::getVisibility(): ?\spaceonfire\SimplePhpApiDoc\Elements\phpDocumentor\Reflection\Php\Visibility
diff --git a/docs/spaceonfire/SimplePhpApiDoc/GeneratorCommand.md b/docs/spaceonfire/SimplePhpApiDoc/GeneratorCommand.md
@@ -17,7 +17,7 @@ GeneratorCommand constructor.
 
 |Param|Type|Description|
 |---|---|---|
-|`$name`|*string|null*||
+|`$name`|*string&#124;null*||
 |`$composer`|*array*||
 
 ```php
diff --git a/docs/spaceonfire/SimplePhpApiDoc/Renderers/Markdown/MarkdownRenderer.md b/docs/spaceonfire/SimplePhpApiDoc/Renderers/Markdown/MarkdownRenderer.md
@@ -28,8 +28,8 @@ MarkdownRenderer constructor.
 
 |Param|Type|Description|
 |---|---|---|
-|`$context`|*\spaceonfire\SimplePhpApiDoc\Context|null*||
-|`$outputDir`|*string|null*||
+|`$context`|*\spaceonfire\SimplePhpApiDoc\Context&#124;null*||
+|`$outputDir`|*string&#124;null*||
 
 ```php
 public function MarkdownRenderer::__construct(\spaceonfire\SimplePhpApiDoc\Context $context = null, string $outputDir = null): mixed
diff --git a/src/Renderers/Markdown/views/_methods.php b/src/Renderers/Markdown/views/_methods.php
@@ -31,12 +31,21 @@
 
         $tagsTable = [['Param', 'Type', 'Description']];
         foreach ($docblock->getTags() as $tag) {
+            if (!in_array($tag->getName(), ['param', 'return', 'throw'], true)) {
+                continue;
+            }
+
+            $types = trim(implode('&#124;', explode('|', $tag->getType() ?? '')));
+            if ($types !== '') {
+                $types = MarkdownHelper::italic($types);
+            }
+
             switch ($tag->getName()) {
                 case 'param':
                     /** @var Param $tag */
                     $tagsTable[] = [
                         MarkdownHelper::code(($tag->isVariadic() ? '...' : '') . '$' . $tag->getVariableName()),
-                        $tag->getType() ? MarkdownHelper::italic((string)$tag->getType()) : null,
+                        $types,
                         (string)$tag->getDescription(),
                     ];
                     break;
@@ -45,7 +54,7 @@
                     /** @var Return_ $tag */
                     $tagsTable[] = [
                         MarkdownHelper::strong('Return'),
-                        $tag->getType() ? MarkdownHelper::italic((string)$tag->getType()) : null,
+                        $types,
                         (string)$tag->getDescription(),
                     ];
                     break;
@@ -54,7 +63,7 @@
                     /** @var Throws $tag */
                     $tagsTable[] = [
                         MarkdownHelper::strong('Throws'),
-                        $tag->getType() ? MarkdownHelper::italic((string)$tag->getType()) : null,
+                        $types,
                         (string)$tag->getDescription(),
                     ];
                     break;
