| 프로퍼티 | 타입 | 설명 | |
|---|---|---|---|
| $description | string | The description as found in the doc comment | |
| $tags | array | An array of tag names and their values (multiple values are possible) |
| 메소드 | 설명 | |
|---|---|---|
| getDescription ( ) : string | Returns the description which has been previously parsed | |
| getTagValues ( string $tagName ) : array | Returns the values of the specified tag. The doc comment must be parsed with parseDocComment() before tags are available. | |
| getTagsValues ( ) : array | Returns the tags which have been previously parsed | |
| isTaggedWith ( string $tagName ) : boolean | Checks if a tag with the given name exists | |
| parseDocComment ( string $docComment ) : void | Parses the given doc comment and saves the result (description and tags) in the parser's object. They can be retrieved by the getTags() getTagValues() and getDescription() methods. |
| 메소드 | 설명 | |
|---|---|---|
| parseTag ( string $line ) : void | Parses a line of a doc comment for a tag and its value. |
| public getDescription ( ) : string | ||
| 리턴 | string | The description which has been parsed |
| public getTagValues ( string $tagName ) : array | ||
| $tagName | string | The tag name to retrieve the values for |
| 리턴 | array | The tag's values |
| public getTagsValues ( ) : array | ||
| 리턴 | array | Array of tag names and their (multiple) values |
| public isTaggedWith ( string $tagName ) : boolean | ||
| $tagName | string | The tag name to check for |
| 리턴 | boolean | TRUE the tag exists, otherwise FALSE |
| public parseDocComment ( string $docComment ) : void | ||
| $docComment | string | A doc comment as returned by the reflection getDocComment() method |
| 리턴 | void | |
| protected string $description | ||
| 리턴 | string | |
| protected array $tags | ||
| 리턴 | array | |
