geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From strub...@apache.org
Subject svn commit: r1800034 - in /geronimo/specs/trunk/geronimo-jcdi_2.0_spec: ./ src/main/java/javax/decorator/ src/main/java/javax/enterprise/context/control/ src/main/java/javax/enterprise/event/ src/main/java/javax/enterprise/inject/se/ src/main/java/java...
Date Tue, 27 Jun 2017 09:04:24 GMT
Author: struberg
Date: Tue Jun 27 09:04:24 2017
New Revision: 1800034

URL: http://svn.apache.org/viewvc?rev=1800034&view=rev
Log:
GERONIMO-6553 fix a few JavaDoc warnings

Modified:
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/pom.xml
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/decorator/Delegate.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/event/ObservesAsync.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/se/SeContainerInitializer.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterBeanDiscovery.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterTypeDiscovery.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessInjectionPoint.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessObserverMethod.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/Unmanaged.java
    geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/util/Nonbinding.java

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/pom.xml
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/pom.xml?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/pom.xml (original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/pom.xml Tue Jun 27 09:04:24 2017
@@ -122,6 +122,14 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <additionalparam>-Xdoclint:none</additionalparam>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/decorator/Delegate.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/decorator/Delegate.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/decorator/Delegate.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/decorator/Delegate.java
Tue Jun 27 09:04:24 2017
@@ -27,7 +27,7 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 /**
- * Defines a delegation point in a {@see Decorator}.
+ * Defines a delegation point in a {@link Decorator}.
  * There must only be one delegation point in a Decorator.
  *
  * @see javax.decorator.Decorator

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
Tue Jun 27 09:04:24 2017
@@ -58,7 +58,7 @@ public interface RequestContextControlle
      * but was not activated by this controller, then it may not be deactivated by this controller,
      * meaning this method will do nothing.
      *
-     * If the context is not active, a {@see ContextNotActiveException} is thrown.
+     * If the context is not active, a {@code ContextNotActiveException} is thrown.
      *
      * @throws ContextNotActiveException if the context is not active
      */

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/event/ObservesAsync.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/event/ObservesAsync.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/event/ObservesAsync.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/event/ObservesAsync.java
Tue Jun 27 09:04:24 2017
@@ -32,8 +32,8 @@ import static java.lang.annotation.Reten
 public @interface ObservesAsync {
 
    /**
-    * Specifies when this observer is invoked, either if the bean already exists or always,
potentially creating the bean
-    * @return
+    * Specifies when this Observer is invoked, either if the bean already exists or always,
potentially creating the bean
+    * @return whether this Observer should always be notified or only if a Contextual Instance
exists already.
     */
    Reception notifyObserver() default Reception.ALWAYS;
 

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/se/SeContainerInitializer.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/se/SeContainerInitializer.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/se/SeContainerInitializer.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/se/SeContainerInitializer.java
Tue Jun 27 09:04:24 2017
@@ -141,7 +141,7 @@ public abstract class SeContainerInitial
      * Adds the given alternative stereotypes to the list of available alternative stereotypes
in the bean archive
      *
      * @param alternativeStereotypeClasses
-     * @return
+     * @return this
      */
     public abstract SeContainerInitializer selectAlternativeStereotypes(Class<? extends
Annotation>... alternativeStereotypeClasses);
 

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterBeanDiscovery.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterBeanDiscovery.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterBeanDiscovery.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterBeanDiscovery.java
Tue Jun 27 09:04:24 2017
@@ -71,10 +71,7 @@ public interface AfterBeanDiscovery
     <T> AnnotatedType<T> getAnnotatedType(Class<T> type, String id);
 
     /**
-     * Get an Iterable of all AnnotatedTypes which implement the given
-     * @param type
-     * @param <T>
-     * @return
+     * @return an Iterable of all AnnotatedTypes which implement the given type
      */
     <T> Iterable<AnnotatedType<T>> getAnnotatedTypes(Class<T> type);
 
@@ -83,11 +80,11 @@ public interface AfterBeanDiscovery
     *
     * A ProcessBean is fired once the bean has been built.
     *
-    * The bean configurator created is meant as a one time use object.  Invoke this method
to create new ones.
+    * The bean configurator created is meant as a one time use object.
+    * Invoke this method to create new Beans.
     *
-    * @param <T>
     * @throws IllegalStateException if used outside of the observer method's invocation
-    * @return
+    * @return a fresh {@code BeanConfigurator} to configure a new bean.
     */
     <T> BeanConfigurator<T> addBean();
 
@@ -100,7 +97,7 @@ public interface AfterBeanDiscovery
     *
     * @param <T>
     * @throws IllegalStateException if used outside of the observer method's invocation
-    * @return
+    * @return an observer method configurator to define an observer method.
     */
     <T> ObserverMethodConfigurator<T> addObserverMethod();
 }

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterTypeDiscovery.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterTypeDiscovery.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterTypeDiscovery.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/AfterTypeDiscovery.java
Tue Jun 27 09:04:24 2017
@@ -76,12 +76,9 @@ public interface AfterTypeDiscovery
     void addAnnotatedType(AnnotatedType<?> type, String id);
 
     /**
-     * Returns a new annotated type configurator based on a new bean id and bean class.
-     *
      * @param clazz to add
      * @param id of the annotated type
-     * @param <T>
-     * @return
+     * @return a new annotated type configurator based on a new bean id and bean class.
      */
     <T> AnnotatedTypeConfigurator<T> addAnnotatedType(Class<T> clazz, String
id);
 }

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessInjectionPoint.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessInjectionPoint.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessInjectionPoint.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessInjectionPoint.java
Tue Jun 27 09:04:24 2017
@@ -35,6 +35,9 @@ public interface ProcessInjectionPoint<T
 
     /**
      * Replace the original InjectionPoint point with the given one.
+     *
+     * You can only either use {@link #setInjectionPoint(InjectionPoint)} or
+     * {@link #configureInjectionPoint()}
      * @param injectionPoint
      */
     void setInjectionPoint(InjectionPoint injectionPoint);
@@ -48,9 +51,12 @@ public interface ProcessInjectionPoint<T
     void addDefinitionError(Throwable t);
 
    /**
-    *  Creates a new configurator for this injection point.
+    *  Creates a new configurator for this injection point
+    *  initialised with the information from the processed injectionPoint
+    *  You can only either use {@link #setInjectionPoint(InjectionPoint)} or
+    *  {@link #configureInjectionPoint()}
     *
-    * @return
+    * @return an {@code InjectionPointConfigurator} to tweak the current InjectionPoint
     */
     InjectionPointConfigurator configureInjectionPoint();
 }

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessObserverMethod.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessObserverMethod.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessObserverMethod.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/ProcessObserverMethod.java
Tue Jun 27 09:04:24 2017
@@ -64,8 +64,11 @@ public interface ProcessObserverMethod<E
     void addDefinitionError(Throwable t);
 
    /**
-    * Creates a configurator for this observer method
-    * @return
+    * Creates a configurator for this observer method.
+    * It is initialised with the information from the currently
+    * processed ObserverMethod
+    *
+    * @return an {@code ObserverMethodConfigurator} to tweak the processed Observermethod
     */
     ObserverMethodConfigurator<EVENTTYPE> configureObserverMethod();
 

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/Unmanaged.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/Unmanaged.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/Unmanaged.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/inject/spi/Unmanaged.java
Tue Jun 27 09:04:24 2017
@@ -28,7 +28,7 @@ import javax.enterprise.context.spi.Crea
  * managed by the CDI container and thus need to be
  * cleaned up manually to not create memory leaks!.
  *
- * Normal code shall use {@link javax.enterprise.inject.Instance<T>} if possible.
+ * Normal code shall use {@link javax.enterprise.inject.Instance} if possible.
  *
  * The reason for using UnmanagedInstance is for
  * &#064;Dependent scoped instances which should not pollute the

Modified: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/util/Nonbinding.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/util/Nonbinding.java?rev=1800034&r1=1800033&r2=1800034&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/util/Nonbinding.java
(original)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/util/Nonbinding.java
Tue Jun 27 09:04:24 2017
@@ -32,9 +32,9 @@ import java.lang.annotation.Target;
  * Example:
  * 
  * <pre>
- * @Qualifier
+ * &#064;Qualifier
  * public @interface Mock {
- *   @NonBinding String name;
+ *   &#064;NonBinding String name;
  * }
  * </pre>
  * 



Mime
View raw message