This repository was archived by the owner on Dec 29, 2020. It is now read-only.
File tree 1 file changed +13
-4
lines changed
1 file changed +13
-4
lines changed Original file line number Diff line number Diff line change 1
1
# PHPDoc to Type Hint
2
2
3
+ ` phpdoc-to-typehint ` adds automatically scalar type hints and return types to all functions and methods of a PHP project
4
+ using existing PHPDoc annotations.
5
+
3
6
[ ![ Build Status] ( https://travis-ci.org/dunglas/phpdoc-to-typehint.svg?branch=master )] ( https://travis-ci.org/dunglas/phpdoc-to-typehint )
4
7
[ ![ Scrutinizer Code Quality] ( https://scrutinizer-ci.com/g/dunglas/phpdoc-to-typehint/badges/quality-score.png?b=master )] ( https://scrutinizer-ci.com/g/dunglas/phpdoc-to-typehint/?branch=master )
5
8
6
- Add automatically scalar type hints and return types to all functions and methods of a PHP project using existing
7
- PHPDoc annotations.
9
+ ** Warning** : this project is an early stage of development. It ** can** damage your code.
10
+ Be sure to make a backup before running this command and to run your test suite after.
11
+
12
+ Please [ report] ( https://github.com/dunglas/phpdoc-to-typehint/issues ) any bug you find using this tool.
13
+
14
+ ## Install and usage
15
+
16
+ 1 . [ Download the latest PHAR file] ( https://github.com/dunglas/phpdoc-to-typehint/releases )
17
+ 2 . Run `php phpdoc-to-typehint.phar <your-project-directory >
8
18
9
- ** Warning** : this project is an early stage and is experimental. It ** can** damage your code.
10
- Be sure to make a backup before running this command and to run all your test suites after.
19
+ You're project should have scalar type hints and return type declarations.
11
20
12
21
## Credits
13
22
You can’t perform that action at this time.
0 commit comments