deltaspike git commit: improve JavaDoc

2018-09-07 Thread struberg 
Repository: deltaspike
Updated Branches:
  refs/heads/master 20ba0e9f7 -> 085918c6c


improve JavaDoc


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

Branch: refs/heads/master
Commit: 085918c6c75a99f18c8bdeb089f48e99b601f132
Parents: 20ba0e9
Author: Mark Struberg 
Authored: Fri Sep 7 13:12:51 2018 +0200
Committer: Mark Struberg 
Committed: Fri Sep 7 13:13:06 2018 +0200

--
 .../deltaspike/jpa/api/entitymanager/PersistenceUnitName.java| 4 
 1 file changed, 4 insertions(+)
--


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/085918c6/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/entitymanager/PersistenceUnitName.java
--
diff --git 
a/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/entitymanager/PersistenceUnitName.java
 
b/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/entitymanager/PersistenceUnitName.java
index 60d6625..dfcf0c9 100644
--- 
a/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/entitymanager/PersistenceUnitName.java
+++ 
b/deltaspike/modules/jpa/api/src/main/java/org/apache/deltaspike/jpa/api/entitymanager/PersistenceUnitName.java
@@ -33,6 +33,10 @@ import static java.lang.annotation.ElementType.TYPE;
 /**
  * The name of the PersistenceUnit to get picked up by the
  * EntityManagerFactoryProducer.
+ *
+ * The EntityManagerFactoryProducer will in turn use the
+ * {@link 
org.apache.deltaspike.jpa.spi.entitymanager.PersistenceConfigurationProvider}
+ * to pick up the properties to be used for creating the {@code 
}EntityManagerFactory}.
  */
 @Target( { TYPE, METHOD, PARAMETER, FIELD })
 @Retention(value = RetentionPolicy.RUNTIME)

[1/2] deltaspike git commit: improve JavaDoc for ConfigProvider

2018-06-05 Thread struberg 
Repository: deltaspike
Updated Branches:
  refs/heads/master 06c3b1445 -> bb5ee1e69


improve JavaDoc for ConfigProvider


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

Branch: refs/heads/master
Commit: b7a37792c09ebc2e85e0d9e5213cac9685b8208c
Parents: 06c3b14
Author: Mark Struberg 
Authored: Tue Jun 5 12:57:29 2018 +0200
Committer: Mark Struberg 
Committed: Tue Jun 5 12:57:29 2018 +0200

--
 .../core/api/config/ConfigResolver.java | 24 
 1 file changed, 24 insertions(+)
--


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/b7a37792/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
--
diff --git 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
index bd087fc..86a1674 100644
--- 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
+++ 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
@@ -639,12 +639,36 @@ public final class ConfigResolver
 }
 
 
+/**
+ * Provide access to the underlying {@link Config} instance.
+ *
+ */
 public interface ConfigProvider
 {
+/**
+ * Return either an existing Config associated with the current TCCL 
or a
+ * new Config and associate it with the TCCL.
+ *
+ * @return the Config associated with the current 
ThreadContextClassLoader
+ */
 Config getConfig();
 
+/**
+ * Return either an existing Config associated with the given 
ClassLoader or a
+ * new Config and associate it with the given ClassLoader.
+ *
+ * @return the Config associated with the given ClassLoader
+ */
 Config getConfig(ClassLoader cl);
 
+/**
+ * Release the Config associated with the given ClassLoader.
+ * This will also properly close all the ConfigSources, Converters, etc
+ * managed by this Config.
+ *
+ * ATTENTION: Usually this method doesn't need to be invoked manually!
+ *   It will automatically get invoked in BeforeShutdown via our 
ConfigExtension internally.
+ */
 void releaseConfig(ClassLoader cl);
 }

deltaspike git commit: improve JavaDoc for message categories

2015-11-19 Thread struberg 
Repository: deltaspike
Updated Branches:
  refs/heads/master d9e7eac3b -> a88e650f7


improve JavaDoc for message categories


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

Branch: refs/heads/master
Commit: a88e650f719f8ceb4edf41988ea71d1ad29a9321
Parents: d9e7eac
Author: Mark Struberg 
Authored: Thu Nov 19 08:56:16 2015 +0100
Committer: Mark Struberg 
Committed: Thu Nov 19 18:40:35 2015 +0100

--
 .../java/org/apache/deltaspike/core/api/message/Message.java| 5 +
 .../org/apache/deltaspike/core/api/message/MessageBundle.java   | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/a88e650f/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/Message.java
--
diff --git 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/Message.java
 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/Message.java
index 2e97d68..9d19119 100644
--- 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/Message.java
+++ 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/Message.java
@@ -87,6 +87,11 @@ public interface Message extends Serializable
  * message we will first search for a messageTemplate with the given 
category by just adding an underscore '_' and
  * the category String to the {@link #getTemplate()}. If no such template 
exists we will fall back to the version
  * without the category String.
+ * 
+ * DeltaSpike JSF messages e.g. distinguish between categories
+ * {@code summary} and {@code detail}
+ * to allow a short and a more detailed explanation in Error, Warn and 
Info popups at the same time.
+ * 
  */
 String toString(String category);
 

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/a88e650f/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
--
diff --git 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
index 889d5cb..9ab019e 100644
--- 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
+++ 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
@@ -68,7 +68,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
  * MessageBundle
  * MessageContextConfig(messageSource = "somepath/myownmessages")
  * 
- * 
+ *
  * 
  *
  *

deltaspike git commit: improve JavaDoc for MessageBundles

2015-11-09 Thread struberg 
Repository: deltaspike
Updated Branches:
  refs/heads/master 71e5ac29c -> da8320520


improve JavaDoc for MessageBundles


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

Branch: refs/heads/master
Commit: da83205205d0333a8ac4135b2a5ee48d0c20d208
Parents: 71e5ac2
Author: Mark Struberg 
Authored: Tue Nov 10 06:50:09 2015 +0100
Committer: Mark Struberg 
Committed: Tue Nov 10 06:50:09 2015 +0100

--
 .../deltaspike/core/api/message/MessageBundle.java | 13 -
 1 file changed, 12 insertions(+), 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/da832052/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
--
diff --git 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
index d531dd4..253676a 100644
--- 
a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
+++ 
b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/message/MessageBundle.java
@@ -55,10 +55,21 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
  * {@link 
org.apache.deltaspike.core.api.message.MessageContext#messageSource(String...)}.
 The fully qualified class
  * name of the interface annotated with MessageBundle will automatically 
be registered as additional
  * messageSource for those messages.
+ * 
+ * By default the Message Source is a resource bundle with the same name as 
the {@code MessageBundle}
+ * annotated interface, e.g. {@code com.acme.MyMessages_en.properties}.
+ * 
  *
  * 
  * MessageBundle can be combined with {@link 
MessageContextConfig} to further customize the
- * message resolution and processing.
+ * message resolution and processing. To use a different resourcebundle, e.g. 
{@code somepath/myownmessages_en.properties}
+ * you might write:
+ * 
+ * MessageBundle
+ * MessageContextConfig(messageSource = "somepath/myownmessages")
+ * 
+ * 
+ * 
  *
  * 
  * Debug hint: Set a breakpoint in 
MessageBundleInvocationHandler#invoke. This will get called for 
every