This is an automated email from the ASF dual-hosted git repository. rzo1 pushed a commit to branch javdoc-fixes in repository https://gitbox.apache.org/repos/asf/storm.git
commit 4d34aee7457290903e04b46c7a1b5679ab48a18b Author: Richard Zowalla <[email protected]> AuthorDate: Fri Aug 25 09:44:14 2023 +0200 STORM-3934 - Fix errors/warnings found while generating javadoc in storm-webapps (documents impl details) --- .../storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java | 5 ++--- .../storm/daemon/logviewer/handler/LogviewerProfileHandler.java | 1 - .../storm/daemon/logviewer/utils/LogviewerResponseBuilder.java | 1 - .../java/org/apache/storm/daemon/utils/ListFunctionalSupport.java | 1 - .../src/main/java/org/apache/storm/daemon/utils/StreamUtil.java | 1 - 5 files changed, 2 insertions(+), 7 deletions(-) diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java index f65b16cd0..0aae783d1 100644 --- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java +++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java @@ -47,13 +47,13 @@ public class LogviewerLogDownloadHandler { } /** - * Download an worker log. + * Download a worker log. * * @param host host address * @param fileName file to download * @param user username * @return a Response which lets browsers download that file. - * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)} + * */ public Response downloadLogFile(String host, String fileName, String user) throws IOException { workerLogs.setLogFilePermission(fileName); @@ -67,7 +67,6 @@ public class LogviewerLogDownloadHandler { * @param fileName file to download * @param user username * @return a Response which lets browsers download that file. - * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)} */ public Response downloadDaemonLogFile(String host, String fileName, String user) throws IOException { return logFileDownloadHelper.downloadFile(host, fileName, user, true); diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java index c68ab3c81..f4bc03a1d 100644 --- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java +++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java @@ -107,7 +107,6 @@ public class LogviewerProfileHandler { * @param fileName dump file name * @param user username * @return a Response which lets browsers download that file. - * @see {@link org.apache.storm.daemon.logviewer.utils.LogFileDownloader#downloadFile(String, String, String, boolean)} */ public Response downloadDumpFile(String topologyId, String hostPort, String fileName, String user) throws IOException { String[] hostPortSplit = hostPort.split(":"); diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java index a44c82566..9d7a85c1b 100644 --- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java +++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java @@ -65,7 +65,6 @@ public class LogviewerResponseBuilder { * @param entity entity object to represent it as JSON * @param callback callbackParameterName for JSONP * @param origin origin - * @see {@link JsonResponseBuilder} */ public static Response buildSuccessJsonResponse(Object entity, String callback, String origin) { return new JsonResponseBuilder().setData(entity).setCallback(callback) diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java index 700fbb700..ed6622bb9 100644 --- a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java +++ b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/ListFunctionalSupport.java @@ -97,7 +97,6 @@ public class ListFunctionalSupport { /** * Drop the only first element and create a new list. equivalent to drop(list, 1). * - * @see {@link ListFunctionalSupport#drop(List, int)} * @param list the list * @return newly created sublist that drops the first element from origin list. null if list is null. */ diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java index 8e8b5d099..adfd075c6 100644 --- a/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java +++ b/storm-webapp/src/main/java/org/apache/storm/daemon/utils/StreamUtil.java @@ -33,7 +33,6 @@ public class StreamUtil { * <p/> * FileInputStream#skip may not work the first time, so ensure it successfully skips the given number of bytes. * - * @see {@link java.io.FileInputStream#skip(long)} * @param stream the stream to skip * @param n bytes to skip */
