Defines an interface for documentation parsers.
Source for this file: /Reflection/src/interfaces/doc_comment_parser.php
Version: | //autogen// |
public ezcReflectionAnnotation[] |
getAnnotations(
)
Retrieve all found annotations |
public ezcReflectionAnnotation[] |
getAnnotationsByName(
$name
)
Return all found annotations with the given name. |
public string |
getLongDescription(
)
Returns long description |
public ezcReflectionAnnotationParam[] |
getParamAnnotations(
)
Retrieve all param annotations |
public ezcReflectionAnnotationReturn[] |
getReturnAnnotations(
)
Retrieve all return annotations |
public string |
getShortDescription(
)
Returns short description |
public ezcReflectionAnnotationVar[] |
getVarAnnotations(
)
Retrieve all var annotations |
public boolean |
hasAnnotation(
$with
)
Checks whether an annotation was used in the parsed documentation fragment |
public void |
parse(
$docComment
)
Initialize parsing of the given documentation fragment. |
Retrieve all found annotations
Return all found annotations with the given name.
Name | Type | Description |
---|---|---|
$name |
string |
Returns long description
Retrieve all param annotations
Retrieve all return annotations
Returns short description
Retrieve all var annotations
Checks whether an annotation was used in the parsed documentation fragment
Name | Type | Description |
---|---|---|
$with |
string | name of used annotation |
Initialize parsing of the given documentation fragment.
Results can be retrieved after completion by the getters provided.
Name | Type | Description |
---|---|---|
$docComment |
string |