DATACMNS-1026 - Polishing.

Minor improvements to Javadoc.

Original pull request: #217.

Author: schauder

src/main/java/org/springframework/data/repository/query/ExtensionAwareEvaluationContextProvider.java

@@ -80,7 +80,7 @@ public ExtensionAwareEvaluationContextProvider() {
 	/**
 	 * Creates a new {@link ExtensionAwareEvaluationContextProvider} for the given {@link EvaluationContextExtension}s.
 	 * 
-	 * @param adapters must not be {@literal null}.
+	 * @param extensions must not be {@literal null}.
 	 */
 	public ExtensionAwareEvaluationContextProvider(List<? extends EvaluationContextExtension> extensions) {
 
@@ -210,7 +210,7 @@ private class ExtensionAwarePropertyAccessor implements PropertyAccessor, Method
 		/**
 		 * Creates a new {@link ExtensionAwarePropertyAccessor} for the given {@link EvaluationContextExtension}s.
 		 * 
-		 * @param adapters must not be {@literal null}.
+		 * @param extensions must not be {@literal null}.
 		 */
 		public ExtensionAwarePropertyAccessor(List<? extends EvaluationContextExtension> extensions) {
 
@@ -307,12 +307,12 @@ public Class<?>[] getSpecificTargetClasses() {
 		}
 
 		/**
-		 * Returns a {@link MethodExecutor}
+		 * Returns a {@link MethodExecutor} wrapping a function from the adapter passed in as an argument.
 		 * 
-		 * @param adapter
-		 * @param name
-		 * @param argumentTypes
-		 * @return
+		 * @param adapter the source of functions to consider.
+		 * @param name the name of the function
+		 * @param argumentTypes the types of the arguments that the function must accept.
+		 * @return a matching {@link MethodExecutor}
 		 */
 		private Optional<MethodExecutor> getMethodExecutor(EvaluationContextExtensionAdapter adapter, String name,
 				List<TypeDescriptor> argumentTypes) {
@@ -325,7 +325,7 @@ private Optional<MethodExecutor> getMethodExecutor(EvaluationContextExtensionAda
 		 * 
 		 * @param extension must not be {@literal null}.
 		 * @param name must not be {@literal null} or empty.
-		 * @return
+		 * @return a {@link TypedValue} matching the given parameters.
 		 */
 		private TypedValue lookupPropertyFrom(EvaluationContextExtensionAdapter extension, String name) {
 
@@ -420,16 +420,16 @@ public EvaluationContextExtensionAdapter(EvaluationContextExtension extension,
 		/**
 		 * Returns the extension identifier.
 		 * 
-		 * @return
+		 * @return the id of the extension
 		 */
-		public String getExtensionId() {
+		String getExtensionId() {
 			return extension.getExtensionId();
 		}
 
 		/**
 		 * Returns all functions exposed.
 		 * 
-		 * @return
+		 * @return all exposed functions.
 		 */
 		Functions getFunctions() {
 			return this.functions;
@@ -438,7 +438,7 @@ Functions getFunctions() {
 		/**
 		 * Returns all properties exposed. Note, the value of a property can be a {@link Function} in turn
 		 * 
-		 * @return
+		 * @return a map from property name to property value.
 		 */
 		public Map<String, Object> getProperties() {
 			return this.properties;

src/main/java/org/springframework/data/repository/query/Functions.java

@@ -33,7 +33,7 @@
 import org.springframework.util.MultiValueMap;
 
 /**
- * {@link MultiValueMap} like datastructure to keep lists of
+ * {@link MultiValueMap} like data structure to keep lists of
  * {@link org.springframework.data.repository.query.spi.Function}s indexed by name and argument list length, where the
  * value lists are actually unique with respect to the signature.
  *