mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 15:51:48 +03:00
Merge branch '1.0.x'
This commit is contained in:
commit
0ab2278667
@ -11,15 +11,20 @@ For Symfony 2.0.x, you need to use the 1.* version of the bundle.
|
||||
|
||||
## Installation ##
|
||||
|
||||
|
||||
This bundle uses
|
||||
[KnpMarkdownBundle](https://github.com/KnpLabs/KnpMarkdownBundle).
|
||||
|
||||
Register the namespace in `app/autoload.php`:
|
||||
|
||||
// app/autoload.php
|
||||
$loader->registerNamespaces(array(
|
||||
// ...
|
||||
'Nelmio' => __DIR__.'/../vendor/bundles',
|
||||
'Knp' => __DIR__.'/../vendor/bundles',
|
||||
));
|
||||
|
||||
Register the bundle in `app/AppKernel.php`:
|
||||
Register the bundles in `app/AppKernel.php`:
|
||||
|
||||
// app/AppKernel.php
|
||||
public function registerBundles()
|
||||
@ -27,6 +32,7 @@ Register the bundle in `app/AppKernel.php`:
|
||||
return array(
|
||||
// ...
|
||||
new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
|
||||
new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(),
|
||||
);
|
||||
}
|
||||
|
||||
|
@ -140,7 +140,7 @@ class ApiDocExtractorTest extends WebTestCase
|
||||
|
||||
$this->assertNotNull($data);
|
||||
$this->assertEquals(
|
||||
"This method is useful to test if the getDocComment works. And, it supports multilines until the first '@' char.",
|
||||
"This method is useful to test if the getDocComment works.",
|
||||
$data['annotation']->getDescription()
|
||||
);
|
||||
}
|
||||
|
@ -137,7 +137,7 @@ _Action without HTTP verb_
|
||||
|
||||
### `ANY` /my-commented/{id}/{page} ###
|
||||
|
||||
_This method is useful to test if the getDocComment works. And, it supports multilines until the first '@' char._
|
||||
_This method is useful to test if the getDocComment works._
|
||||
|
||||
#### Requirements ####
|
||||
|
||||
|
@ -185,7 +185,7 @@ class SimpleFormatterTest extends WebTestCase
|
||||
'id' => array('type' => 'int', 'description' => 'A nice comment', 'value' => ''),
|
||||
'page' => array('type' => 'int', 'description' => '', 'value' => ''),
|
||||
),
|
||||
'description' => 'This method is useful to test if the getDocComment works. And, it supports multilines until the first \'@\' char.',
|
||||
'description' => 'This method is useful to test if the getDocComment works.',
|
||||
'documentation' => "This method is useful to test if the getDocComment works.\nAnd, it supports multilines until the first '@' char."
|
||||
),
|
||||
4 =>
|
||||
|
Loading…
x
Reference in New Issue
Block a user