fix javadoc errors so java 8 is not complaining
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/models/api@1687185 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/sling/models/annotations/Model.java b/src/main/java/org/apache/sling/models/annotations/Model.java
index 42b4406..5d17b74 100644
--- a/src/main/java/org/apache/sling/models/annotations/Model.java
+++ b/src/main/java/org/apache/sling/models/annotations/Model.java
@@ -53,9 +53,9 @@
/**
*
- * @return {@link ValidationStrategy.DISABLED} in case the model should not be validated through Sling Validation (default),
- * {@link ValidationStrategy.REQUIRED} in case the model should be validated and if no appropriate Sling Validation Model exists it is considered invalid or
- * {@link ValidationStrategy.OPTIONAL} in case the model should be validated only in case an appropriate Sling Validation Model is found.
+ * @return {@link ValidationStrategy#DISABLED} in case the model should not be validated through Sling Validation (default),
+ * {@link ValidationStrategy#REQUIRED} in case the model should be validated and if no appropriate Sling Validation Model exists it is considered invalid or
+ * {@link ValidationStrategy#OPTIONAL} in case the model should be validated only in case an appropriate Sling Validation Model is found.
* @see <a href="http://sling.apache.org/documentation/bundles/validation.html">Sling Validation</a>
*/
public ValidationStrategy validation() default ValidationStrategy.DISABLED;
diff --git a/src/main/java/org/apache/sling/models/annotations/Path.java b/src/main/java/org/apache/sling/models/annotations/Path.java
index 7dec5f5..e730aa0 100644
--- a/src/main/java/org/apache/sling/models/annotations/Path.java
+++ b/src/main/java/org/apache/sling/models/annotations/Path.java
@@ -24,8 +24,8 @@
import javax.inject.Qualifier;
/**
- * Provide path(s) on an @Inject. Not necessarily tied to the Resource Path injector (thus no
- * @Source annotation), may be reused for other injector types.
+ * Provide path(s) on an @Inject. Not necessarily tied to the Resource Path injector (thus no
+ * @Source annotation), may be reused for other injector types.
*/
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
diff --git a/src/main/java/org/apache/sling/models/annotations/injectorspecific/ChildResource.java b/src/main/java/org/apache/sling/models/annotations/injectorspecific/ChildResource.java
index 25881bd..14c9cdf 100644
--- a/src/main/java/org/apache/sling/models/annotations/injectorspecific/ChildResource.java
+++ b/src/main/java/org/apache/sling/models/annotations/injectorspecific/ChildResource.java
@@ -36,6 +36,7 @@
@InjectAnnotation
@Source("child-resources")
public @interface ChildResource {
+
/**
* Specifies the name of the child resource.
* If empty or not set, then the name is derived from the method or field.
@@ -56,6 +57,7 @@
* the standard annotations ({@link org.apache.sling.models.annotations.Optional}, {@link org.apache.sling.models.annotations.Required}) are used.
* If even those are not available the default injection strategy defined on the {@link org.apache.sling.models.annotations.Model} applies.
* Default value = DEFAULT.
+ * @return Injection strategy
*/
public InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;
@@ -64,4 +66,5 @@
* property of the adaptable.
*/
public String via() default "";
+
}
diff --git a/src/main/java/org/apache/sling/models/annotations/injectorspecific/OSGiService.java b/src/main/java/org/apache/sling/models/annotations/injectorspecific/OSGiService.java
index fa487c0..93c2317 100644
--- a/src/main/java/org/apache/sling/models/annotations/injectorspecific/OSGiService.java
+++ b/src/main/java/org/apache/sling/models/annotations/injectorspecific/OSGiService.java
@@ -39,7 +39,7 @@
/**
* specifies the RFC 1960-based filter string, which is evaluated when retrieving the service. If empty string or left out, then no filtering is being performed.
*
- * @see "Core Specification, section 5.5, for a description of the filter string
+ * @see "Core Specification, section 5.5, for a description of the filter string"
* @see <a href="http://www.ietf.org/rfc/rfc1960.txt">RFC 1960</a>
*/
public String filter() default "";
diff --git a/src/main/java/org/apache/sling/models/annotations/injectorspecific/ScriptVariable.java b/src/main/java/org/apache/sling/models/annotations/injectorspecific/ScriptVariable.java
index dd7a80f..0ed5eb0 100644
--- a/src/main/java/org/apache/sling/models/annotations/injectorspecific/ScriptVariable.java
+++ b/src/main/java/org/apache/sling/models/annotations/injectorspecific/ScriptVariable.java
@@ -29,7 +29,7 @@
/**
* Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a
- * script variable (from the {@link org.apache.sling.api.scripting.SlingBindings})
+ * script variable (from the org.apache.sling.api.scripting.SlingBindings)
*
*/
@Target({ METHOD, FIELD, PARAMETER })
diff --git a/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java b/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
index d92e872..e99bb69 100644
--- a/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
+++ b/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
@@ -30,10 +30,9 @@
/**
* Injects common Sling objects that can be derived from either a SlingHttpServletRequest, a ResourceResolver or a
* Resource.
- * The injection is class-based.
- * <p>
- * Supports the following objects:
+ * <p>The injection is class-based.</p>
* <table>
+ * <caption>Supports the following objects:</caption>
* <tr>
* <th style="text-align:left">Class</th>
* <th style="text-align:left">Description</th>
@@ -42,35 +41,35 @@
* <th style="text-align:center">Resource</th>
* </tr>
* <tr style="background-color:#eee">
- * <td>{@link ResourceResolver}</td>
+ * <td>ResourceResolver</td>
* <td>Resource resolver</td>
* <td style="text-align:center">X</td>
* <td style="text-align:center">X</td>
* <td style="text-align:center">X</td>
* </tr>
* <tr>
- * <td>{@link Resource}</td>
+ * <td>Resource</td>
* <td>Resource</td>
* <td style="text-align:center">X</td>
* <td></td>
* <td style="text-align:center">X</td>
* </tr>
* <tr style="background-color:#eee">
- * <td>{@link SlingHttpServletRequest}</td>
+ * <td>SlingHttpServletRequest</td>
* <td>Sling request</td>
* <td style="text-align:center">X</td>
* <td></td>
* <td></td>
* </tr>
* <tr>
- * <td>{@link SlingHttpServletResponse}</td>
+ * <td>SlingHttpServletResponse</td>
* <td>Sling response</td>
* <td style="text-align:center">X</td>
* <td></td>
* <td></td>
* </tr>
* <tr style="background-color:#eee">
- * <td>{@link SlingScriptHelper}</td>
+ * <td>SlingScriptHelper</td>
* <td>Sling script helper</td>
* <td style="text-align:center">X</td>
* <td></td>
diff --git a/src/main/java/org/apache/sling/models/factory/InvalidModelException.java b/src/main/java/org/apache/sling/models/factory/InvalidModelException.java
index 26d79f2..2e24ee3 100644
--- a/src/main/java/org/apache/sling/models/factory/InvalidModelException.java
+++ b/src/main/java/org/apache/sling/models/factory/InvalidModelException.java
@@ -17,7 +17,7 @@
package org.apache.sling.models.factory;
/**
- * Thrown in case the given model type could not be validated through the {@link ModelValidation}.
+ * Thrown in case the given model type could not be validated through the model validation.
* The actual validation error message is encapsulated
* @see ModelFactory
*/
diff --git a/src/main/java/org/apache/sling/models/factory/ModelFactory.java b/src/main/java/org/apache/sling/models/factory/ModelFactory.java
index 2bba7dc..ec9e663 100644
--- a/src/main/java/org/apache/sling/models/factory/ModelFactory.java
+++ b/src/main/java/org/apache/sling/models/factory/ModelFactory.java
@@ -26,6 +26,7 @@
*
*/
public interface ModelFactory {
+
/**
* Instantiates the given Sling Model class from the given adaptable.
* @param adaptable the adaptable to use to instantiate the Sling Model Class
@@ -36,7 +37,7 @@
* @throws ModelClassException in case the model could not be instantiated because model annotation was missing, reflection failed, no valid constructor was found or post-construct could not be called
* @throws PostConstructException in case the post-construct method has thrown an exception itself
* @throws ValidationException in case validation could not be performed for some reason (e.g. no validation information available)
- * @throws InvalidModelException in case the given model type could not be validated through the {@link ModelValidation}
+ * @throws InvalidModelException in case the given model type could not be validated through the model validation
*/
public @Nonnull <ModelType> ModelType createModel(@Nonnull Object adaptable, @Nonnull Class<ModelType> type) throws MissingElementsException,
InvalidAdaptableException, ModelClassException, PostConstructException, ValidationException, InvalidModelException;
diff --git a/src/main/java/org/apache/sling/models/factory/ValidationException.java b/src/main/java/org/apache/sling/models/factory/ValidationException.java
index 58f056e..4cf1602 100644
--- a/src/main/java/org/apache/sling/models/factory/ValidationException.java
+++ b/src/main/java/org/apache/sling/models/factory/ValidationException.java
@@ -16,11 +16,10 @@
*/
package org.apache.sling.models.factory;
-
/**
* Thrown in case an validation could not be performed for the given model.
- * (although it would be required through {@link org.apache.sling.models.annotations.ValidationStrategy.REQUIRED}).
- * Depends on the actual implementation under which exact cirumstances this is thrown.
+ * (although it would be required through {@link org.apache.sling.models.annotations.ValidationStrategy#REQUIRED}).
+ * Depends on the actual implementation under which exact circumstances this is thrown.
* @see ModelFactory
*/
public class ValidationException extends RuntimeException {
diff --git a/src/main/java/org/apache/sling/models/spi/injectorspecific/InjectAnnotationProcessor.java b/src/main/java/org/apache/sling/models/spi/injectorspecific/InjectAnnotationProcessor.java
index 9f652aa..eda3a5d 100644
--- a/src/main/java/org/apache/sling/models/spi/injectorspecific/InjectAnnotationProcessor.java
+++ b/src/main/java/org/apache/sling/models/spi/injectorspecific/InjectAnnotationProcessor.java
@@ -18,7 +18,7 @@
/**
* Processor for injector-specific annotations.
- * @deprecated Use {@link InjectAnntoationProcessor2} instead
+ * @deprecated Use {@link InjectAnnotationProcessor2} instead
*/
@Deprecated
public interface InjectAnnotationProcessor {
@@ -58,10 +58,8 @@
*
* @return the value to be used for the default or null, in
* which case the standard annotation should be used.
- * @deprecated use {@link InjectAnntoationProcessor2.getInjectionStrategy} instead
+ * @deprecated use {@link InjectAnnotationProcessor2#getInjectionStrategy()} instead
*/
Boolean isOptional();
-
-
}
