jmx-dev RFR Doclint cleanup of javax.management

roger riggs roger.riggs at oracle.com
Tue Nov 12 06:52:41 PST 2013


Hi Jaroslav,

Thanks for the review and comments.

I derived the changes from the warning messages from -Xdoclint.

For both <p> and <li> the closing tag is optional  in HTML 4.01 
Transitional generated by javadoc.
The convention in the core libraries seems to be to omit them,
reducing the amount of [unnecessary] markup in the source.

Did you use a tool to flag these?  Which?

The webrev is updated with the corrections below.
Please me know if you agree or not.

Webrev:
http://cr.openjdk.java.net/~rriggs/webrev-lint-mgmt-8028014/


On 11/12/2013 4:48 AM, Jaroslav Bachorik wrote:
> Hi Roger,
>
> The following comments are based on the presumption that the contained 
> HTML should be well-formed.
>
> src/share/classes/javax/management/MBeanFeatureInfo.java
> L183, L231 - missing </p>
For these the natural </p> would be at L169, L215; but can be/are omitted.
>
> src/share/classes/javax/management/MBeanInfo.java
> L640, L686 - missing </p>
>
> src/share/classes/javax/management/MBeanServerConnection.java
> L630 - missing </p>
>
> src/share/classes/javax/management/MBeanServerNotification.java
> L89 - missing </p>
>
> src/share/classes/javax/management/MXBean.java
> L788 - missing </p>
>
> src/share/classes/javax/management/ObjectName.java
> L198 - missing </p>
> L204 - missing </p>
> L1552 - missing </p>
>
> src/share/classes/javax/management/PersistentMBean.java
> L78 - missing </p><p>
> L79 - there should be <pre> after this line
> L83 - should be * }</PRE></p>
Corrected to restore the structure.
>
> src/share/classes/javax/management/loading/MLet.java
> L154 - extraneous </dd>
(These lines had improper nesting in the original).
L154 </dd> matches L151 <dd>
L158 </dd> matches L144 <dd>
>
> src/share/classes/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.java 
>
> L130 - missing </p>
>
> src/share/classes/javax/management/openmbean/CompositeDataInvocationHandler.java 
>
> L83 - missing </p>
>
> src/share/classes/javax/management/openmbean/OpenMBeanParameterInfoSupport.java 
>
> L123 - missing </p>
>
> src/share/classes/javax/management/remote/JMXConnector.java
> L79 - missing </p>
>
> src/share/classes/javax/management/remote/rmi/RMIConnector.java
> L1697 - missing </li> after this line
> L1701 - missing </li> after this line
Added to be consistent with file local conventions.

Thanks, Roger

>
> -JB-
>
> On 11.11.2013 23:20, roger riggs wrote:
>> Please review and comment.
>>
>> This changeset addresses the warnings and errors of doclint and
>> improves the quality of the generated html.
>> No spec or implementation is changed by this changeset
>>
>> The changes address issues including html syntax, accessibility issues,
>> and html tag improper use and list structure.
>> Refer to the error log attached to the bug report [1] for details.
>>
>> Please review:
>>     http://cr.openjdk.java.net/~rriggs/webrev-lint-mgmt-8028014/
>>
>> Thanks, Roger
>>
>> [1] https://bugs.openjdk.java.net/browse/JDK-8028014
>>
>



More information about the jmx-dev mailing list