File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change 33
44This is a experiment! Lets check and fix the php documentation automatically.
55
6+ ### install
67``` bash
78git clone https://github.com/php/doc-en.git
89git clone https://github.com/php/php-src.git // optional: by default we use the PhpStorm Stubs
910git clone https://github.com/voku/php-doc-fixer.git
1011cd php-doc-fixer/
1112composer update --prefer-dist
13+ ```
14+
15+ ### command
16+ ```
1217php 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+ ```
You can’t perform that action at this time.
0 commit comments