tapestry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hls...@apache.org
Subject [1/2] git commit: Improve some documentation
Date Tue, 04 Jun 2013 00:50:55 GMT
Updated Branches:
  refs/heads/master fe478d686 -> 85284b2b1


Improve some documentation


Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/99a1d81a
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/99a1d81a
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/99a1d81a

Branch: refs/heads/master
Commit: 99a1d81a6c51bd51b3dc3776e39a11b1e3bc3b05
Parents: fe478d6
Author: Howard M. Lewis Ship <hlship@apache.org>
Authored: Mon Jun 3 16:56:35 2013 -0700
Committer: Howard M. Lewis Ship <hlship@apache.org>
Committed: Mon Jun 3 16:56:35 2013 -0700

----------------------------------------------------------------------
 .../services/javascript/Initialization.java        |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/99a1d81a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java
b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java
index b201de8..64cb880 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/javascript/Initialization.java
@@ -24,8 +24,8 @@ public interface Initialization
 {
 
     /**
-     * Specifies the function to invoke.  If not invoked, then the module is expected to
export
-     * just a single function.
+     * Specifies the function to invoke.  If this method is not invoked, then the module
is expected to export
+     * just a single function (which may, or may not, take {@linkplain #with(Object...) parameters}).
      *
      * @param functionName
      *         name of a function exported by the module.
@@ -35,6 +35,8 @@ public interface Initialization
 
     /**
      * Changes the initialization priority of the initialization from its default, {@link
InitializationPriority#NORMAL}.
+     * <p/>
+     * Note: it is possible that this method may be removed before release 5.4 is final.
      *
      * @param priority
      *         new priority
@@ -43,7 +45,7 @@ public interface Initialization
     Initialization priority(InitializationPriority priority);
 
     /**
-     * Specifies the arguments to be passed to the function. Normally, just a single {@link
org.apache.tapestry5.json.JSONObject}
+     * Specifies the arguments to be passed to the function. Often, just a single {@link
org.apache.tapestry5.json.JSONObject}
      * is passed. When multiple Initializations exist with the same function name (or no
function name), and no arguments,
      * they are coalesced into a single Initialization: it is assumed that an initialization
with no parameters needs to
      * only be invoked once.


Mime
View raw message