Code Review Request: 6328537: Improve javadocs for Socket class by adding references to SocketOptions

[Chris Hegarty]

On 11/05/2013 00:35, Kurchi Hazra wrote:
> This is a simple improvement in the javadocs of the Socket and ServerSocket
> classes, to cross-reference the SocketOptions class where appropriate.
> It looks
> like a lot of changes in the webrev, only because I have re-justified
> the text
> in some cases.
>
> Bug: http://bugs.sun.com/view_bug.do?bug_id=6328537
> Webrev:http://cr.openjdk.java.net/~khazra/6328537/webrev.00/

This will make navigating from these API's to the specification for 
their respective options much easier. A simple change, but very user 
friendly.

> The specdiff isn't very helpful, but here it is:
> http://cr.openjdk.java.net/~khazra/6328537/specdiff.00/

Not at all. It gives confidence that nothing untoward has accidentally 
changed. Especially, as you say, when there is significant realignment 
of the method descriptions.

As Alan pointed out, at some point we need to sort out the relationship 
to StandardSocketOptions, but what you have is fine for now.

Thanks,
-Chris.

>
> Thanks,
> - Kurchi