You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by li...@apache.org on 2012/01/25 08:02:22 UTC

[5/6] git commit: Fixing up JavaDoc, removing TODO about javadoc

Fixing up JavaDoc, removing TODO about javadoc


Project: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/commit/cdd297d8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/tree/cdd297d8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/diff/cdd297d8

Branch: refs/heads/master
Commit: cdd297d84473fec605d6979d2cb8599873089b50
Parents: 7ecfeed
Author: Jason Porter <li...@apache.org>
Authored: Tue Jan 24 23:30:43 2012 -0700
Committer: Jason Porter <li...@apache.org>
Committed: Tue Jan 24 23:30:43 2012 -0700

----------------------------------------------------------------------
 .../metadata/builder/AnnotatedCallableImpl.java    |    5 ++++-
 .../core/api/metadata/builder/AnnotatedImpl.java   |   15 +++++++++++++++
 .../api/metadata/builder/AnnotatedMemberImpl.java  |    9 +++++++++
 .../metadata/builder/AnnotatedParameterImpl.java   |    8 +++++++-
 .../api/metadata/builder/AnnotatedTypeImpl.java    |   12 ++++++++++++
 .../api/metadata/builder/AnnotationBuilder.java    |    1 -
 .../core/api/metadata/builder/AnnotationStore.java |    1 -
 7 files changed, 47 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedCallableImpl.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedCallableImpl.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedCallableImpl.java
index 52786cf..953af8d 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedCallableImpl.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedCallableImpl.java
@@ -29,7 +29,7 @@ import java.util.List;
 import java.util.Map;
 
 /**
- *
+ * Implementation of {@link AnnotatedCallable}
  */
 abstract class AnnotatedCallableImpl<X, Y extends Member> extends AnnotatedMemberImpl<X, Y>
         implements AnnotatedCallable<X>
@@ -47,6 +47,9 @@ abstract class AnnotatedCallableImpl<X, Y extends Member> extends AnnotatedMembe
                 parameterTypeOverrides);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public List<AnnotatedParameter<X>> getParameters()
     {
         return Collections.unmodifiableList(parameters);

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedImpl.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedImpl.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedImpl.java
index 17ca2d5..7da44e3 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedImpl.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedImpl.java
@@ -70,30 +70,45 @@ abstract class AnnotatedImpl implements Annotated
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public <T extends Annotation> T getAnnotation(Class<T> annotationType)
     {
         return annotations.getAnnotation(annotationType);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<Annotation> getAnnotations()
     {
         return annotations.getAnnotations();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
     {
         return annotations.isAnnotationPresent(annotationType);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<Type> getTypeClosure()
     {
         return new HashSet<Type>(typeClosure);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Type getBaseType()
     {

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedMemberImpl.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedMemberImpl.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedMemberImpl.java
index d339250..576c4aa 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedMemberImpl.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedMemberImpl.java
@@ -42,18 +42,27 @@ abstract class AnnotatedMemberImpl<X, M extends Member> extends AnnotatedImpl im
         this.javaMember = member;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public AnnotatedType<X> getDeclaringType()
     {
         return declaringType;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public M getJavaMember()
     {
         return javaMember;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean isStatic()
     {

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedParameterImpl.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedParameterImpl.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedParameterImpl.java
index c9682d2..0165aa9 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedParameterImpl.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedParameterImpl.java
@@ -24,7 +24,7 @@ import javax.enterprise.inject.spi.AnnotatedParameter;
 import java.lang.reflect.Type;
 
 /**
- *
+ * Implementation of {@link AnnotatedParameter}.
  */
 class AnnotatedParameterImpl<X> extends AnnotatedImpl implements AnnotatedParameter<X>
 {
@@ -43,12 +43,18 @@ class AnnotatedParameterImpl<X> extends AnnotatedImpl implements AnnotatedParame
         this.position = position;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public AnnotatedCallable<X> getDeclaringCallable()
     {
         return declaringCallable;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public int getPosition()
     {

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedTypeImpl.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedTypeImpl.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedTypeImpl.java
index 0b70766..70fd78d 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedTypeImpl.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotatedTypeImpl.java
@@ -125,24 +125,36 @@ class AnnotatedTypeImpl<X> extends AnnotatedImpl implements AnnotatedType<X>
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<AnnotatedConstructor<X>> getConstructors()
     {
         return Collections.unmodifiableSet(constructors);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<AnnotatedField<? super X>> getFields()
     {
         return Collections.unmodifiableSet(fields);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Class<X> getJavaClass()
     {
         return javaClass;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<AnnotatedMethod<? super X>> getMethods()
     {

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationBuilder.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationBuilder.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationBuilder.java
index 5f4317a..ad7d43b 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationBuilder.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationBuilder.java
@@ -34,7 +34,6 @@ import java.util.Set;
  * A store of annotations to be used {@link AnnotatedTypeBuilder} and other places
  * where a collection of annotations needs manipulation.
  */
-//X TODO: JavaDoc the methods
 public class AnnotationBuilder
 {
     private final Map<Class<? extends Annotation>, Annotation> annotationMap;

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/cdd297d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationStore.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationStore.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationStore.java
index 1a6b7fb..20b865d 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationStore.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/metadata/builder/AnnotationStore.java
@@ -30,7 +30,6 @@ import static java.util.Collections.unmodifiableSet;
 /**
  * A helper class used to hold annotations on a type or member.
  */
-//X TODO: JavaDoc
 class AnnotationStore
 {
     private final Map<Class<? extends Annotation>, Annotation> annotationMap;