| How do I add extra validations to javadocs? [message #899911] |
Thu, 02 August 2012 15:20  |
Eclipse User |
|
|
|
On our project, we place @author and @since javadoc tags on the classes, methods and attributes we create.
As a rule, if one is the @author of a class, there's no need for him/her to place @author tags on its methods and attributes, even if they were included on a later version.
Similarly, if a class has a @since tag, there's no need to place @since tags on its methods and attributes when they have the same value.
Is there a way to validate the tags according to those rules, show them as warnings on Eclipse's Problems view and provide quick fixes for them on code editor?
|
|
|
| Re: How do I add extra validations to javadocs? [message #900259 is a reply to message #899911] |
Mon, 06 August 2012 04:49  |
| Eclipse User |
|
|
|
On 02.08.2012 21:20, Mario Marinato wrote:
> On our project, we place @author and @since javadoc tags on the
> classes, methods and attributes we create.
>
> As a rule, if one is the @author of a class, there's no need for
> him/her to place @author tags on its methods and attributes, even if
> they were included on a later version.
>
> Similarly, if a class has a @since tag, there's no need to place
> @since tags on its methods and attributes when they have the same value.
>
> Is there a way to validate the tags according to those rules, show
> them as warnings on Eclipse's Problems view and provide quick fixes
> for them on code editor?
It is possible: you can write your own compilation participant and your
own quick fixes.
Dani
|
|
|
|
Powered by
FUDForum. Page generated in 0.03384 seconds
Home