RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

adds the ability to modify the documentation property inside custom extractor handlers

Browse Source
This commit is contained in:
keith kirk 2013-07-25 13:47:54 -07:00
parent 3b6223feb2
commit f67dfb05db
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Annotation/ApiDoc.php
View File

@ -266,6 +266,14 @@ class ApiDoc
$this->documentation = $documentation; $this->documentation = $documentation;
} }
/**
* @return string
*/
public function getDocumentation()
{
return $this->documentation;
}
/** /**
* @return Boolean * @return Boolean
*/ */

8
Extractor/ApiDocExtractor.php
View File

@ -239,6 +239,9 @@ class ApiDocExtractor
// create a new annotation // create a new annotation
$annotation = clone $annotation; $annotation = clone $annotation;
// doc
$annotation->setDocumentation($this->commentExtractor->getDocCommentText($method));
// parse annotations // parse annotations
$this->parseAnnotations($annotation, $route, $method); $this->parseAnnotations($annotation, $route, $method);
@ -247,7 +250,7 @@ class ApiDocExtractor
// description // description
if (null === $annotation->getDescription()) { if (null === $annotation->getDescription()) {
$comments = explode("\n", $this->commentExtractor->getDocCommentText($method)); $comments = explode("\n", $annotation->getDocumentation());
// just set the first line // just set the first line
$comment = trim($comments[0]); $comment = trim($comments[0]);
$comment = preg_replace("#\n+#", ' ', $comment); $comment = preg_replace("#\n+#", ' ', $comment);
@ -259,9 +262,6 @@ class ApiDocExtractor
} }
} }
// doc
$annotation->setDocumentation($this->commentExtractor->getDocCommentText($method));
// input (populates 'parameters' for the formatters) // input (populates 'parameters' for the formatters)
if (null !== $input = $annotation->getInput()) { if (null !== $input = $annotation->getInput()) {
$parameters = array(); $parameters = array();