Code Review Request: 8025763
Mike Duigou
mike.duigou at oracle.com
Mon Dec 2 18:25:15 UTC 2013
The missing @since for overridden methods and missing @throws for unchecked exceptions is a known javadoc behaviour. Apparently there's some disagreement as to whether it is a bug but I encourage you to add the tags.
Mike
On Nov 27 2013, at 12:55 , Bradford Wetmore <Bradford.Wetmore at Oracle.COM> wrote:
> Sean wrote:
>
> > That kind of seems like a javadoc bug to me. Shouldn't it add the
> > @since tag as part of inheriting the javadoc?
>
> On the chance that this is a real bug, I filed this yesterday:
>
> https://bugs.openjdk.java.net/browse/JDK-8029241
>
> @throws/@since are both missing (others?), it seems more efficient from a developer perspective to simply copy this info to the overridden classes, instead of making the developer drill down to get the rest of the information.
>
> Tony wrote:
>
> > Let me see if setting @since doesn't cause the inheritance of the
> > other tag to stop. If it doesn't I'll fix it for 8.
>
> I'm guessing that if you add anything, it's going to suppress the inherited javadoc, so you'll have to wait for JDK-8029241 to be fixed.
>
> But for the case of new stuff where you've provided new text, I feel it should have an @since added.
>
> And feel free to clean up the > 80 char lines! ;)
>
> Brad
>
>
>
> On 11/27/2013 12:46 PM, Anthony Scarpino wrote:
>>
>>> On Nov 27, 2013, at 10:12 AM, Sean Mullan <sean.mullan at oracle.com> wrote:
>>>
>>>> On 11/26/2013 08:20 PM, Bradford Wetmore wrote:
>>>> Tony,
>>>>
>>>> I note the @since's are missing for the new methods, both in the
>>>> generated output in the overridden methods (i.e. no javadoc), and the
>>>> methods in which you've changed the behavior (i.e. new javadoc).
>>>>
>>>> I'm not sure what you can do about the previous behavior (cc'ing
>>>> Mike/Sowmya, maybe they know), but what about the new ones?
>>>
>>> That kind of seems like a javadoc bug to me. Shouldn't it add the @since tag as part of inheriting the javadoc?
>>>
>>> Anyway, adding @since tags would be considered a docs only change, so Tony you could still fix this for JDK 8 - can you file a bug?
>>>
>>> Thanks,
>>> Sean
>>
>> My first thought was it would be a javadoc issue too.
>>
>> Let me see if setting @since doesn't cause the inheritance of the other tag to stop. If it doesn't I'll fix it for 8.
>>
>> Tony
>>
>>>
>>>>
>>>> Brad
>>>>
>>>>
>>>>
>>>>> On 10/21/2013 2:48 PM, Sean Mullan wrote:
>>>>>> On 10/18/2013 10:52 PM, Anthony Scarpino wrote:
>>>>>> I've updated the webrev
>>>>>>
>>>>>> http://cr.openjdk.java.net/~ascarpino/8025763/webrev.01/
>>>>>
>>>>> Update looks good.
>>>>>
>>>>> --Sean
>>>
More information about the security-dev
mailing list