Skip to content

Fix inconsistent strong tag appearance in documentation #4177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ protected FieldNamingStrategy fieldNamingStrategy() {
* {@link org.springframework.data.mongodb.core.index.IndexDefinition} from the entity or not.
*
* @return {@literal false} by default. <br />
* <strong>INFO</strong>: As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}.
* <strong>INFO:</strong> As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}.
* @since 2.2
*/
protected boolean autoIndexCreation() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public static CollectionOptions timeSeries(String timeField) {

/**
* Create new {@link CollectionOptions} with already given settings and capped set to {@literal true}. <br />
* <strong>NOTE</strong> Using capped collections requires defining {@link #size(long)}.
* <strong>NOTE:</strong> Using capped collections requires defining {@link #size(long)}.
*
* @return new {@link CollectionOptions}.
* @since 2.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ interface TerminatingRemove<T> {

/**
* Remove and return all matching documents. <br/>
* <strong>NOTE</strong> The entire list of documents will be fetched before sending the actual delete commands.
* <strong>NOTE:</strong> The entire list of documents will be fetched before sending the actual delete commands.
* Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete
* operation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ interface TerminatingRemove<T> {

/**
* Remove and return all matching documents. <br/>
* <strong>NOTE</strong> The entire list of documents will be fetched before sending the actual delete commands.
* <strong>NOTE:</strong> The entire list of documents will be fetched before sending the actual delete commands.
* Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete
* operation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public static DateFromString dateFromString(String value) {
* +/-[hh], e.g. "+03"</td>
* </tr>
* </table>
* <strong>NOTE: </strong>Support for timezones in aggregations Requires MongoDB 3.6 or later.
* <strong>NOTE:</strong> Support for timezones in aggregations Requires MongoDB 3.6 or later.
*
* @author Christoph Strobl
* @author Mark Paluch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

/**
* {@link ProxyFactory} to create a proxy for {@link MongoPersistentProperty#getType()} to resolve a reference lazily.
* <strong>NOTE</strong> This class is intended for internal usage only.
* <strong>NOTE:</strong> This class is intended for internal usage only.
*
* @author Christoph Strobl
* @author Mark Paluch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ public TextIndexDefinitionBuilder named(String name) {

/**
* Define the index to span all fields using wildcard. <br/>
* <strong>NOTE</strong> {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard.
* <strong>NOTE:</strong> {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard.
*
* @return
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public WildcardIndex() {}
/**
* Create a new instance of {@link WildcardIndex} for the given {@literal path}. If no {@literal path} is provided the
* index will be considered a root one using {@code $**}. <br />
* <strong>NOTE</strong> {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)}
* <strong>NOTE:</strong> {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)}
* can only be used for top level index definitions having an {@literal empty} or {@literal null} path.
*
* @param path can be {@literal null}. If {@literal null} all fields will be indexed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
/**
* Explicitly specify sub fields to be in-/excluded as a {@link org.bson.Document#parse(String) prasable} String.
* <br />
* <strong>NOTE: </strong>Can only be applied on root level documents.
* <strong>NOTE:</strong> Can only be applied on root level documents.
*
* @return empty by default.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
* {@literal null} values are not written to the target {@code Document}. Setting the value to {@link Write#ALWAYS}
* explicitly adds an entry for the given field holding {@literal null} as a value {@code 'fieldName' : null }.
* <br />
* <strong>NOTE</strong>Setting the value to {@link Write#ALWAYS} may lead to increased document size.
* <strong>NOTE:</strong> Setting the value to {@link Write#ALWAYS} may lead to increased document size.
*
* @return {@link Write#NON_NULL} by default.
* @since 3.3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ public void setApplicationContext(ApplicationContext applicationContext) throws

/**
* Returns whether auto-index creation is enabled or disabled. <br />
* <strong>NOTE:</strong>Index creation should happen at a well-defined time that is ideally controlled by the
* <strong>NOTE:</strong> Index creation should happen at a well-defined time that is ideally controlled by the
* application itself.
*
* @return {@literal true} when auto-index creation is enabled; {@literal false} otherwise. <br />
* <strong>INFO</strong>: As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x.
* <strong>INFO:</strong> As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x.
* @since 2.2
* @see org.springframework.data.mongodb.core.index.Indexed
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
* is either a single or multiple indexed properties that exist in every document in the collection.
* <br />
* By default the {@literal id} property is used for sharding. <br />
* <strong>NOTE</strong> Required indexes are not created automatically. Create these either externally, via
* <strong>NOTE:</strong> Required indexes are not created automatically. Create these either externally, via
* {@link org.springframework.data.mongodb.core.index.IndexOperations#ensureIndex(org.springframework.data.mongodb.core.index.IndexDefinition)}
* or by annotating your domain model with {@link org.springframework.data.mongodb.core.index.Indexed}/
* {@link org.springframework.data.mongodb.core.index.CompoundIndex} along with enabled
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public static NearQuery near(double x, double y, Metric metric) {

/**
* Creates a new {@link NearQuery} starting at the given {@link Point}. <br />
* <strong>NOTE</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
* <strong>NOTE:</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
* values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the
* {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to
* different results when using a {@link Metrics#NEUTRAL neutral Metric}.
Expand All @@ -241,7 +241,7 @@ public static NearQuery near(Point point) {
* Creates a {@link NearQuery} starting near the given {@link Point} using the given {@link Metric} to adapt given
* values to further configuration. E.g. setting a {@link #maxDistance(double)} will be interpreted as a value of the
* initially set {@link Metric}. <br />
* <strong>NOTE</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
* <strong>NOTE:</strong> There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point}
* values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the
* {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to
* different results when using a {@link Metrics#NEUTRAL neutral Metric}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ default Mono<ObjectId> store(Publisher<DataBuffer> content, @Nullable String fil

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

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