Skip to content

Commit 2c94ecc

Browse files
committed
Fix Javadoc errors
1 parent 8b85d87 commit 2c94ecc

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

src/main/java/com/fasterxml/jackson/databind/JsonDeserializer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public abstract class JsonDeserializer<T>
7676
* ...
7777
* }
7878
* </pre>
79-
* Jackson consumes the two tokens (the <tt>@class</tt> field name
79+
* Jackson consumes the two tokens (the {@code @class} field name
8080
* and its value) in order to learn the class and select the deserializer.
8181
* Thus, the stream is pointing to the FIELD_NAME for the first field
8282
* after the @class. Thus, if you want your method to work correctly

src/main/java/com/fasterxml/jackson/databind/JsonNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ public boolean asBoolean(boolean defaultValue) {
809809
/**
810810
* Method that will return a {@link JsonNode} wrapped in Java's {@link Optional}.
811811
*
812-
* @return `Optional<JsonNode>` containing this node, or {@link Optional#empty()}
812+
* @return {@code Optional<JsonNode>} containing this node, or {@link Optional#empty()}
813813
* if this is a {@link MissingNode}.
814814
* @since 2.19
815815
*/

src/main/java/com/fasterxml/jackson/databind/ObjectMapper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2331,7 +2331,7 @@ public ObjectMapper setConstructorDetector(ConstructorDetector cd) {
23312331
/**
23322332
* Method for specifying {@link CacheProvider} instance, to provide Cache instances to be used in components downstream.
23332333
*
2334-
* @cacheProvider Cache provider for this mapper to use
2334+
* @param cacheProvider Cache provider for this mapper to use
23352335
*
23362336
* @throws IllegalArgumentException if given provider is null
23372337
*

src/main/java/com/fasterxml/jackson/databind/deser/ContextualDeserializer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public interface ContextualDeserializer
3535
* @return Deserializer to use for deserializing values of specified property;
3636
* may be this instance or a new instance.
3737
*
38-
* @throws JsonMappingException
38+
* @throws JsonMappingException If there is problem with contextualization
3939
*/
4040
public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
4141
BeanProperty property)

src/main/java/com/fasterxml/jackson/databind/deser/DeserializerFactory.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636
* </li>
3737
* <li>For all other types, {@link #createBeanDeserializer} is used.
3838
* </ul>
39-
*<p>
4039
*/
4140
public abstract class DeserializerFactory
4241
{

src/main/java/com/fasterxml/jackson/databind/jsontype/BasicPolymorphicTypeValidator.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
*<br>
1818
* For example:
1919
*<pre>
20+
* [ADD EXAMPLE HERE]
2021
*</pre>
2122
*
2223
* @since 2.10

src/main/java/com/fasterxml/jackson/databind/node/ContainerNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ public final NumericNode numberNode(long v) {
189189
* Short-cut for:
190190
*<pre>
191191
* removeIf(JsonNode::isNull);
192-
*<pre>
192+
*</pre>
193193
*
194194
* @return Container node itself (to allow method call chaining)
195195
*

src/main/java/com/fasterxml/jackson/databind/util/internal/PrivateMaxEntriesMap.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@
4646
* concurrency for updates, and a maximum capacity to bound the map by. This
4747
* implementation differs from {@link ConcurrentHashMap} in that it maintains a
4848
* page replacement algorithm that is used to evict an entry when the map has
49-
* exceeded its capacity. Unlike the <tt>Java Collections Framework</tt>, this
49+
* exceeded its capacity. Unlike the {@code Java Collections Framework}, this
5050
* map does not have a publicly visible constructor and instances are created
5151
* through a {@link Builder}.
5252
* <p>
5353
* An entry is evicted from the map when the entry size exceeds
54-
* its <tt>maximum capacity</tt> threshold.
54+
* its {@code maximum capacity} threshold.
5555
* <p>
5656
* An {@code EvictionListener} may be supplied for notification when an entry
5757
* is evicted from the map. This listener is invoked on a caller's thread and
@@ -62,7 +62,7 @@
6262
* operation asynchronously, such as by submitting a task to an
6363
* {@link java.util.concurrent.ExecutorService}.
6464
* <p>
65-
* The <tt>concurrency level</tt> determines the number of threads that can
65+
* The {@code concurrency level} determines the number of threads that can
6666
* concurrently modify the table. Using a significantly higher or lower value
6767
* than needed can waste space or lead to thread contention, but an estimate
6868
* within an order of magnitude of the ideal value does not usually have a
@@ -74,7 +74,7 @@
7474
* interfaces.
7575
* <p>
7676
* Like {@link java.util.Hashtable} but unlike {@link HashMap}, this class
77-
* does <em>not</em> allow <tt>null</tt> to be used as a key or value. Unlike
77+
* does <em>not</em> allow {@code null} to be used as a key or value. Unlike
7878
* {@link java.util.LinkedHashMap}, this class does <em>not</em> provide
7979
* predictable iteration order. A snapshot of the keys and entries may be
8080
* obtained in ascending and descending order of retention.
@@ -447,8 +447,8 @@ void drainWriteBuffer() {
447447
}
448448

449449
/**
450-
* Attempts to transition the node from the <tt>alive</tt> state to the
451-
* <tt>retired</tt> state.
450+
* Attempts to transition the node from the {@code alive} state to the
451+
* {@code retired} state.
452452
*
453453
* @param node the entry in the page replacement policy
454454
* @param expect the expected weighted value
@@ -463,8 +463,8 @@ boolean tryToRetire(Node<K, V> node, WeightedValue<V> expect) {
463463
}
464464

465465
/**
466-
* Atomically transitions the node from the <tt>alive</tt> state to the
467-
* <tt>retired</tt> state, if a valid transition.
466+
* Atomically transitions the node from the {@code alive} state to the
467+
* {@code retired} state, if a valid transition.
468468
*
469469
* @param node the entry in the page replacement policy
470470
*/
@@ -482,8 +482,8 @@ void makeRetired(Node<K, V> node) {
482482
}
483483

484484
/**
485-
* Atomically transitions the node to the <tt>dead</tt> state and decrements
486-
* the <tt>weightedSize</tt>.
485+
* Atomically transitions the node to the {@code dead} state and decrements
486+
* the {@code weightedSize}.
487487
*
488488
* @param node the entry in the page replacement policy
489489
*/
@@ -895,7 +895,7 @@ public void setNext(Node<K, V> next) {
895895
this.next = next;
896896
}
897897

898-
/** Retrieves the value held by the current <tt>WeightedValue</tt>. */
898+
/** Retrieves the value held by the current {@code WeightedValue}. */
899899
V getValue() {
900900
return get().value;
901901
}
@@ -1168,7 +1168,7 @@ public Builder() {
11681168
}
11691169

11701170
/**
1171-
* Specifies the initial capacity of the hash table (default <tt>16</tt>).
1171+
* Specifies the initial capacity of the hash table (default {@code 16}).
11721172
* This is the number of key-value pairs that the hash table can hold
11731173
* before a resize operation is required.
11741174
*
@@ -1198,7 +1198,7 @@ public Builder<K, V> maximumCapacity(long capacity) {
11981198
/**
11991199
* Specifies the estimated number of concurrently updating threads. The
12001200
* implementation performs internal sizing to try to accommodate this many
1201-
* threads (default <tt>16</tt>).
1201+
* threads (default {@code 16}).
12021202
*
12031203
* @param concurrencyLevel the estimated number of concurrently updating
12041204
* threads

src/main/java/com/fasterxml/jackson/databind/util/internal/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* <p>
2525
* The {@link com.fasterxml.jackson.databind.util.internal.PrivateMaxEntriesMap}
2626
* class supplies an efficient, scalable, thread-safe, bounded map. As with the
27-
* <tt>Java Collections Framework</tt> the "Concurrent" prefix is used to
27+
* {@code Java Collections Framework} the "Concurrent" prefix is used to
2828
* indicate that the map is not governed by a single exclusion lock.
2929
*
3030
* @see <a href="http://code.google.com/p/concurrentlinkedhashmap/">

0 commit comments

Comments
 (0)