Skip to content

Commit 6444899

Browse files
committed
Move example directory, remove submodule
1 parent c4496c6 commit 6444899

File tree

15 files changed

+561
-6
lines changed

15 files changed

+561
-6
lines changed

.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.

.wiki/Home.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Pizza Place (Example documentation)
2+
3+
This is an automatically generated documentation for **Pizza Place (Example documentation)**.
4+
5+
## Namespaces
6+
7+
### \PhpDocumentorMarkdown\Example
8+
9+
#### Classes
10+
11+
| Class | Description |
12+
|------------------------------------------------------------------------------|------------------------------|
13+
| [`AbstractProduct`](./classes/PhpDocumentorMarkdown/Example/AbstractProduct) | Base class for all products. |
14+
| [`Pizza`](./classes/PhpDocumentorMarkdown/Example/Pizza) | A pizza \| pie's. |
15+
16+
#### Traits
17+
18+
| Trait | Description |
19+
|------------------------------------------------------------------------------|---------------------------------|
20+
| [`ReviewableTrait`](./classes/PhpDocumentorMarkdown/Example/ReviewableTrait) | A trait for reviewable objects. |
21+
22+
#### Interfaces
23+
24+
| Interface | Description |
25+
|--------------------------------------------------------------------------------|--------------------------|
26+
| [`Arrayable`](./classes/PhpDocumentorMarkdown/Example/Arrayable) | |
27+
| [`ManyInterfaces`](./classes/PhpDocumentorMarkdown/Example/ManyInterfaces) | A ManyInterfaces |
28+
| [`ProductInterface`](./classes/PhpDocumentorMarkdown/Example/ProductInterface) | Interface for a product. |
29+
30+
### \PhpDocumentorMarkdown\Example\Pizza
31+
32+
#### Classes
33+
34+
| Class | Description |
35+
|----------------------------------------------------------------|--------------------------|
36+
| [`Base`](./classes/PhpDocumentorMarkdown/Example/Pizza/Base) | Represents a pizza base. |
37+
| [`Sauce`](./classes/PhpDocumentorMarkdown/Example/Pizza/Sauce) | Pizza sauce class. |
38+
39+
### \PhpDocumentorMarkdown\Functions
40+
41+
#### Functions
42+
43+
| Function | Description |
44+
|--------------------------------------------------------------------------|--------------------------------------------------|
45+
| [`mockFunctionWithParameters()`](./functions/mockFunctionWithParameters) | Mock function to demonstrate parameter handling. |
46+
| [`getDatabaseConfig()`](./functions/getDatabaseConfig) | Get database configuration. |
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# AbstractProduct
2+
3+
Base class for all products.
4+
5+
***
6+
7+
* Full name: `\PhpDocumentorMarkdown\Example\AbstractProduct`
8+
* This class implements:
9+
[`\PhpDocumentorMarkdown\Example\ProductInterface`](./ProductInterface)
10+
* This class is an **Abstract class**
11+
12+
**See Also:**
13+
14+
* https://example.com
15+
16+
## Methods
17+
18+
### getTaxRate
19+
20+
Get the tax rate for the product.
21+
22+
```php
23+
public getTaxRate(): float
24+
```
25+
26+
***
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Arrayable
2+
3+
***
4+
5+
* Full name: `\PhpDocumentorMarkdown\Example\Arrayable`
6+
7+
## Methods
8+
9+
### toArray
10+
11+
Get the instance as an array.
12+
13+
```php
14+
public toArray(): array
15+
```
16+
17+
***
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# ManyInterfaces
2+
3+
A ManyInterfaces
4+
5+
ManyInterfaces description
6+
7+
- **See:** \PhpDocumentorMarkdown\Example\AbstractProduct
8+
9+
***
10+
11+
* Full name: `\PhpDocumentorMarkdown\Example\ManyInterfaces`
12+
* Parent interfaces:
13+
[`\PhpDocumentorMarkdown\Example\ProductInterface`](./ProductInterface),
14+
`JsonSerializable`
15+
16+
## Inherited methods
17+
18+
### toArray
19+
20+
Get the instance as an array.
21+
22+
```php
23+
public toArray(): array
24+
```
25+
26+
***
27+
28+
### __construct
29+
30+
```php
31+
public __construct(string $name, float $price): mixed
32+
```
33+
34+
**Parameters:**
35+
36+
| Parameter | Type | Description |
37+
|-----------|------------|----------------|
38+
| `$name` | **string** | Product name. |
39+
| `$price` | **float** | Product price. |
40+
41+
***
42+
43+
### getName
44+
45+
Get the name of the product.
46+
47+
```php
48+
public getName(): string
49+
```
50+
51+
***
52+
53+
### getPrice
54+
55+
Get the price of the product.
56+
57+
```php
58+
public getPrice(): float
59+
```
60+
61+
***
62+
63+
### getTaxRate
64+
65+
Get the tax rate for this product.
66+
67+
```php
68+
public getTaxRate(): float
69+
```
70+
71+
***
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Pizza
2+
3+
A pizza \| pie's.
4+
5+
***
6+
7+
* Full name: `\PhpDocumentorMarkdown\Example\Pizza`
8+
* Parent class: [`\PhpDocumentorMarkdown\Example\AbstractProduct`](./AbstractProduct)
9+
* This class implements:
10+
[`\PhpDocumentorMarkdown\Example\ProductInterface`](./ProductInterface),
11+
`JsonSerializable`
12+
13+
## Properties
14+
15+
### name
16+
17+
Product name.
18+
19+
```php
20+
private string $name
21+
```
22+
23+
***
24+
25+
### price
26+
27+
Product price.
28+
29+
```php
30+
protected float $price
31+
```
32+
33+
***
34+
35+
### base
36+
37+
Pizza base.
38+
39+
```php
40+
protected \PhpDocumentorMarkdown\Example\Pizza\Base|null $base
41+
```
42+
43+
Property base description
44+
45+
- **See:** \PhpDocumentorMarkdown\Example\ManyInterfaces
46+
47+
***
48+
49+
## Methods
50+
51+
### __construct
52+
53+
Constructor title
54+
55+
```php
56+
public __construct(string $name = '', float $price = 10.0, \PhpDocumentorMarkdown\Example\Pizza\Base|null $base = null): mixed
57+
```
58+
59+
Constructor description
60+
61+
- **See:** \PhpDocumentorMarkdown\Example\ManyInterfaces
62+
- **See:** https://example.com
63+
64+
**Parameters:**
65+
66+
| Parameter | Type | Description |
67+
|-----------|-----------------------------------------------------|----------------|
68+
| `$name` | **string** | Product name. |
69+
| `$price` | **float** | Product price. |
70+
| `$base` | **\PhpDocumentorMarkdown\Example\Pizza\Base\|null** | Pizza's base. |
71+
72+
***
73+
74+
### getName
75+
76+
Get the name of the product.
77+
78+
```php
79+
public getName(): string
80+
```
81+
82+
**Return Value:**
83+
84+
The name of the product.
85+
86+
***
87+
88+
### getPrice
89+
90+
Get the price of the product.
91+
92+
```php
93+
public getPrice(): float
94+
```
95+
96+
***
97+
98+
### jsonSerialize
99+
100+
```php
101+
public jsonSerialize(): mixed
102+
```
103+
104+
***
105+
106+
### toArray
107+
108+
Get the instance as an array.
109+
110+
```php
111+
public toArray(): array
112+
```
113+
114+
***
115+
116+
## Inherited methods
117+
118+
### getTaxRate
119+
120+
Get the tax rate for the product.
121+
122+
```php
123+
public getTaxRate(): float
124+
```
125+
126+
***
127+
128+
### isReviewed
129+
130+
Whether the object has been reviewed.
131+
132+
```php
133+
public isReviewed(): bool
134+
```
135+
136+
***
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Base
2+
3+
Represents a pizza base.
4+
5+
***
6+
7+
* Full name: `\PhpDocumentorMarkdown\Example\Pizza\Base`
8+
9+
## Constants
10+
11+
| Constant | Visibility | Type | Value |
12+
|---------------------------|------------|------|-------|
13+
| `YEAST_SOURDOUGH_STARTER` | private | | 0b1 |
14+
| `YEAST_FRESH` | public | | 0b10 |
15+
| `YEAST_ACTIVE_DRY` | public | | 0b11 |
16+
17+
## Properties
18+
19+
### sauce
20+
21+
The sauce used.
22+
23+
```php
24+
protected \PhpDocumentorMarkdown\Example\Pizza\Sauce $sauce
25+
```
26+
27+
***
28+
29+
### yeast
30+
31+
Type of yeast used.
32+
33+
```php
34+
protected int $yeast
35+
```
36+
37+
***
38+
39+
## Methods
40+
41+
### __construct
42+
43+
```php
44+
public __construct(\PhpDocumentorMarkdown\Example\Pizza\Sauce $sauce, int $yeast = self::YEAST_SOURDOUGH_STARTER): mixed
45+
```
46+
47+
**Parameters:**
48+
49+
| Parameter | Type | Description |
50+
|-----------|------------------------------------------------|-------------|
51+
| `$sauce` | **\PhpDocumentorMarkdown\Example\Pizza\Sauce** | |
52+
| `$yeast` | **int** | |
53+
54+
***
55+
56+
### getSauce
57+
58+
```php
59+
public getSauce(): \PhpDocumentorMarkdown\Example\Pizza\Sauce
60+
```
61+
62+
***
63+
64+
### getYeast
65+
66+
```php
67+
public getYeast(): int
68+
```
69+
70+
**Throws:**
71+
72+
- [`Exception`](../../../Exception)
73+
74+
***

0 commit comments

Comments
 (0)