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

Add documentation in README

Browse source
This commit is contained in:
Samuel Gordalina 2012-07-13 14:07:56 +01:00 • committed by William DURAND
parent 07e6a19dd4
commit dccebe0439
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
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",