Skip to content

Commit db31d35

Browse files
committed
parseAnnotation short description
1 parent 10d8374 commit db31d35

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

src/annotations/standard/PropertyAnnotation.php

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,35 @@
1414
namespace mindplay\annotations\standard;
1515

1616
use mindplay\annotations\Annotation;
17-
use mindplay\annotations\IAnnotationParser;
1817
use mindplay\annotations\AnnotationException;
19-
use mindplay\annotations\IAnnotationFileAware;
2018
use mindplay\annotations\AnnotationFile;
19+
use mindplay\annotations\IAnnotationFileAware;
20+
use mindplay\annotations\IAnnotationParser;
21+
2122

2223
/**
23-
* Defines a magic/virtual property and it's type
24+
* Defines a magic/virtual property and it's type.
2425
*
2526
* @usage('class'=>true, 'inherited'=>true)
2627
*/
2728
class PropertyAnnotation extends Annotation implements IAnnotationParser, IAnnotationFileAware
2829
{
2930
/**
30-
* Specifies the property type
31+
* Specifies the property type.
3132
*
3233
* @var string
3334
*/
3435
public $type;
3536

3637
/**
37-
* Specifies the property name
38+
* Specifies the property name.
3839
*
3940
* @var string
4041
*/
4142
public $name;
4243

4344
/**
44-
* Specifies the property description
45+
* Specifies the property description.
4546
*
4647
* @var string
4748
*/
@@ -55,9 +56,11 @@ class PropertyAnnotation extends Annotation implements IAnnotationParser, IAnnot
5556
protected $file;
5657

5758
/**
59+
* Parse the standard PHP-DOC "property" annotation.
60+
*
5861
* @param string $value The raw string value of the Annotation.
5962
*
60-
* @return array An array of Annotation properties.
63+
* @return array ['type', 'name'] or ['type', 'name', 'description'] if description is set.
6164
*/
6265
public static function parseAnnotation($value)
6366
{

0 commit comments

Comments
 (0)