Enable PHPDoc @link feature

This commit is contained in:
Vincent CHALAMON 2013-08-16 19:18:05 +02:00
parent 4fb050175a
commit a1517543e8
3 changed files with 25 additions and 0 deletions

View File

@ -49,6 +49,11 @@ class ApiDoc
*/
private $output = null;
/**
* @var string
*/
private $link = null;
/**
* Most of the time, a single line of text describing the action.
*
@ -242,6 +247,14 @@ class ApiDoc
$this->description = $description;
}
/**
* @param string $link
*/
public function setLink($link)
{
$this->link = $link;
}
/**
* @param string $section
*/
@ -441,6 +454,10 @@ class ApiDoc
$data['description'] = $description;
}
if ($link = $this->link) {
$data['link'] = $link;
}
if ($documentation = $this->documentation) {
$data['documentation'] = $documentation;
}

View File

@ -337,6 +337,9 @@ class ApiDocExtractor
if (preg_match('{^@deprecated\b(.*)}', trim($line), $matches)) {
$annotation->setDeprecated(true);
}
if (preg_match('{^@link\b(.*)}', trim($line), $matches)) {
$annotation->setLink($matches[1]);
}
}
$regexp = '{(\w*) *\$%s\b *(.*)}i';

View File

@ -48,6 +48,11 @@
<div>{{ data.documentation|extra_markdown }}</div>
{% endif %}
{% if data.link is defined and data.link is not empty %}
<h4>Link</h4>
<div><a href="{{ data.link }}" target="_blank">{{ data.link }}</a></div>
{% endif %}
{% if data.requirements is defined and data.requirements is not empty %}
<h4>Requirements</h4>
<table class="fullwidth">