[
https://issues.apache.org/jira/browse/COLLECTIONS-757?focusedWorklogId=411612&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-411612
]
ASF GitHub Bot logged work on COLLECTIONS-757:
----------------------------------------------
Author: ASF GitHub Bot
Created on: 28/Mar/20 04:51
Start Date: 28/Mar/20 04:51
Worklog Time Spent: 10m
Work Description: kinow commented on pull request #144: [COLLECTIONS-757]
Update the JavaDoc of the BidiMap
URL:
https://github.com/apache/commons-collections/pull/144#discussion_r399619466
##########
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:
This might have been intentional? Some people prefer to avoid adding too
many links in the Javadoc (forgot where I saw a presentation about that, but it
was in some guide for writing Javadocs where the author mentioned to keep the
number of links low, so users are not distracted).
----------------------------------------------------------------
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 411612)
Time Spent: 0.5h (was: 20m)
> Some bugs need to fix with JavaDoc in the BidiMap
> -------------------------------------------------
>
> Key: COLLECTIONS-757
> URL: https://issues.apache.org/jira/browse/COLLECTIONS-757
> Project: Commons Collections
> Issue Type: Improvement
> Components: BidiMap
> Reporter: Chen Guoping
> Priority: Major
> Labels: documentation
> Fix For: 4.5
>
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Some bugs need to fix with JavaDoc in the BidiMap.
> I had provided a PR to fix it.
> [https://github.com/apache/commons-collections/pull/144]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
