Review Request : 7198272 - RFE : Javadoc Accessibility : Generate WAI-ARIA compliant HTML

[Jonathan Gibbons]

On 11/14/2012 10:05 PM, jayashree viswanathan wrote:
> On 06-11-2012 3:48 AM, Jonathan Gibbons wrote:
>> On 11/05/2012 12:25 PM, Jonathan Gibbons wrote:
>>> On 11/05/2012 08:06 AM, jayashree viswanathan wrote:
>>>> Hi Jon ,
>>>>
>>>> Can you please review the changeset for the bug 7198272 ?
>>>>
>>>> The Changeset and example page are available in the below link .
>>>>
>>>> http://cr.openjdk.java.net/~jviswana/7198272/
>>>>
>>>> Thanks a lot !
>>>>
>>>> Regards,
>>>> Jayashree V
>>>>
>>>
>>>
>>> Jayashree,
>>>
>>> My initial reaction is that there are no tests for such a lot of 
>>> lines being changed.
>>>
>>> I know you don't have access (yet) to the OpenJDK bug system, but 
>>> the general rules for fixing bugs still apply [1], especially 
>>> section 6, "Is it possible to write a test to detect the bug?"
>>>
>>> Note that we are beginning to use code coverage tools to detect that 
>>> lines modified in a changeset are executed by the corresponding tests.
>>>
>>> -- Jon
>>>
>>> [1] http://openjdk.java.net/guide/changePlanning.html#bug
>>>
>>>
>>
>> Jayashree,
>>
>> One additional question ... while tests in the repo can be used to 
>> verify your specific changes, what tools are available for ensuring 
>> that, as a whole, javadoc output is WAI-ARIA compliant? In other 
>> words, if some other developer changes the content of docs generated 
>> by javadoc, how do we make sure that the output remains compliant?
>>
>> -- Jon
>>
> Hi Jon,
>
> Thanks a lot for all your quick responses , and sorry for the delay in 
> getting back to you.
>
> We have Explored various tools including Juicy studio[Mozilla firefox 
> plugin] , and had discussions with Oracle and IBM test community to 
> find a Open Source tool ,adopted for the purpose though could not find 
> one .
>
> I have thus added some JTREG scenarios , and I can happily add more to 
> make it better if the need be .
>
> On the question , if some other developer changes the content of the 
> docs generated by javadoc , I agree that JTREG may not come to picture 
> there ,though this can be achieved  by running  the web accessibility 
> tools may/may not be open source available , on the final web-page 
> ready to be published by specific users/developers/team/product .
>
> Also I appreciate the Experimental tool you have come up with which 
> will be very useful for helping developers to find non-Tool [javadoc] 
> issues , which includes issues in comment .
>
>
> Thanks and Regards,
> Jayashree Viswanathan
>

Hi Jayashree,

In the past, we have used a tool known internally as "htmlcheck" which 
is a wrapper around the publicly available (but now very old) "nsgmls" 
which can check documents against a DTD, and which can run in batch 
mode.  I'll get in touch with folk in the Oracle test community to get 
their input on this.  Obviously, I am very keen that we should be able 
to validate javadoc output to whatever standard is required of us.

-- Jon