On Aug 29, 2011, at 6:20 PM, Sergiu Dumitriu wrote:
> On 08/28/2011 06:29 AM, Vincent Massol wrote:
>> Hi devs,
>>
>> I've just realized that using @override is enough to generate a proper
>> javadoc copied from the overriden method and that checkstyle doesn't
>> complain either.
>>
>> Basically instead of writing:
>>
>> /**
>> * {@inheritDoc}
>> *
>> * @see org.xwiki.logging.LoggerManager#popLogListener()
>> */
>> @Override
>> public EventListener popLogListener()
>>
>>
>> We can simply write:
>>
>> @Override
>> public EventListener popLogListener()
>>
>> Advantages:
>> 1) Less text to type and smaller class files
>> 2) Less duplicated text
>>
>> I thus propose to use this from now and to progressively remove unnecessary
>> javadoc in our legacy code.
>>
>> BTW this is also explained in the javadoc tool:
>> See section "Automatic Reuse of Method Comments" in
>> http://download.oracle.com/javase/1.3/docs/tooldocs/win32/javadoc.html
>>
>> WDYT?
>>
>> Here's my +1
>
> +1, but:
>
> Will checkstyle succeed?
Yes (see above my first line ;)).
Thanks
-Vincent
_______________________________________________
devs mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/devs
