ExampleTag
This class is only intended to work with @example
tag. It’s instance is already predefined in PhpDocumentor::tags()
.
/**
* @example some_dir/some_file.php 12 24 Misterious foo function in action
*/
function foo()
{
}
$doc = (new ReflectionFunction('foo'))->getDocComment();
$notations = getNotations($doc);
var_export($notations);
That results in
[
'example' => [
'location' => 'some_dir/some_file.php',
'start_line' => 12,
'number_of_lines' => 24,
'description' => 'Misterious foo function in action'
]
]