Adding some more documentation

Plugin javadoc
springfox · Jun 13, 2014 · 84c871e · 84c871e
1 parent 1eddb04
commit 84c871e
Show file tree

Hide file tree

Showing 8 changed files with 179 additions and 130 deletions.
diff --git a/.cache b/.cache
diff --git a/docs/swaggerSpringMvc.odg b/docs/swaggerSpringMvc.odg
diff --git a/next-release.md b/next-release.md
@@ -92,7 +92,7 @@ The `@EnableSwagger` annotation, in this example, enables swagger-springmvc out
 json Resource Listing is available at /api-docs
 
 
-#### Spring xml Configuratio
+#### Spring xml Configuration
 - To get the default implementation simply define a bean of type: `com.mangofactory.swagger.configuration.SpringSwaggerConfig`
 
 ```xml

diff --git a/...-springmvc/src/main/java/com/mangofactory/swagger/authorization/AuthorizationContext.java b/...-springmvc/src/main/java/com/mangofactory/swagger/authorization/AuthorizationContext.java
@@ -13,9 +13,9 @@
 import static com.mangofactory.swagger.ScalaUtils.toScalaList;
 
 /**
- * A class to represent a default set of authorizations to apply toe each api operation
- * To customize which request mappings/operations the list of authorizations are applied to
- * Specify the custom includePatterns or requestMethods
+ * A class to represent a default set of authorizations to apply to each api operation
+ * To customize which request mappings the list of authorizations are applied to Specify the custom includePatterns
+ * or requestMethods
  */
 public class AuthorizationContext {
 

diff --git a/...springmvc/src/main/java/com/mangofactory/swagger/configuration/JacksonSwaggerSupport.java b/...springmvc/src/main/java/com/mangofactory/swagger/configuration/JacksonSwaggerSupport.java
@@ -51,8 +51,8 @@ public void setup() {
       }
     }
 
-    Map<String, DefaultModelPropertiesProvider> beans = applicationContext.getBeansOfType
-            (DefaultModelPropertiesProvider.class);
+    Map<String, DefaultModelPropertiesProvider> beans =
+            applicationContext.getBeansOfType(DefaultModelPropertiesProvider.class);
 
     for (DefaultModelPropertiesProvider defaultModelPropertiesProvider : beans.values()) {
       defaultModelPropertiesProvider.setObjectMapper(this.springsMessageConverterObjectMapper);

diff --git a/...r-springmvc/src/main/java/com/mangofactory/swagger/configuration/SpringSwaggerConfig.java b/...r-springmvc/src/main/java/com/mangofactory/swagger/configuration/SpringSwaggerConfig.java
@@ -37,24 +37,11 @@
 import java.util.Map;
 import java.util.Set;
 
-import static com.google.common.collect.Maps.newLinkedHashMap;
-import static com.google.common.collect.Sets.newHashSet;
-import static com.mangofactory.swagger.ScalaUtils.toOption;
-import static org.springframework.http.HttpStatus.CREATED;
-import static org.springframework.http.HttpStatus.FORBIDDEN;
-import static org.springframework.http.HttpStatus.NOT_FOUND;
-import static org.springframework.http.HttpStatus.NO_CONTENT;
-import static org.springframework.http.HttpStatus.OK;
-import static org.springframework.http.HttpStatus.UNAUTHORIZED;
-import static org.springframework.web.bind.annotation.RequestMethod.DELETE;
-import static org.springframework.web.bind.annotation.RequestMethod.GET;
-import static org.springframework.web.bind.annotation.RequestMethod.HEAD;
-import static org.springframework.web.bind.annotation.RequestMethod.OPTIONS;
-import static org.springframework.web.bind.annotation.RequestMethod.PATCH;
-import static org.springframework.web.bind.annotation.RequestMethod.POST;
-import static org.springframework.web.bind.annotation.RequestMethod.PUT;
-import static org.springframework.web.bind.annotation.RequestMethod.TRACE;
-
+import static com.google.common.collect.Maps.*;
+import static com.google.common.collect.Sets.*;
+import static com.mangofactory.swagger.ScalaUtils.*;
+import static org.springframework.http.HttpStatus.*;
+import static org.springframework.web.bind.annotation.RequestMethod.*;
 @Configuration
 @ComponentScan(basePackages = {"com.mangofactory.swagger.controllers"})
 @Import(SwaggerModelsConfiguration.class)

diff --git a/...r-springmvc/src/main/java/com/mangofactory/swagger/paths/RelativeSwaggerPathProvider.java b/...r-springmvc/src/main/java/com/mangofactory/swagger/paths/RelativeSwaggerPathProvider.java
@@ -1,6 +1,6 @@
 package com.mangofactory.swagger.paths;
 
-public class RelativeSwaggerPathProvider extends SwaggerPathProvider {
+public class  RelativeSwaggerPathProvider extends SwaggerPathProvider {
     public static final String ROOT = "/";
 
     @Override