<Swing Dev> RFR: 8046485: Add missing @since tag under javax.swing.*

[Henry Jen]

+1, for any new code, we should definitely do that. It would be nice to 
add them for existing classes, I can slightly modify the tool and clean 
it up in a separate round, which I prefer we do.

Cheers,
Henry

On 06/18/2014 05:31 PM, Joe Darcy wrote:
> FWIW, if I were reviewing code in a new package, I would want to see
> @since tags in all top-level types in the new package and not just on
> the package-info.java/package.html file.
>
> Cheers,
>
> -Joe
>
> On 06/18/2014 02:42 PM, Phil Race wrote:
>> So for the specific case of the nimbus class I can see that the entire
>> package was new in 1.7 so the individual classes added at that time
>> do not need an @since tag.
>>
>> But my main question was whether you have inspected all
>> classes in all swing packages and none were fouhd in need of an
>> update .. I suppose its likely that after 1.2 people were more
>> diligent in adding these tags.
>>
>> Assuming the answer is yes, then I'm OK. If no, then I'm OK
>> too although at least then we'd know you still had to do those
>> packages ..
>>
>> -phil.
>>
>> On 6/18/2014 11:11 AM, Henry Jen wrote:
>>>
>>>
>>> On 06/18/2014 10:44 AM, Phil Race wrote:
>>>> Hello,
>>>>
>>>> You say "under" javax.swing but you don't seem to be touching
>>>> any sub-packages.
>>>
>>> No, sub-packages has @since in correponding package.html. I use * to
>>> mean entitiy in this package, and ** to signal subpackage as well.
>>>
>>> If it helps, I can remove .* from the subject.
>>>
>>>> I notice there is at least one @since 1.7 you
>>>> added to the Painter interface - so they aren't all 1.2 - and yet
>>>> you didn't add the @since 1.7 to the sole class that implements
>>>> Painter - perhaps because its in a sub-package.
>>>>
>>>
>>> It's used in javax.swing.plaf.nimbus, which has @since 1.7.
>>>
>>>> Also note that whilst @since 1.2 is strictly correct in terms of
>>>> Java SE
>>>> but Swing was initially an unbundled library - somewhat analagous
>>>> to Java FX 2.x, and ran on JDK 1.1.x
>>>>
>>>
>>> Understood. We are focus to make sure @since has the first version
>>> since the inclusion in J2SE. Other version information, as Mark
>>> suggested, can be expressed after comma. In case Java FX is included
>>> in JDK9, we would expect it to have have @since 1.9, Java FX x.x.
>>>
>>> As swing component currenly doesn't have that extra version
>>> information, we will simply mark the J2SE debut.
>>>
>>> Cheers,
>>> Henry
>>>
>>>> -phil.
>>>>
>>>> On 6/18/2014 9:16 AM, Henry Jen wrote:
>>>>> Thanks, Alexander.
>>>>>
>>>>> Cheers,
>>>>> Henry
>>>>>
>>>>> On 06/18/2014 03:44 AM, Alexander Scherbatiy wrote:
>>>>>>
>>>>>>    The fix looks good for me.
>>>>>>
>>>>>>    Thanks,
>>>>>>    Alexandr.
>>>>>>
>>>>>> On 6/11/2014 4:00 AM, Henry Jen wrote:
>>>>>>> Hi,
>>>>>>>
>>>>>>> Please review a trivial webrev that provides missing @since tag for
>>>>>>> elements under javax.swing,
>>>>>>>
>>>>>>> Essentially it's simply add @since 1.2 for all
>>>>>>> classes/interfaces/exception that are missing @since tag, as JDK 1.2
>>>>>>> package.html has @since tag but was removed in 1.3.
>>>>>>>
>>>>>>> The @since tag is added to *.java instead of package.html so that we
>>>>>>> can have javac report javadoc via
>>>>>>> javax.lang.model.util.Elements.getDocComment(Element c).
>>>>>>>
>>>>>>> http://cr.openjdk.java.net/~henryjen/jdk9/8046485/0/webrev/
>>>>>>>
>>>>>>> Cheers,
>>>>>>> Henry
>>>>>>
>>>>
>>
>