[cdi-dev] [JBoss JIRA] (CDI-737) Typo in the javadoc of ProcessBean

Clement Escoffier (Jira) issues at jboss.org
Thu Nov 15 04:07:00 EST 2018


Clement Escoffier created CDI-737:
-------------------------------------

             Summary: Typo in the javadoc of ProcessBean
                 Key: CDI-737
                 URL: https://issues.jboss.org/browse/CDI-737
             Project: CDI Specification Issues
          Issue Type: Bug
          Components: Javadoc and API
    Affects Versions: 2.0.SP1
            Reporter: Clement Escoffier


Just a typo, the `@return` tag of `javax.enterprise.inject.spi.ProcessBean#getAnnotated` does not link to the right type. It should be:

{code:java}
/**
     * Returns the {@link javax.enterprise.inject.spi.AnnotatedType} representing the bean class, the
     * {@link javax.enterprise.inject.spi.AnnotatedMethod} representing the producer method, or the
     * {@link javax.enterprise.inject.spi.AnnotatedField} representing the producer field.
     * 
     * <p>
     * If invoked upon a {@link ProcessSyntheticBean} event, non-portable behavior results and the returned value should be ignored.
     * </p>
     * 
     * @return the {@link javax.enterprise.inject.spi.Annotated} for the bean being registered
     * @throws IllegalStateException if called outside of the observer method invocation
     */
    public Annotated getAnnotated();
{code}

The existing code references `AnnotatedType`.



--
This message was sent by Atlassian Jira
(v7.12.1#712002)


More information about the cdi-dev mailing list