Document view names for all AnalysisEngines

[GoogleCodeExporter]

Please use labels and text to provide additional information.

We need to document the names of all views that each AnalysisEngine reads
from or writes to. For example, TreebankGoldAnnotator reads from
"TreebankView" and writes to "_InitialView", but doesn't document this
anywhere. This is crucial for users that want to use our annotators with
other views, e.g. through view mapping:

http://incubator.apache.org/uima/downloads/releaseDocs/2.2.2-incubating/docs/htm
l/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.aae.logging

Original issue reported on code.google.com by steven.b...@gmail.com on 5 Dec 2008 at 7:13

[GoogleCodeExporter]

Didn't ViewNames resolve this issue?  I think we can close this one.

Original comment by pvogren@gmail.com on 13 Mar 2009 at 8:14

[GoogleCodeExporter]

We haven't really documented which AnalysisEngine uses which view from 
ViewNames.
It's in the code, but as far as I know it's not in the documentation anywhere.
Basically now that ViewNames exists, any code that imports ViewNames should also
document what it's using from there.

Original comment by steven.b...@gmail.com on 13 Mar 2009 at 8:20

[GoogleCodeExporter]

Why?  It seems that if the purpose of the views are documented in ViewNames and 
all
the descriptor files have their sofa capabilities specified (which is now 
done), then
we've got it covered.  Adding more javadoc may just be an invitation to more 
future
out-of-date documentation.  

I vote for closing this one - but if you want to work on this I won't stop you. 

Original comment by pvogren@gmail.com on 13 Mar 2009 at 9:18

[GoogleCodeExporter]

With all the sofa capabilities specified, I'm happy to see this issue closed. 
Thanks!

Original comment by steven.b...@gmail.com on 13 Mar 2009 at 10:20

[GoogleCodeExporter]

we decided to close this one a month ago and never did.  'tis done now.

Original comment by pvogren@gmail.com on 14 Apr 2009 at 2:29

• Changed state: WontFix