Merge pull request #653 from entering/doc-annotations-reference

Documentation add annotations reference

Author: lsmith77

Resources/doc/annotations-reference.md

@@ -0,0 +1,84 @@
+Full default annotations
+==========================
+
+### Param fetcher
+
+#### QueryParam
+
+```php
+use FOS\RestBundle\Controller\Annotations\QueryParam;
+
+/**
+ * @QueryParam(
+ *   name="",
+ *   requirements="",
+ *   default=null,
+ *   description="",
+ *   strict=false,
+ *   array=false,
+ *   nullable=false
+ * )
+ */
+```
+
+#### RequestParam
+
+```php
+use FOS\RestBundle\Controller\Annotations\RequestParam;
+
+/**
+ * @RequestParam(
+ *   name="",
+ *   requirements="",
+ *   default=null,
+ *   description="",
+ *   strict=true,
+ *   array=false,
+ *   nullable=false
+ * )
+ */
+```
+
+### View
+
+```php
+use FOS\RestBundle\Controller\Annotations\View;
+
+/**
+ * @View(
+ *  templateVar="",
+ *  statusCode=null,
+ *  serializerGroups={},
+ *  populateDefaultVars=true,
+ *  serializerEnableMaxDepthChecks=false
+ * )
+ */
+```
+
+### Routing
+
+#### Route prefix
+
+```php
+use FOS\RestBundle\Controller\Annotations\Prefix;
+
+/**
+ * @Prefix("")
+ */
+```
+
+#### Route name prefix
+
+```php
+use FOS\RestBundle\Controller\Annotations\NamePrefix;
+
+/**
+ * @NamePrefix("")
+ */
+```
+
+#### Route
+
+RestBundle extends the [@Route](http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/routing.html) annotation from Symfony.
+
+@Delete @Get @Head @Link @Patch @Post @Put @Unlink have the same options as @Route

Resources/doc/index.md

@@ -23,8 +23,9 @@ FOSRestBundle provides several tools to assist in building REST applications:
 - [Manual definition of routes](7-manual-route-definition.md)
 
 ### Config reference
-Check out the [configuration reference](configuration-reference.md) for a reference on the available configuration options.
 
+- [Configuration reference](configuration-reference.md) for a reference on the available configuration options
+- [Annotations reference](annotations-reference.md) for a reference on on the available configurations through annotations
 
 ### Example application(s)