Polish Javadoc to prepare builds with JDK 17.

Issue #2068.
This commit is contained in:
Oliver Drotbohm
2021-09-21 15:25:53 +02:00
parent 806a886df1
commit c6b77e3dd9
22 changed files with 44 additions and 51 deletions

View File

@@ -51,7 +51,7 @@ public class ValidationErrors extends AbstractPropertyBindingResult {
* Creates a new {@link ValidationErrors} instance for the given source object and {@link PersistentEntity}.
*
* @param source the source object to gather validation errors on, must not be {@literal null}.
* @param entity the {@link PersistentEntity} for the given source instance, must not be {@literal null}.
* @param entities the {@link PersistentEntities} for the given source instance, must not be {@literal null}.
*/
public ValidationErrors(Object source, PersistentEntities entities) {

View File

@@ -58,7 +58,7 @@ public class MetadataConfiguration {
/**
* Configures whether to expose the ALPS resources.
*
* @param alpsEnabled the alpsEnabled to set
* @param enableAlps whether to expose ALPS resources.
*/
public void setAlpsEnabled(boolean enableAlps) {
this.alpsEnabled = enableAlps;

View File

@@ -46,7 +46,6 @@ import org.springframework.util.StringUtils;
* @author Greg Turnquist
* @author Mark Paluch
*/
@SuppressWarnings("deprecation")
public class RepositoryRestConfiguration {
static final URI NO_URI = URI.create("");
@@ -367,7 +366,7 @@ public class RepositoryRestConfiguration {
/**
* Set whether to return a response body after updating an entity.
*
* @param returnBody can be {@literal null}, expressing the decision shall be derived from the presence of an
* @param returnBodyOnUpdate can be {@literal null}, expressing the decision shall be derived from the presence of an
* {@code Accept} header in the request.
* @return {@literal this}
*/
@@ -535,7 +534,7 @@ public class RepositoryRestConfiguration {
/**
* Configures whether to enable enum value translation via the Spring Data REST default resource bundle. Defaults to
* {@literal false} for backwards compatibility reasons. Will use the fully qualified enum name as key. For further
* details see {@link EnumTranslator}.
* details see {code EnumTranslator}.
*
* @param enableEnumTranslation
* @see #getEnumTranslationConfiguration()
@@ -675,7 +674,7 @@ public class RepositoryRestConfiguration {
}
/**
* The {@link RelProvider} to be used to calculate the link relation defaults for repositories.
* The {@link LinkRelationProvider} to be used to calculate the link relation defaults for repositories.
*
* @deprecated since 3.5, use {@link #setLinkRelationProvider(LinkRelationProvider)} instead.
*/

View File

@@ -139,7 +139,7 @@ public class ExposureConfiguration implements ExposureConfigurer {
/**
* Returns whether PUT requests can be used to create new instances of the given domain type.
*
* @param metadata must not be {@literal null}.
* @param domainType must not be {@literal null}.
* @return
*/
public boolean allowsPutForCreation(Class<?> domainType) {

View File

@@ -33,11 +33,13 @@ public final class ParameterMetadata {
/**
* Creates a new {@link ParameterMetadata} for the given {@link MethodParameter} and base rel.
*
* @param name must not be {@literal null} or empty.
* @param parameter must not be {@literal null} or empty.
* @param baseRel must not be {@literal null} or empty.
*/
public ParameterMetadata(MethodParameter parameter, String baseRel) {
Assert.notNull(parameter, "MethodParameter must not be null!");
this.name = parameter.getParameterName();
Assert.hasText(name, "Parameter name must not be null or empty!");

View File

@@ -65,9 +65,8 @@ public interface ResourceMetadata extends CollectionResourceMapping {
SearchResourceMappings getSearchResourceMappings();
/**
* Returns the supported {@link HttpMethod}s for the given {@link ResourceType}.
* Returns the supported {@link HttpMethod}s.
*
* @param resourcType must not be {@literal null}.
* @return
*/
SupportedHttpMethods getSupportedHttpMethods();

View File

@@ -24,7 +24,7 @@ import org.springframework.hateoas.server.LinkRelationProvider;
import org.springframework.util.Assert;
/**
* A {@link RelProvider} based on the {@link ResourceMappings} for the registered repositories.
* A {@link LinkRelationProvider} based on the {@link ResourceMappings} for the registered repositories.
*
* @author Oliver Gierke
*/