Fix a few Javadoc issues (#1075)

eisop · Jan 28, 2025 · ccfbe4b · ccfbe4b
1 parent a014022
commit ccfbe4b
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/...org/checkerframework/checker/index/substringindex/SubstringIndexAnnotatedTypeFactory.java b/...org/checkerframework/checker/index/substringindex/SubstringIndexAnnotatedTypeFactory.java
@@ -80,8 +80,8 @@ protected DependentTypesHelper createDependentTypesHelper() {
 
     /**
      * The Substring Index qualifier hierarchy. The hierarchy consists of a top element {@link
-     * UNKNOWN} of type {@link SubstringIndexUnknown}, bottom element {@link BOTTOM} of type {@link
-     * SubstringIndexBottom}, and elements of type {@link SubstringIndexFor} that follow the
+     * #UNKNOWN} of type {@link SubstringIndexUnknown}, bottom element {@link #BOTTOM} of type
+     * {@link SubstringIndexBottom}, and elements of type {@link SubstringIndexFor} that follow the
      * subtyping relation of {@link UBQualifier}.
      */
     private final class SubstringIndexQualifierHierarchy extends ElementQualifierHierarchy {

diff --git a/...rk-test/src/main/java/org/checkerframework/framework/test/diagnostics/TestDiagnostic.java b/...rk-test/src/main/java/org/checkerframework/framework/test/diagnostics/TestDiagnostic.java
@@ -236,7 +236,7 @@ public int hashCode() {
     /**
      * Returns a representation of this diagnostic as if it appeared in a diagnostics file. This
      * uses only the base file name, not the full path, and only the message key, not the full
-     * message. Field {@link messageKeyParens} influences whether the message key is output in
+     * message. Field {@link #messageKeyParens} influences whether the message key is output in
      * parentheses.
      *
      * @return a representation of this diagnostic as if it appeared in a diagnostics file

diff --git a/framework/src/main/java/org/checkerframework/common/returnsreceiver/FluentAPIGenerator.java b/framework/src/main/java/org/checkerframework/common/returnsreceiver/FluentAPIGenerator.java
@@ -51,7 +51,7 @@ private enum FluentAPIGenerators {
             /**
              * The qualified name of the AutoValue Builder annotation. This needs to be constructed
              * dynamically due to a side effect of the shadow plugin. See {@link
-             * getAutoValueBuilderCanonicalName()} for more information.
+             * #getAutoValueBuilderCanonicalName()} for more information.
              */
             private final String AUTO_VALUE_BUILDER = getAutoValueBuilderCanonicalName();
 

diff --git a/framework/src/main/java/org/checkerframework/framework/stub/AnnotationFileParser.java b/framework/src/main/java/org/checkerframework/framework/stub/AnnotationFileParser.java
@@ -2070,7 +2070,7 @@ private void annotateTypeParameters(
      * zero or more mappings. Each mapping is from an element that {@code member} would override to
      * {@code member}.
      *
-     * <p>This method does not read or write field {@link annotationFileAnnos}.
+     * <p>This method does not read or write field {@link #annotationFileAnnos}.
      *
      * @param elementsToDecl the mapping that is side-effected by this method
      * @param fakeOverrideDecls fake overrides, also side-effected by this method

diff --git a/framework/src/main/java/org/checkerframework/framework/util/QualifierKindHierarchy.java b/framework/src/main/java/org/checkerframework/framework/util/QualifierKindHierarchy.java
@@ -30,7 +30,7 @@
  * ElementQualifierHierarchy} (but <em>not</em> {@link MostlyNoElementQualifierHierarchy}) to
  * implement methods that compare {@link javax.lang.model.element.AnnotationMirror}s, such as {@link
  * org.checkerframework.framework.type.QualifierHierarchy#isSubtypeShallow(AnnotationMirror,
- * TypeMirror, AnnotationMirror, TypeMirror)}.
+ * javax.lang.model.type.TypeMirror, AnnotationMirror, javax.lang.model.type.TypeMirror)}.
  *
  * @see DefaultQualifierKindHierarchy
  * @see org.checkerframework.framework.util.DefaultQualifierKindHierarchy.DefaultQualifierKind