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

Merge pull request #180 from lightglitch/deprecated

Browse Source 
Added support for deprecated phpdoc tag
This commit is contained in:
William Durand 2013-04-16 12:30:26 -07:00
commit c5971321cc
3 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Extractor/ApiDocExtractor.php
View File

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

12
Tests/Extractor/ApiDocExtratorTest.php
View File

@ -179,4 +179,16 @@ class ApiDocExtractorTest extends WebTestCase
$annotation->getCache()
);
}
public function testGetWithDeprecated()
{
$container = $this->getContainer();
$extractor = $container->get('nelmio_api_doc.extractor.api_doc_extractor');
$annotation = $extractor->get('Nelmio\ApiDocBundle\Tests\Fixtures\Controller\TestController::DeprecatedAction', 'test_route_14');
$this->assertNotNull($annotation);
$this->assertTrue(
$annotation->getDeprecated()
);
}
}

8
Tests/Fixtures/Controller/TestController.php
View File

@ -154,4 +154,12 @@ class TestController
public function cachedAction()
{
}
/**
* @ApiDoc()
* @deprecated
*/
public function deprecatedAction()
{
}
}