Result: 5 +1, no 0, no -1
The vote is passed and I've updated
http://dev.xwiki.org/xwiki/bin/view/Community/JavaCodeStyle#HDonotduplicateJavadoc
Thanks
-Vincent
On Aug 28, 2011, at 12:29 PM, 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
>
> Thanks
> -Vincent
>
_______________________________________________
devs mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/devs
