Skip to content

Commit 7f74794

Browse files
Ahlichristophstrobl
authored andcommitted
Fix inconsistent strong tag usage in javadoc.
Closes: #4177
1 parent 238d8c5 commit 7f74794

15 files changed

+18
-18
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ protected FieldNamingStrategy fieldNamingStrategy() {
206206
* {@link org.springframework.data.mongodb.core.index.IndexDefinition} from the entity or not.
207207
*
208208
* @return {@literal false} by default. <br />
209-
* <strong>INFO</strong>: As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}.
209+
* <strong>INFO:</strong> As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}.
210210
* @since 2.2
211211
*/
212212
protected boolean autoIndexCreation() {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public static CollectionOptions emitChangedRevisions() {
114114

115115
/**
116116
* Create new {@link CollectionOptions} with already given settings and capped set to {@literal true}. <br />
117-
* <strong>NOTE</strong> Using capped collections requires defining {@link #size(long)}.
117+
* <strong>NOTE:</strong> Using capped collections requires defining {@link #size(long)}.
118118
*
119119
* @return new {@link CollectionOptions}.
120120
* @since 2.0

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ interface TerminatingRemove<T> {
7676

7777
/**
7878
* Remove and return all matching documents. <br/>
79-
* <strong>NOTE</strong> The entire list of documents will be fetched before sending the actual delete commands.
79+
* <strong>NOTE:</strong> The entire list of documents will be fetched before sending the actual delete commands.
8080
* Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete
8181
* operation.
8282
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ interface TerminatingRemove<T> {
6969

7070
/**
7171
* Remove and return all matching documents. <br/>
72-
* <strong>NOTE</strong> The entire list of documents will be fetched before sending the actual delete commands.
72+
* <strong>NOTE:</strong> The entire list of documents will be fetched before sending the actual delete commands.
7373
* Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete
7474
* operation.
7575
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ public static DateFromString dateFromString(String value) {
159159
* +/-[hh], e.g. "+03"</td>
160160
* </tr>
161161
* </table>
162-
* <strong>NOTE: </strong>Support for timezones in aggregations Requires MongoDB 3.6 or later.
162+
* <strong>NOTE:</strong> Support for timezones in aggregations Requires MongoDB 3.6 or later.
163163
*
164164
* @author Christoph Strobl
165165
* @author Mark Paluch

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

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

4848
/**
4949
* {@link ProxyFactory} to create a proxy for {@link MongoPersistentProperty#getType()} to resolve a reference lazily.
50-
* <strong>NOTE</strong> This class is intended for internal usage only.
50+
* <strong>NOTE:</strong> This class is intended for internal usage only.
5151
*
5252
* @author Christoph Strobl
5353
* @author Mark Paluch

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ public TextIndexDefinitionBuilder named(String name) {
244244

245245
/**
246246
* Define the index to span all fields using wildcard. <br/>
247-
* <strong>NOTE</strong> {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard.
247+
* <strong>NOTE:</strong> {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard.
248248
*
249249
* @return
250250
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public WildcardIndex() {}
6161
/**
6262
* Create a new instance of {@link WildcardIndex} for the given {@literal path}. If no {@literal path} is provided the
6363
* index will be considered a root one using {@code $**}. <br />
64-
* <strong>NOTE</strong> {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)}
64+
* <strong>NOTE:</strong> {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)}
6565
* can only be used for top level index definitions having an {@literal empty} or {@literal null} path.
6666
*
6767
* @param path can be {@literal null}. If {@literal null} all fields will be indexed.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
/**
120120
* Explicitly specify sub fields to be in-/excluded as a {@link org.bson.Document#parse(String) prasable} String.
121121
* <br />
122-
* <strong>NOTE: </strong>Can only be applied on root level documents.
122+
* <strong>NOTE:</strong> Can only be applied on root level documents.
123123
*
124124
* @return empty by default.
125125
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
* {@literal null} values are not written to the target {@code Document}. Setting the value to {@link Write#ALWAYS}
7373
* explicitly adds an entry for the given field holding {@literal null} as a value {@code 'fieldName' : null }.
7474
* <br />
75-
* <strong>NOTE</strong>Setting the value to {@link Write#ALWAYS} may lead to increased document size.
75+
* <strong>NOTE:</strong> Setting the value to {@link Write#ALWAYS} may lead to increased document size.
7676
*
7777
* @return {@link Write#NON_NULL} by default.
7878
* @since 3.3

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
9797

9898
/**
9999
* Returns whether auto-index creation is enabled or disabled. <br />
100-
* <strong>NOTE:</strong>Index creation should happen at a well-defined time that is ideally controlled by the
100+
* <strong>NOTE:</strong> Index creation should happen at a well-defined time that is ideally controlled by the
101101
* application itself.
102102
*
103103
* @return {@literal true} when auto-index creation is enabled; {@literal false} otherwise. <br />
104-
* <strong>INFO</strong>: As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x.
104+
* <strong>INFO:</strong> As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x.
105105
* @since 2.2
106106
* @see org.springframework.data.mongodb.core.index.Indexed
107107
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
* is either a single or multiple indexed properties that exist in every document in the collection.
6565
* <br />
6666
* By default the {@literal id} property is used for sharding. <br />
67-
* <strong>NOTE</strong> Required indexes are not created automatically. Create these either externally, via
67+
* <strong>NOTE:</strong> Required indexes are not created automatically. Create these either externally, via
6868
* {@link org.springframework.data.mongodb.core.index.IndexOperations#ensureIndex(org.springframework.data.mongodb.core.index.IndexDefinition)}
6969
* or by annotating your domain model with {@link org.springframework.data.mongodb.core.index.Indexed}/
7070
* {@link org.springframework.data.mongodb.core.index.CompoundIndex} along with enabled

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ public static NearQuery near(double x, double y, Metric metric) {
232232

233233
/**
234234
* Creates a new {@link NearQuery} starting at the given {@link Point}. <br />
235-
* <strong>NOTE</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
235+
* <strong>NOTE:</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
236236
* values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the
237237
* {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to
238238
* different results when using a {@link Metrics#NEUTRAL neutral Metric}.
@@ -248,7 +248,7 @@ public static NearQuery near(Point point) {
248248
* Creates a {@link NearQuery} starting near the given {@link Point} using the given {@link Metric} to adapt given
249249
* values to further configuration. E.g. setting a {@link #maxDistance(double)} will be interpreted as a value of the
250250
* initially set {@link Metric}. <br />
251-
* <strong>NOTE</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
251+
* <strong>NOTE:</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
252252
* values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the
253253
* {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to
254254
* different results when using a {@link Metrics#NEUTRAL neutral Metric}.

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsOperations.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ default Mono<ObjectId> store(Publisher<DataBuffer> content, @Nullable String fil
173173

174174
/**
175175
* Returns a {@link Flux} emitting all files matching the given query. <br />
176-
* <strong>Note:</strong> Currently {@link Sort} criteria defined at the {@link Query} will not be regarded as MongoDB
176+
* <strong>NOTE:</strong> Currently {@link Sort} criteria defined at the {@link Query} will not be regarded as MongoDB
177177
* does not support ordering for GridFS file access.
178178
*
179179
* @see <a href="https://jira.mongodb.org/browse/JAVA-431">MongoDB Jira: JAVA-431</a>
@@ -185,7 +185,7 @@ default Mono<ObjectId> store(Publisher<DataBuffer> content, @Nullable String fil
185185
/**
186186
* Returns a {@link Mono} emitting a single {@link com.mongodb.client.gridfs.model.GridFSFile} matching the given
187187
* query or {@link Mono#empty()} in case no file matches. <br />
188-
* <strong>NOTE</strong> If more than one file matches the given query the resulting {@link Mono} emits an error. If
188+
* <strong>NOTE:</strong> If more than one file matches the given query the resulting {@link Mono} emits an error. If
189189
* you want to obtain the first found file use {@link #findFirst(Query)}.
190190
*
191191
* @param query must not be {@literal null}.

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsResource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ public Mono<GridFSFile> getGridFSFile() {
136136

137137
/**
138138
* Obtain the data as {@link InputStream}. <br />
139-
* <strong>NOTE</strong> Buffers data in memory. Use {@link #getDownloadStream()} for large files.
139+
* <strong>NOTE:</strong> Buffers data in memory. Use {@link #getDownloadStream()} for large files.
140140
*
141141
* @throws IllegalStateException if the underlying {@link Publisher} has already been consumed.
142142
* @see org.springframework.core.io.InputStreamResource#getInputStream()

0 commit comments

Comments
 (0)