You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2020/06/02 10:49:14 UTC

[GitHub] [commons-collections] XenoAmess opened a new pull request #165: Refine javadoc and fix typos

XenoAmess opened a new pull request #165:
URL: https://github.com/apache/commons-collections/pull/165


   1. refine javadocs.
   2. fix typos.


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433795336



##########
File path: src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
##########
@@ -341,10 +341,6 @@ public V selectValue(final K key) {
         return entry.getValue();
     }
 
-    /**
-     * This is equivalent to the other {@link #selectR(TrieEntry, int, Object, int, Cursor, Reference)}
-     * method but without its overhead because we're selecting only one best matching Entry from the {@link Trie}.
-     */

Review comment:
       > I think this one needs to stay?
   @kinow 
   I delete it because I can never found that function it point to.
   If you can show me where that function is : `selectR(TrieEntry, int, Object, int, Cursor, Reference)`, maybe I can fix the javadoc in a better way.




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] kinow closed pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
kinow closed pull request #165:
URL: https://github.com/apache/commons-collections/pull/165


   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented 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 a really...busy...)
   So if you really want some of the docs be fixed soon, you can apply javadoc:fix on it, and revert all things it messed up, only leave some good changes.(but that is also a time coster).


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
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).


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] kinow commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
kinow commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433788010



##########
File path: src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
##########
@@ -341,10 +341,6 @@ public V selectValue(final K key) {
         return entry.getValue();
     }
 
-    /**
-     * This is equivalent to the other {@link #selectR(TrieEntry, int, Object, int, Cursor, Reference)}
-     * method but without its overhead because we're selecting only one best matching Entry from the {@link Trie}.
-     */

Review comment:
       I think this one needs to stay?




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
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 it, and revert all things it messed up, only leave some good changes.(but that is also a time coster).


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] coveralls edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
coveralls edited a comment on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-637488425


   
   [![Coverage Status](https://coveralls.io/builds/31440627/badge)](https://coveralls.io/builds/31440627)
   
   Coverage remained the same at 90.123% when pulling **09f9fdde8ba8b5e83634255862c7f72757e37c5e on XenoAmess:refine_javadoc_and_fix_typos** into **6b4d75f725d9636b3ec6d5c24d410bece5e2fcc7 on apache:master**.
   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433847044



##########
File path: src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
##########
@@ -29,7 +29,7 @@
  * all data at the edges of the {@link org.apache.commons.collections4.Trie}
  * (and having empty internal nodes), PATRICIA stores data in every node.
  * This allows for very efficient traversal, insert, delete, predecessor,
- * successor, prefix, range, and {@link #select(Object)}
+ * successor, prefix, range, and {@link #select(String)}

Review comment:
       @dota17
   Though I have no idea why it can pass on 8 but not others....
   Strange isn't it...
   ![image](https://user-images.githubusercontent.com/17455337/83521545-f9ab4680-a511-11ea-8ff6-9a6c1734c46b.png)
   




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433795336



##########
File path: src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
##########
@@ -341,10 +341,6 @@ public V selectValue(final K key) {
         return entry.getValue();
     }
 
-    /**
-     * This is equivalent to the other {@link #selectR(TrieEntry, int, Object, int, Cursor, Reference)}
-     * method but without its overhead because we're selecting only one best matching Entry from the {@link Trie}.
-     */

Review comment:
       > I think this one needs to stay?
   
   I delete it because I can never found that function it point to.




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] kinow commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
kinow commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433816020



##########
File path: src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
##########
@@ -341,10 +341,6 @@ public V selectValue(final K key) {
         return entry.getValue();
     }
 
-    /**
-     * This is equivalent to the other {@link #selectR(TrieEntry, int, Object, int, Cursor, Reference)}
-     * method but without its overhead because we're selecting only one best matching Entry from the {@link Trie}.
-     */

Review comment:
       Ah, you are correct! There was another method, but it was removed when the base class was renamed and the code changed a little bit to create this abstract class - https://github.com/apache/commons-collections/commit/83226e162de60bd22551b1a37cc3e513811e1449#diff-821b6e7d45ec0fd696f3cdc8027f029cL303
   
   All good here then. Thanks!




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-643755003


   the travis-ci false pending for several days already.
   will try to retrigger it.


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] coveralls commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
coveralls commented on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-637488425


   
   [![Coverage Status](https://coveralls.io/builds/31183231/badge)](https://coveralls.io/builds/31183231)
   
   Coverage decreased (-0.03%) to 90.094% when pulling **d4bcae0548d7fb3f3bcdc2eb99f152c3839197d9 on XenoAmess:refine_javadoc_and_fix_typos** into **6b4d75f725d9636b3ec6d5c24d410bece5e2fcc7 on apache:master**.
   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433795336



##########
File path: src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
##########
@@ -341,10 +341,6 @@ public V selectValue(final K key) {
         return entry.getValue();
     }
 
-    /**
-     * This is equivalent to the other {@link #selectR(TrieEntry, int, Object, int, Cursor, Reference)}
-     * method but without its overhead because we're selecting only one best matching Entry from the {@link Trie}.
-     */

Review comment:
       > I think this one needs to stay?
   
   @kinow 
   I delete it because I can never found that function it point to.
   If you can show me where that function is : `selectR(TrieEntry, int, Object, int, Cursor, Reference)`, maybe I can fix the javadoc in a better way.




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] dota17 commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
dota17 commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433830911



##########
File path: src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
##########
@@ -279,7 +279,7 @@ protected void registerCursor(final Cursor<E> cursor) {
     }
 
     /**
-     * Deregisters a cursor from the list to be notified of changes.
+     * Deregister a cursor from the list to be notified of changes.

Review comment:
       garydgregory on 17 Apr Member
   If a method starts with "make...", it usually reads better to start the Javadoc with "Makes..." IMO, It's confusing to have the Javadoc be different, otherwise you could say that all method that start with "set..." also "forces" a value.




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] coveralls edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
coveralls edited a comment on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-637488425


   
   [![Coverage Status](https://coveralls.io/builds/32214840/badge)](https://coveralls.io/builds/32214840)
   
   Coverage remained the same at 90.122% when pulling **8f53f1c842ba33d27b6f00cbcc489542a54b082c on XenoAmess:refine_javadoc_and_fix_typos** into **fd462c155b0484a0ae918dcd1ebd44f351636ea8 on apache:master**.
   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433846044



##########
File path: src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
##########
@@ -29,7 +29,7 @@
  * all data at the edges of the {@link org.apache.commons.collections4.Trie}
  * (and having empty internal nodes), PATRICIA stores data in every node.
  * This allows for very efficient traversal, insert, delete, predecessor,
- * successor, prefix, range, and {@link #select(Object)}
+ * successor, prefix, range, and {@link #select(String)}

Review comment:
       @dota17 
   yes you are correct.
   It can pass on one of my machines with jdk8 so I thought it be correct.
   but actually according to travis-ci, it can only pass openjdk8 and oraclejdk8, but fails on other jdks.
   so I will revert it.
   Thank you!




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-637457648


   Several people suggested me not to put everything in one single pr, but split them.
   So I listened to their advice, and let things done one by one.


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433841232



##########
File path: src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
##########
@@ -279,7 +279,7 @@ protected void registerCursor(final Cursor<E> cursor) {
     }
 
     /**
-     * Deregisters a cursor from the list to be notified of changes.
+     * Deregister a cursor from the list to be notified of changes.

Review comment:
       @dota17 
   yes you are right.
   will revert it.
   ---
   btw, should I change it to `Unregister a cursor from the list to be notified of changes.`?
   because the function name used unregisterCursor, so I guess should we make it somehow compatibility?

##########
File path: src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
##########
@@ -279,7 +279,7 @@ protected void registerCursor(final Cursor<E> cursor) {
     }
 
     /**
-     * Deregisters a cursor from the list to be notified of changes.
+     * Deregister a cursor from the list to be notified of changes.

Review comment:
       @dota17 
   
   yes you are right.
   will revert it.
   `---`
   btw, should I change it to `Unregister a cursor from the list to be notified of changes.`?
   because the function name used unregisterCursor, so I guess should we make it somehow compatibility?




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] coveralls edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
coveralls edited a comment on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-637488425


   
   [![Coverage Status](https://coveralls.io/builds/31185352/badge)](https://coveralls.io/builds/31185352)
   
   Coverage remained the same at 90.123% when pulling **7f920b6b74c7e83f62230b8f372766f520f41ad4 on XenoAmess:refine_javadoc_and_fix_typos** into **6b4d75f725d9636b3ec6d5c24d410bece5e2fcc7 on apache:master**.
   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] kinow commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
kinow commented on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-680442438


   Merged. Thanks @XenoAmess !
   Bruno


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] wlfbck commented on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
wlfbck commented on pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#issuecomment-658205744


   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.


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess edited a comment on pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
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 time coster).


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] XenoAmess commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
XenoAmess commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433841232



##########
File path: src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
##########
@@ -279,7 +279,7 @@ protected void registerCursor(final Cursor<E> cursor) {
     }
 
     /**
-     * Deregisters a cursor from the list to be notified of changes.
+     * Deregister a cursor from the list to be notified of changes.

Review comment:
       yes you are right.
   will revert it.




----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [commons-collections] dota17 commented on a change in pull request #165: [COLLECTIONS-764] Refine javadoc and fix typos

Posted by GitBox <gi...@apache.org>.
dota17 commented on a change in pull request #165:
URL: https://github.com/apache/commons-collections/pull/165#discussion_r433834707



##########
File path: src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
##########
@@ -29,7 +29,7 @@
  * all data at the edges of the {@link org.apache.commons.collections4.Trie}
  * (and having empty internal nodes), PATRICIA stores data in every node.
  * This allows for very efficient traversal, insert, delete, predecessor,
- * successor, prefix, range, and {@link #select(Object)}
+ * successor, prefix, range, and {@link #select(String)}

Review comment:
       [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:javadoc (default-cli) on project commons-collections4: An error has occurred in Javadoc report generation: 
   [ERROR] Exit code: 1 - /home/travis/build/apache/commons-collections/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java:32: error: reference not found
   [ERROR]  * successor, prefix, range, and {@link #select(String)}
   
   Maybe it's not need to update.




----------------------------------------------------------------
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:
users@infra.apache.org