[ 
https://issues.apache.org/jira/browse/COLLECTIONS-764?focusedWorklogId=461441&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-461441
 ]

ASF GitHub Bot logged work on COLLECTIONS-764:
----------------------------------------------

                Author: ASF GitHub Bot
            Created on: 21/Jul/20 07:38
            Start Date: 21/Jul/20 07:38
    Worklog Time Spent: 10m 
      Work Description: XenoAmess edited a comment on pull request #165:
URL: 
https://github.com/apache/commons-collections/pull/165#issuecomment-661688227


   @wlfbck
   > Do these fixes include that for example 
[CircularFifoQueue](https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/org/apache/commons/collections4/queue/CircularFifoQueue.html)
 has dummydoc for `poll()`, `element()`, `peek()`, `remove()`? Because that 
stuff is not in the source, so i assume it is generated. But it hides the 
original javadoc from java.util.Queue, which is very annoying.
   
   Nope.
   But I think it shall be able to be solved by adding: 
   ```
       /**
        * {@inheritDoc}
        */
   ```
   
   The question you mentioned is planned to be fixed by using 
maven-javadoc-plugin.
   Currently the plan is:
   1. wait for me fully recover from a flu.(not yet QAQ)
   2. my pr about some basic refinement to maven-javadoc-plugin get reviewed 
and passed.(still waiting)
   3. I will make a pr to fix some bugs in maven-javadoc-plugin's javadoc:fix 
operation, and see it get passed.
   4. I use the javadoc:fix on this repo, and see what doc can be auto fixed.
   
   The reason I don't want to use the javadoc:fix now is it really have some 
bugs, I mean, quite some.
   But that will take lots of times to wait (maven guys are really...busy...)
   So if you really want some of the docs be fixed soon, you can apply 
javadoc:fix on this repo, and revert all things it messed up, only leave some 
good changes.(but that is also a human-time-coster).
   
   Anyway, it should be in another pr. This pr is already too large.


----------------------------------------------------------------
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: 461441)
    Time Spent: 3h 40m  (was: 3.5h)

> Refine javadoc and fix typos
> ----------------------------
>
>                 Key: COLLECTIONS-764
>                 URL: https://issues.apache.org/jira/browse/COLLECTIONS-764
>             Project: Commons Collections
>          Issue Type: Improvement
>            Reporter: Jin Xu
>            Priority: Minor
>          Time Spent: 3h 40m
>  Remaining Estimate: 0h
>
> [https://github.com/apache/commons-collections/pull/165]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to