Uploaded image for project: 'UIMA'
  1. UIMA
  2. UIMA-2695

Bad code reference in API doc

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 2.4.0SDK
    • 2.4.1SDK
    • None
    • None

    Description

      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.

      Attachments

        Activity

          People

            schor Marshall Schor
            drzhonghao Hao Zhong
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: