From dccebe0439b86038541c0debc6ca238af60982da Mon Sep 17 00:00:00 2001 From: Samuel Gordalina Date: Fri, 13 Jul 2012 14:07:56 +0100 Subject: [PATCH] Add documentation in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c92d0ad..e28453e 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,10 @@ use Nelmio\ApiDocBundle\Annotation\ApiDoc; class YourController extends Controller { /** + * This the documentation description of your method, it will appear + * on a specific pane. It will read all the text until the first + * annotation. + * * @ApiDoc( * resource=true, * description="This is a description of your API method",