Initially I just want to get *something* documented.  This can then be
collated and written up in the class doc as you suggested.
Ultimately I am planning to add a table to the class docs which will list
the keystroke, modifiers, description & when/if it consumes.

What inconsistency do you mean?
Are you referring to the fact I have only checked in javadocs for
ComponentKeyListener#keyTyped() methods?   (I am working through
ComponentKeyListener a method at a time)
Or that other, non-ComponentKeyListener events are not documented?

Chris

On 16 September 2010 22:26, Greg Brown <[email protected]> wrote:

> This seems fine, but it does create an inconsistency with the other event
> handlers which don't have such Javadoc. Maybe a better place to capture this
> would be in the class doc? There, we could describe how the skin behaves as
> a whole.
>
> On Sep 16, 2010, at 11:22 AM, [email protected] wrote:
>
> > Author: cbartlett
> > Date: Thu Sep 16 15:22:16 2010
> > New Revision: 997787
> >
> > URL: http://svn.apache.org/viewvc?rev=997787&view=rev
> > Log:
> > PIVOT-637 - Javadoc comments for ComponentKeyListener#keyTyped() methods
> >
> > Modified:
> >
>  
> pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java
> >
>  pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraMenuSkin.java
> >
>  
> pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
> >    pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
> >    pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ListButtonSkin.java
> > ...
>
>
>

Reply via email to