From c4911f57d2460d7e177acb21fd876072df423909 Mon Sep 17 00:00:00 2001 From: William DURAND Date: Fri, 13 Jul 2012 16:04:29 +0200 Subject: [PATCH 1/2] Fix tests --- Tests/Extractor/ApiDocExtratorTest.php | 2 +- Tests/Formatter/MarkdownFormatterTest.php | 2 +- Tests/Formatter/SimpleFormatterTest.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Tests/Extractor/ApiDocExtratorTest.php b/Tests/Extractor/ApiDocExtratorTest.php index 8e912ab..a5567f4 100644 --- a/Tests/Extractor/ApiDocExtratorTest.php +++ b/Tests/Extractor/ApiDocExtratorTest.php @@ -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() ); } diff --git a/Tests/Formatter/MarkdownFormatterTest.php b/Tests/Formatter/MarkdownFormatterTest.php index a2ae4f3..0952f8f 100644 --- a/Tests/Formatter/MarkdownFormatterTest.php +++ b/Tests/Formatter/MarkdownFormatterTest.php @@ -124,7 +124,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 #### diff --git a/Tests/Formatter/SimpleFormatterTest.php b/Tests/Formatter/SimpleFormatterTest.php index b472096..9b7abcf 100644 --- a/Tests/Formatter/SimpleFormatterTest.php +++ b/Tests/Formatter/SimpleFormatterTest.php @@ -167,7 +167,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." ), 3 => From da12c85ddcb559c0bd5b9d596b362d2eba3949ee Mon Sep 17 00:00:00 2001 From: William DURAND Date: Fri, 13 Jul 2012 16:06:01 +0200 Subject: [PATCH 2/2] Update README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e28453e..a2aea6a 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,20 @@ The **NelmioApiDocBundle** bundle allows you to generate a decent documentation ## 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() @@ -24,6 +29,7 @@ Register the bundle in `app/AppKernel.php`: return array( // ... new Nelmio\ApiDocBundle\NelmioApiDocBundle(), + new Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(), ); }