RFR [9] 8081517: minor cleanup for docs
Roger Riggs
Roger.Riggs at Oracle.com
Fri Jun 5 14:08:39 UTC 2015
Hi Alexander,
On code examples, please use the template:
<pre>{@code
}</pre>
(not just <pre>... </pre>)
See TraceClassVisitor.java: 92+
and FtpURLConnection.java:68
I would use @code instead of @literal in HttpAuthenticator.java:59; it
will make the protocol stand out.
Also in PlatformLogger.java:74+
2)
If indentation is in the scope of your cleanup...
In JdbcRowSetImpl.java, the indentation of continued lines after @return
or @param tags
isn't correct; the continued line should be indented.
And there are a some very long lines that should be wrapped;
See +5637... "If the SQL AS clause was not..."
+5784 the indentation needs to be fixed.
+5840 also
+5988
+6265 and after...
in many cases the lines that follow of "/*" do not align the "* ".
CachedRowSetWriter.java:
- many method comment blocks are not aligned properly with the method of
field that follows.
For example,
/**
* The <code>Connection</code> object that this writer will use to make a
* connection to the data source to which it will write data.
*
*/
private transient Connection con;
3)
CachedRowSetWriter.java:
+1056: The tag "@ param" should be tighted up to "@param"
Thanks, Roger
On 6/5/2015 8:51 AM, alexander stepanov wrote:
> Hello,
>
> Could you please review the fix
> http://cr.openjdk.java.net/~avstepan/8081517/webrev.00/
> for
> https://bugs.openjdk.java.net/browse/JDK-8081517
>
> Just some cleanup for docs.
>
> Thanks,
> Alexander
More information about the core-libs-dev
mailing list