kinow commented on a change in pull request #144: [COLLECTIONS-757] Update the
JavaDoc of the BidiMap
URL:
https://github.com/apache/commons-collections/pull/144#discussion_r410519550
##########
File path:
src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
##########
@@ -26,9 +26,9 @@
import org.apache.commons.collections4.BidiMap;
/**
- * Implementation of {@code BidiMap} that uses two {@code LinkedHashMap}
instances.
+ * Implementation of {@link BidiMap} that uses two {@link LinkedHashMap}
instances.
Review comment:
I found the document I mentioned earlier. It was not exactly a presentation,
but the Oracle docs for javadocs:
https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide
(where it says "Use in-line links economically"). There's also a similar style
guide in UI/UX, to avoid cluttering user interfaces. However, I'm fine
whichever way :+1:
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
