Skip to content

Commit 3d36fed

Browse files
committed
[+]: update the README
1 parent f035129 commit 3d36fed

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,26 @@
33

44
This is a experiment! Lets check and fix the php documentation automatically.
55

6+
### install
67
```bash
78
git clone https://github.com/php/doc-en.git
89
git clone https://github.com/php/php-src.git // optional: by default we use the PhpStorm Stubs
910
git clone https://github.com/voku/php-doc-fixer.git
1011
cd php-doc-fixer/
1112
composer update --prefer-dist
13+
```
14+
15+
### command
16+
```
1217
php bin/phpdocfixer run [--auto-fix="true"] [--remove-array-value-info="true"] [--stubs-path="../php-src/"] [--stubs-file-extension=".stub.php"] ../doc-en/reference/
1318
```
19+
20+
### example: sync types from PhpStorm Stubs into the php-documentation
21+
```
22+
php bin/phpdocfixer run --auto-fix="true" --remove-array-value-info="true" ../doc-en/reference/
23+
```
24+
25+
### example: sync types from php-src into the php-documentation, but only for BCMath (bc)
26+
```
27+
php bin/phpdocfixer run --auto-fix="true" --stubs-path="../php-src/" --stubs-file-extension=".stub.php" ../doc-en/reference/bc/
28+
```

0 commit comments

Comments
 (0)