From 087cf190341b7615683f1d2415dd8133a6e9c3a3 Mon Sep 17 00:00:00 2001 From: shalvah Date: Sun, 9 Sep 2018 21:14:55 +0100 Subject: [PATCH] Update documentation --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 924afa47..59fa88f6 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,9 @@ Route::group(array('prefix' => 'api/v1', 'middleware' => []), function () { Option | Description --------- | ------- `output` | The output path used for the generated documentation. Default: `public/docs` -`routePrefix` | The route prefix to use for generation - `*` can be used as a wildcard -`routes` | The route names to use for generation - Required if no routePrefix is provided +`routePrefix` | The route prefix(es) to use for generation. `*` can be used as a wildcard. Multiple route prefixes can be specified by separating them with a comma (for instance `/v1,/v2`) +`routeDomain` | The route domain(s) to use for generation. `*` can be used as a wildcard. Multiple route domains can be specified by separating them with a comma +`routes` | The route names to use for generation - Required if no routePrefix or routeDomain is provided `middleware` | The middlewares to use for generation `noResponseCalls` | Disable API response calls `noPostmanCollection` | Disable Postman collection creation @@ -92,7 +93,7 @@ This package uses these resources to generate the API documentation: This package uses the HTTP controller doc blocks to create a table of contents and show descriptions for your API methods. -Using `@resource` in a doc block prior to each controller is useful as it creates a Group within the API documentation for all methods defined in that controller (rather than listing every method in a single list for all your controllers), but using `@resource` is not required. The short description after the `@resource` should be unique to allow anchor tags to navigate to this section. A longer description can be included below. +Using `@resource` in a doc block prior to each controller is useful as it creates a Group within the API documentation for all methods defined in that controller (rather than listing every method in a single list for all your controllers), but using `@resource` is not required. The short description after the `@resource` should be unique to allow anchor tags to navigate to this section. A longer description can be included below. Custom formatting and `