Skip to content

Commit 9fbf391

Browse files
committed
Fix Javadoc.
Fix invalid links. Replace Javadoc links to JSR-305 with code annotations. Replace self-enclosing tags with simple ones. See #2423
1 parent bf3c9a5 commit 9fbf391

File tree

53 files changed

+101
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+101
-114
lines changed

src/main/java/org/springframework/data/annotation/PersistenceConstructor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import java.lang.annotation.Target;
2222

2323
/**
24-
* @author Jon Brisbin <[email protected]>
24+
* @author Jon Brisbin
2525
*/
2626
@Retention(RetentionPolicy.RUNTIME)
2727
@Target(ElementType.CONSTRUCTOR)

src/main/java/org/springframework/data/auditing/IsNewAwareAuditingHandler.java

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
*/
1616
package org.springframework.data.auditing;
1717

18-
import java.util.Optional;
19-
2018
import org.springframework.data.mapping.PersistentEntity;
2119
import org.springframework.data.mapping.PersistentProperty;
2220
import org.springframework.data.mapping.context.MappingContext;
@@ -26,8 +24,8 @@
2624

2725
/**
2826
* {@link AuditingHandler} extension that uses {@link PersistentEntity#isNew(Object)} to expose a generic
29-
* {@link #markAudited(Optional)} method that will route calls to {@link #markCreated(Optional)} or
30-
* {@link #markModified(Optional)} based on the {@link IsNewStrategy} determined from the factory.
27+
* {@link #markAudited(Object)} method that will route calls to {@link #markCreated(Object)} or
28+
* {@link #markModified(Object)} based on the {@link IsNewStrategy} determined from the factory.
3129
*
3230
* @author Oliver Gierke
3331
* @author Christoph Strobl
@@ -65,7 +63,7 @@ public IsNewAwareAuditingHandler(PersistentEntities entities) {
6563

6664
/**
6765
* Marks the given object created or modified based on {@link PersistentEntity#isNew(Object)}. Will route the calls to
68-
* {@link #markCreated(Optional)} and {@link #markModified(Optional)} accordingly.
66+
* {@link #markCreated(Object)} and {@link #markModified(Object)} accordingly.
6967
*
7068
* @param object must not be {@literal null}.
7169
*/

src/main/java/org/springframework/data/domain/Sort.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ public Order(@Nullable Direction direction, String property) {
402402
*
403403
* @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}
404404
* @param property must not be {@literal null} or empty.
405-
* @param nullHandling must not be {@literal null}.
405+
* @param nullHandlingHint must not be {@literal null}.
406406
*/
407407
public Order(@Nullable Direction direction, String property, NullHandling nullHandlingHint) {
408408
this(direction, property, DEFAULT_IGNORE_CASE, nullHandlingHint);

src/main/java/org/springframework/data/domain/jaxb/SpringDataJaxb.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ public static class PageDto extends RepresentationModel {
108108
* @param source
109109
* @param adapter must not be {@literal null}.
110110
* @return
111-
* @throws Exception
112111
*/
113112
public static <T, S> List<T> unmarshal(Collection<S> source, XmlAdapter<S, T> adapter) {
114113

@@ -136,7 +135,6 @@ public static <T, S> List<T> unmarshal(Collection<S> source, XmlAdapter<S, T> ad
136135
* @param source
137136
* @param adapter must not be {@literal null}.
138137
* @return
139-
* @throws Exception
140138
*/
141139
public static <T, S> List<S> marshal(@Nullable Iterable<T> source, XmlAdapter<S, T> adapter) {
142140

src/main/java/org/springframework/data/geo/GeoPage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class GeoPage<T> extends PageImpl<GeoResult<T>> {
4141
/**
4242
* Creates a new {@link GeoPage} from the given {@link GeoResults}.
4343
*
44-
* @param content must not be {@literal null}.
44+
* @param results must not be {@literal null}.
4545
*/
4646
public GeoPage(GeoResults<T> results) {
4747

src/main/java/org/springframework/data/geo/format/DistanceFormatter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
/**
3434
* Converter to create {@link Distance} instances from {@link String} representations. The supported format is a decimal
3535
* followed by whitespace and a metric abbreviation. We currently support the following abbreviations:
36-
* {@value #SUPPORTED_METRICS}.
36+
* {@link #SUPPORTED_METRICS}.
3737
*
3838
* @author Oliver Gierke
3939
* @author Christoph Strobl

src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
/**
3131
* A {@link RevisionMetadata} implementation that inspects the given object for fields with the configured annotations
32-
* and returns the field's values on calls to {@link #getRevisionDate()}, {@link #getRevisionInstant()} and
32+
* and returns the field's values on calls to {@link #getRevisionInstant()}, {@link #getRevisionInstant()} and
3333
* {@link #getRevisionNumber()}.
3434
*
3535
* @author Oliver Gierke

src/main/java/org/springframework/data/mapping/Alias.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
/**
2323
* A container object which may or may not contain a type alias value. If a value is present, {@code isPresent()} will
2424
* return {@code true} and {@link #getValue()} will return the value.
25-
* <p/>
25+
* <p>
2626
* Additional methods that depend on the presence or absence of a contained value are provided, such as
2727
* {@link #hasValue(Object)} or {@link #isPresent()}
28-
* <p/>
28+
* <p>
2929
* Aliases are immutable once created.
3030
*
3131
* @author Oliver Gierke

src/main/java/org/springframework/data/mapping/Association.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Value object to capture {@link Association}s.
2222
*
2323
* @param <P> {@link PersistentProperty}s the association connects.
24-
* @author Jon Brisbin <[email protected]>
24+
* @author Jon Brisbin
2525
* @author Mark Paluch
2626
*/
2727
public class Association<P extends PersistentProperty<P>> {

src/main/java/org/springframework/data/mapping/AssociationHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/**
1919
* Callback interface to implement functionality to be applied to a collection of {@link Association}s.
2020
*
21-
* @author Jon Brisbin <[email protected]>
21+
* @author Jon Brisbin
2222
* @author Oliver Gierke
2323
*/
2424
public interface AssociationHandler<P extends PersistentProperty<P>> {

0 commit comments

Comments
 (0)