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

Merge pull request #554 from greg0ire/documentation

Browse Source 
proofread the index
This commit is contained in:
William Durand 2014-12-11 14:13:04 +01:00
commit 8ff30b7dec
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Resources/doc/index.md
View File

@ -226,13 +226,12 @@ Also bundle will get information from the other annotations:
### PHPDoc ### PHPDoc
Route functions marked as @deprecated will be set method as deprecation in Actions marked as @deprecated will be marked as such in the interface.
documentation.
#### JMS Serializer Features #### JMS Serializer Features
The bundle has support for some of the JMS Serializer features and use these The bundle has support for some of the JMS Serializer features and uses this
extra information in the generated documentation. extra piece of information in the generated documentation.
##### Group Exclusion Strategy ##### Group Exclusion Strategy
@ -373,7 +372,8 @@ If you want to generate a static version of your documentation without sandbox,
### Swagger support ### Swagger support
Read the [documentation for Swagger integration](https://github.com/nelmio/NelmioApiDocBundle/blob/master/Resources/doc/swagger-support.md) for the necessary steps to make a Swagger-compliant documentation for your API. Read the [documentation for Swagger integration](https://github.com/nelmio/NelmioApiDocBundle/blob/master/Resources/doc/swagger-support.md)
for the necessary steps to make a Swagger-compliant documentation for your API.
### Caching ### Caching
@ -466,7 +466,7 @@ services:
``` ```
Look at the built-in [Handlers](https://github.com/nelmio/NelmioApiDocBundle/tree/master/Extractor/Handler). Look at the built-in [Handlers](https://github.com/nelmio/NelmioApiDocBundle/tree/master/Extractor/Handler).
### Reference Configuration ### Configuration Reference
``` yaml ``` yaml
nelmio_api_doc: nelmio_api_doc: