[ZOOKEEPER-3789] fix the build warnings about @see,@link,@return found by IDEA

• Type: Improvement
• Status: In Progress
• Priority: Minor
• Resolution: Unresolved
• Component/s: server
• Labels: pull-request-available
• Assignee: Ling Mao
• Reporter: Ling Mao
• Created: 09/Apr/20 02:36
• Updated: 17/Mar/23 12:41

Description

1. I use my IDEA to find these maven build warnings:

/Library/Java/JavaVirtualMachines/jdk1.8.0_191.jdk/Contents/Home/bin/java -Dmaven.multiModuleProjectDirectory=/Users/maoling/workspaces/workspace_zookeeper/zookeeper "-Dmaven.home=/Applications/IntelliJ IDEA.app/Contents/plugins/maven/lib/maven3" "-Dclassworlds.conf=/Applications/IntelliJ IDEA.app/Contents/plugins/maven/lib/maven3/bin/m2.conf" "-Dmaven.ext.class.path=/Applications/IntelliJ IDEA.app/Contents/plugins/maven/lib/maven-event-listener.jar" "-javaagent:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=58545:/Applications/IntelliJ IDEA.app/Contents/bin" -Dfile.encoding=UTF-8 -classpath "/Applications/IntelliJ IDEA.app/Contents/plugins/maven/lib/maven3/boot/plexus-classworlds-2.6.0.jar" org.codehaus.classworlds.Launcher -Didea.version2019.3.1 -DskipTests=true package -P !java-build

Javadoc Warnings
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:340: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getEphemerals(EphemeralsCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:340: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getEphemerals(String, EphemeralsCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:271: ?? - ??@link: ?org.apache.zookeeper.ZooKeeper????sync(String, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:150: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getACL(String, Stat, ACLCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:89: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getAllChildrenNumber(String, AllChildrenNumberCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:202: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getChildren(String, boolean, Children2Callback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:202: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getChildren(String, Watcher, Children2Callback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:179: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getChildren(String, boolean, ChildrenCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:179: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getChildren(String, Watcher, ChildrenCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:227: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????create(String, byte[], List, CreateMode, Create2Callback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:227: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????create(String, byte[], List, CreateMode, Create2Callback, Object, long)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:121: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getData(String, boolean, DataCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:121: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getData(String, Watcher, DataCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:121: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getConfig(boolean, DataCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:121: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????getConfig(Watcher, DataCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:328: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????multi(Iterable, MultiCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:70: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????exists(String, boolean, StatCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:70: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????exists(String, Watcher, StatCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:70: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????setData(String, byte[], int, StatCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:70: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????setACL(String, List, int, StatCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:262: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????create(String, byte[], List, CreateMode, StringCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:299: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????delete(String, int, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:299: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????removeAllWatches(String, Watcher.WatcherType, boolean, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:299: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????removeWatches(String, Watcher, Watcher.WatcherType, boolean, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:299: ?? - ??@see: ?org.apache.zookeeper.ZooKeeper????sync(String, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/AsyncCallback.java:299: ?? - ??@link: ?org.apache.zookeeper.ZooKeeper????delete(String, int, VoidCallback, Object)
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/ZKDatabase.java:513: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/util/CircularBuffer.java:70: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/persistence/FileTxnLog.java:318: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/persistence/FileTxnSnapLog.java:571: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/persistence/SnapStream.java:215: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/persistence/Util.java:264: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/persistence/Util.java:274: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/Learner.java:94: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/Leader.java:1201: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/LearnerMaster.java:131: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/Leader.java:265: ?? - @param argument "qv," ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/Leader.java:977: ?? - @param argument "zxid," ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/Leader.java:977: ?? - @param argument "sid," ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/LearnerHandler.java:1142: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/QuorumPeer.java:1949: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/cli/AclParser.java:37: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/cli/CliCommand.java:77: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/cli/CliCommand.java:85: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/cli/CliCommand.java:93: ?? - @return ???????
/Users/maoling/workspaces//zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/cli/CliCommand.java:118: ?? - @return ???????

Issue Links

• is related to: ZOOKEEPER-3767 fix a large amount of maven build warnings
• links to: GitHub Pull Request #1317