Skip to content

Commit 46a218c

Browse files
committed
Update README.md
1 parent 46bcd87 commit 46a218c

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,43 @@
22

33
[![Build Status](https://travis-ci.org/mnapoli/PhpDocReader.png?branch=master)](https://travis-ci.org/mnapoli/PhpDocReader) [![Coverage Status](https://coveralls.io/repos/mnapoli/PhpDocReader/badge.png)](https://coveralls.io/r/mnapoli/PhpDocReader)
44

5-
This project is a sub-project of [PHP-DI](http://mnapoli.github.io/PHP-DI/).
5+
This project is used by:
6+
7+
- [PHP-DI](http://php-di.org/)
8+
- [phockito-unit-php-di](https://github.com/balihoo/phockito-unit-php-di)
9+
10+
Fork the README to add your project here.
11+
12+
## Features
13+
14+
PhpDocReader parses `@var` and `@param` values in PHP docblocks:
15+
16+
```php
17+
18+
use My\Cache\Backend;
19+
20+
class Cache
21+
{
22+
/**
23+
* @var Backend
24+
*/
25+
protected $backend;
26+
27+
/**
28+
* @param Backend $backend
29+
*/
30+
public function __construct($backend)
31+
{
32+
}
33+
}
34+
```
35+
36+
It supports namespaced class names with the same resolution rules as PHP:
37+
38+
- fully qualified name (starting with `\`)
39+
- imported class name (eg. `use My\Cache\Backend;`)
40+
- relative class name (from the current namespace, like `SubNamespace\MyClass`)
41+
- aliased class name (eg. `use My\Cache\Backend as FooBar;`)
642

743
## Usage
844

0 commit comments

Comments
 (0)