Repository: wicket
Updated Branches:
  refs/heads/master 09bb69a91 -> dc859a546


WICKET-5652 Improve Javadoc of Ajax behaviors concerning their onXyz() methods

(cherry picked from commit 56f8c4ca0d0dd52b9d61d48aa1ec699b129d103c)


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

Branch: refs/heads/master
Commit: dc859a546ba68a47bb7be2a3e05dc411b394fd99
Parents: 09bb69a
Author: Martin Tzvetanov Grigorov <[email protected]>
Authored: Mon Aug 4 16:38:10 2014 +0200
Committer: Martin Tzvetanov Grigorov <[email protected]>
Committed: Mon Aug 4 16:40:10 2014 +0200

----------------------------------------------------------------------
 .../java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java  | 3 ++-
 .../java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java     | 2 ++
 .../src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java | 1 +
 .../org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java  | 1 +
 .../org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java   | 3 ++-
 .../ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java      | 5 ++++-
 .../wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java     | 2 ++
 .../org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java     | 3 +++
 .../org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java | 4 +++-
 .../java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java  | 3 ++-
 10 files changed, 22 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java
index 5ecf56e..307c8ba 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AbstractAjaxTimerBehavior.java
@@ -28,7 +28,8 @@ import org.apache.wicket.util.time.Duration;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
- * 
+ * @see #onTimer(AjaxRequestTarget)
+ * @see #onRestart(AjaxRequestTarget)
  */
 public abstract class AbstractAjaxTimerBehavior extends 
AbstractDefaultAjaxBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java
index c106d72..015f59f 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxClientInfoBehavior.java
@@ -32,6 +32,8 @@ import org.apache.wicket.util.time.Duration;
 /**
  * An behavior that collects the information to populate
  * WebClientInfo's ClientProperties by using Ajax
+ *
+ * @see #onClientInfo(AjaxRequestTarget, 
org.apache.wicket.protocol.http.request.WebClientInfo)
  */
 public class AjaxClientInfoBehavior extends AbstractAjaxTimerBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java
index 0cee432..76ffee2 100644
--- a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java
+++ b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxEventBehavior.java
@@ -45,6 +45,7 @@ import org.apache.wicket.util.lang.Args;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
+ * @see #onEvent(AjaxRequestTarget)
  */
 public abstract class AjaxEventBehavior extends AbstractDefaultAjaxBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
index ae8ea0a..79494af 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
@@ -34,6 +34,7 @@ import org.apache.wicket.util.string.StringValue;
  * Note: this behavior may be assigned only to an instance of a WebPage class.
  *
  * @since 6.0
+ * @see #onNewWindow(AjaxRequestTarget)
  */
 public abstract class AjaxNewWindowNotifyingBehavior extends 
AbstractDefaultAjaxBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java
index 0a7552e..595345e 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxSelfUpdatingTimerBehavior.java
@@ -24,7 +24,8 @@ import org.apache.wicket.util.time.Duration;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
- * 
+ * @see #onTimer(AjaxRequestTarget)
+ * @see #onPostProcessTarget(AjaxRequestTarget)
  */
 public class AjaxSelfUpdatingTimerBehavior extends AbstractAjaxTimerBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java
index 1017c46..feaa75c 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormChoiceComponentUpdatingBehavior.java
@@ -37,7 +37,10 @@ import org.apache.wicket.request.resource.ResourceReference;
  * Use the normal {@link AjaxFormComponentUpdatingBehavior} for the normal 
single component fields
  * 
  * @author jcompagner
- * 
+ * @author svenmeier
+ *
+ * @see 
org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior#onUpdate(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see 
org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior#onError(org.apache.wicket.ajax.AjaxRequestTarget,
 RuntimeException)
  * @see RadioChoice
  * @see CheckBoxMultipleChoice
  * @see RadioGroup

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
index 934604b..82777c5 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
@@ -43,6 +43,8 @@ import org.slf4j.LoggerFactory;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
+ * @see #onUpdate(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see #onError(org.apache.wicket.ajax.AjaxRequestTarget, RuntimeException)
  */
 public abstract class AjaxFormComponentUpdatingBehavior extends 
AjaxEventBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java
index bebe85d..1ad09cb 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormSubmitBehavior.java
@@ -36,6 +36,9 @@ import 
org.apache.wicket.markup.html.form.IFormSubmittingComponent;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
+ * @see #onSubmit(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see #onAfterSubmit(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see #onError(org.apache.wicket.ajax.AjaxRequestTarget)
  */
 public abstract class AjaxFormSubmitBehavior extends AjaxEventBehavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java
index 5ecee13..9137f79 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormValidatingBehavior.java
@@ -39,7 +39,9 @@ import org.apache.wicket.util.visit.IVisitor;
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
- * 
+ * @see #onSubmit(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see #onAfterSubmit(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see #onError(org.apache.wicket.ajax.AjaxRequestTarget)
  */
 public class AjaxFormValidatingBehavior extends Behavior
 {

http://git-wip-us.apache.org/repos/asf/wicket/blob/dc859a54/wicket-core/src/main/java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java
----------------------------------------------------------------------
diff --git 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java
 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java
index 863eded..f363cd8 100644
--- 
a/wicket-core/src/main/java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java
+++ 
b/wicket-core/src/main/java/org/apache/wicket/ajax/form/OnChangeAjaxBehavior.java
@@ -35,7 +35,8 @@ import org.apache.wicket.markup.html.form.TextField;
  * @author Janne Hietam&auml;ki (janne)
  * 
  * @since 1.3
- * @see AjaxFormComponentUpdatingBehavior
+ * @see 
org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior#onUpdate(org.apache.wicket.ajax.AjaxRequestTarget)
+ * @see 
org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior#onError(org.apache.wicket.ajax.AjaxRequestTarget,
 RuntimeException)
  */
 public abstract class OnChangeAjaxBehavior extends 
AjaxFormComponentUpdatingBehavior
 {

Reply via email to