[
https://issues.apache.org/jira/browse/UIMA-2695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13613724#comment-13613724
]
Marshall Schor commented on UIMA-2695:
--------------------------------------
Thank you for the feedback. I fixed items 1 and 3.
Regarding item 2, there is a class whose name is FeatureStructureImpl, but it
is not included in the API docs you looked at because it is an "internal"
class, and to decrease the chance that users accidentally might use an internal
API, these are intentionally not included in the API documents. Unfortunately,
this means that occasionally references like this will happen.
> Bad code reference in API doc
> -----------------------------
>
> Key: UIMA-2695
> URL: https://issues.apache.org/jira/browse/UIMA-2695
> Project: UIMA
> Issue Type: Bug
> Affects Versions: 2.4.0SDK
> Reporter: Hao Zhong
> Assignee: Marshall Schor
> Priority: Minor
>
> 1.
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/UIMARuntimeException.html
> "CasManager.release(CAS) was called with a CAS that does not belong to this
> CasManager."
> According to
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/CasManager.html,
> CasManager has not a release method, but a releaseCas method.
> 2.
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/jcas/cas/TOP.html
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/jcas/cas/NonEmptyFSList.html
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/index.html?org/apache/uima/jcas/cas/ByteArray.html
> These classes extend the org.apache.uima.cas.impl.FeatureStructureImpl
> class. However, according to
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/cas/impl/package-summary.html,
> the org.apache.uima.cas.impl package does not have a class whose name is
> FeatureStructureImpl.
> Uimaj 2.3 has such a class. Perhaps, it is deleted in the latest version.
> 3.
> http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/jcas/tcas/DocumentAnnotation.html
> "When text CASs are created, one instance of this type is created and made
> accessable via a call to the JCasImpl.getDocumentAnnotationFs() method."
> Uimaj 2.4 does not have a JCasImpl class, whereas Uimaj 2.3 has.
> Please revise the documents to reflect the latest code.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
