Ok, I didn't checked JIRA, sorry. 

Thanks, 

Baptiste

> Date: Thu, 29 Oct 2009 10:22:45 -0400
> Subject: Re: Problem in the documentation ?
> From: [email protected]
> To: [email protected]
> 
> On Thu, Oct 29, 2009 at 7:20 AM, Baptiste Gaillard
> <[email protected]> wrote:
> >
> > Hi,
> >
> > I am creating CAS Pools manually for my application using the following 
> > constructor:
> >
> > public CasPool(int aNumInstances, Collection 
> > aComponentDescriptionsOrMetaData, Properties aPerformanceTuningSettings, 
> > ResourceManager aResourceManager) throws ResourceInitializationException;
> >
> > I think there is a small problem in the Java Doc of this constructor for 
> > the parameter 'aComponentDescriptionsOrMetaData'.
> >
> >   * @ param aComponentDescriptionsOrMetaData
> >   *          a collection of {...@link AnalysisEngineDescription},
> >   *          {...@link CollectionReaderDescription}, {...@link 
> > CasConsumerDescription}, or
> >   *          {...@link ProcessingResourceMetaData} objects.
> >
> > This says that the parameter can be an {...@link 
> > AnalysisEngineDescription}, {...@link CollectionReaderDescription}, 
> > {...@link CasConsumerDescription} or {...@link ProcessingResourceMetaData} 
> > but I think it can only be of type {...@link ProcessingResourceMetaData}.
> >
> > This is because the CasPool constructor calls (indirectly) the 
> > 'CasDefinition(Collection aMetaDataToMerge, ResourceManager 
> > aResourceManager)' constructor which takes a collection of {...@link 
> > ProcessingResourceMetaData} and cannot have {...@link 
> > AnalysisEngineDescription}, {...@link CollectionReaderDescription}, 
> > {...@link CasConsumerDescription} types inside this collection.
> >
> > I think the 'CasDefinition(Collection aMetaDataToMerge, ResourceManager 
> > aResourceManager)' constructor should be documented and the Java Doc of 
> > CasPool constructor corrected.
> >
> > Am I right with this Java Doc problem ?
> >
> 
> Yes, you're right.  This problem was noticed recently by Joern
> Kottmann and he has already fixed it on trunk under this JIRA issue:
> https://issues.apache.org/jira/browse/UIMA-1499
> 
>  -Adam
                                          
_________________________________________________________________
Nouveau Windows 7 : Trouvez le PC qui vous convient. En savoir plus.
http://clk.atdmt.com/FRM/go/181574580/direct/01/

Reply via email to