MissingSummary: don't fail in the case that javac fails to provide an…

… endpos for @see. Fixes external #1444 ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=288656035
google · Jan 9, 2020 · 39d2506 · 39d2506
1 parent 604ec31
commit 39d2506
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 9 deletions.
diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/javadoc/MissingSummary.java b/core/src/main/java/com/google/errorprone/bugpatterns/javadoc/MissingSummary.java
@@ -149,16 +149,22 @@ private Description generateReturnFix(
 
   private Description generateSeeFix(DocTreePath docTreePath, SeeTree seeTree, VisitorState state) {
     int pos = ((DCDocComment) docTreePath.getDocComment()).comment.getSourcePos(0);
+    // javac fails to provide an endpos for @see sometimes; don't emit a fix in that case.
+    SuggestedFix replacement = Utils.replace(seeTree, "", state);
     SuggestedFix fix =
-        SuggestedFix.builder()
-            .merge(Utils.replace(seeTree, "", state))
-            .replace(
-                pos,
-                pos,
-                String.format(
-                    "See {@link %s}.\n",
-                    seeTree.getReference().stream().map(Object::toString).collect(joining(" "))))
-            .build();
+        replacement.isEmpty()
+            ? replacement
+            : SuggestedFix.builder()
+                .merge(replacement)
+                .replace(
+                    pos,
+                    pos,
+                    String.format(
+                        "See {@link %s}.\n",
+                        seeTree.getReference().stream()
+                            .map(Object::toString)
+                            .collect(joining(" "))))
+                .build();
     return buildDescription(diagnosticPosition(docTreePath, state))
         .setMessage(String.format(CONSIDER_USING_MESSAGE, "see"))
         .addFix(fix)

diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/javadoc/Utils.java b/core/src/main/java/com/google/errorprone/bugpatterns/javadoc/Utils.java
@@ -32,6 +32,7 @@
 import com.sun.tools.javac.tree.JCTree;
 import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
+import com.sun.tools.javac.util.Position;
 import java.util.Optional;
 import javax.annotation.Nullable;
 
@@ -65,6 +66,9 @@ static SuggestedFix replace(DocTree docTree, String replacement, VisitorState st
     int startPos = getStartPosition(docTree, state);
     int endPos =
         (int) positions.getEndPosition(compilationUnitTree, getDocCommentTree(state), docTree);
+    if (endPos == Position.NOPOS) {
+      return SuggestedFix.builder().build();
+    }
     return SuggestedFix.replace(startPos, endPos, replacement);
   }