Add package-info.java to each package

Closes gh-109

spring-restdocs-core/src/main/java/org/springframework/restdocs/constraints/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting a RESTful API's constraints.
+ */
+package org.springframework.restdocs.constraints;

spring-restdocs-core/src/main/java/org/springframework/restdocs/curl/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting the curl command required to make a request to a RESTful API.
+ */
+package org.springframework.restdocs.curl;

spring-restdocs-core/src/main/java/org/springframework/restdocs/http/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting the HTTP request sent to a RESTful API and the HTTP response that is
+ * returned.
+ */
+package org.springframework.restdocs.http;

spring-restdocs-core/src/main/java/org/springframework/restdocs/hypermedia/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting a RESTful API that uses hypermedia.
+ */
+package org.springframework.restdocs.hypermedia;

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Operation API that describes a request that was sent and the response that was
+ * received when calling a RESTful API.
+ */
+package org.springframework.restdocs.operation;

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Support for preprocessing an operation prior to it being documented.
+ */
+package org.springframework.restdocs.operation.preprocess;

spring-restdocs-core/src/main/java/org/springframework/restdocs/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Core Spring REST Docs classes. 
+ */
+package org.springframework.restdocs;

spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting the payload of a RESTful API's requests and responses.
+ */
+package org.springframework.restdocs.payload;

spring-restdocs-core/src/main/java/org/springframework/restdocs/request/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Documenting query and path parameters of requests sent to a RESTful API.
+ */
+package org.springframework.restdocs.request;

spring-restdocs-core/src/main/java/org/springframework/restdocs/snippet/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Snippet generation.
+ */
+package org.springframework.restdocs.snippet;

spring-restdocs-core/src/main/java/org/springframework/restdocs/templates/mustache/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * JMustache-based implementation of the template API.
+ */
+package org.springframework.restdocs.templates.mustache;

spring-restdocs-core/src/main/java/org/springframework/restdocs/templates/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Template API used to render documentation snippets.
+ */
+package org.springframework.restdocs.templates;

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/IterableEnumeration.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.restdocs.mockmvc.util;
+package org.springframework.restdocs.mockmvc;
 
 import java.util.Enumeration;
 import java.util.Iterator;
@@ -26,7 +26,7 @@ import java.util.Iterator;
  *
  * @param <T> the type of the Enumeration's contents
  */
-public final class IterableEnumeration<T> implements Iterable<T> {
+final class IterableEnumeration<T> implements Iterable<T> {
 
 	private final Enumeration<T> enumeration;
 
@@ -63,7 +63,7 @@ public final class IterableEnumeration<T> implements Iterable<T> {
 	 * @param enumeration The enumeration to expose as an {@code Iterable}
 	 * @return the iterable
 	 */
-	public static <T> Iterable<T> iterable(Enumeration<T> enumeration) {
+	static <T> Iterable<T> iterable(Enumeration<T> enumeration) {
 		return new IterableEnumeration<T>(enumeration);
 	}
 

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/MockMvcOperationRequestFactory.java

@@ -16,7 +16,7 @@
 
 package org.springframework.restdocs.mockmvc;
 
-import static org.springframework.restdocs.mockmvc.util.IterableEnumeration.iterable;
+import static org.springframework.restdocs.mockmvc.IterableEnumeration.iterable;
 
 import java.io.IOException;
 import java.io.PrintWriter;

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java

@@ -16,7 +16,7 @@
 
 package org.springframework.restdocs.mockmvc;
 
-import static org.springframework.restdocs.mockmvc.util.IterableEnumeration.iterable;
+import static org.springframework.restdocs.mockmvc.IterableEnumeration.iterable;
 
 import java.util.ArrayList;
 import java.util.Arrays;

spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Core classes for using Spring REST Docs with Spring Test's MockMvc.
+ */
+package org.springframework.restdocs.mockmvc;