You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2012/06/12 12:10:11 UTC
[1/2] git commit: DELTASPIKE-102 fix JavaDocs
Updated Branches:
refs/heads/master 8a8878faf -> 334d37d86
DELTASPIKE-102 fix JavaDocs
Project: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/commit/334d37d8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/tree/334d37d8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/diff/334d37d8
Branch: refs/heads/master
Commit: 334d37d8601f864efaf1ce41fdfad12a6390be94
Parents: ccf7875
Author: Mark Struberg <st...@apache.org>
Authored: Tue Jun 12 12:09:17 2012 +0200
Committer: Mark Struberg <st...@apache.org>
Committed: Tue Jun 12 12:09:17 2012 +0200
----------------------------------------------------------------------
.../core/api/exclude/annotation/Exclude.java | 20 +++++++-------
.../deltaspike/core/util/HierarchyDiscovery.java | 2 -
.../deltaspike/core/util/ProjectStageProducer.java | 2 +-
.../deltaspike/core/util/ReflectionUtils.java | 3 --
.../api/temptestutil/ShrinkWrapArchiveUtil.java | 6 +---
.../deltaspike/jpa/api/TransactionHelper.java | 2 +-
.../ResourceLocalPersistenceStrategy.java | 1 -
.../context/TransactionBeanStorage.java | 2 +-
.../test/util/ShrinkWrapArchiveUtil.java | 6 +---
.../DefaultAuthenticatorSelector.java | 2 -
.../impl/authorization/SecurityExtension.java | 6 +---
.../authorization/SecurityMetaDataStorage.java | 4 ---
.../test/util/ShrinkWrapArchiveUtil.java | 5 +--
13 files changed, 20 insertions(+), 41 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/exclude/annotation/Exclude.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/exclude/annotation/Exclude.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/exclude/annotation/Exclude.java
index a12559c..c780a96 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/exclude/annotation/Exclude.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/exclude/annotation/Exclude.java
@@ -29,11 +29,11 @@ import java.lang.annotation.Target;
/**
* Supported usages:
* <pre>
- * @Exclude
- * @Exclude(ifProjectStage=Production.class)
- * @Exclude(exceptIfProjectStage=UnitTest.class)
- * @Exclude(onExpression="myProperty==myValue")
- * @Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class)
+ * @Exclude
+ * @Exclude(ifProjectStage=Production.class)
+ * @Exclude(exceptIfProjectStage=UnitTest.class)
+ * @Exclude(onExpression="myProperty==myValue")
+ * @Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class)
* </pre>
*
* <p/>
@@ -41,21 +41,21 @@ import java.lang.annotation.Target;
* <p/>
* <p>the following bean gets excluded in any case</p>
* <pre>
- * @Exclude
+ * @Exclude
* public class NoBean {}
* </pre>
*
* <p/>
* <p>the following bean gets excluded in case of project-stage development</p>
* <pre>
- * @Exclude(ifProjectStage = ProjectStage.Development.class)
+ * @Exclude(ifProjectStage = ProjectStage.Development.class)
* public class ProductionBean {}
* </pre>
*
* <p/>
* <p>the following bean gets excluded in every case except of project-stage development</p>
* <pre>
- * @Exclude(exceptIfProjectStage = ProjectStage.Development.class)
+ * @Exclude(exceptIfProjectStage = ProjectStage.Development.class)
* public class DevBean {}
* </pre>
*
@@ -63,13 +63,13 @@ import java.lang.annotation.Target;
* <p>the following bean gets excluded if the expression evaluates to true.
* that means there is a configured property called 'myProper' with the value 'myValue'</p>
* <pre>
- * @Exclude(onExpression="myProperty==myValue")
+ * @Exclude(onExpression="myProperty==myValue")
* public class ProductionBean {}
* </pre>
*
* <p/>
* <p>the following bean gets excluded if the expression evaluates to true</p>
- * @Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class)
+ * @Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class)
* public class ProductionBean {}
*/
@Retention(RetentionPolicy.RUNTIME)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/HierarchyDiscovery.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/HierarchyDiscovery.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/HierarchyDiscovery.java
index b0a68ee..df9bbcb 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/HierarchyDiscovery.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/HierarchyDiscovery.java
@@ -146,8 +146,6 @@ public class HierarchyDiscovery
/**
* Gets the actual types by resolving TypeParameters.
*
- * @param beanType
- * @param type
* @return actual type
*/
private Type resolveType(Type beanType, Type beanType2, Type type)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ProjectStageProducer.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ProjectStageProducer.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ProjectStageProducer.java
index 6135e0f..49300ad 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ProjectStageProducer.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ProjectStageProducer.java
@@ -169,7 +169,7 @@ public class ProjectStageProducer implements Serializable
* Usage:
* <pre>
* new ProjectStageProducer() {
- * @Override
+ * @Override
* protected void reset() { super.reset(); }
* }.reset();
* </pre>
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ReflectionUtils.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ReflectionUtils.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ReflectionUtils.java
index 755f81b..8679092 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ReflectionUtils.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/util/ReflectionUtils.java
@@ -293,9 +293,6 @@ public abstract class ReflectionUtils
/**
* Checks if a method is abstract
- *
- * @param method
- * @return
*/
public static boolean isAbstract(Method method)
{
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/core/impl/src/test/java/org/apache/deltaspike/test/core/api/temptestutil/ShrinkWrapArchiveUtil.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/impl/src/test/java/org/apache/deltaspike/test/core/api/temptestutil/ShrinkWrapArchiveUtil.java b/deltaspike/core/impl/src/test/java/org/apache/deltaspike/test/core/api/temptestutil/ShrinkWrapArchiveUtil.java
index a0f115e..0ddb732 100644
--- a/deltaspike/core/impl/src/test/java/org/apache/deltaspike/test/core/api/temptestutil/ShrinkWrapArchiveUtil.java
+++ b/deltaspike/core/impl/src/test/java/org/apache/deltaspike/test/core/api/temptestutil/ShrinkWrapArchiveUtil.java
@@ -49,11 +49,10 @@ public class ShrinkWrapArchiveUtil
* Resolve all markerFiles from the current ClassPath and package the root nodes
* into a JavaArchive.
* @param classLoader to use
- * @param markerFile
+ * @param markerFile finding this marker file will trigger creating the JavaArchive.
* @param includeIfPackageExists if not null, we will only create JavaArchives if the given package exists
* @param excludeIfPackageExists if not null, we will <b>not</b> create JavaArchives if the given package exists.
* This has a higher precedence than includeIfPackageExists.
- * @return
*/
public static JavaArchive[] getArchives(ClassLoader classLoader,
String markerFile,
@@ -288,8 +287,7 @@ public class ShrinkWrapArchiveUtil
/**
* check if the given url path is a Jar
- * @param urlPath
- * @return
+ * @param urlPath to check
*/
private static String isJarUrl(String urlPath) {
// common prefixes of the url are: jar: (tomcat), zip: (weblogic) and wsjar: (websphere)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/TransactionHelper.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/TransactionHelper.java b/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/TransactionHelper.java
index 6281e4c..70ed5db 100644
--- a/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/TransactionHelper.java
+++ b/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/TransactionHelper.java
@@ -54,7 +54,7 @@ public class TransactionHelper
/**
* Execute the given {@link Callable} in a Transitional manner.
*
- * @param callable
+ * @param callable which will get executed in a @Transactional block
* @param <T> the return type of the executed {@link Callable}
* @return the return value of the executed {@link Callable}
* @throws Exception
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/ResourceLocalPersistenceStrategy.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/ResourceLocalPersistenceStrategy.java b/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/ResourceLocalPersistenceStrategy.java
index 9742f02..0311ae6 100644
--- a/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/ResourceLocalPersistenceStrategy.java
+++ b/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/ResourceLocalPersistenceStrategy.java
@@ -255,7 +255,6 @@ public class ResourceLocalPersistenceStrategy implements PersistenceStrategy
* This method might get overridden in subclasses to supply better error messages.
* This is useful if e.g. a JPA provider only provides a stubborn Exception for
* their ConstraintValidationExceptions.
- * @param e
* @return the wrapped or unwrapped Exception
*/
protected Exception prepareException(Exception e)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/context/TransactionBeanStorage.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/context/TransactionBeanStorage.java b/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/context/TransactionBeanStorage.java
index f892663..f95a46d 100644
--- a/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/context/TransactionBeanStorage.java
+++ b/deltaspike/modules/jpa/impl/src/main/java/org/apache/deltaspike/jpa/impl/transaction/context/TransactionBeanStorage.java
@@ -214,7 +214,7 @@ public class TransactionBeanStorage
/**
* Properly destroy all the given beans.
- * @param activeBeans
+ * @param activeBeans to destroy
*/
private void destroyBeans(Map<Contextual, TransactionBeanEntry> activeBeans)
{
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/jpa/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/jpa/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java b/deltaspike/modules/jpa/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
index a816810..ff8fd82 100644
--- a/deltaspike/modules/jpa/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
+++ b/deltaspike/modules/jpa/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
@@ -47,11 +47,10 @@ public class ShrinkWrapArchiveUtil
* Resolve all markerFiles from the current ClassPath and package the root nodes
* into a JavaArchive.
* @param classLoader to use
- * @param markerFile
+ * @param markerFile finding this marker file will trigger creating the JavaArchive.
* @param includeIfPackageExists if not null, we will only create JavaArchives if the given package exists
* @param excludeIfPackageExists if not null, we will <b>not</b> create JavaArchives if the given package exists.
* This has a higher precedence than includeIfPackageExists.
- * @return
*/
public static JavaArchive[] getArchives(ClassLoader classLoader,
String markerFile,
@@ -287,8 +286,7 @@ public class ShrinkWrapArchiveUtil
/**
* check if the given url path is a Jar
- * @param urlPath
- * @return
+ * @param urlPath to check
*/
private static String isJarUrl(String urlPath) {
// common prefixes of the url are: jar: (tomcat), zip: (weblogic) and wsjar: (websphere)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authentication/DefaultAuthenticatorSelector.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authentication/DefaultAuthenticatorSelector.java b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authentication/DefaultAuthenticatorSelector.java
index 6c6b2cc..e2fd543 100644
--- a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authentication/DefaultAuthenticatorSelector.java
+++ b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authentication/DefaultAuthenticatorSelector.java
@@ -55,8 +55,6 @@ public class DefaultAuthenticatorSelector implements AuthenticatorSelector
* and the user has provided their own custom Authenticator, return that one
* 4. If the user hasn't provided a custom Authenticator, return IdmAuthenticator
* and attempt to use the Identity Management API to authenticate
- *
- * @return
*/
public Authenticator getSelectedAuthenticator()
{
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityExtension.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityExtension.java b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityExtension.java
index 91a8a18..8b00aba 100644
--- a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityExtension.java
+++ b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityExtension.java
@@ -84,9 +84,7 @@ public class SecurityExtension implements Extension, Deactivatable
}
/**
- * @param <X>
- * @param event
- * @param beanManager
+ * Handles @Secured beans
*/
@SuppressWarnings("UnusedDeclaration")
public <X> void processAnnotatedType(@Observes ProcessAnnotatedType<X> event, final BeanManager beanManager)
@@ -222,8 +220,6 @@ public class SecurityExtension implements Extension, Deactivatable
* Registers the specified authorizer method (i.e. a method annotated with
* the @Secures annotation)
*
- * @param annotatedMethod
- * @param beanManager
* @throws SecurityDefinitionException
*/
private void registerAuthorizer(AnnotatedMethod<?> annotatedMethod, BeanManager beanManager)
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityMetaDataStorage.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityMetaDataStorage.java b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityMetaDataStorage.java
index f466c47..b1ced5a 100644
--- a/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityMetaDataStorage.java
+++ b/deltaspike/modules/security/impl/src/main/java/org/apache/deltaspike/security/impl/authorization/SecurityMetaDataStorage.java
@@ -70,10 +70,6 @@ class SecurityMetaDataStorage
/**
* This method is invoked by the security interceptor to obtain the
* authorizer stack for a secured method
- *
- * @param targetClass
- * @param targetMethod
- * @return
*/
Set<Authorizer> getAuthorizers(Class<?> targetClass, Method targetMethod)
{
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/334d37d8/deltaspike/modules/security/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
----------------------------------------------------------------------
diff --git a/deltaspike/modules/security/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java b/deltaspike/modules/security/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
index a9424f6..2b44343 100644
--- a/deltaspike/modules/security/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
+++ b/deltaspike/modules/security/impl/src/test/java/org/apache/deltaspike/test/util/ShrinkWrapArchiveUtil.java
@@ -47,7 +47,7 @@ public class ShrinkWrapArchiveUtil
* Resolve all markerFiles from the current ClassPath and package the root nodes
* into a JavaArchive.
* @param classLoader to use
- * @param markerFile
+ * @param markerFile finding this marker file will trigger creating the JavaArchive.
* @param includeIfPackageExists if not null, we will only create JavaArchives if the given package exists
* @param excludeIfPackageExists if not null, we will <b>not</b> create JavaArchives if the given package exists.
* This has a higher precedence than includeIfPackageExists.
@@ -287,8 +287,7 @@ public class ShrinkWrapArchiveUtil
/**
* check if the given url path is a Jar
- * @param urlPath
- * @return
+ * @param urlPath to check
*/
private static String isJarUrl(String urlPath) {
// common prefixes of the url are: jar: (tomcat), zip: (weblogic) and wsjar: (websphere)