Skip to content

Commit 4856c9b

Browse files
committed
DATAMONGO-1587 - Polishing.
Convert @see http://… links to valid format using @see <a href=…>…</a>
1 parent 644c1a2 commit 4856c9b

38 files changed

+156
-158
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/GeoCommandStatistics.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 the original author or authors.
2+
* Copyright 2016-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -62,7 +62,7 @@ public static GeoCommandStatistics from(Document commandResult) {
6262
* didn't return any result introduced in MongoDB 3.2 RC1.
6363
*
6464
* @return
65-
* @see https://jira.mongodb.org/browse/SERVER-21024
65+
* @see <a href="https://jira.mongodb.org/browse/SERVER-21024">MongoDB Jira SERVER-21024</a>
6666
*/
6767
public double getAverageDistance() {
6868

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2010-2016 the original author or authors.
2+
* Copyright 2010-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -686,7 +686,7 @@ public <T> GeoResults<T> geoNear(NearQuery near, Class<T> entityClass, String co
686686
* As MongoDB currently (2.4.4) doesn't support the skipping of elements in near queries
687687
* we skip the elements ourselves to avoid at least the document 2 object mapping overhead.
688688
*
689-
* @see https://jira.mongodb.org/browse/SERVER-3925
689+
* @see <a href="https://jira.mongodb.org/browse/SERVER-3925">MongoDB Jira: SERVER-3925</a>
690690
*/
691691
if (index >= elementsToSkip) {
692692
result.add(callback.doWith((Document) element));

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveMongoOperations.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@
4646
*
4747
* @author Mark Paluch
4848
* @author Christoph Strobl
49+
* @since 2.0
4950
* @see Flux
5051
* @see Mono
51-
* @see http://projectreactor.io/docs/
52-
* @since 2.0
52+
* @see <a href="http://projectreactor.io/docs/">Project Reactor</a>
5353
*/
5454
public interface ReactiveMongoOperations {
5555

@@ -393,7 +393,7 @@ public interface ReactiveMongoOperations {
393393
<T> Flux<GeoResult<T>> geoNear(NearQuery near, Class<T> entityClass, String collectionName);
394394

395395
/**
396-
* Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
396+
* Triggers <a href="https://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
397397
* to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query}.
398398
*
399399
* @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
@@ -405,7 +405,7 @@ public interface ReactiveMongoOperations {
405405
<T> Mono<T> findAndModify(Query query, Update update, Class<T> entityClass);
406406

407407
/**
408-
* Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
408+
* Triggers <a href="https://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
409409
* to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query}.
410410
*
411411
* @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
@@ -418,7 +418,7 @@ public interface ReactiveMongoOperations {
418418
<T> Mono<T> findAndModify(Query query, Update update, Class<T> entityClass, String collectionName);
419419

420420
/**
421-
* Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
421+
* Triggers <a href="https://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
422422
* to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query} taking
423423
* {@link FindAndModifyOptions} into account.
424424
*
@@ -432,7 +432,7 @@ public interface ReactiveMongoOperations {
432432
<T> Mono<T> findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass);
433433

434434
/**
435-
* Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
435+
* Triggers <a href="https://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify <a/>
436436
* to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query} taking
437437
* {@link FindAndModifyOptions} into account.
438438
*

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -598,7 +598,7 @@ public String toString() {
598598
* Describes the system variables available in MongoDB aggregation framework pipeline expressions.
599599
*
600600
* @author Thomas Darimont
601-
* @see http://docs.mongodb.org/manual/reference/aggregation-variables
601+
* @see <a href="https://docs.mongodb.org/manual/reference/aggregation-variables">Aggregation Variables</a>
602602
*/
603603
enum SystemVariable {
604604

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
/**
2121
* Holds a set of configurable aggregation options that can be used within an aggregation pipeline. A list of support
2222
* aggregation options can be found in the MongoDB reference documentation
23-
* http://docs.mongodb.org/manual/reference/command/aggregate/#aggregate
23+
* https://docs.mongodb.org/manual/reference/command/aggregate/#aggregate
2424
*
2525
* @author Thomas Darimont
2626
* @author Oliver Gierke

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BucketAutoOperation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* instances of this class directly.
3131
*
3232
* @see <a href=
33-
* "http://docs.mongodb.org/manual/reference/aggregation/bucketAuto/">http://docs.mongodb.org/manual/reference/aggregation/bucketAuto/</a>
33+
* "https://docs.mongodb.org/manual/reference/aggregation/bucketAuto/">https://docs.mongodb.org/manual/reference/aggregation/bucketAuto/</a>
3434
* @see BucketOperationSupport
3535
* @author Mark Paluch
3636
* @author Christoph Strobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BucketOperation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* We recommend to use the static factory method {@link Aggregation#bucket(String)} instead of creating instances of
3535
* this class directly.
3636
*
37-
* @see <a href="http://docs.mongodb.org/manual/reference/aggregation/bucket/">http://docs.mongodb.org/manual/reference/aggregation/bucket/</a>
37+
* @see <a href="https://docs.mongodb.org/manual/reference/aggregation/bucket/">https://docs.mongodb.org/manual/reference/aggregation/bucket/</a>
3838
* @see BucketOperationSupport
3939
* @author Mark Paluch
4040
* @since 1.10

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ConditionalOperators.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ private boolean usesCriteriaDefinition() {
230230
* converted to a simple MongoDB type.
231231
*
232232
* @see <a href=
233-
* "http://docs.mongodb.com/manual/reference/operator/aggregation/ifNull/">http://docs.mongodb.com/manual/reference/operator/aggregation/ifNull/</a>
233+
* "https://docs.mongodb.com/manual/reference/operator/aggregation/ifNull/">https://docs.mongodb.com/manual/reference/operator/aggregation/ifNull/</a>
234234
* @author Mark Paluch
235235
*/
236236
public static class IfNull implements AggregationExpression {
@@ -533,7 +533,7 @@ public interface ThenBuilder {
533533
* simple MongoDB type.
534534
*
535535
* @see <a href=
536-
* "http://docs.mongodb.com/manual/reference/operator/aggregation/cond/">http://docs.mongodb.com/manual/reference/operator/aggregation/cond/</a>
536+
* "https://docs.mongodb.com/manual/reference/operator/aggregation/cond/">https://docs.mongodb.com/manual/reference/operator/aggregation/cond/</a>
537537
* @author Mark Paluch
538538
* @author Christoph Strobl
539539
*/

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/FacetOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 the original author or authors.
2+
* Copyright 2016-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -38,10 +38,10 @@
3838
* We recommend to use the static factory method {@link Aggregation#facet()} instead of creating instances of this class
3939
* directly.
4040
*
41-
* @see http://docs.mongodb.org/manual/reference/aggregation/facet/
4241
* @author Mark Paluch
4342
* @author Christoph Strobl
4443
* @since 1.10
44+
* @see <a href="https://docs.mongodb.org/manual/reference/aggregation/facet/">MongoDB Aggregation Framework: $facet</a>
4545
*/
4646
public class FacetOperation implements FieldsExposingAggregationOperation {
4747

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/GraphLookupOperation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* of this class directly.
3737
*
3838
* @see <a href=
39-
* "http://docs.mongodb.org/manual/reference/aggregation/graphLookup/">http://docs.mongodb.org/manual/reference/aggregation/graphLookup/</a>
39+
* "https://docs.mongodb.org/manual/reference/aggregation/graphLookup/">https://docs.mongodb.org/manual/reference/aggregation/graphLookup/</a>
4040
* @author Mark Paluch
4141
* @author Christoph Strobl
4242
* @since 1.10

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/GroupOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -33,13 +33,13 @@
3333
* We recommend to use the static factory method {@link Aggregation#group(Fields)} instead of creating instances of this
3434
* class directly.
3535
*
36-
* @see http://docs.mongodb.org/manual/reference/aggregation/group/#stage._S_group
3736
* @author Sebastian Herold
3837
* @author Thomas Darimont
3938
* @author Oliver Gierke
4039
* @author Gustavo de Geus
4140
* @author Christoph Strobl
4241
* @since 1.3
42+
* @see <a href="https://docs.mongodb.org/manual/reference/aggregation/group/">MongoDB Aggregation Framework: $group</a>
4343
*/
4444
public class GroupOperation implements FieldsExposingAggregationOperation {
4545

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/LimitOperation.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,12 +23,12 @@
2323
* <p>
2424
* We recommend to use the static factory method {@link Aggregation#limit(long)} instead of creating instances of this
2525
* class directly.
26-
*
27-
* @see http://docs.mongodb.org/manual/reference/aggregation/limit/
26+
*
2827
* @author Thomas Darimont
2928
* @author Oliver Gierke
3029
* @author Christoph Strobl
3130
* @since 1.3
31+
* @see <a href="https://docs.mongodb.org/manual/reference/aggregation/limit/">MongoDB Aggregation Framework: $limit</a>
3232
*/
3333
public class LimitOperation implements AggregationOperation {
3434

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/LookupOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 the original author or authors.
2+
* Copyright 2016-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -27,8 +27,8 @@
2727
* @author Alessio Fachechi
2828
* @author Christoph Strobl
2929
* @author Mark Paluch
30-
* @see http://docs.mongodb.org/manual/reference/aggregation/lookup/#stage._S_lookup
3130
* @since 1.9
31+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/">MongoDB Aggregation Framework: $lookup</a>
3232
*/
3333
public class LookupOperation implements FieldsExposingAggregationOperation, InheritsFieldsAggregationOperation {
3434

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/MatchOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2015 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -26,11 +26,11 @@
2626
* {@link Aggregation#match(org.springframework.data.mongodb.core.query.Criteria)} instead of creating instances of this
2727
* class directly.
2828
*
29-
* @see http://docs.mongodb.org/manual/reference/aggregation/match/
3029
* @author Sebastian Herold
3130
* @author Thomas Darimont
3231
* @author Oliver Gierke
3332
* @since 1.3
33+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/match/">MongoDB Aggregation Framework: $match</a>
3434
*/
3535
public class MatchOperation implements AggregationOperation {
3636

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/OutOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 the original author or authors.
2+
* Copyright 2016-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,9 +24,9 @@
2424
* We recommend to use the static factory method {@link Aggregation#out(String)} instead of creating instances of this
2525
* class directly.
2626
*
27-
* @see http://docs.mongodb.org/manual/reference/aggregation/out/
2827
* @author Nikolay Bogdanov
2928
* @author Christoph Strobl
29+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/out/">MongoDB Aggregation Framework: $out</a>
3030
*/
3131
public class OutOperation implements AggregationOperation {
3232

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ProjectionOperation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@
4040
* We recommend to use the static factory method {@link Aggregation#project(Fields)} instead of creating instances of
4141
* this class directly.
4242
*
43-
* @see http://docs.mongodb.org/manual/reference/aggregation/project/
4443
* @author Tobias Trelle
4544
* @author Thomas Darimont
4645
* @author Oliver Gierke
4746
* @author Christoph Strobl
4847
* @author Mark Paluch
4948
* @since 1.3
49+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/project/">MongoDB Aggregation Framework: $project</a>
5050
*/
5151
public class ProjectionOperation implements FieldsExposingAggregationOperation {
5252

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ReplaceRootOperation.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 the original author or authors.
2+
* Copyright 2016-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,11 +30,10 @@
3030
* We recommend to use the static factory method {@link Aggregation#replaceRoot(String)} instead of creating instances
3131
* of this class directly.
3232
*
33-
* @see <a href=
34-
* "https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/">https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/</a>
3533
* @author Mark Paluch
3634
* @author Christoph Strobl
3735
* @since 1.10
36+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/">MongoDB Aggregation Framework: $replaceRoot</a>
3837
*/
3938
public class ReplaceRootOperation implements FieldsExposingAggregationOperation {
4039

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SkipOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,11 +24,11 @@
2424
* We recommend to use the static factory method {@link Aggregation#skip(int)} instead of creating instances of this
2525
* class directly.
2626
*
27-
* @see http://docs.mongodb.org/manual/reference/aggregation/skip/
2827
* @author Thomas Darimont
2928
* @author Oliver Gierke
3029
* @author Christoph Strobl
3130
* @since 1.3
31+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/skip/">MongoDB Aggregation Framework: $skip</a>
3232
*/
3333
public class SkipOperation implements AggregationOperation {
3434

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/SortOperation.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -27,12 +27,12 @@
2727
* <p>
2828
* We recommend to use the static factory method {@link Aggregation#sort(Direction, String...)} instead of creating
2929
* instances of this class directly.
30-
*
31-
* @see http://docs.mongodb.org/manual/reference/aggregation/sort/#pipe._S_sort
30+
*
3231
* @author Thomas Darimont
3332
* @author Oliver Gierke
3433
* @author Christoph Strobl
3534
* @since 1.3
35+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/sort/">MongoDB Aggregation Framework: $sort</a>
3636
*/
3737
public class SortOperation implements AggregationOperation {
3838

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/UnwindOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2016 the original author or authors.
2+
* Copyright 2013-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -25,12 +25,12 @@
2525
* We recommend to use the static factory method {@link Aggregation#unwind(String)} instead of creating instances of
2626
* this class directly.
2727
*
28-
* @see http://docs.mongodb.org/manual/reference/aggregation/unwind/#pipe._S_unwind
2928
* @author Thomas Darimont
3029
* @author Oliver Gierke
3130
* @author Mark Paluch
3231
* @author Christoph Strobl
3332
* @since 1.3
33+
* @see <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/">MongoDB Aggregation Framework: $unwind</a>
3434
*/
3535
public class UnwindOperation
3636
implements AggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation {

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/geo/GeoJson.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2015 the original author or authors.
2+
* Copyright 2015-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ public interface GeoJson<T extends Iterable<?>> {
2727
* String value representing the type of the {@link GeoJson} object.
2828
*
2929
* @return will never be {@literal null}.
30-
* @see http://geojson.org/geojson-spec.html#geojson-objects
30+
* @see <a href="http://geojson.org/geojson-spec.html#geojson-objects">http://geojson.org/geojson-spec.html#geojson-objects</a>
3131
*/
3232
String getType();
3333

@@ -36,7 +36,7 @@ public interface GeoJson<T extends Iterable<?>> {
3636
* determined by {@link #getType()} of geometry.
3737
*
3838
* @return will never be {@literal null}.
39-
* @see http://geojson.org/geojson-spec.html#geometry-objects
39+
* @see <a href="http://geojson.org/geojson-spec.html#geometry-objects">http://geojson.org/geojson-spec.html#geometry-objects</a>
4040
*/
4141
T getCoordinates();
4242
}

0 commit comments

Comments
 (0)