Merge branch TheWhatis/master

Co-authored-by: TheWhatis <[email protected]>

Author: Saggre

example/Home.md

@@ -0,0 +1,54 @@
+
+***
+
+# Pizza Place (Example documentation)
+
+
+
+This is an automatically generated documentation for **Pizza Place (Example documentation)**.
+
+
+## Namespaces
+
+
+### \PhpDocumentorMarkdown\Example
+
+#### Classes
+
+| Class | Description |
+|-------|-------------|
+| [`AbstractProduct`](./classes/PhpDocumentorMarkdown/Example/AbstractProduct.md) | Base class for all products.|
+| [`Pizza`](./classes/PhpDocumentorMarkdown/Example/Pizza.md) | A pizza.|
+
+
+#### Traits
+
+| Trait | Description |
+|-------|-------------|
+| [`ReviewableTrait`](./classes/PhpDocumentorMarkdown/Example/ReviewableTrait.md) | A trait for reviewable objects.|
+
+
+
+#### Interfaces
+
+| Interface | Description |
+|-----------|-------------|
+| [`ManyInterfaces`](./classes/PhpDocumentorMarkdown/Example/ManyInterfaces.md) | A ManyInterfaces|
+| [`ProductInterface`](./classes/PhpDocumentorMarkdown/Example/ProductInterface.md) | Interface for a product.|
+
+
+
+### \PhpDocumentorMarkdown\Example\Pizza
+
+#### Classes
+
+| Class | Description |
+|-------|-------------|
+| [`Base`](./classes/PhpDocumentorMarkdown/Example/Pizza/Base.md) | Represents a pizza base.|
+| [`Sauce`](./classes/PhpDocumentorMarkdown/Example/Pizza/Sauce.md) | Pizza sauce class.|
+
+
+
+
+***
+> Automatically generated on 2023-11-16

example/classes/PhpDocumentorMarkdown/Example/Pizza/Base.md

@@ -0,0 +1,124 @@
+***
+
+# Base
+
+Represents a pizza base.
+
+
+* Full name: `\PhpDocumentorMarkdown\Example\Pizza\Base`
+
+
+## Constants
+
+| Constant | Visibility | Type | Value |
+|:---------|:-----------|:-----|:------|
+|`YEAST_SOURDOUGH_STARTER`|private| |0b1|
+|`YEAST_FRESH`|public| |0b10|
+|`YEAST_ACTIVE_DRY`|public| |0b11|
+
+## Properties
+
+
+### sauce
+
+The sauce used.
+
+```php
+protected \PhpDocumentorMarkdown\Example\Pizza\Sauce $sauce
+```
+
+
+
+
+
+
+***
+
+### yeast
+
+Type of yeast used.
+
+```php
+protected int $yeast
+```
+
+
+
+
+
+
+***
+
+## Methods
+
+
+### __construct
+
+
+
+```php
+public __construct(\PhpDocumentorMarkdown\Example\Pizza\Sauce $sauce, int $yeast = self::YEAST_SOURDOUGH_STARTER): mixed
+```
+
+
+
+
+
+
+
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `$sauce` | **\PhpDocumentorMarkdown\Example\Pizza\Sauce** |  |
+| `$yeast` | **int** |  |
+
+
+
+
+***
+
+### getSauce
+
+
+
+```php
+public getSauce(): \PhpDocumentorMarkdown\Example\Pizza\Sauce
+```
+
+
+
+
+
+
+
+
+
+
+
+***
+
+### getYeast
+
+
+
+```php
+public getYeast(): int
+```
+
+
+
+
+
+
+
+
+
+
+
+***
+
+
+***
+> Automatically generated on 2023-11-16

src/Example/ManyInterfaces.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpDocumentorMarkdown\Example;
+
+use JsonSerializable;
+
+/**
+ * A ManyInterfaces
+ *
+ * ManyInterfaces description {@see AbstractProduct}
+ */
+interface ManyInterfaces extends ProductInterface, JsonSerializable
+{
+    // ...
+}

src/Example/Pizza.php

@@ -29,11 +29,17 @@ class Pizza extends AbstractProduct implements ProductInterface, JsonSerializabl
     /**
      * Pizza base.
      *
+     * Property base description {@see ManyInterfaces}
+     *
      * @var Base|null
      */
     protected ?Base $base;
 
     /**
+     * Constructor title
+     *
+     * Constructor description {@see ManyInterfaces} {@see https://example.com}
+     *
      * @param  string  $name  Product name.
      * @param  float  $price  Product price.
      * @param  Base|null  $base  Pizza base.
@@ -69,4 +75,9 @@ public function jsonSerialize()
     {
         // TODO: Implement jsonSerialize() method.
     }
+
+    public function toArray(): array
+    {
+        // TODO: Implement toArray() method.
+    }
 }

tests/Functional/expected/Home.md

@@ -24,6 +24,7 @@ This is an automatically generated documentation for **Pizza Place (Example docu
 | Interface                                                                         | Description              |
 |-----------------------------------------------------------------------------------|--------------------------|
 | [`Arrayable`](./classes/PhpDocumentorMarkdown/Example/Arrayable.md)               |                          |
+| [`ManyInterfaces`](./classes/PhpDocumentorMarkdown/Example/ManyInterfaces.md)     | A ManyInterfaces         |
 | [`ProductInterface`](./classes/PhpDocumentorMarkdown/Example/ProductInterface.md) | Interface for a product. |
 
 ### \PhpDocumentorMarkdown\Example\Pizza

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/AbstractProduct.md

@@ -2,6 +2,8 @@
 
 Base class for all products.
 
+***
+
 * Full name: `\PhpDocumentorMarkdown\Example\AbstractProduct`
 * This class implements:
   [`\PhpDocumentorMarkdown\Example\ProductInterface`](./ProductInterface.md)

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/Arrayable.md

@@ -1,5 +1,7 @@
 # Arrayable
 
+***
+
 * Full name: `\PhpDocumentorMarkdown\Example\Arrayable`
 
 ## Methods

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/ManyInterfaces.md

@@ -0,0 +1,68 @@
+# ManyInterfaces
+
+ManyInterfaces description
+
+- **See:** \PhpDocumentorMarkdown\Example\AbstractProduct
+
+***
+
+* Full name: `\PhpDocumentorMarkdown\Example\ManyInterfaces`
+* Parent interfaces:
+  [`\PhpDocumentorMarkdown\Example\ProductInterface`](./ProductInterface.md)[`JsonSerializable`](../../JsonSerializable.md),
+
+## Inherited methods
+
+### toArray
+
+Get the instance as an array.
+
+```php
+public toArray(): array
+```
+
+***
+
+### __construct
+
+```php
+public __construct(string $name, float $price): mixed
+```
+
+**Parameters:**
+
+| Parameter | Type       | Description    |
+|-----------|------------|----------------|
+| `$name`   | **string** | Product name.  |
+| `$price`  | **float**  | Product price. |
+
+***
+
+### getName
+
+Get the name of the product.
+
+```php
+public getName(): string
+```
+
+***
+
+### getPrice
+
+Get the price of the product.
+
+```php
+public getPrice(): float
+```
+
+***
+
+### getTaxRate
+
+Get the tax rate for this product.
+
+```php
+public getTaxRate(): float
+```
+
+***

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/Pizza.md

@@ -2,6 +2,8 @@
 
 A pizza \| pie.
 
+***
+
 * Full name: `\PhpDocumentorMarkdown\Example\Pizza`
 * Parent class: [`\PhpDocumentorMarkdown\Example\AbstractProduct`](./AbstractProduct.md)
 * This class implements:
@@ -38,16 +40,27 @@ Pizza base.
 protected \PhpDocumentorMarkdown\Example\Pizza\Base|null $base
 ```
 
+Property base description 
+
+- **See:** \PhpDocumentorMarkdown\Example\ManyInterfaces
+
 ***
 
 ## Methods
 
 ### __construct
 
+Constructor title
+
 ```php
 public __construct(string $name, float $price, \PhpDocumentorMarkdown\Example\Pizza\Base|null $base = null): mixed
 ```
 
+Constructor description 
+
+- **See:** \PhpDocumentorMarkdown\Example\ManyInterfaces 
+- **See:** https://example.com
+
 **Parameters:**
 
 | Parameter | Type                                                | Description    |
@@ -90,6 +103,16 @@ public jsonSerialize(): mixed
 
 ***
 
+### toArray
+
+Get the instance as an array.
+
+```php
+public toArray(): array
+```
+
+***
+
 ## Inherited methods
 
 ### getTaxRate

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/Pizza/Base.md

@@ -2,6 +2,8 @@
 
 Represents a pizza base.
 
+***
+
 * Full name: `\PhpDocumentorMarkdown\Example\Pizza\Base`
 
 ## Constants