Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
Yeah, of course that is true if the fields are non-public and javadoc is not instructed to include them, but that goes without saying. However some people do use -protected, -private & -package as they are supported by the javadoc tool. Defaults are often changed. I have worked at companies who r

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
What I mean is that private fields aren't included in Javadoc by default, so in general you won't see the field at all, never mind the fact that it is annotated with @BXML. It's not *harmful* to add @Documented to @BXML - I just don't think it's going to have much effect, that's all. G On Aug

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
Choosing not to include it in Javadocs it is fine if we are certain that it is of no value, or is detrimental in some way. I don't see how it it would be detrimental, and it might be useful to some people, so I would prefer to include it. Or let me put it this way - if annotations were *included*

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
> I'm not saying that it would help to enhance the Pivot API Javadocs in > any way. Just that it would be there for Pivot consumers when they > generate Javadocs for their own code that uses @BXML. @BXML is primarily meant for application, not platform, usage anyways, so that's OK. I'm just wond

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
Not sure what you mean exactly. If I write some custom code that uses the @BXML annotation, the generated Javadocs would include the @BXML annotation if the access level allowed for that field to be documented at all. If all of my @BXML annotated fields are private I can still use the '-private'

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
> I agree, but I suppose it might still be useful to see what custom > code uses the BXML annotation and therefore would require signing to > run in an applet. How would you see it though, if the field isn't documented?

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
I agree, but I suppose it might still be useful to see what custom code uses the BXML annotation and therefore would require signing to run in an applet. I'm creating a JIRA ticket now and adding a patch for all 3. On 8 August 2011 20:40, Greg Brown wrote: >> Just played around with @BXML, and d

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
> Just played around with @BXML, and don't see much value there. If the fields are private (the common case) then I tend to agree, since they wouldn't be Javadoc'ed anyways.

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
Just played around with @BXML, and don't see much value there. However, I do favour more documentation when practical, especially when it is automatically generated and therefore kept in sync. How about I just add the @Documented to all 3? Chris On 8 August 2011 20:15, Greg Brown wrote: > IDPro

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
IDProperty might benefit. Not sure about @BXML, but probably. On Aug 8, 2011, at 9:06 AM, Chris Bartlett wrote: > I thought they were included by default (if you can excuse the pun), > but only realised that DefaultProperty wasn't when I went looking for > it just now. > > I take it you have no

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
n time with this for the 2.0.1 or should we go into 2.0.2 (I think > it's good enough) ? > Useful even a an improvement ticket ? > > Bye > > > -- > View this message in context: > http://apache-pivot-developers.417237.n3.nabble.com/DefaultProperty-in-Javadocs-tp3

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
I thought they were included by default (if you can excuse the pun), but only realised that DefaultProperty wasn't when I went looking for it just now. I take it you have no objection to me adding it then? Any thoughts about other Pivot annotations? On 8 August 2011 20:02, Greg Brown wrote: > Th

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Sandro Martini
Hi all, still in time with this for the 2.0.1 or should we go into 2.0.2 (I think it's good enough) ? Useful even a an improvement ticket ? Bye -- View this message in context: http://apache-pivot-developers.417237.n3.nabble.com/DefaultProperty-in-Javadocs-tp3235437p3235489.html Sent fro

Re: @DefaultProperty in Javadocs

2011-08-08 Thread Greg Brown
That's cool - I was not aware of that feature. On Aug 8, 2011, at 8:39 AM, Chris Bartlett wrote: > Is there any reason why the DefaultProperty annotation is not > annotated itself with java.lang.annotation.Documented? > > Doing so means that users will be able to see what WTK (or other) > classe

@DefaultProperty in Javadocs

2011-08-08 Thread Chris Bartlett
Is there any reason why the DefaultProperty annotation is not annotated itself with java.lang.annotation.Documented? Doing so means that users will be able to see what WTK (or other) classes are have the DefaultProperty annotation and its value by looking at the Javadoc for that class. Are there