li3_docs\doc\Docblock::_parse()
Parses a docblock into its major components of summary
, description
and tags
.
Parameters
-
string
$comment
The docblock string to be parsed
Returns
voidSource
protected function _parse($comment) {
$summary = null;
$description = null;
$tags = array();
$comment = trim(preg_replace('/^(\s*\/\*\*|\s*\*{1,2}\/|\s*\* ?)/m', '', $comment));
$comment = str_replace("\r\n", "\n", $comment);
if ($items = preg_split('/\n@/ms', $comment, 2)) {
list($summary, $tags) = $items + array('', '');
$this->_tags = $tags ? $this->_parseTags("@{$tags}") : array();
}
if (strpos($summary, "\n\n")) {
list($summary, $description) = explode("\n\n", $summary, 2);
}
$this->_summary = $this->_clean($summary);
$this->_description = $this->_clean($description);
}