RFR: JDK-8028712 : Tidy warnings cleanup for java.sql package
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712 This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation. Best regards, Serge V. Lugovoy
Hi Serge, A fine point but in java/sql/package.html; the self closing tag "<br/>" is not supported in HTML 3.2 (defined in the DOCTYPE)). Simply <br> is sufficient. The rest looks fine to me. (Not a Reviewer) Roger On 12/5/2013 12:25 PM, Serge wrote:
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712
This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation.
Best regards, Serge V. Lugovoy
On 05/12/2013 17:25, Serge wrote:
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712
This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation. The removal of the <p> tags seems okay. The only thing that I'm not sure about the addition of <br/> to the package docs (is that needed?).
Lance - while scanning this patch then it appears that some of the formatting in the javadoc comments is all over the place (java.sql.Connection is one example). It might be good to clean that up once the jdk9 project is open for business. -Alan
Hi Serge This looks OK. For --- old/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.587885460 +0000 +++ new/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.435885464 +0000 Please remove the following -------------------- Package Specification • Specification of the JDBC 4.0 API Related Documentation • Getting Started--overviews of the major interfaces • Chapters on the JDBC API--from the online version of The Java Tutorial Continued • JDBCTMAPI Tutorial and Reference, Third Edition-- a complete reference and tutorial for the JDBC 3.0 API ---------------- The above links keep breaking now that we are off of java.sun.com And I agree with roger, please use <br> Alan, yes I can look to clean up some of the formatting crud for Java SE 9 once we have access to the workspace Thank you for doing this Serge. Best Lance On Dec 5, 2013, at 10:31 AM, Alan Bateman wrote:
On 05/12/2013 17:25, Serge wrote:
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712
This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation. The removal of the <p> tags seems okay. The only thing that I'm not sure about the addition of <br/> to the package docs (is that needed?).
Lance - while scanning this patch then it appears that some of the formatting in the javadoc comments is all over the place (java.sql.Connection is one example). It might be good to clean that up once the jdk9 project is open for business.
-Alan
Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037 Oracle Java Engineering 1 Network Drive Burlington, MA 01803 Lance.Andersen@oracle.com
Hi all. Please review a second fix http://cr.openjdk.java.net/~yan/8028712/webrev.03/ for https://bugs.openjdk.java.net/browse/JDK-8028712 I deleted part of java/sql/package.html, and replaced "br/" to "br" for compliance with html 3.2 On 12/05/2013 10:39 PM, Lance Andersen - Oracle wrote:
Hi Serge
This looks OK.
For
--- old/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.587885460 +0000 +++ new/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.435885464 +0000
Please remove the following
-------------------- Package Specification
. Specification of the JDBC 4.0 API Related Documentation
. Getting Started--overviews of the major interfaces . Chapters on the JDBC API--from the online version of The Java Tutorial Continued . JDBCTMAPI Tutorial and Reference, Third Edition-- a complete reference and tutorial for the JDBC 3.0 API
----------------
The above links keep breaking now that we are off of java.sun.com
And I agree with roger, please use <br>
Alan, yes I can look to clean up some of the formatting crud for Java SE 9 once we have access to the workspace
Thank you for doing this Serge.
Best Lance On Dec 5, 2013, at 10:31 AM, Alan Bateman wrote:
On 05/12/2013 17:25, Serge wrote:
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712
This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation. The removal of the <p> tags seems okay. The only thing that I'm not sure about the addition of <br/> to the package docs (is that needed?).
Lance - while scanning this patch then it appears that some of the formatting in the javadoc comments is all over the place (java.sql.Connection is one example). It might be good to clean that up once the jdk9 project is open for business.
-Alan
Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037 Oracle Java Engineering 1 Network Drive Burlington, MA 01803 Lance.Andersen@oracle.com
Hi Serge, On Dec 20, 2013, at 9:16 AM, Serge wrote:
Hi all.
Please review a second fix http://cr.openjdk.java.net/~yan/8028712/webrev.03/
for https://bugs.openjdk.java.net/browse/JDK-8028712
I deleted part of java/sql/package.html,
I did not see the section below deleted, perhaps the change did not get pushed to where you generated the webrev from?
and replaced "br/" to "br" for compliance with html 3.2
On 12/05/2013 10:39 PM, Lance Andersen - Oracle wrote:
Hi Serge
This looks OK.
For
--- old/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.587885460 +0000 +++ new/src/share/classes/java/sql/package.html 2013-12-05 15:08:50.435885464 +0000
Please remove the following
-------------------- Package Specification
. Specification of the JDBC 4.0 API Related Documentation
. Getting Started--overviews of the major interfaces . Chapters on the JDBC API--from the online version of The Java Tutorial Continued . JDBCTMAPI Tutorial and Reference, Third Edition-- a complete reference and tutorial for the JDBC 3.0 API
----------------
The above links keep breaking now that we are off of java.sun.com
And I agree with roger, please use <br>
Alan, yes I can look to clean up some of the formatting crud for Java SE 9 once we have access to the workspace
Thank you for doing this Serge.
Best Lance On Dec 5, 2013, at 10:31 AM, Alan Bateman wrote:
On 05/12/2013 17:25, Serge wrote:
Hi all, please review the fix http://cr.openjdk.java.net/~yan/8028712/webrev.02/ <http://cr.openjdk.java.net/%7Eyan/8028712/webrev.02/> for https://bugs.openjdk.java.net/browse/JDK-8028712
This patch cleanup tidy warnings for generated html documentation, and do not affect the appearance of the documentation. The removal of the <p> tags seems okay. The only thing that I'm not sure about the addition of <br/> to the package docs (is that needed?).
Lance - while scanning this patch then it appears that some of the formatting in the javadoc comments is all over the place (java.sql.Connection is one example). It might be good to clean that up once the jdk9 project is open for business.
-Alan
Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037 Oracle Java Engineering 1 Network Drive Burlington, MA 01803 Lance.Andersen@oracle.com
Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037 Oracle Java Engineering 1 Network Drive Burlington, MA 01803 Lance.Andersen@oracle.com
participants (4)
-
Alan Bateman
-
Lance Andersen - Oracle
-
roger riggs
-
Serge