Add documentation in README

This commit is contained in:
Samuel Gordalina 2012-07-13 14:07:56 +01:00 committed by William DURAND
parent 07e6a19dd4
commit dccebe0439

View File

@ -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",