From 685b799c3772be7013612cd07da619c3c7142cf9 Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Fri, 30 Apr 2010 16:27:12 +0000 Subject: [PATCH] 309185 - Fix the over 300 Javadoc warnings git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1634 7e9141cc-0065-0410-87d8-b60c137991c4 --- .../java/org/eclipse/jetty/test/MavenTestingUtils.java | 4 ++-- .../org/eclipse/jetty/test/support/StringUtil.java | 2 +- .../jetty/test/support/rawhttp/HttpRequestTester.java | 2 +- .../jetty/test/support/rawhttp/HttpResponseTester.java | 6 +++--- .../jetty/test/support/rawhttp/HttpTesting.java | 10 ++++++---- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/tests/test-integration/src/test/java/org/eclipse/jetty/test/MavenTestingUtils.java b/tests/test-integration/src/test/java/org/eclipse/jetty/test/MavenTestingUtils.java index 4a622f6aba0..3c362560250 100644 --- a/tests/test-integration/src/test/java/org/eclipse/jetty/test/MavenTestingUtils.java +++ b/tests/test-integration/src/test/java/org/eclipse/jetty/test/MavenTestingUtils.java @@ -93,7 +93,7 @@ public class MavenTestingUtils * * @param test * the junit 3.x testcase to base this new directory on. - * @return + * @return the dir in /target/ that uses the JUnit 3.x {@link TestCase#getName()} to make itself unique. */ public static File getTargetTestingDir(TestCase test) { @@ -105,7 +105,7 @@ public class MavenTestingUtils * * @param testname * the testname to create directory against. - * @return + * @return the dir in /target/ that uses the an arbitrary name. */ public static File getTargetTestingDir(String testname) { diff --git a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/StringUtil.java b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/StringUtil.java index bc520d15d7a..3d845bec6d9 100644 --- a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/StringUtil.java +++ b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/StringUtil.java @@ -118,7 +118,7 @@ public class StringUtil * * @param str * input string. - * @return + * @return the same string, with any LF or CR returned as system default. */ public static String toSystemLN(String str) { diff --git a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpRequestTester.java b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpRequestTester.java index 4361533bb16..34293bf70fd 100644 --- a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpRequestTester.java +++ b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpRequestTester.java @@ -173,7 +173,7 @@ public class HttpRequestTester /** * @param cookie - * @see org.eclipse.jetty.http.HttpFields#addSetCookie(javax.servlet.http.Cookie) + * @see org.eclipse.jetty.http.HttpFields#addSetCookie(org.eclipse.jetty.http.HttpCookie) */ public void addSetCookie(Cookie cookie) { diff --git a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpResponseTester.java b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpResponseTester.java index 07deaf00287..3eaa47039ff 100644 --- a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpResponseTester.java +++ b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpResponseTester.java @@ -226,7 +226,7 @@ public class HttpResponseTester /** * @param name - * @return + * @return the header value as a date * @see org.eclipse.jetty.http.HttpFields#getDateField(java.lang.String) */ public long getDateHeader(String name) @@ -236,7 +236,7 @@ public class HttpResponseTester /** * @param name - * @return + * @return the header value as a long * @throws NumberFormatException * @see org.eclipse.jetty.http.HttpFields#getLongField(java.lang.String) */ @@ -247,7 +247,7 @@ public class HttpResponseTester /** * @param name - * @return + * @return the header value * @see org.eclipse.jetty.http.HttpFields#getStringField(java.lang.String) */ public String getHeader(String name) diff --git a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpTesting.java b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpTesting.java index 27d58e426b0..312d9369cc1 100644 --- a/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpTesting.java +++ b/tests/test-integration/src/test/java/org/eclipse/jetty/test/support/rawhttp/HttpTesting.java @@ -144,7 +144,7 @@ public class HttpTesting * Read the raw response from the socket. * * @param sock - * @return + * @return all of the the data from the socket as a String * @throws IOException */ public String readRaw(Socket sock) throws IOException @@ -157,10 +157,12 @@ public class HttpTesting } /** - * Read the raw response from the socket, reading whatever is available. Any SocketTimeoutException is consumed and just stops the reading. + * Read the raw response from the socket, reading whatever is available. + * Any {@link SocketTimeoutException} is consumed and just stops the reading. * * @param sock - * @return + * @return the raw data from the socket in string form, reading whatever is available. + * a {@link SocketTimeoutException} will result in the read stopping. * @throws IOException */ public String readRawAvailable(Socket sock) throws IOException @@ -190,7 +192,7 @@ public class HttpTesting * * Note: not for HTTPS requests. * - * @param request + * @param rawRequest * the request * @return the response * @throws IOException