You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2014/11/13 08:47:02 UTC
[2/2] isis git commit: Javadoc fixes in applib's annotations
Javadoc fixes in applib's annotations
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/d15cec10
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/d15cec10
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/d15cec10
Branch: refs/heads/master
Commit: d15cec100c4c9bf006e5118ad90c22ba90f7f917
Parents: 7c76632
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Wed Oct 1 15:22:07 2014 +0200
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Nov 13 07:46:38 2014 +0000
----------------------------------------------------------------------
.../org/apache/isis/applib/annotation/ActionInteraction.java | 2 +-
.../apache/isis/applib/annotation/CollectionInteraction.java | 2 +-
.../java/org/apache/isis/applib/annotation/Immutable.java | 4 ++--
.../java/org/apache/isis/applib/annotation/Mandatory.java | 2 +-
.../org/apache/isis/applib/annotation/MemberGroupLayout.java | 7 -------
.../apache/isis/applib/annotation/PropertyInteraction.java | 3 ++-
.../apache/isis/core/metamodel/facetapi/MethodRemover.java | 6 +++---
7 files changed, 10 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/ActionInteraction.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/ActionInteraction.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/ActionInteraction.java
index e8714e9..bd88d5e 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/ActionInteraction.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/ActionInteraction.java
@@ -27,7 +27,7 @@ import org.apache.isis.applib.services.eventbus.ActionInteractionEvent;
/**
* Indicates that a member is an action that should use a custom
- * (subclass of) {@link org.apache.isis.applib.services.eventbus.ActionInteractionEvent} to propogate the phases
+ * (subclass of) {@link org.apache.isis.applib.services.eventbus.ActionInteractionEvent} to propagate the phases
* of the interaction with collaborators over the registered
* {@link org.apache.isis.applib.services.eventbus.EventBusService}.
*
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/CollectionInteraction.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/CollectionInteraction.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/CollectionInteraction.java
index e0f7934..f59e3d4 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/CollectionInteraction.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/CollectionInteraction.java
@@ -27,7 +27,7 @@ import org.apache.isis.applib.services.eventbus.CollectionInteractionEvent;
/**
* Indicates that a member is (the accessor of) a collection that should use a custom (subclass of)
- * {@link org.apache.isis.applib.services.eventbus.CollectionInteractionEvent} to propogate the phases of the
+ * {@link org.apache.isis.applib.services.eventbus.CollectionInteractionEvent} to propagate the phases of the
* interaction with collaborators over the registered {@link org.apache.isis.applib.services.eventbus.EventBusService}.
*
* <p>For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/Immutable.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/Immutable.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/Immutable.java
index c892fa2..fae878d 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/Immutable.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/Immutable.java
@@ -29,9 +29,9 @@ import java.lang.annotation.Target;
* Indicates that an instance cannot be changed.
*
* <p>
- * To make something always immutable used the form <tt>@Immutable</tt>. To make
+ * To make something always immutable use the form <tt>@Immutable</tt>. To make
* something immutable only once persisted use the form
- * <tt>@Immutable(Immutable.ONCE_PERSISTED)</tt>.
+ * <tt>@Immutable(When.ONCE_PERSISTED)</tt>.
*
* <p>
* By default any {@link Value value} types are assumed to be immutable, though
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/Mandatory.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/Mandatory.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/Mandatory.java
index 3d701a2..2f0aebd 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/Mandatory.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/Mandatory.java
@@ -44,7 +44,7 @@ import java.lang.annotation.Target;
* annotation, so that Isis can apply the constraint even though the objectstore
* is unable to do so.
*
- * @see Optional
+ * @see Optional
*/
@Inherited
@Target({ ElementType.METHOD })
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/MemberGroupLayout.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/MemberGroupLayout.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/MemberGroupLayout.java
index 87d17cb..9434938 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/MemberGroupLayout.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/MemberGroupLayout.java
@@ -24,19 +24,12 @@ import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import java.util.ArrayList;
-import java.util.Arrays;
import java.util.List;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
import com.google.common.base.Function;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
-import org.apache.isis.applib.annotation.MemberGroupLayout.ColumnSpans;
-
/**
* A successor to {@link MemberGroups}, specifying the (groups of) members in a page,
* column by column.
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/applib/src/main/java/org/apache/isis/applib/annotation/PropertyInteraction.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/PropertyInteraction.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/PropertyInteraction.java
index f99f768..d1a9b4d 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/PropertyInteraction.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/PropertyInteraction.java
@@ -27,7 +27,7 @@ import org.apache.isis.applib.services.eventbus.PropertyInteractionEvent;
/**
* Indicates that a member is (the accessor of) a property that should use a custom (subclass of)
- * {@link org.apache.isis.applib.services.eventbus.PropertyInteractionEvent} to propogate the phases of the
+ * {@link org.apache.isis.applib.services.eventbus.PropertyInteractionEvent} to propagate the phases of the
* interaction with collaborators over the registered {@link org.apache.isis.applib.services.eventbus.EventBusService}.
* Applies only to properties; any changes should be propagated as events to subscribers.
@@ -47,6 +47,7 @@ import org.apache.isis.applib.services.eventbus.PropertyInteractionEvent;
* load them using a repository, and then to delegate to the event to them.
*
* @see org.apache.isis.applib.annotation.PostsPropertyChangedEvent
+ * @see com.google.common.eventbus.Subscribe
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
http://git-wip-us.apache.org/repos/asf/isis/blob/d15cec10/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facetapi/MethodRemover.java
----------------------------------------------------------------------
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facetapi/MethodRemover.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facetapi/MethodRemover.java
index 58effa5..365e2c5 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facetapi/MethodRemover.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facetapi/MethodRemover.java
@@ -46,9 +46,9 @@ public interface MethodRemover {
* that match the criteria and remove them from the implementation's list so
* that they are not considered for subsequent scans.
*
- * @param forClass
- * - if <tt>true</tt>, then looking for <tt>static</tt> methods
- * (otherwise instance methods).
+ * @param methodScope
+ * - whether looking for <tt>static</tt> (class) or
+ * instance-level methods.
*/
void removeMethod(MethodScope methodScope, String methodName, Class<?> returnType, Class<?>[] parameterTypes);