You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by db...@apache.org on 2019/05/15 08:44:25 UTC
[tomee] 01/12: Clean javadoc errors
This is an automated email from the ASF dual-hosted git repository.
dblevins pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git
commit 50564d1289d48c839b441e838045e5fdaf3b3f79
Author: David Blevins <da...@gmail.com>
AuthorDate: Wed May 15 15:45:18 2019 +0900
Clean javadoc errors
---
.../main/java/org/apache/openejb/loader/Files.java | 2 +-
.../main/java/org/apache/openejb/loader/IO.java | 2 +-
.../java/org/apache/openejb/loader/Options.java | 25 +++++++++-------------
.../org/apache/openejb/loader/SystemInstance.java | 3 +--
.../java/org/apache/openejb/observer/Event.java | 2 +-
5 files changed, 14 insertions(+), 20 deletions(-)
diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/Files.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/Files.java
index ff3f32d..cc97b3b 100644
--- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/Files.java
+++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/Files.java
@@ -326,7 +326,7 @@ public class Files {
* Delete a file and all contents if specified file is a directory
*
* @param file File
- * @Throws IllegalStateException on failure at any point
+ * @throws IllegalStateException on failure at any point
*/
public static void remove(final File file) {
diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/IO.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/IO.java
index 157aaa5..507ec2e 100644
--- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/IO.java
+++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/IO.java
@@ -50,7 +50,7 @@ import java.util.zip.ZipOutputStream;
/**
* @version $Revision$ $Date$
- * <p/>
+ *
* NOTE: CHECK ExecMojo before adding dependency or inner class to it please
*/
public class IO {
diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/Options.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/Options.java
index 8eb4ce4..355bfe6 100644
--- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/Options.java
+++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/Options.java
@@ -30,38 +30,38 @@ import java.lang.reflect.Constructor;
* The purpose of this class is to provide a more strongly typed version of a
* java.util.Properties object. So far it is a read only view of the properties
* and does not set data into the underlying Properties instance.
- * <p/>
+ *
* Similar to java.util.Properties it will delegate to a "parent" instance when
* a property is not found. If a property is found but its value cannot be parsed
* as the desired data type, the parent's value is used.
- * <p/>
+ *
* By default this object will log nothing, but if a Log implementation is set the
* Options class will log three kinds of statements:
- * <p/>
+ *
* - When a property is not found: the property name and default value in use along
* with all possible values (enums only). Debug level.
* - When a property is found: the property name and value. Info level.
* - When a property value cannot be parsed: the property name and invalid value. Warn level.
- * <p/>
+ *
* Logging the user supplied values onto INFO is really nice as it shows up in the standard
* log output and allows us to easily see which values the user has changed from the default.
* It's rather impossible to diagnose issues without this information.
- * <p/>
+ *
* ENUM SETS:
- * <p/>
+ *
* Properties that accept a Set of enum values automatically accept ALL and NONE in
* addition to the explicitly created enum items.
- * <p/>
+ *
* Using ALL. This allows users to have an easy way to imply "all" without having to
* hardcode an the entire list of enum items and protects against the case where that
* list may grow in the future.
- * <p/>
+ *
* Using NONE. This allows users an alternative to using an empty string when explicitly
* specifying that none of the options should be used.
- * <p/>
+ *
* In the internal code, this allows us to have these concepts in all enum options
* without us having to add NONE or ALL enum items explicitly which leads to strange code.
- * <p/>
+ *
* Additionally TRUE is an alias for ALL and FALSE an alias for NONE. This allows options
* that used to support only true/false values to be further defined in the future without
* breaking compatibility.
@@ -266,11 +266,6 @@ public class Options {
/**
* Use this instead of Enum.valueOf() when you want to ensure that the
* the enum values are case insensitive.
- *
- * @param enumType
- * @param name
- * @param <T>
- * @return
*/
public static <T extends Enum<T>> T valueOf(final Class<T> enumType, final String name) {
final Map<String, T> map = new HashMap<>();
diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/SystemInstance.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/SystemInstance.java
index 6084943..063e913 100644
--- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/SystemInstance.java
+++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/SystemInstance.java
@@ -31,13 +31,12 @@ import java.util.concurrent.atomic.AtomicReference;
/**
* This class aims to be the one and only static in the entire SYSTEM
A static, singleton, instance of this class can be created with the {@link #init(Properties)} method
- * <p/>
+ *
* It is assumed that only one singleton per classloader is possible in any given VM
* Thus loading this instance in a classloader will mean there can only be one OpenEJB
* instance for that classloader and all children classloaders.
*
* @version $Revision$ $Date$
- * @org.apache.xbean.XBean element="system"
*/
public final class SystemInstance {
private static final String PROFILE_PROP = "openejb.profile";
diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/observer/Event.java b/container/openejb-loader/src/main/java/org/apache/openejb/observer/Event.java
index 0dd5759..5ef8ac3 100644
--- a/container/openejb-loader/src/main/java/org/apache/openejb/observer/Event.java
+++ b/container/openejb-loader/src/main/java/org/apache/openejb/observer/Event.java
@@ -23,7 +23,7 @@ import static java.lang.annotation.ElementType.TYPE;
/**
* Exists for documentation purposes
- * <p/>
+ *
* Event guidelines:
* - Fields should be final
* - Avoid logic