On 19/03/2009, Matt Benson <gudnabr...@yahoo.com> wrote: > > > --- On Thu, 3/19/09, James Carman <ja...@carmanconsulting.com> wrote: > > > From: James Carman <ja...@carmanconsulting.com> > > Subject: Re: [LANG] 3.0 JCIP Annotations > > > To: "Commons Developers List" <dev@commons.apache.org> > > > Date: Thursday, March 19, 2009, 1:14 AM > > On Wed, Mar 18, 2009 at 10:21 PM, > > > Stephen Colebourne > > <scolebou...@btopenworld.com> > > wrote: > > > > > > > Thats OK technically (as there is no runtime > > dependency on > > > net.jcip.annotations). However, I suspect it will > > confuse users, as very few > > > people realise that no dependency is created beyond > > compilation time. > > > > > > > > I agree. Most folks don't know that there annotation > > classes aren't > > really required at runtime. If we're just looking for > > documentation, > > can't we have our own doclet? > > > *I* didn't know that the classes weren't required at RT... but I still don't > know that we should consider that a blocker. Seems like a couple of > well-placed warnings in documentation would take care of that pretty well. > What does the annotation look like in the Javadoc?
It appears as a single line containing the tag at the start of the class Javadoc. I've not tried with multple annotations, so I don't know if they have one line each or if they get combined. > Because if the POM has it marked as optional (we can even include a comment > there explaining further) good idea, I'll do that. > then the Javadoc would be the only place left for a user to get the wrong > idea. Adding our own annotation seems like NIH... > Yes, unless it is a Commons-specific (or ASF) annotation (who knows, this might be useful one day), we should use exising ones. > -Matt > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > > For additional commands, e-mail: dev-h...@commons.apache.org > > > > > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
