diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/util/ThirdPartyLibrary.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/util/ThirdPartyLibrary.java index cf55df6990d..15538a5ce57 100644 --- a/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/util/ThirdPartyLibrary.java +++ b/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/util/ThirdPartyLibrary.java @@ -1,6 +1,7 @@ package tech.picnic.errorprone.bugpatterns.util; import com.google.errorprone.VisitorState; +import com.google.errorprone.bugpatterns.BugChecker; import com.google.errorprone.suppliers.Supplier; import com.sun.tools.javac.code.ClassFinder; import com.sun.tools.javac.code.Symbol.CompletionFailure; @@ -10,8 +11,8 @@ * Utility class that helps decide whether it is appropriate to introduce references to (well-known) * third-party libraries. * - *

This class should be used by bug checkers that may otherwise suggest the introduction of code - * that depends on possibly-not-present third-party libraries. + *

This class should be used by {@link BugChecker}s that may otherwise suggest the introduction + * of code that depends on possibly-not-present third-party libraries. */ // XXX: Consider giving users more fine-grained control. This would be beneficial in cases where a // dependency is on the classpath, but new usages are undesirable. @@ -25,14 +26,14 @@ public enum ThirdPartyLibrary { /** * Google's Guava. * - * @see Guava on Github + * @see Guava on GitHub */ GUAVA("com.google.common.collect.ImmutableList"), /** * New Relic's Java agent API. * * @see New Relic - * Java agent API on Github + * Java agent API on GitHub */ NEW_RELIC_AGENT_API("com.newrelic.api.agent.Agent"), /** @@ -57,7 +58,7 @@ public enum ThirdPartyLibrary { * the given context. * * @param state The context under consideration. - * @return {@code true} iff if it is okay to assume or create a dependency on this library. + * @return {@code true} iff it is okay to assume or create a dependency on this library. */ public boolean canUse(VisitorState state) { return canUse.get(state);