Extends
lithium\test\Unit
This is a short description.
This is a longer description...
That contains
multiple lines
Returns
void This tag contains a email@address.com.Links
Source
public function testTagParsing() {
$info = Inspector::info(__METHOD__ . '()');
$result = Docblock::comment($info['comment']);
$this->assertEqual('This is a short description.', $result['description']);
$expected = "This is a longer description...\nThat contains\nmultiple lines";
$this->assertEqual($expected, $result['text']);
$tags = $result['tags'];
$expected = array('important', 'discuss', 'link', 'see', 'return');
$this->assertEqual($expected, array_keys($tags));
$this->assertEqual("This is a tag that\n spans\nseveral\nlines.", $tags['discuss'][0]);
$this->assertEqual("The second discussion item", $tags['discuss'][1]);
$this->assertEqual('void This tag contains a email@address.com.', $tags['return']);
$this->assertEqual(array(), Docblock::tags(null));
$this->assertEqual(array('params' => array()), Docblock::tags("Foobar\n\n@param string"));
}