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

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 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( * @ApiDoc(
* resource=true, * resource=true,
* description="This is a description of your API method", * description="This is a description of your API method",