Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Eclipse Platform » How do I add extra validations to javadocs?
How do I add extra validations to javadocs? [message #899911] Thu, 02 August 2012 19:20 Go to next message
Mario Marinato is currently offline Mario MarinatoFriend
Messages: 29
Registered: March 2011
Location: Brazil
Junior Member
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?


Mário Marinato
From Brazil
Re: How do I add extra validations to javadocs? [message #900259 is a reply to message #899911] Mon, 06 August 2012 08:49 Go to previous messageGo to next message
Dani Megert is currently offline Dani MegertFriend
Messages: 3801
Registered: July 2009
Senior Member
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
Re: How do I add extra validations to javadocs? [message #900290 is a reply to message #900259] Mon, 06 August 2012 11:50 Go to previous message
Mario Marinato is currently offline Mario MarinatoFriend
Messages: 29
Registered: March 2011
Location: Brazil
Junior Member
Yay! An starting point! "Compilation participant" it what I was looking for. Thanks.

Mário Marinato
From Brazil
Previous Topic:Eclispe RCP application contains non declared menu
Next Topic:Adapter Factory Not loaded
Goto Forum:
  


Current Time: Mon Dec 22 02:19:21 GMT 2014

Powered by FUDForum. Page generated in 0.01842 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software