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 (JIRA)" <ui...@incubator.apache.org> on 2006/11/24 03:25:01 UTC

[jira] Created: (UIMA-70) JavaDoc doesn't match impl

JavaDoc doesn't match impl
--------------------------

                 Key: UIMA-70
                 URL: http://issues.apache.org/jira/browse/UIMA-70
             Project: UIMA
          Issue Type: Improvement
          Components: Core Java Framework
            Reporter: Marshall Schor
            Priority: Minor
             Fix For: 2.1


Javadoc for AnnotatorContext_impl constructor says it throws ResourceConfigurationException, but it doesn't.

While we're at it (wish)- it would be good to run some automated tool to check for other wrong instances of throws in javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (UIMA-70) JavaDoc doesn't match impl

Posted by "Adam Lally (JIRA)" <ui...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/UIMA-70?page=comments#action_12453613 ] 
            
Adam Lally commented on UIMA-70:
--------------------------------

Regarding an automated tool:  The javadoc tool catches these kinds of problems, I think.  There are many warnings generated by our javadoc build that usually go unnoticed.  Probably we should have a policy of reviewing and fixing these before each release.

> JavaDoc doesn't match impl
> --------------------------
>
>                 Key: UIMA-70
>                 URL: http://issues.apache.org/jira/browse/UIMA-70
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>            Reporter: Marshall Schor
>            Priority: Minor
>             Fix For: 2.1
>
>
> Javadoc for AnnotatorContext_impl constructor says it throws ResourceConfigurationException, but it doesn't.
> While we're at it (wish)- it would be good to run some automated tool to check for other wrong instances of throws in javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (UIMA-70) JavaDoc doesn't match impl

Posted by "Thilo Goetz (JIRA)" <ui...@incubator.apache.org>.
    [ https://issues.apache.org/jira/browse/UIMA-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12466494 ] 

Thilo Goetz commented on UIMA-70:
---------------------------------

You can configure Eclipse to give you warnings for these kinds of issues.  That's a lot easier than hunt through the javadocs compiler output.

> JavaDoc doesn't match impl
> --------------------------
>
>                 Key: UIMA-70
>                 URL: https://issues.apache.org/jira/browse/UIMA-70
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>            Reporter: Marshall Schor
>         Assigned To: Adam Lally
>            Priority: Minor
>             Fix For: 2.1
>
>
> Javadoc for AnnotatorContext_impl constructor says it throws ResourceConfigurationException, but it doesn't.
> While we're at it (wish)- it would be good to run some automated tool to check for other wrong instances of throws in javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Closed: (UIMA-70) JavaDoc doesn't match impl

Posted by "Thilo Goetz (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-70?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Thilo Goetz closed UIMA-70.
---------------------------

    Resolution: Fixed

> JavaDoc doesn't match impl
> --------------------------
>
>                 Key: UIMA-70
>                 URL: https://issues.apache.org/jira/browse/UIMA-70
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>            Reporter: Marshall Schor
>         Assigned To: Adam Lally
>            Priority: Minor
>             Fix For: 2.1
>
>
> Javadoc for AnnotatorContext_impl constructor says it throws ResourceConfigurationException, but it doesn't.
> While we're at it (wish)- it would be good to run some automated tool to check for other wrong instances of throws in javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Assigned: (UIMA-70) JavaDoc doesn't match impl

Posted by "Adam Lally (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-70?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Adam Lally reassigned UIMA-70:
------------------------------

    Assignee: Adam Lally

> JavaDoc doesn't match impl
> --------------------------
>
>                 Key: UIMA-70
>                 URL: https://issues.apache.org/jira/browse/UIMA-70
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>            Reporter: Marshall Schor
>         Assigned To: Adam Lally
>            Priority: Minor
>             Fix For: 2.1
>
>
> Javadoc for AnnotatorContext_impl constructor says it throws ResourceConfigurationException, but it doesn't.
> While we're at it (wish)- it would be good to run some automated tool to check for other wrong instances of throws in javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira