On 12/11/2013 5:04 PM, Richard Eckart de Castilho wrote:
> On 11.12.2013, at 19:34, Marshall Schor <[email protected]> wrote:
>
>> For public APIs having Javadoc comments, the @param, @return @throws elements
>> must correspond to the situation, and have a non-blank description. So, a
>> parameter "aCAS" needs to be written @param aCAS the CAS (or something
>> similar).
> Did you try just removing the @param and @return declarations for those
> obvious cases?
yes, the lint says they're missing if they're removed.
>
>> The JCas generation mechanism currently produces things it uses to control
>> its
>> weaving together of user-added code with generated code. These things are
>> Javadoc comments, for example:
>>
>> /** @generated */
> The JCas classes also cause another kind of warning in my Eclipse when custom
> type inherits form another custom type: Unnecessary @SuppressWarnings
> ("hiding")
ok - maybe that can also be fixed...
>
>> This will have to be carefully reworked, because the generated Javadoc
>> comments
>> won't pass the lint test for various reasons. This may take a bit of work /
>> time…
> Are you considering to switch to real Java annotations (probably with
> RetentionPolicy.SOURCE)?
not at this time - it's more work :-)
And, I'm hoping to do another release right around the end of the year, to pick
up changes that some are waiting for.
-Marshall
>
> -- Richard
