Skip to content

Commit

Permalink
Fix some javadoc lint
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 530417201
  • Loading branch information
cushon authored and Error Prone Team committed May 8, 2023
1 parent 80a944b commit b482675
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* <ul>
* <li>For humans: it indicates that the class/interface (and subclasses) is thread-safe
* <li>For machines: it causes the annotated class/interface -- and all of its subtypes -- to be
* validated by the {@link com.google.errorprone.bugpatterns.threadsafety.ThreadSafeChecker}
* validated by the {@code com.google.errorprone.bugpatterns.threadsafety.ThreadSafeChecker}
* {@code BugChecker}.
* </ul>
*
Expand All @@ -53,8 +53,8 @@
* keeping it thread-safe is even more so.
*
* <p>The remainder of this javadoc describes the heuristics enforced by {@code ThreadSafeChecker}
* and the related {@link com.google.errorprone.bugpatterns.threadsafety.GuardedByChecker} and
* {@link com.google.errorprone.bugpatterns.threadsafety.ImmutableChecker} on which the former
* and the related {@code com.google.errorprone.bugpatterns.threadsafety.GuardedByChecker} and
* {@code com.google.errorprone.bugpatterns.threadsafety.ImmutableChecker} on which the former
* relies.
*
* <p>The {@code ThreadSafeChecker} heuristics enforce that every field meets at least one of these
Expand All @@ -73,10 +73,10 @@
* requirement is that it meets at least one of these four conditions:
*
* <ul>
* <li>it is listed as a well-known immutable type in {@link
* <li>it is listed as a well-known immutable type in {@code
* com.google.errorprone.bugpatterns.threadsafety.WellKnownMutability} (e.g. a field of type
* {@link String}); and/or
* <li>it is listed as a well-known thread-safe type in {@link
* <li>it is listed as a well-known thread-safe type in {@code
* com.google.errorprone.bugpatterns.threadsafety.WellKnownThreadSafety} (e.g. a field of type
* {@link java.util.concurrent.atomic.AtomicBoolean}); and/or
* <li>it is annotated with {@link Immutable}; and/or
Expand All @@ -85,7 +85,7 @@
*
* <p>This first requirement means the type is at least inherently shallowly thread-safe.
*
* <p>Fields annotated with {@link javax.annotation.concurrent.GuardedBy} are likely the meat of a
* <p>Fields annotated with {@code javax.annotation.concurrent.GuardedBy} are likely the meat of a
* mutable thread-safe class: these are things that need to be mutated, but should be done so in a
* safe manner -- i.e., (most likely) in critical sections of code that protect their access by
* means of a lock. See more information in that annotation's javadoc.
Expand Down

0 comments on commit b482675

Please sign in to comment.