RFR: JDK-8186684: Fix broken links in java.base API docs
Martin Buchholz
martinrb at google.com
Wed Aug 23 21:41:48 UTC 2017
I would be inclined to "fix the tool first" if it's not too hard.
---
Shouldn't the below have a proper arglist?
Consider instead
{@link #add(Object) add(E)}
Consider fixing the javadoc tool so that one can actually write {@link
#add(E)}
--- old/src/java.base/share/classes/java/util/ArrayDeque.java 2017-08-23
11:36:43.286955464 -0700
+++ new/src/java.base/share/classes/java/util/ArrayDeque.java 2017-08-23
11:36:43.070945993 -0700
@@ -293,7 +293,7 @@
/**
* Inserts the specified element at the end of this deque.
*
- * <p>This method is equivalent to {@link #add}.
+ * <p>This method is equivalent to {@link #add()}.
*
* @param e the element to add
* @throws NullPointerException if the specified element is null
What about all the other ArrayDeque methods below:
./ArrayDeque.java:296: * <p>This method is equivalent to {@link #add}.
./ArrayDeque.java:483: * <p>This method is equivalent to {@link
#addLast}.
./ArrayDeque.java:497: * <p>This method is equivalent to {@link
#offerLast}.
./ArrayDeque.java:513: * <p>This method is equivalent to {@link
#removeFirst}.
./ArrayDeque.java:527: * <p>This method is equivalent to {@link
#pollFirst}.
./ArrayDeque.java:541: * <p>This method is equivalent to {@link
#getFirst}.
./ArrayDeque.java:554: * <p>This method is equivalent to {@link
#peekFirst}.
./ArrayDeque.java:569: * <p>This method is equivalent to {@link
#addFirst}.
./ArrayDeque.java:582: * <p>This method is equivalent to {@link
#removeFirst()}.
More information about the core-libs-dev
mailing list