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

Merge branch '1.0.x'

Browse Source
This commit is contained in:
William DURAND 2012-07-13 16:08:29 +02:00
commit 0ab2278667
4 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,15 +11,20 @@ For Symfony 2.0.x, you need to use the 1.* version of the bundle.
## Installation ## ## Installation ##
This bundle uses
[KnpMarkdownBundle](https://github.com/KnpLabs/KnpMarkdownBundle).
Register the namespace in `app/autoload.php`: Register the namespace in `app/autoload.php`:
// app/autoload.php // app/autoload.php
$loader->registerNamespaces(array( $loader->registerNamespaces(array(
// ... // ...
'Nelmio' => __DIR__.'/../vendor/bundles', '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 // app/AppKernel.php
public function registerBundles() public function registerBundles()
@ -27,6 +32,7 @@ Register the bundle in `app/AppKernel.php`:
return array( return array(
// ... // ...
new Nelmio\ApiDocBundle\NelmioApiDocBundle(), new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(),
); );
} }

2
Tests/Extractor/ApiDocExtratorTest.php
View File

@ -140,7 +140,7 @@ class ApiDocExtractorTest extends WebTestCase
$this->assertNotNull($data); $this->assertNotNull($data);
$this->assertEquals( $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() $data['annotation']->getDescription()
); );
} }

2
Tests/Formatter/MarkdownFormatterTest.php
View File

@ -137,7 +137,7 @@ _Action without HTTP verb_
### `ANY` /my-commented/{id}/{page} ### ### `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 #### #### Requirements ####

2
Tests/Formatter/SimpleFormatterTest.php
View File

@ -185,7 +185,7 @@ class SimpleFormatterTest extends WebTestCase
'id' => array('type' => 'int', 'description' => 'A nice comment', 'value' => ''), 'id' => array('type' => 'int', 'description' => 'A nice comment', 'value' => ''),
'page' => array('type' => 'int', 'description' => '', '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." 'documentation' => "This method is useful to test if the getDocComment works.\nAnd, it supports multilines until the first '@' char."
), ),
4 => 4 =>