[tomcat] branch master updated: Fix Javadoc errors

2021-03-15 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/master by this push:
 new ea3c2b5  Fix Javadoc errors
ea3c2b5 is described below

commit ea3c2b57e6c8ae5bbdaee2ea0f77d965653e654f
Author: Mark Thomas 
AuthorDate: Mon Mar 15 19:46:10 2021 +

Fix Javadoc errors
---
 java/org/apache/coyote/http2/Http2Parser.java | 8 +---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/java/org/apache/coyote/http2/Http2Parser.java 
b/java/org/apache/coyote/http2/Http2Parser.java
index 0895668..bf0565d 100644
--- a/java/org/apache/coyote/http2/Http2Parser.java
+++ b/java/org/apache/coyote/http2/Http2Parser.java
@@ -759,8 +759,9 @@ class Http2Parser {
  * @param swallowedDataBytesCount   The number of bytes that the parser
  *  swallowed.
  *
- * @throws ConnectionException
- * @throws IOException
+ * @throws ConnectionException If an error fatal to the HTTP/2
+ * connection occurs while swallowing the payload
+ * @throws IOException If an I/O occurred while swallowing the payload
  */
 void onSwallowedDataFramePayload(int streamId, int 
swallowedDataBytesCount) throws ConnectionException, IOException;
 
@@ -801,7 +802,8 @@ class Http2Parser {
  *  frame
  * @param size  The payload size of the swallowed frame
  *
- * @throws IOException
+ * @throws IOException If an I/O occurred while swallowing the unknown
+ * frame
  */
 void onSwallowedUnknownFrame(int streamId, int frameTypeId, int flags, 
int size) throws IOException;
 }


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org



[tomcat] branch master updated: Fix Javadoc errors

2020-12-04 Thread markt
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/master by this push:
 new 0fbab05  Fix Javadoc errors
0fbab05 is described below

commit 0fbab050ce47157e22c9f1eae776c12c1adad346
Author: Mark Thomas 
AuthorDate: Fri Dec 4 09:05:56 2020 +

Fix Javadoc errors
---
 java/org/apache/tomcat/util/net/SSLSupport.java   | 7 ---
 java/org/apache/tomcat/util/net/jsse/JSSESupport.java | 2 +-
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/java/org/apache/tomcat/util/net/SSLSupport.java 
b/java/org/apache/tomcat/util/net/SSLSupport.java
index 2a69b8c..bf80f94 100644
--- a/java/org/apache/tomcat/util/net/SSLSupport.java
+++ b/java/org/apache/tomcat/util/net/SSLSupport.java
@@ -151,7 +151,8 @@ public interface SSLSupport {
  *
  * @return the list of SSL/TLS protocol versions requested by the client
  *
- * @throws IOException
+ * @throws IOException If an error occurs trying to obtain the client
+ *   requested protocol information from the socket
  */
 public String getRequestedProtocols() throws IOException;
 
@@ -159,8 +160,8 @@ public interface SSLSupport {
 *
 * @return the list of SSL/TLS ciphers requested by the client
 *
-* @throws IOException
+ * @throws IOException If an error occurs trying to obtain the client
+ *   request cipher information from the socket
 */
public String getRequestedCiphers() throws IOException;
 }
-
diff --git a/java/org/apache/tomcat/util/net/jsse/JSSESupport.java 
b/java/org/apache/tomcat/util/net/jsse/JSSESupport.java
index fdce0c2..10e9417 100644
--- a/java/org/apache/tomcat/util/net/jsse/JSSESupport.java
+++ b/java/org/apache/tomcat/util/net/jsse/JSSESupport.java
@@ -78,7 +78,7 @@ public class JSSESupport implements SSLSupport, 
SSLSessionManager {
 private Map> additionalAttributes;
 
 /**
- * @param session
+ * @param session SSLSession from which information is to be extracted
  *
  * @deprecated This will be removed in Tomcat 10.1.x onwards
  * Use {@link JSSESupport#JSSESupport(SSLSession, Map)}


-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org