You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@uima.apache.org by Marshall Schor <ms...@schor.com> on 2010/05/17 20:15:27 UTC

how to fix javadoc comment in Tagger annotator

The class IModeResource in Tagger has this:

public interface IModelResource {
 
  /**
   * Obtain an input stream for this resource.
   * @return
   */
  ModelGeneration getModel();

ModelGeneration is not an input stream.  What should the Javadoc say?

-Marshall Schor

Re: how to fix javadoc comment in Tagger annotator

Posted by Thilo Götz <tw...@gmx.de>.

On 5/17/2010 20:15, Marshall Schor wrote:
> The class IModeResource in Tagger has this:
> 
> public interface IModelResource {
>  
>   /**
>    * Obtain an input stream for this resource.
>    * @return
>    */
>   ModelGeneration getModel();
> 
> ModelGeneration is not an input stream.  What should the Javadoc say?

I looked at it briefly, and I have no idea.  Just delete
the comment if you don't like it.  It's better to have no
javadoc than to have vacuous, erroneous or misleading docs.

--Thilo

> 
> -Marshall Schor