docs: update docs and comment

swaggo · Apr 30, 2024 · fb72892 · fb72892
1 parent ef2b23b
commit fb72892
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -195,12 +195,13 @@ func main() {
 }
 ```
 
-| Option  | Type | Default | Description |
-| ------------------------ | ------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| URL  | string | "doc.json" | URL pointing to API definition |
-| DocExpansion  | string | "list" | Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). |
-| DeepLinking  | bool | true | If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information. |
+| Option | Type | Default | Description |
+| ----------------------- | ------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| URL | string | "doc.json" | URL pointing to API definition |
+| DocExpansion | string | "list" | Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). |
+| DeepLinking | bool | true | If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information. |
 | DefaultModelsExpandDepth | int | 1 | Default expansion depth for models (set to -1 completely hide the models). |
-| InstanceName | string | "swagger" | The instance name of the swagger document. If multiple different swagger instances should be deployed on one gin router, ensure that each instance has a unique name (use the _--instanceName_ parameter to generate swagger documents with _swag init_). |
-| PersistAuthorization | bool | false | If set to true, it persists authorization data and it would not be lost on browser close/refresh. |
-| Oauth2DefaultClientID | string | "" | If set, it's used to prepopulate the _client_id_ field of the OAuth2 Authorization dialog. |
+| DefaultModelExpandDepth | int | 1 | The default expansion depth for the model on the model-example section. |
+| InstanceName | string | "swagger" | The instance name of the swagger document. If multiple different swagger instances should be deployed on one gin router, ensure that each instance has a unique name (use the _--instanceName_ parameter to generate swagger documents with _swag init_). |
+| PersistAuthorization | bool | false | If set to true, it persists authorization data and it would not be lost on browser close/refresh. |
+| Oauth2DefaultClientID | string | "" | If set, it's used to prepopulate the _client_id_ field of the OAuth2 Authorization dialog. |
diff --git a/swagger.go b/swagger.go
@@ -87,7 +87,6 @@ func DefaultModelsExpandDepth(depth int) func(*Config) {
 }
 
 // DefaultModelExpandDepth set the default expansion depth for the model on the model-example section
-// (set to -1 completely hide the models).
 func DefaultModelExpandDepth(depth int) func(*Config) {
  return func(c *Config) {
  c.DefaultModelExpandDepth = depth