deltaspike-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From strub...@apache.org
Subject deltaspike git commit: improve JavaDoc for message categories
Date Thu, 19 Nov 2015 17:42:29 GMT
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 <struberg@apache.org>
Authored: Thu Nov 19 08:56:16 2015 +0100
Committer: Mark Struberg <struberg@apache.org>
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.
+     * <p>
+     * DeltaSpike JSF messages e.g. distinguish between categories
+     * {@code &quot;summary&quot;} and {@code &quot;detail&quot;}
+     * to allow a short and a more detailed explanation in Error, Warn and Info popups at
the same time.
+     * </p>
      */
     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;
  * &#064;MessageBundle
  * &#064;MessageContextConfig(messageSource = "somepath/myownmessages")
  * </pre>
- * 
+ *
  * </p>
  *
  * <p>


Mime
View raw message