diff --git a/pom.xml b/pom.xml index 77925349..e8b98bfd 100644 --- a/pom.xml +++ b/pom.xml @@ -1049,16 +1049,16 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.10.4 + 3.3.1 true
${project.name}
${source.level} true - -Xdoclint:none + none - https://docs.spring.io/spring/docs/5.1.x/javadoc-api - https://docs.oracle.com/javase/8/docs/api + https://docs.spring.io/spring/docs/${spring.version}/javadoc-api/ + https://docs.oracle.com/javase/8/docs/api/
diff --git a/src/main/java/org/springframework/hateoas/AffordanceModel.java b/src/main/java/org/springframework/hateoas/AffordanceModel.java index 36e6059f..52bf55b7 100644 --- a/src/main/java/org/springframework/hateoas/AffordanceModel.java +++ b/src/main/java/org/springframework/hateoas/AffordanceModel.java @@ -241,7 +241,8 @@ public abstract class AffordanceModel { * @param * @param target * @return - * @deprecated since 1.3, prefer setting up the model types via {@link #createProperties(Function)} + * @deprecated since 1.3, prefer setting up the model types via + * {@link AffordanceModel#createProperties(BiFunction)}. */ @Deprecated default & Named> T applyTo(T target) { diff --git a/src/main/java/org/springframework/hateoas/CollectionModel.java b/src/main/java/org/springframework/hateoas/CollectionModel.java index c98dda6d..00047887 100644 --- a/src/main/java/org/springframework/hateoas/CollectionModel.java +++ b/src/main/java/org/springframework/hateoas/CollectionModel.java @@ -168,7 +168,7 @@ public class CollectionModel extends RepresentationModel> * @param content must not be {@literal null}. * @return * @since 1.1 - * @see #withFallbackType(Class) + * @see #withFallbackType(Class, Class...) * @see #withFallbackType(ResolvableType) */ public static CollectionModel of(Iterable content) { @@ -182,7 +182,7 @@ public class CollectionModel extends RepresentationModel> * @param links the links to be added to the {@link CollectionModel}. * @return * @since 1.1 - * @see #withFallbackType(Class) + * @see #withFallbackType(Class, Class...) * @see #withFallbackType(ResolvableType) */ public static CollectionModel of(Iterable content, Link... links) { @@ -196,7 +196,7 @@ public class CollectionModel extends RepresentationModel> * @param links the links to be added to the {@link CollectionModel}. * @return * @since 1.1 - * @see #withFallbackType(Class) + * @see #withFallbackType(Class, Class...) * @see #withFallbackType(ResolvableType) */ public static CollectionModel of(Iterable content, Iterable links) { diff --git a/src/main/java/org/springframework/hateoas/IanaUriSchemes.java b/src/main/java/org/springframework/hateoas/IanaUriSchemes.java index a79cdc3b..8a33b172 100644 --- a/src/main/java/org/springframework/hateoas/IanaUriSchemes.java +++ b/src/main/java/org/springframework/hateoas/IanaUriSchemes.java @@ -23,7 +23,7 @@ import java.util.HashSet; * A list of well-defined URI schemes governed by IANA. * * @author Oliver Drotbohm - * @see Official IANA URI scheme registry * @since 1.2 */ public class IanaUriSchemes { diff --git a/src/main/java/org/springframework/hateoas/mediatype/AffordanceOperations.java b/src/main/java/org/springframework/hateoas/mediatype/AffordanceOperations.java index abc539e6..70482e61 100644 --- a/src/main/java/org/springframework/hateoas/mediatype/AffordanceOperations.java +++ b/src/main/java/org/springframework/hateoas/mediatype/AffordanceOperations.java @@ -22,7 +22,7 @@ import org.springframework.hateoas.Link; * Operations commons to all builder APIs. * * @author Oliver Drotbohm - * @see AffordanceBuilder + * @see ConfigurableAffordance */ public interface AffordanceOperations { diff --git a/src/main/java/org/springframework/hateoas/mediatype/ConfigurableAffordance.java b/src/main/java/org/springframework/hateoas/mediatype/ConfigurableAffordance.java index a4b2a83f..17cf70c7 100644 --- a/src/main/java/org/springframework/hateoas/mediatype/ConfigurableAffordance.java +++ b/src/main/java/org/springframework/hateoas/mediatype/ConfigurableAffordance.java @@ -166,15 +166,15 @@ public interface ConfigurableAffordance extends AffordanceOperations { Affordances build(); /** - * Create a new {@link AffordanceBuilder} by copying all attributes and replacing the {@literal target}. + * Create a new {@link ConfigurableAffordance} by copying all attributes and replacing the {@literal target}. * - * @param target + * @param target must not be {@literal null}. * @return */ ConfigurableAffordance withTarget(Link target); /** - * Create a new {@link AffordanceBuilder} by copying all attributes and replacing the {@literal name}. + * Create a new {@link ConfigurableAffordance} by copying all attributes and replacing the {@literal name}. * * @param name can be {@literal null}. * @return diff --git a/src/main/java/org/springframework/hateoas/mediatype/hal/HalModelBuilder.java b/src/main/java/org/springframework/hateoas/mediatype/hal/HalModelBuilder.java index 8d43e3e0..888e9140 100644 --- a/src/main/java/org/springframework/hateoas/mediatype/hal/HalModelBuilder.java +++ b/src/main/java/org/springframework/hateoas/mediatype/hal/HalModelBuilder.java @@ -30,7 +30,6 @@ import org.springframework.hateoas.MediaTypes; import org.springframework.hateoas.RepresentationModel; import org.springframework.hateoas.server.core.EmbeddedWrappers; import org.springframework.lang.Nullable; -import org.springframework.ui.Model; import org.springframework.util.Assert; import com.fasterxml.jackson.annotation.JsonUnwrapped; @@ -251,7 +250,7 @@ public class HalModelBuilder { /** * Initiates the setup of a preview given the current payload. Clients have to conclude the setup calling any of the - * {@link EntityPreviewBuilder#forLink(Link)} methods. As an example, the call chain of: + * {@link PreviewBuilder#forLink(Link)} methods. As an example, the call chain of: * *
 	 * ….preview(…).forLink("…", "relation")
@@ -314,7 +313,7 @@ public class HalModelBuilder {
 	/**
 	 * Add a {@link Link} to the whole thing.
 	 * 

- * NOTE: This adds it to the top level. If you need a link inside an entity, then use the {@link Model.Builder} to + * NOTE: This adds it to the top level. If you need a link inside an entity, then use the {@link HalModelBuilder} to * define it as well. * * @param link must not be {@literal null}. diff --git a/src/main/java/org/springframework/hateoas/mediatype/html/HtmlInputType.java b/src/main/java/org/springframework/hateoas/mediatype/html/HtmlInputType.java index b7cdd98d..3f1ef1cb 100644 --- a/src/main/java/org/springframework/hateoas/mediatype/html/HtmlInputType.java +++ b/src/main/java/org/springframework/hateoas/mediatype/html/HtmlInputType.java @@ -144,7 +144,7 @@ public class HtmlInputType { /** * Returns the {@link HtmlInputType} derived from the given {@link ResolvableType}. * - * @param resolvableType must not be {@literal null}. + * @param type must not be {@literal null}. * @return */ @Nullable diff --git a/src/main/java/org/springframework/hateoas/server/EntityLinks.java b/src/main/java/org/springframework/hateoas/server/EntityLinks.java index 17feba1c..623aa98c 100644 --- a/src/main/java/org/springframework/hateoas/server/EntityLinks.java +++ b/src/main/java/org/springframework/hateoas/server/EntityLinks.java @@ -25,9 +25,9 @@ import org.springframework.util.Assert; /** * Accessor to links pointing to controllers backing an entity type. The {@link IllegalArgumentException} potentially - * thrown by the declared methods will only appear if the {@link #supports(Class)} method has returned {@literal false} - * and the method has been invoked anyway, i.e. if {@link #supports(Class)} returns {@literal true} it's safe to invoke - * the interface methods an the exception will never be thrown. + * thrown by the declared methods will only appear if the {@link Plugin#supports(Class)} method has returned + * {@literal false} and the method has been invoked anyway, i.e. if {@link Plugin#supports(Class)} returns + * {@literal true} it's safe to invoke the interface methods an the exception will never be thrown. * * @author Oliver Gierke */ @@ -69,7 +69,7 @@ public interface EntityLinks extends Plugin> { * Returns a {@link LinkBuilder} able to create links to the controller managing the given entity type and identifier * extractor. Implementations will know about the URI structure being used to expose item-resource URIs. * - * @param type the entity to point to, must not be {@literal null}. + * @param entity the entity to point to, must not be {@literal null}. * @param identifierExtractor an extractor function to determine the id of the given entity, must not be * {@literal null}. * @return the {@link LinkBuilder} pointing to the item resource identified by the given entity. Will never be @@ -111,7 +111,7 @@ public interface EntityLinks extends Plugin> { * type of the link will be determined by the implementation class and should be defaulted to * {@link IanaLinkRelations#SELF}. * - * @param type the entity to point to, must not be {@literal null}. + * @param entity the entity to point to, must not be {@literal null}. * @param identifierExtractor an extractor function to determine the id of the given entity. * @return the {@link Link} pointing to the resource exposed for the given entity. Will never be {@literal null}. * @throws IllegalArgumentException in case the given type is unknown the entity links infrastructure.