Code Review Request, JDK-8184316, Typo in javax.net.ssl.SSLServerSocket class documentation
Sean Mullan
sean.mullan at oracle.com
Tue Jul 25 17:14:30 UTC 2017
On 7/25/17 12:26 PM, Xuelei Fan wrote:
> Good catch! More update:
>
> javax/net/ssl/SSLServerSocket.java
> ----------------------------------
> /**
> - * This class extends <code>ServerSocket</code>s and
> + * This class extends <code>ServerSocket</code> and
> * provides secure server sockets using protocols such as the Secure
> * Sockets Layer (SSL) or Transport Layer Security (TLS) protocols.
> * <P>
> * Instances of this class are generally created using a
> * <code>SSLServerSocketFactory</code>. The primary function
> - * of <code>SSLServerSocket</code>s
> + * of <code>SSLServerSocket</code>
> * is to create <code>SSLSocket</code>s by <code>accept</code>ing
> * connections.
> * <P>
> - * <code>SSLServerSocket</code>s contain several pieces of state data
> + * <code>SSLServerSocket</code> contains several pieces of state data
I think this sentence sounds better if it starts with "An
SSLServerSocket ...". Same comment below ...
> * which are inherited by the <code>SSLSocket</code> at
> * socket creation. These include the enabled cipher
> * suites and protocols, whether client
>
>
> javax/net/ssl/SSLSocket.java
> ----------------------------
> /**
> - * This class extends <code>Socket</code>s and provides secure
> - * socket using protocols such as the "Secure
> + * This class extends <code>Socket</code> and provides secure
> + * sockets using protocols such as the "Secure
> * Sockets Layer" (SSL) or IETF "Transport Layer Security" (TLS)
> protocols.
> * <P>
> * Such sockets are normal stream sockets, but they
> @@ -105,7 +105,7 @@
> * non-private (unencrypted) communications will such a ciphersuite be
> * selected.
> *
> - * <P>When <code>SSLSocket</code>s are first created, no handshaking
> + * <P>When <code>SSLSocket</code> is first created, no handshaking
> * is done so that applications may first set their communication
> * preferences: what cipher suites to use, whether the socket should be
> * in client or server mode, etc.
> @@ -118,7 +118,7 @@
> * objects are passed to <em>HandshakeCompletedListener</em> instances,
> * which are registered by users of this API.
> *
> - * <code>SSLSocket</code>s are created by <code>SSLSocketFactory</code>s,
> + * <code>SSLSocket</code> is created by <code>SSLSocketFactory</code>,
"An SSLSocket ..."
--Sean
More information about the security-dev
mailing list