myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From we...@apache.org
Subject svn commit: r1164112 [1/2] - in /myfaces/core/trunk/api: ./ src/assembler/ src/main/javascript/META-INF/resources/myfaces/_impl/_util/ src/main/javascript/META-INF/resources/myfaces/_impl/core/ src/main/javascript/META-INF/resources/myfaces/_impl/i18n/...
Date Thu, 01 Sep 2011 15:30:54 GMT
Author: werpu
Date: Thu Sep  1 15:30:53 2011
New Revision: 1164112

URL: http://svn.apache.org/viewvc?rev=1164112&view=rev
Log:
https://issues.apache.org/jira/browse/MYFACES-3292
merging the jsdocs in the javascript files
adding the plugin reference for the jsdocs
adding the jsdoc compiler assembly file



Added:
    myfaces/core/trunk/api/src/assembler/jsdoc-compiler.xml
Modified:
    myfaces/core/trunk/api/pom.xml
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Dom.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_HtmlStripper.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Lang.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_ListenerQueue.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Queue.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/Impl.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/_Runtime.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_de.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_es.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_fr.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_it.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_nl.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_ru.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxRequest.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxResponse.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxUtils.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_BaseRequest.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_FinalizeableObj.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_IFrameRequest.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_Transports.js
    myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/api/jsf.js

Modified: myfaces/core/trunk/api/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/pom.xml?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/pom.xml (original)
+++ myfaces/core/trunk/api/pom.xml Thu Sep  1 15:30:53 2011
@@ -437,6 +437,35 @@
             </pluginRepositories>
         </profile>
 
+        <!--
+            this optional profile generates the jsdoc content from
+            the embedded javascripts
+        -->
+
+        <profile>
+            <id>generateJsDoc</id>
+            <build>
+              <plugins>
+                    <plugin>
+                        <groupId>org.apache.myfaces.buildtools</groupId>
+                        <artifactId>myfaces-jsdoc-plugin</artifactId>
+                        <version>1.0-SNAPSHOT</version>
+
+                        <executions>
+                            <execution>
+                                <phase>generate-resources</phase>
+                                <goals>
+                                    <goal>jsdoc</goal>
+                                </goals>
+                            </execution>
+
+                        </executions>
+
+                    </plugin>
+               </plugins>
+            </build>
+        </profile>
+
     </profiles>
 
     

Added: myfaces/core/trunk/api/src/assembler/jsdoc-compiler.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/assembler/jsdoc-compiler.xml?rev=1164112&view=auto
==============================================================================
--- myfaces/core/trunk/api/src/assembler/jsdoc-compiler.xml (added)
+++ myfaces/core/trunk/api/src/assembler/jsdoc-compiler.xml Thu Sep  1 15:30:53 2011
@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<includes>
+    <include>**/api/jsf.js</include>
+    <include>**/_impl/core/_Runtime.js</include>
+    <include>**/_impl/i18n/Messages.js</include>
+    <include>**/_impl/i18n/Messages_de.js</include>
+    <include>**/_impl/i18n/Messages_es.js</include>
+    <include>**/_impl/i18n/Messages_fr.js</include>
+    <include>**/_impl/i18n/Messages_it.js</include>
+    <include>**/_impl/i18n/Messages_nl.js</include>
+    <include>**/_impl/i18n/Messages_ru.js</include>
+
+
+    <include>**/_impl/_util/_Lang.js</include>
+    <include>**/_impl/_util/_Dom.js</include>
+    <include>**/_impl/_util/_Queue.js</include>
+    <include>**/_impl/_util/_ListenerQueue.js</include>
+    <include>**/_impl/_util/_HtmlStripper.js</include>
+
+
+    <include>**/_impl/xhrCore/_FinalizeableObj.js</include>
+    <include>**/_impl/xhrCore/_AjaxUtils.js</include>
+    <include>**/_impl/xhrCore/_AjaxRequestQueue.js</include>
+    <include>**/_impl/xhrCore/_BaseRequest.js</include>
+    <include>**/_impl/xhrCore/_AjaxRequest.js</include>
+
+    <!-- this is pure 2.1 functionality -->
+    <include>**/_impl/xhrCore/_IFrameRequest.js</include>
+
+    <include>**/_impl/xhrCore/_AjaxResponse.js</include>
+    <include>**/_impl/xhrCore/_Transports.js</include>
+    <include>**/_impl/core/Impl.js</include>
+
+</includes>

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Dom.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Dom.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Dom.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Dom.js Thu Sep  1 15:30:53 2011
@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
-
 /**
- * A collection of dom helper routines
+ * @class
+ * @name _Dom
+ * @memberOf myfaces._impl._util
+ * @extends myfaces._impl.core._Runtime
+ * @description Object singleton collection of dom helper routines
  * (which in later incarnations will
  * get browser specific speed optimizations)
  *
@@ -25,20 +28,12 @@
  * the parts which our impl uses.
  * A jquery like query API would be nice
  * but this would blow up our codebase significantly
- *
- * TODO we have to split this class and make it more oo
- * with a node and nodelist class which then can be utilized
- * by the other parts of the system
- *
  */
-/** @namespace myfaces._impl._util._Dom */
-
-/** @namespace NodeFilter */
-/** @namespace NodeFilter.FILTER_ACCEPT */
-/** @namespace NodeFilter.FILTER_SKIP */
-/** @namespace NodeFilter.FILTER_REJECT */
-/** @namespace NodeFilter.SHOW_ELEMENT */
-myfaces._impl.core._Runtime.singletonExtendClass("myfaces._impl._util._Dom", Object, {
+myfaces._impl.core._Runtime.singletonExtendClass("myfaces._impl._util._Dom", Object,
+/**
+ * @lends myfaces._impl._util._Dom.prototype
+ */
+{
     IE_QUIRKS_EVENTS : {
         "onabort": true,
         "onload":true,
@@ -63,18 +58,21 @@ myfaces._impl.core._Runtime.singletonExt
 
     /*table elements which are used in various parts */
     TABLE_ELEMS:  {
-            "thead": true,
-            "tbody": true,
-            "tr": true,
-            "th": true,
-            "td": true,
-            "tfoot" : true
+        "thead": true,
+        "tbody": true,
+        "tr": true,
+        "th": true,
+        "td": true,
+        "tfoot" : true
     },
 
     _Lang:  myfaces._impl._util._Lang,
     _RT:    myfaces._impl.core._Runtime,
     _dummyPlaceHolder:null,
 
+    /**
+     * standard constructor
+     */
     constructor_: function() {
         //we have to trigger it upfront because mozilla runs the eval
         //after the dom updates and hence causes a race conditon if used on demand
@@ -105,7 +103,7 @@ myfaces._impl.core._Runtime.singletonExt
     /**
      * Run through the given Html item and execute the inline scripts
      * (IE doesn't do this by itself)
-     * @param {|Node|} item
+     * @param {Node} item
      */
     runScripts: function(item, xmlData) {
         var finalScripts    = [];
@@ -179,7 +177,7 @@ myfaces._impl.core._Runtime.singletonExt
      * determines to fetch a node
      * from its id or name, the name case
      * only works if the element is unique in its name
-     * @param elem
+     * @param {String} elem
      */
     byIdOrName: function(elem) {
         if(!this._Lang.isString(elem)) return elem;
@@ -317,8 +315,13 @@ myfaces._impl.core._Runtime.singletonExt
         this._removeNode(item, false);
         return null;
     },
-
-     detach: function(items) {
+    /**
+     * detchaes a set of nodes from their parent elements
+     * in a browser independend manner
+     * @param {Nodelist} items the items which need to be detached
+     * @return {Array} an array of nodes with the detached dom nodes
+     */
+    detach: function(items) {
         var ret = [];
         if('undefined' != typeof items.nodeType) {
             if(items.parentNode) {
@@ -328,8 +331,8 @@ myfaces._impl.core._Runtime.singletonExt
             }
             return ret;
         }
-
-
+        //all ies treat node lists not as arrays so we have to take
+        //an intermediate step
         var items = this._Lang.objToArray(items);
         for(var cnt = 0; cnt < items.length; cnt++) {
             ret.push(items[cnt].parentNode.removeChild(items[cnt]));
@@ -509,7 +512,7 @@ myfaces._impl.core._Runtime.singletonExt
         for (var cnt = 0; cnt < depth; cnt++) {
             evalNodes = evalNodes.childNodes[0];
         }
-        var ret = (evalNodes.parentNode) ? this.detach( evalNodes.parentNode.childNodes) : null;
+        var ret = (evalNodes.parentNode) ? this.detach(evalNodes.parentNode.childNodes) : null;
 
         if ('undefined' == typeof evalNodes || null == evalNodes) {
             //fallback for htmlunit which should be good enough
@@ -1545,7 +1548,20 @@ myfaces._impl.core._Runtime.singletonExt
         }
 
         return this._dummyPlaceHolder;
+    },
+
+    /**
+     * fetches the window id for the current request
+     * note, this is a preparation method for jsf 2.2
+     */
+    getWindowId: function() {
+        var href = window.location.href;
+        var windowId = "windowId";
+        var regex = new RegExp("[\\?&]" + windowId + "=([^&#\\;]*)");
+        var results = regex.exec(href);
+        return (results != null) ? results[1] : null;
     }
+
 });
 
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_HtmlStripper.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_HtmlStripper.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_HtmlStripper.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_HtmlStripper.js Thu Sep  1 15:30:53 2011
@@ -15,17 +15,28 @@
 */
 
 /**
- * <p>
+ * @class
+ * @name _HtmlStripper
+ * @memberOf myfaces._impl._util
+ * @extends myfaces._impl.core._Runtime
+ * @description
  *  Fallback routine if the browser embedded xml parser fails on the document
  *  This fallback is not failsafe but should give enough cover to handle all cases
- * </p>
  */
 
 /** @namespace myfaces._impl._util._HtmlStripper */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._HtmlStripper", Object, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._HtmlStripper", Object,
+/** @lends myfaces._impl._util._HtmlStripper.prototype */
+{
     BEGIN_TAG: "html",
     END_TAG: "lmth",
-
+    /**
+     * main parse routine parses the document for a given tag name
+     *
+     *
+     * @param theString  the markup string to be parsed
+     * @param tagNameStart the tag name to be parsed for
+     */
     parse : function(theString, tagNameStart) {
         this.tokens = theString.split("");
         this.tagAttributes = {};

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Lang.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Lang.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Lang.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Lang.js Thu Sep  1 15:30:53 2011
@@ -27,10 +27,30 @@
  space is not worth the loss of readability
  */
 
-//Intellij Warnings settings
-/** @namespace myfaces._impl._util._Lang */
-/** @namespace window.console */
-myfaces._impl.core._Runtime.singletonDelegateObj("myfaces._impl._util._Lang", myfaces._impl.core._Runtime, {
+
+/**
+ * @memberOf myfaces._impl
+ * @namespace
+ * @name _util
+ */
+(myfaces._impl._util) ? myfaces._impl._util: {};
+
+
+
+/**
+ * @class
+ * @name _Lang
+ * @memberOf myfaces._impl._util
+ * @extends myfaces._impl.core._Runtime
+ * @description Object singleton for Language related methods, this object singleton
+ * decorates the namespace myfaces._impl.core._Runtime and adds a bunch of new methods to
+ * what _Runtime provided
+ * */
+var _Lang = myfaces._impl.core._Runtime.singletonDelegateObj("myfaces._impl._util._Lang", myfaces._impl.core._Runtime,
+        /**
+         * @lends myfaces._impl._util._Lang.prototype
+         */
+        {
 
     _processedExceptions: {},
 
@@ -846,5 +866,4 @@ myfaces._impl.core._Runtime.singletonDel
 
         return bufInstance;
     }
-})
-        ;
+});

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_ListenerQueue.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_ListenerQueue.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_ListenerQueue.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_ListenerQueue.js Thu Sep  1 15:30:53 2011
@@ -20,18 +20,23 @@
 
 
 
-
 /**
- * Simple listener queue with closures which shall be
- * called
- *
- * idea:
- * var queue = new myfaces._impl._util._ListenerQueue();
+ * @class
+ * @name _ListenerQueue
+ * @extends myfaces._impl._util._Queue
+ * @memberOf myfaces._impl._util
+ * @description Implementation of the listener queue for jsf.js
+ * <p>It is based upon our high performance queue and adds dedicated
+ * methods for listener based closures to the mix </p>
+ * */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._ListenerQueue", myfaces._impl._util._Queue,
+/**
+ * @lends myfaces._impl._util._ListenerQueue.prototype
  */
-
-/** @namespace myfaces._impl._util._ListenerQueue */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._ListenerQueue", myfaces._impl._util._Queue, {
-
+{
+    /**
+     * standard constructor
+     */
     constructor_: function() {
         this._callSuper("constructor");
     },
@@ -39,9 +44,9 @@ myfaces._impl.core._Runtime.extendClass(
     /**
      * listener type safety assertion function
      *
-     * @param listener must be of type function otherwise an error is raised
+     * @param {function} listener must be of type function otherwise an error is raised
      */
-    _assertListener : function(/*function*/listener) {
+    _assertListener : function( listener) {
         if ("function" != typeof (listener)) {
             var msg = myfaces._impl._util._Lang.getMessage("ERR_PARAM_GENERIC",null,"_ListenerQueue", arguments.caller.toString(),"function" );
             throw Error(msg);
@@ -51,9 +56,9 @@ myfaces._impl.core._Runtime.extendClass(
     /**
      * adds a listener to the queue
      *
-     * @param listener the listener to be added
+     * @param {function} listener the listener to be added
      */
-    enqueue : function(/*function*/listener) {
+    enqueue : function(listener) {
         this._assertListener(listener);
         this._callSuper("enqueue", listener);
     },
@@ -61,17 +66,18 @@ myfaces._impl.core._Runtime.extendClass(
     /**
      * removes a listener form the queue
      *
-     * @param listener the listener to be removed
+     * @param {function} listener the listener to be removed
      */
-    remove : function(/*function*/listener) {
+    remove : function(listener) {
         this._assertListener(listener);
         this._callSuper("remove", listener);
     },
 
     /**
      * generic broadcast with a number of arguments being passed down
+     * @param {Object} argument, the arguments passed down which are broadcast
      */
-    broadcastEvent : function(/*any*/argument) {
+    broadcastEvent : function(argument) {
         var _Lang = myfaces._impl._util._Lang;
         var _args = _Lang.objToArray(arguments);
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Queue.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Queue.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Queue.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/_util/_Queue.js Thu Sep  1 15:30:53 2011
@@ -14,8 +14,19 @@
  * limitations under the License.
  */
 
-/** @namespace myfaces._impl._util._Queue */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._Queue", Object, {
+/**
+ * @class
+ * @name _Queue
+ * @memberOf myfaces._impl._util
+ * @description Queue implementation used by our runtime system
+ * improved version of
+ * @see <a href="http://safalra.com/web-design/javascript/queues/Queue.js">http://safalra.com/web-design/javascript/queues/Queue.js</a>
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl._util._Queue", Object,
+  /**
+   * @lends myfaces._impl._util._Queue.prototype
+   */
+{
     //faster queue by http://safalra.com/web-design/javascript/queues/Queue.js
     //license public domain
     //The trick is to simply reduce the number of slice and slice ops to a bare minimum.
@@ -24,22 +35,37 @@ myfaces._impl.core._Runtime.extendClass(
     _space : 0,
     _size: -1,
 
+    /**
+     * Standard constructor
+     */
     constructor_: function() {
         this._q = [];
         this._Lang = myfaces._impl._util._Lang;
     },
 
+    /**
+     * @return the length of the queue as integer
+     */
     length: function() {
         // return the number of elements in the queue
         return this._q.length - this._space;
 
     },
 
+    /**
+     * @return true if the current queue is empty false otherwise
+     */
     isEmpty: function() {
         // return true if the queue is empty, and false otherwise
         return (this._q.length == 0);
     },
 
+    /**
+     * Sets the current queue to a new size, all overflow elements at the end are stripped
+     * automatically
+     *
+     * @param {int} newSize as numeric value
+     */
     setQueueSize: function(newSize) {
         this._size = newSize;
         this._readjust();
@@ -80,6 +106,10 @@ myfaces._impl.core._Runtime.extendClass(
         }
     },
 
+    /**
+     * dequeues the last element in the queue
+     * @return {Object} element which is dequeued
+     */
     dequeue: function() {
         // initialise the element to return to be undefined
         var element = null;
@@ -117,6 +147,10 @@ myfaces._impl.core._Runtime.extendClass(
      * simple foreach
      *
      * @param closure a closure which processes the element
+     * @code
+     *   queue.each(function(element) {
+     *      //do something with the element
+     *   });
      */
     each: function(closure) {
         this._Lang.arrForEach(this._q, closure, this._space);
@@ -134,10 +168,17 @@ myfaces._impl.core._Runtime.extendClass(
         return this._Lang.arrFilter(this._q, closure, this._space);
     },
 
+    /**
+     * @param element
+     * @return the current index of the element in the queue or -1 if it is not found
+     */
     indexOf: function(element) {
         return this._Lang.arrIndexOf(this._q, element);
     },
 
+    /**
+     * resets the queue to initial empty state
+     */
     cleanup: function() {
         this._q = [];
         this._space = 0;

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/Impl.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/Impl.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/Impl.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/Impl.js Thu Sep  1 15:30:53 2011
@@ -14,9 +14,18 @@
  * limitations under the License.
  */
 
-/** @namespace myfaces._impl.core.Impl*/
-/** @namespace myfaces._impl._util._ListenerQueue */
-myfaces._impl.core._Runtime.singletonExtendClass("myfaces._impl.core.Impl", Object, {
+/**
+ * @class
+ * @name Impl
+ * @memberOf myfaces._impl.core
+ * @description Implementation singleton which implements all interface method
+ * defined by our jsf.js API
+ * */
+myfaces._impl.core._Runtime.singletonExtendClass("myfaces._impl.core.Impl", Object,
+/**
+ * @lends myfaces._impl.core.Impl.prototype
+ */
+{
 
     //third option myfaces._impl.xhrCoreAjax which will be the new core impl for now
     _transport      : new (myfaces._impl.core._Runtime.getGlobalConfig("transport", myfaces._impl.xhrCore._Transports))(),
@@ -148,6 +157,16 @@ myfaces._impl.core._Runtime.singletonExt
         //options not set we define a default one with nothing
         options = options || {};
 
+		/*preparations for jsf 2.2 windowid handling*/
+        //pass the window id into the options if not set already
+        if(!options.windowId) {
+            var windowId = _Dom.getWindowId();
+            (windowId) ? options["javax.faces.windowId"] = windowId: null;
+        } else {
+            options["javax.faces.windowId"] = options.windowId;
+            delete options.windowId;
+        }
+
         /**
          * we cross reference statically hence the mapping here
          * the entire mapping between the functions is stateless
@@ -280,9 +299,9 @@ myfaces._impl.core._Runtime.singletonExt
      * determines the transport type to be called
      * for the ajax call
      *
-     * @param context
-     * @param passThrgh
-     * @param form
+     * @param context the context
+     * @param passThrgh  pass through values
+     * @param form the form which issues the request
      */
     _getTransportType: function(context, passThrgh, form) {
         /**

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/_Runtime.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/_Runtime.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/_Runtime.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/core/_Runtime.js Thu Sep  1 15:30:53 2011
@@ -34,32 +34,79 @@
  */
 /** @namespace myfaces._impl.core._Runtime*/
 
-(!window.myfaces) ? window.myfaces = {} : null;
-(!myfaces._impl) ? myfaces._impl = {} : null;
-(!myfaces._impl.core) ? myfaces._impl.core = {} : null;
+/**
+* @namespace
+* @name window
+* @description supplimental window methods.
+*/
+
+
+
+if(!window.myfaces) {
+    /**
+     * @namespace
+     * @name myfaces
+     */
+    var myfaces = new function() {};
+    window.myfaces = myfaces;
+}
+
+
+
+/**
+* @memberOf myfaces
+* @namespace
+* @name _impl
+*/
+myfaces._impl = (myfaces._impl) ? myfaces._impl : {};
+/**
+ * @memberOf myfaces._impl
+ * @namespace
+ * @name core
+ */
+myfaces._impl.core = (myfaces._impl.core) ? myfaces._impl.core : {};
 //now this is the only time we have to do this cascaded and manually
 //for the rest of the classes our reserveNamespace function will do the trick
 //Note, this class uses the classical closure approach (to save code)
 //it cannot be inherited by our inheritance mechanism, but must be delegated
 //if you want to derive from it
 //closures and prototype inheritance do not mix, closures and delegation however do
+/**
+ * @ignore
+ */
 if (!myfaces._impl.core._Runtime) {
+    /**
+     * @memberOf myfaces._impl.core
+     * @namespace
+     * @name _Runtime
+     */
     myfaces._impl.core._Runtime = new function() {
         //the rest of the namespaces can be handled by our namespace feature
         //helper to avoid unneeded hitches
+        /**
+         * @borrows myfaces._impl.core._Runtime as _T
+         */
         var _T = this;
 
         //namespace idx to speed things up by hitting eval way less
-        _T._reservedNMS = {};
+        this._reservedNMS = {};
 
         /**
          * replacement counter for plugin classes
          */
-        _T._classReplacementCnt = 0;
+        this._classReplacementCnt = 0;
 
         /*cascaded eval methods depending upon the browser*/
 
-        /*legacy browser IE*/
+        /**
+         * @function
+         * @param code
+
+         *
+         * evals a script globally using exec script (ie6 fallback)
+         * @param {String} code the code which has to be evaluated
+         * @borrows myfaces._impl.core._Runtime as _T
+         */
         _T._evalExecScript = function(code) {
             //execScript definitely only for IE otherwise we might have a custom
             //window extension with undefined behavior on our necks
@@ -78,7 +125,8 @@ if (!myfaces._impl.core._Runtime) {
          * but seems to be the only method which works on blackberry correctly
          * hence we are going to use it as fallback
          *
-         * @param code the code part to be evaled
+         * @param {String} code the code part to be evaled
+         * @borrows myfaces._impl.core._Runtime as _T
          */
         _T._evalBBOld = function(code) {
             var location = document.getElementsByTagName("head")[0] || document.documentElement;
@@ -90,6 +138,11 @@ if (!myfaces._impl.core._Runtime) {
             return null;
         };
 
+        /**
+         * @name myfaces._impl.core._Runtime._standardGlobalEval
+         * @private
+         * @param {String} code
+         */
         _T._standardGlobalEval = function(code) {
             //fix which works in a cross browser way
             //we used to scope an anonymous function
@@ -110,16 +163,9 @@ if (!myfaces._impl.core._Runtime) {
 
         /**
          * global eval on scripts
-         *
-         * usage return _T.globalEval('myvar.myvar2;');
-         *
-         *
-         * Note some libraries like jquery use html head attachments
-         * to run the global eval, at least for loaded scripts
-         * this methid was flaky and failed on chrome under certain conditions,
-         * since our method works reliably in modern browsers currently in use
-         * we do it via eval, we still can switch to the head method
-         * if there are arguments why that one works better than ours
+         * @param {String} code
+         * @name myfaces._impl.core._Runtime.globalEval
+         * @function
          */
         _T.globalEval = function(code) {
             //TODO add a config param which allows to evaluate global scripts even if the call
@@ -147,8 +193,10 @@ if (!myfaces._impl.core._Runtime) {
          * myNameSpace = obj because the result of fetch is already the object
          * which the namespace points to, hence this function
          *
-         * @param nms the namespace to be assigned to
-         * @param obj the  object to be assigned
+         * @param {String} nms the namespace to be assigned to
+         * @param {Any} obj the  object to be assigned
+         * @name myfaces._impl.core._Runtime.applyToGlobalNamespace
+         * @function
          */
         _T.applyToGlobalNamespace = function(nms, obj) {
             var splitted = nms.split(/\./);
@@ -164,10 +212,10 @@ if (!myfaces._impl.core._Runtime) {
 
         /**
          * fetches the object the namespace points to
-         * @param nms the namespace which has to be fetched
+         * @param {String} nms the namespace which has to be fetched
          * @return the object the namespace points to or null if nothing is found
          */
-        _T.fetchNamespace = function(nms) {
+        this.fetchNamespace = function(nms) {
             if ('undefined' == typeof nms || null == nms || !_T._reservedNMS[nms]) {
                 return null;
             }
@@ -208,10 +256,10 @@ if (!myfaces._impl.core._Runtime) {
          * Backported from dojo
          * a failsafe string determination method
          * (since in javascript String != "" typeof alone fails!)
-         * @param it {|Object|} the object to be checked for being a string
-         * @return true in case of being a string false otherwise
+         * @param {Object} it  the object to be checked for being a string
+         * @return {boolean} true in case of being a string false otherwise
          */
-        _T.isString = function(/*anything*/ it) {
+        this.isString = function(/*anything*/ it) {
             //	summary:
             //		Return true if it is a String
             return !!arguments.length && it != null && (typeof it == "string" || it instanceof String); // Boolean
@@ -241,11 +289,11 @@ if (!myfaces._impl.core._Runtime) {
          * complexity while a simple map lookup is (O)log n with additional speedup from the engine.
          *
          *
-         * @param {|String|} nms
-         * @returns true if it was not provided
+         * @param {String} nms
+         * @returns {boolean} true if it was not provided
          * false otherwise for further action
          */
-        _T.reserveNamespace = function(nms, obj) {
+        this.reserveNamespace = function(nms, obj) {
 
             if (!_T.isString(nms)) {
                 throw Error("Namespace must be a string with . as delimiter");
@@ -283,7 +331,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param {Object} root the root element
          * @param {String} subNms the namespace
          */
-        _T.exists = function(root, subNms) {
+        this.exists = function(root, subNms) {
             if (!root) {
                 return false;
             }
@@ -333,11 +381,9 @@ if (!myfaces._impl.core._Runtime) {
          * myfacesScriptRoot to the root of your script files (aka under normal circumstances
          * resources/scripts)
          *
-         * @param localOptions
-         * @param configName
-         * @param defaultValue
+         * @param {String} nms, the subnamespace to be required
          */
-        _T.require = function(nms) {
+        this.require = function(nms) {
             //namespace exists
             if (_T.exists(nms)) return;
             var rootPath = _T.getGlobalConfig("myfacesScriptRoot", "");
@@ -351,17 +397,17 @@ if (!myfaces._impl.core._Runtime) {
          *
          * @return either the config entry or if none is given the default value
          */
-        _T.getGlobalConfig = function(configName, defaultValue) {
-            /**
-             * note we could use exists but this is an heavy operation, since the config name usually
-             * given this function here is called very often
-             * is a single entry without . in between we can do the lighter shortcut
-             */
-            return (myfaces["config"] && 'undefined' != typeof myfaces.config[configName] ) ?
-                    myfaces.config[configName]
-                    :
-                    defaultValue;
-        };
+         this.getGlobalConfig = function(configName, defaultValue) {
+                    /**
+                     * note we could use exists but this is an heavy operation, since the config name usually
+                     * given this function here is called very often
+                     * is a single entry without . in between we can do the lighter shortcut
+                     */
+                    return (myfaces["config"] && 'undefined' != typeof myfaces.config[configName] ) ?
+                            myfaces.config[configName]
+                            :
+                            defaultValue;
+                };
 
         /**
          * gets the local or global options with local ones having higher priority
@@ -374,7 +420,7 @@ if (!myfaces._impl.core._Runtime) {
          *
          * @return either the config entry or if none is given the default value
          */
-        _T.getLocalOrGlobalConfig = function(localOptions, configName, defaultValue) {
+        this.getLocalOrGlobalConfig = function(localOptions, configName, defaultValue) {
             /*use(myfaces._impl._util)*/
             var _local = !!localOptions;
             var _localResult;
@@ -395,7 +441,7 @@ if (!myfaces._impl.core._Runtime) {
          * 1.5 for mozillas send as binary implementation
          * 2 for xhr level 2
          */
-        _T.getXHRLvl = function() {
+        this.getXHRLvl = function() {
             if (!_T.XHR_LEVEL) {
                 _T.getXHRObject();
             }
@@ -411,7 +457,7 @@ if (!myfaces._impl.core._Runtime) {
          *
          * @return the xhr object according to the browser type
          */
-        _T.getXHRObject = function() {
+        this.getXHRObject = function() {
             //since this is a global object ie hates it if we do not check for undefined
             if (window.XMLHttpRequest) {
                 var _ret = new XMLHttpRequest();
@@ -445,7 +491,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param {Boolean} async tells whether the script can be asynchronously loaded or not, currently
          * not used
          */
-        _T.loadScriptEval = function(src, type, defer, charSet, async) {
+        this.loadScriptEval = function(src, type, defer, charSet, async) {
             var xhr = _T.getXHRObject();
             xhr.open("GET", src, false);
 
@@ -490,7 +536,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param {Boolean} defer  defer true or false, same as the javascript tag defer param
          * @param {String} charSet the charset under which the script has to be loaded
          */
-        _T.loadScriptByBrowser = function(src, type, defer, charSet, async) {
+        this.loadScriptByBrowser = function(src, type, defer, charSet, async) {
             //if a head is already present then it is safer to simply
             //use the body, some browsers prevent head alterations
             //after the first initial rendering
@@ -525,14 +571,14 @@ if (!myfaces._impl.core._Runtime) {
                 holder.appendChild(script);
 
             } catch (e) {
-                //in case of a loading error we retry via eval    
+                //in case of a loading error we retry via eval
                 return false;
             }
 
             return true;
         };
 
-        _T.loadScript = function(src, type, defer, charSet, async) {
+        this.loadScript = function(src, type, defer, charSet, async) {
             //the chrome engine has a nasty javascript bug which prevents
             //a correct order of scripts being loaded
             //if you use script source on the head, we  have to revert
@@ -571,12 +617,12 @@ if (!myfaces._impl.core._Runtime) {
          *      _T._callDelegate("myMethod", arg1,"hello world");
          *
          *
-         * @param newCls the new class name to be generated
-         * @param delegateObj the delegation object
-         * @param protoFuncs the prototype functions which should be attached
-         * @param nmsFuncs the namespace functions which should be attached to the namespace
+         * @param {String} newCls the new class name to be generated
+         * @param {Object} delegateObj the delegation object
+         * @param {Map} protoFuncs the prototype functions which should be attached
+         * @param {Map} nmsFuncs the namespace functions which should be attached to the namespace
          */
-        _T.delegateObj = function(newCls, delegateObj, protoFuncs, nmsFuncs) {
+        this.delegateObj = function( newCls, delegateObj, protoFuncs, nmsFuncs) {
             if (!_T.isString(newCls)) {
                 throw Error("new class namespace must be of type String");
             }
@@ -618,12 +664,14 @@ if (!myfaces._impl.core._Runtime) {
             return newCls;
         };
 
-        /**
+        /*
          * prototype based delegation inheritance
          *
          * implements prototype delegaton inheritance dest <- a
          *
-         * usage var newClass = _T.extends( function (var1, var2) {
+         * usage
+         * <pre>
+         *  var newClass = _T.extends( function (var1, var2) {
          *                                          _T._callSuper("constructor", var1,var2);
          *                                     };
          *                                  ,origClass);
@@ -641,19 +689,21 @@ if (!myfaces._impl.core._Runtime) {
          *                                  _T._callSuper("method2", F1,"hello world");
          *                              }
          *              });
-         *
+         * </p>
          * @param {function|String} newCls either a unnamed function which can be assigned later or a namespace
          * @param {function} extendCls the function class to be extended
          * @param {Object} protoFuncs (Map) an optional map of prototype functions which in case of overwriting a base function get an inherited method
          *
          * To explain further
          * prototype functions:
+         * <pre>
          *  newClass.prototype.<prototypeFunction>
          * namspace function
-         *  newClass.<namespaceFunction> = function() {...}
+         *  newCls.<namespaceFunction> = function() {...}
+         *  </pre>
          */
 
-        _T.extendClass = function(newCls, extendCls, protoFuncs, nmsFuncs) {
+        this.extendClass = function(newCls, extendCls, protoFuncs, nmsFuncs) {
 
             if (!_T.isString(newCls)) {
                 throw Error("new class namespace must be of type String");
@@ -682,12 +732,16 @@ if (!myfaces._impl.core._Runtime) {
                 var tmpFunc = function() {
                 };
                 tmpFunc.prototype = extendCls.prototype;
-                newCls.prototype = new tmpFunc();
-                tmpFunc = null;
-                newCls.prototype.constructor = newCls;
-                newCls.prototype._parentCls = extendCls.prototype;
 
-                newCls.prototype._callSuper = function(methodName) {
+                var newClazz = newCls;
+                newClazz.prototype = new tmpFunc();
+                tmpFunc = null;
+                newClazz.prototype.constructor = newCls;
+                newClazz.prototype._parentCls = extendCls.prototype;
+                /**
+                 * @ignore
+                 */
+                newClazz.prototype._callSuper = function(methodName) {
                     var passThrough = (arguments.length == 1) ? [] : Array.prototype.slice.call(arguments, 1);
 
                     //we store the descension level of each method under a mapped
@@ -715,7 +769,7 @@ if (!myfaces._impl.core._Runtime) {
                     }
                 };
                 //reference to its own type
-                newCls.prototype._mfClazz = newCls;
+                newClazz.prototype._mfClazz = newCls;
             }
 
             //we now map the function map in
@@ -741,7 +795,7 @@ if (!myfaces._impl.core._Runtime) {
          * TODO do not use this function yet it needs some refinement, it will be interesting later
          * anyway
          */
-        _T.pluginClass = function(classNms, protoFuncs, overWrite) {
+        this.pluginClass = function(classNms, protoFuncs, overWrite) {
             var oldClass = _T.fetchNamespace(classNms);
             if (!oldClass) throw new Error("The class namespace " + classNms + " is not existent");
 
@@ -768,7 +822,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param {function} extendsCls the function class to be extended
          * @param {Object} protoFuncs (Map) an optional map of prototype functions which in case of overwriting a base function get an inherited method
          */
-                _T.singletonExtendClass = function(newCls, extendsCls, protoFuncs, nmsFuncs) {
+                this.singletonExtendClass = function(newCls, extendsCls, protoFuncs, nmsFuncs) {
                     return _makeSingleton(_T.extendClass, newCls, extendsCls, protoFuncs, nmsFuncs);
                 };
 
@@ -780,7 +834,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param protoFuncs the prototype functions which are attached on prototype level
          * @param nmsFuncs the functions which are attached on the classes namespace level
          */
-        _T.singletonDelegateObj = function(newCls, delegateObj, protoFuncs, nmsFuncs) {
+        this.singletonDelegateObj = function(newCls, delegateObj, protoFuncs, nmsFuncs) {
             if (_T._reservedNMS[newCls]) {
                 return;
             }
@@ -843,7 +897,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param probe the probe to be checked for the correct type
          * @param theType the type to be checked for
          */
-        _T.assertType = function(probe, theType) {
+        this.assertType = function(probe, theType) {
             return _T.isString(theType) ? probe == typeof theType : probe instanceof theType;
         };
 
@@ -852,7 +906,7 @@ if (!myfaces._impl.core._Runtime) {
          * @param func the function which should be added to the load
          * chain (note we cannot rely on return values here, hence jsf.util.chain will fail)
          */
-        _T.addOnLoad = function(target, func) {
+        this.addOnLoad = function(target, func) {
             var oldonload = (target) ? target.onload : null;
             target.onload = (!oldonload) ? func : function() {
                 try {
@@ -877,7 +931,7 @@ if (!myfaces._impl.core._Runtime) {
          * </ul>
          * null is returned if the browser fails to determine the language settings
          */
-        _T.getLanguage = function(lOverride) {
+        this.getLanguage = function(lOverride) {
             var deflt = {language: "en", variant: "UK"}; //default language and variant
             try {
                 var lang = lOverride || navigator.language || navigator.browserLanguage;

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages.js Thu Sep  1 15:30:53 2011
@@ -15,66 +15,122 @@
  */
 
 /**
- * System messages base version
+ * @memberOf myfaces._impl
+ * @namespace
+ * @name i18n
+ */
+
+
+/**
+ * System messages base version    <p />
  * (note the base version is basically the en_US) version
  * of all messages
  *
- * @namespace myfaces._impl.i18n.Messages
+ * @class
+ * @name Messages
+ * @memberOf myfaces._impl.i18n
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages", Object,
+/**
+ * @lends myfaces._impl.i18n.Messages.prototype
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages", Object, {
+{
 
     MSG_TEST:               "Testmessage",
 
     /*Messages*/
+    /** @constant */
     MSG_DEV_MODE:           "Note, this message is only sent, because project stage is development and no " +
                             "other error listeners are registered.",
+    /** @constant */
     MSG_AFFECTED_CLASS:     "Affected Class:",
+    /** @constant */
     MSG_AFFECTED_METHOD:    "Affected Method:",
-
+    /** @constant */
     MSG_ERROR_NAME:         "Error Name:",
+    /** @constant */
     MSG_ERROR_MESSAGE:      "Error Name:",
-
+    /** @constant */
     MSG_ERROR_DESC:         "Error Description:",
+    /** @constant */
     MSG_ERROR_NO:           "Error Number:",
+    /** @constant */
     MSG_ERROR_LINENO:       "Error Line Number:",
 
     /*Errors and messages*/
+    /** @constant */
     ERR_FORM:               "Sourceform could not be determined, either because element is not attached to a form or we have multiple forms with named elements of the same identifier or name, stopping the ajax processing",
+    /** @constant */
     ERR_VIEWSTATE:          "jsf.viewState: param value not of type form!",
+    /** @constant */
     ERR_TRANSPORT:          "Transport type {0} does not exist",
+    /** @constant */
     ERR_EVT_PASS:           "an event must be passed down (either a an event object null or undefined) ",
+    /** @constant */
     ERR_CONSTRUCT:          "Parts of the response couldn't be retrieved when constructing the event data: {0} ",
+    /** @constant */
     ERR_MALFORMEDXML:       "The server response could not be parsed, the server has returned with a response which is not xml !",
+    /** @constant */
     ERR_SOURCE_FUNC:        "source cannot be a function (probably source and event were not defined or set to null",
+    /** @constant */
     ERR_EV_OR_UNKNOWN:      "An event object or unknown must be passed as second parameter",
+    /** @constant */
     ERR_SOURCE_NOSTR:       "source cannot be a string",
+    /** @constant */
     ERR_SOURCE_DEF_NULL:    "source must be defined or null",
 
     //_Lang.js
+    /** @constant */
     ERR_MUST_STRING:        "{0}: {1} namespace must be of type String",
+    /** @constant */
     ERR_REF_OR_ID:          "{0}: {1} a reference node or identifier must be provided",
+    /** @constant */
     ERR_PARAM_GENERIC:      "{0}: parameter {1} must be of type {2}",
+    /** @constant */
     ERR_PARAM_STR:          "{0}: {1} param must be of type string",
+    /** @constant */
     ERR_PARAM_STR_RE:       "{0}: {1} param must be of type string or a regular expression",
+    /** @constant */
     ERR_PARAM_MIXMAPS:      "{0}: both a source as well as a destination map must be provided",
+    /** @constant */
     ERR_MUST_BE_PROVIDED:   "{0}: an {1} and a {2} must be provided",
+    /** @constant */
     ERR_MUST_BE_PROVIDED1:  "{0}: {1} must be set",
 
+    /** @constant */
     ERR_REPLACE_EL:         "replaceElements called while evalNodes is not an array",
+
+    /** @constant */
     ERR_EMPTY_RESPONSE:     "{0}: The response cannot be null or empty!",
+    /** @constant */
     ERR_ITEM_ID_NOTFOUND:   "{0}: item with identifier {1} could not be found",
+    /** @constant */
     ERR_PPR_IDREQ:          "{0}: Error in PPR Insert, id must be present",
+    /** @constant */
     ERR_PPR_INSERTBEFID:    "{0}: Error in PPR Insert, before id or after id must be present",
+    /** @constant */
     ERR_PPR_INSERTBEFID_1:  "{0}: Error in PPR Insert, before  node of id {1} does not exist in document",
+    /** @constant */
     ERR_PPR_INSERTBEFID_2:  "{0}: Error in PPR Insert, after  node of id {1} does not exist in document",
 
+    /** @constant */
     ERR_PPR_DELID:          "{0}: Error in delete, id not in xml markup",
+    /** @constant */
     ERR_PPR_UNKNOWNCID:     "{0}:  Unknown Html-Component-ID: {1}",
+
+    /** @constant */
     ERR_NO_VIEWROOTATTR:    "{0}: Changing of ViewRoot attributes is not supported",
+    /** @constant */
     ERR_NO_HEADATTR:        "{0}: Changing of Head attributes is not supported",
+    /** @constant */
     ERR_RED_URL:            "{0}: Redirect without url",
 
+    /** @constant */
     ERR_REQ_FAILED_UNKNOWN: "Request failed with unknown status",
+
+    /** @constant */
     ERR_REQU_FAILED: "Request failed with status {0} and reason {1}",
+
+    /** @constant */
     UNKNOWN: "UNKNOWN"
 });

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_de.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_de.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_de.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_de.js Thu Sep  1 15:30:53 2011
@@ -14,21 +14,29 @@
  * limitations under the License.
  */
 
+
+
 /**
  * System messages german version
  * (note the base version is basically the en_US) version
  * of all messages
- *
+ * <p />
  * We use inheritance to overide the default messages with our
  * german one, variants can derive from the german one (like
  * suisse which do not have the emphasized s)
- *
+ * <p />
  * By using inheritance we can be sure that we fall back to the default one
  * automatically and that our variants only have to override the parts
  * which have changed from the baseline
  *
+ * @class
+ * @name Messages_de
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_de", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_de", myfaces._impl.i18n.Messages,
+/** @lends myfaces._impl.i18n.Messages_de.prototype */
+{
 
     MSG_TEST:               "Testnachricht",
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_es.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_es.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_es.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_es.js Thu Sep  1 15:30:53 2011
@@ -19,9 +19,14 @@
  * (note the base version is basically the en_US) version
  * of all messages
  *
+ * @class
+ * @name Messages_es
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_es", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_es", myfaces._impl.i18n.Messages,
+/** @lends myfaces._impl.i18n.Messages_es.prototype */
+{
 
 
     MSG_TEST:               "Mensajeprueba",
@@ -29,53 +34,53 @@ myfaces._impl.core._Runtime.extendClass(
     /*Messages*/
     MSG_DEV_MODE:           "Aviso. Este mensaje solo se envia porque el 'Project Stage' es 'Development' y no hay otros 'listeners' de errores registrados.",
     MSG_AFFECTED_CLASS:     "Clase Afectada:",
-    MSG_AFFECTED_METHOD:    "MŽtodo Afectado:",
+    MSG_AFFECTED_METHOD:    "M�todo Afectado:",
 
     MSG_ERROR_NAME:         "Nombre del Error:",
     MSG_ERROR_MESSAGE:      "Nombre del Error:",
 
-    MSG_ERROR_DESC:         "Descripci—n del Error:",
-    MSG_ERROR_NO:           "Nœmero de Error:",
-    MSG_ERROR_LINENO:       "Nœmero de L’nea del Error:",
+    MSG_ERROR_DESC:         "Descripci�n del Error:",
+    MSG_ERROR_NO:           "N�mero de Error:",
+    MSG_ERROR_LINENO:       "N�mero de L�nea del Error:",
 
     /*Errors and messages*/
     ERR_FORM:               "El formulario de origen no ha podido ser determinado, debido a que el elemento no forma parte de un formulario o hay diversos formularios con elementos usando el mismo nombre o identificador. Parando el procesamiento de Ajax.",
-    ERR_VIEWSTATE:          "jsf.viewState: el valor del par‡metro no es de tipo 'form'!",
+    ERR_VIEWSTATE:          "jsf.viewState: el valor del par�metro no es de tipo 'form'!",
     ERR_TRANSPORT:          "El tipo de transporte {0} no existe",
     ERR_EVT_PASS:           "un evento debe ser transmitido (sea null o no definido)",
     ERR_CONSTRUCT:          "Partes de la respuesta no pudieron ser recuperadas cuando construyendo los datos del evento: {0} ",
     ERR_MALFORMEDXML:       "La respuesta del servidor no ha podido ser interpretada. El servidor ha devuelto una respuesta que no es xml !",
-    ERR_SOURCE_FUNC:        "el origen no puede ser una funci—n (probablemente 'source' y evento no han sido definidos o son 'null'",
-    ERR_EV_OR_UNKNOWN:      "Un objeto de tipo evento o desconocido debe ser pasado como segundo par‡metro",
+    ERR_SOURCE_FUNC:        "el origen no puede ser una funci�n (probablemente 'source' y evento no han sido definidos o son 'null'",
+    ERR_EV_OR_UNKNOWN:      "Un objeto de tipo evento o desconocido debe ser pasado como segundo par�metro",
     ERR_SOURCE_NOSTR:       "el origen no puede ser 'string'",
     ERR_SOURCE_DEF_NULL:    "el origen debe haber sido definido o ser 'null'",
 
     //_Lang.js
     ERR_MUST_STRING:        "{0}: {1} namespace debe ser de tipo String",
     ERR_REF_OR_ID:          "{0}: {1} una referencia a un nodo o identificador tiene que ser pasada",
-    ERR_PARAM_GENERIC:      "{0}: el par‡metro {1} tiene que ser de tipo {2}",
-    ERR_PARAM_STR:          "{0}: el par‡metro {1} tiene que ser de tipo string",
-    ERR_PARAM_STR_RE:       "{0}: el par‡metro {1} tiene que ser de tipo string o una expresi—n regular",
+    ERR_PARAM_GENERIC:      "{0}: el par�metro {1} tiene que ser de tipo {2}",
+    ERR_PARAM_STR:          "{0}: el par�metro {1} tiene que ser de tipo string",
+    ERR_PARAM_STR_RE:       "{0}: el par�metro {1} tiene que ser de tipo string o una expresi�n regular",
     ERR_PARAM_MIXMAPS:      "{0}: han de ser pasados tanto un origen como un destino",
     ERR_MUST_BE_PROVIDED:   "{0}: {1} y {2} deben ser pasados",
     ERR_MUST_BE_PROVIDED1:  "{0}: {1} debe estar definido",
 
     ERR_REPLACE_EL:         "replaceElements invocado mientras que evalNodes no es un an array",
-    ERR_EMPTY_RESPONSE:     "{0}: ÁLa respuesta no puede ser de tipo 'null' o vac’a!",
+    ERR_EMPTY_RESPONSE:     "{0}: �La respuesta no puede ser de tipo 'null' o vac�a!",
     ERR_ITEM_ID_NOTFOUND:   "{0}: el elemento con identificador {1} no ha sido encontrado",
     ERR_PPR_IDREQ:          "{0}: Error en PPR Insert, 'id' debe estar presente",
-    ERR_PPR_INSERTBEFID:    "{0}: Error in PPR Insert, antes de 'id' o despuŽs de 'id' deben estar presentes",
+    ERR_PPR_INSERTBEFID:    "{0}: Error in PPR Insert, antes de 'id' o despu�s de 'id' deben estar presentes",
     ERR_PPR_INSERTBEFID_1:  "{0}: Error in PPR Insert, antes de nodo con id {1} no existe en el documento",
-    ERR_PPR_INSERTBEFID_2:  "{0}: Error in PPR Insert, despuŽs de nodo con id {1} no existe en el documento",
+    ERR_PPR_INSERTBEFID_2:  "{0}: Error in PPR Insert, despu�s de nodo con id {1} no existe en el documento",
 
     ERR_PPR_DELID:          "{0}: Error durante borrado, id no presente en xml",
     ERR_PPR_UNKNOWNCID:     "{0}:  Desconocido Html-Component-ID: {1}",
     ERR_NO_VIEWROOTATTR:    "{0}: El cambio de atributos de ViewRoot attributes no es posible",
     ERR_NO_HEADATTR:        "{0}: El cambio de los atributos de Head attributes no es posible",
-    ERR_RED_URL:            "{0}: Redirecci—n sin url",
+    ERR_RED_URL:            "{0}: Redirecci�n sin url",
 
-    ERR_REQ_FAILED_UNKNOWN: "La petici—n ha fallado con estado desconocido",
-    ERR_REQU_FAILED:        "La petici—n ha fallado con estado {0} y raz—n {1}",
+    ERR_REQ_FAILED_UNKNOWN: "La petici�n ha fallado con estado desconocido",
+    ERR_REQU_FAILED:        "La petici�n ha fallado con estado {0} y raz�n {1}",
     UNKNOWN:                "DESCONOCIDO"
 
 });
\ No newline at end of file

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_fr.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_fr.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_fr.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_fr.js Thu Sep  1 15:30:53 2011
@@ -20,8 +20,14 @@
  * (note the base version is basically the en) version
  * of all messages
  *
+ * @class
+ * @name Messages_fr
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_fr", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_fr", myfaces._impl.i18n.Messages,
+/** @lends myfaces._impl.i18n.Messages_fr.prototype */
+{
     MSG_TEST:               "MessageTest FR",
 
        /*Messages*/

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_it.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_it.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_it.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_it.js Thu Sep  1 15:30:53 2011
@@ -19,10 +19,16 @@
  * (note the base version is basically the en_US) version
  * of all messages
  *
+ * @class
+ * @name Messages_it
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_it", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_it", myfaces._impl.i18n.Messages,
+/** @lends myfaces._impl.i18n.Messages_it.prototype */
+{
     /*Messages*/
-    MSG_DEV_MODE:           "Questo messaggio  stato inviato esclusivamente perch il progetto  in development stage e nessun altro listener  stato registrato.",
+    MSG_DEV_MODE:           "Questo messaggio � stato inviato esclusivamente perch� il progetto � in development stage e nessun altro listener � stato registrato.",
     MSG_AFFECTED_CLASS:     "Classi coinvolte:",
     MSG_AFFECTED_METHOD:    "Metodi coinvolti:",
 
@@ -34,15 +40,15 @@ myfaces._impl.core._Runtime.extendClass(
     MSG_ERROR_LINENO:       "Numero di riga dell'errore:",
 
     /*Errors and messages*/
-    ERR_FORM:               "Il Sourceform non puo' essere determinato a causa di una delle seguenti ragioni: l'elemento non e' agganciato ad un form oppure sono presenti pi form con elementi con lo stesso nome, il che blocca l'elaborazione ajax",
-    ERR_VIEWSTATE:          "jsf.viewState: il valore del parametro non  di tipo form!",
+    ERR_FORM:               "Il Sourceform non puo' essere determinato a causa di una delle seguenti ragioni: l'elemento non e' agganciato ad un form oppure sono presenti pi� form con elementi con lo stesso nome, il che blocca l'elaborazione ajax",
+    ERR_VIEWSTATE:          "jsf.viewState: il valore del parametro non � di tipo form!",
     ERR_TRANSPORT:          "Il transport type {0} non esiste",
-    ERR_EVT_PASS:           " necessario passare un evento (sono accettati anche gli event object null oppure undefined) ",
-    ERR_CONSTRUCT:          "Durante la costruzione dell' event data: {0} non  stato possibile acquisire alcune parti della response ",
-    ERR_MALFORMEDXML:       "Il formato della risposta del server non era xml, non  stato quindi possibile effettuarne il parsing!",
+    ERR_EVT_PASS:           "� necessario passare un evento (sono accettati anche gli event object null oppure undefined) ",
+    ERR_CONSTRUCT:          "Durante la costruzione dell' event data: {0} non � stato possibile acquisire alcune parti della response ",
+    ERR_MALFORMEDXML:       "Il formato della risposta del server non era xml, non � stato quindi possibile effettuarne il parsing!",
     ERR_SOURCE_FUNC:        "source non puo' essere una funzione (probabilmente source and event non erano stati definiti o sono null",
     ERR_EV_OR_UNKNOWN:      "Come secondo parametro bisogna passare un event object oppure unknown",
-    ERR_SOURCE_NOSTR:       "source non pu˜ essere una stringa di testo",
+    ERR_SOURCE_NOSTR:       "source non pu� essere una stringa di testo",
     ERR_SOURCE_DEF_NULL:    "source deve essere definito oppure  null",
 
     //_Lang.js
@@ -51,13 +57,13 @@ myfaces._impl.core._Runtime.extendClass(
     ERR_PARAM_GENERIC:      "{0}: il parametro {1} deve essere di tipo {2}",
     ERR_PARAM_STR:          "{0}: {1} parametro deve essere di tipo String",
     ERR_PARAM_STR_RE:       "{0}: {1} parametro deve essere di tipo String oppure una regular expression",
-    ERR_PARAM_MIXMAPS:      "{0}:  necessario specificare sia  source che destination map",
-    ERR_MUST_BE_PROVIDED:   "{0}:  necessario specificare sia {1} che {2} ",
+    ERR_PARAM_MIXMAPS:      "{0}: � necessario specificare sia  source che destination map",
+    ERR_MUST_BE_PROVIDED:   "{0}: � necessario specificare sia {1} che {2} ",
     ERR_MUST_BE_PROVIDED1:  "{0}: {1} deve essere settato",
 
-    ERR_REPLACE_EL:         "replaceElements chiamato metre evalNodes non  un array",
+    ERR_REPLACE_EL:         "replaceElements chiamato metre evalNodes non � un array",
     ERR_EMPTY_RESPONSE:     "{0}: La response non puo' essere nulla o vuota!",
-    ERR_ITEM_ID_NOTFOUND:   "{0}: non  stato trovato alcun item con identificativo {1}",
+    ERR_ITEM_ID_NOTFOUND:   "{0}: non � stato trovato alcun item con identificativo {1}",
     ERR_PPR_IDREQ:          "{0}: Errore durante la PPR Insert, l' id deve essere specificato",
     ERR_PPR_INSERTBEFID:    "{0}: Errore durante la PPR Insert, before id o after id deve essere specificato",
     ERR_PPR_INSERTBEFID_1:  "{0}: Errore durante la PPR Insert, before node of id {1} non esiste nel document",
@@ -65,7 +71,7 @@ myfaces._impl.core._Runtime.extendClass(
 
     ERR_PPR_DELID:          "{0}: Errore durante la delete, l'id non e' nella forma di un markup xml",
     ERR_PPR_UNKNOWNCID:     "{0}:   Html-Component-ID: {1} sconosciuto",
-    ERR_NO_VIEWROOTATTR:    "{0}: La modifica degli attributi del ViewRoot non  supportata",
-    ERR_NO_HEADATTR:        "{0}: La modifica degli attributi di Head non  supportata",
+    ERR_NO_VIEWROOTATTR:    "{0}: La modifica degli attributi del ViewRoot non � supportata",
+    ERR_NO_HEADATTR:        "{0}: La modifica degli attributi di Head non � supportata",
     ERR_RED_URL:            "{0}: Redirect senza url"
 });
\ No newline at end of file

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_nl.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_nl.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_nl.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_nl.js Thu Sep  1 15:30:53 2011
@@ -15,11 +15,16 @@
  */
 
 /**
- * System messages base version
- * (note the base version is basically the en_US) version
- * of all messages
+ * System messages dutch version
+ *
+ * @class
+ * @name Messages_nl
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_nl", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_nl", myfaces._impl.i18n.Messages,
+/** @lends myfaces._impl.i18n.Messages_nl.prototype */
+{
 
     MSG_TEST:               "Testbericht",
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_ru.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_ru.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_ru.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/i18n/Messages_ru.js Thu Sep  1 15:30:53 2011
@@ -16,11 +16,15 @@
 
 /**
  * System messages kyrillic/russian version
- * (note the base version is basically the en_US) version
- * of all messages
  *
+ * @class
+ * @name Messages_nl
+ * @extends myfaces._impl.i18n.Messages
+ * @memberOf myfaces._impl.i18n
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_ru", myfaces._impl.i18n.Messages, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.i18n.Messages_ru", myfaces._impl.i18n.Messages,
+/** myfaces._impl.i18n.Messages_ru.prototype */
+{
 
     MSG_TEST:               "ТестовоеСообщение",
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxRequest.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxRequest.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxRequest.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxRequest.js Thu Sep  1 15:30:53 2011
@@ -22,22 +22,25 @@
  * Author: Ganesh Jung (latest modification by $Author: ganeshpuri $)
  * Version: $Revision: 1.4 $ $Date: 2009/05/31 09:16:44 $
  */
-/** @namespace myfaces._impl.xhrCore._AjaxRequest */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxRequest", myfaces._impl.xhrCore._BaseRequest, {
-
-
-    /*
-     note there is a load of common properties
-     inherited by the base class which define the corner
-     parameters and the general internal behavior
-     like _onError etc...
-     */
 
+/**
+ * @class
+ * @name _AjaxRequest
+ * @memberOf myfaces._impl.xhrCore
+ * @extends myfaces._impl.xhrCore._BaseRequest
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxRequest", myfaces._impl.xhrCore._BaseRequest,
+/** myfaces._impl.xhrCore._AjaxRequest.prototype */
+{
     /**
      * Constructor
-     * @arguments  an arguments map which an override any of the given protected
+     * <p />
+     * note there is a load of common properties
+     * inherited by the base class which define the corner
+     * parameters and the general internal behavior
+     * like _onError etc...
+     * @param {Map} an arguments map which an override any of the given protected
      * instance variables, by a simple name value pair combination
-     *
      */
     constructor_: function(arguments) {
 

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxResponse.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxResponse.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxResponse.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxResponse.js Thu Sep  1 15:30:53 2011
@@ -14,8 +14,17 @@
  * limitations under the License.
  */
 
-/** @namespace myfaces._impl.xhrCore._AjaxResponse */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxResponse", myfaces._impl.xhrCore._FinalizeableObj, {
+/**
+ * @class
+ * @name _AjaxResponse
+ * @memberOf myfaces._impl.xhrCore
+ * @extends myfaces._impl.xhrCore._FinalizeableObj
+ * @description
+ * This class is responsible for handling the standardized xml ajax response
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxResponse", myfaces._impl.xhrCore._FinalizeableObj,
+/** @lends myfaces._impl.xhrCore._AjaxResponse.prototype */
+{
 
     /*partial response types*/
     RESP_PARTIAL : "partial-response",
@@ -42,7 +51,8 @@ myfaces._impl.core._Runtime.extendClass(
 
 
     /**
-     * Constructor
+     * Standard constructor
+     *
      * @param {function} base request classed parent object
      * @param {function} onException
      * @param {function} onWarning
@@ -151,6 +161,11 @@ myfaces._impl.core._Runtime.extendClass(
         }
     },
 
+    /**
+     * fixes the viewstates in the current page
+     *
+     * @param context
+     */
     fixViewStates : function(context) {
 
         if (null == this.appliedViewState) {
@@ -218,7 +233,13 @@ myfaces._impl.core._Runtime.extendClass(
     },
 
 
-
+    /**
+     * processes an incoming error from the response
+     * which is hosted under the &lt;error&gt; tag
+     * @param request the current request
+     * @param context the contect object
+     * @param node the node in the xml hosting the error message
+     */
     processError : function(request, context, node) {
         /**
          * <error>
@@ -234,6 +255,12 @@ myfaces._impl.core._Runtime.extendClass(
         _Impl.sendError(request, context, myfaces._impl.core.Impl.SERVER_ERROR, errorName, errorMessage);
     },
 
+    /**
+     * processes an incoming xml redirect directive from the ajax response
+     * @param request the request object
+     * @param context the context
+     * @param node the node hosting the redirect data
+     */
     processRedirect : function(request, context, node) {
         /**
          * <redirect url="url to redirect" />

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxUtils.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxUtils.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxUtils.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_AjaxUtils.js Thu Sep  1 15:30:53 2011
@@ -13,8 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** @namespace myfaces._impl.xhrCore._AjaxUtils */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxUtils", myfaces._impl.xhrCore._FinalizeableObj, {
+/**
+ * @class
+ * @name _AjaxUtils
+ * @memberOf myfaces._impl.xhrCore
+ * @extends myfaces._impl.xhrCore._FinalizeableObj
+ * @description
+ *
+ * A set of helper routines which are utilized within our Ajax subsystem and nowhere else
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._AjaxUtils", myfaces._impl.xhrCore._FinalizeableObj,
+/** @lends myfaces._impl.xhrCore._AjaxUtils.prototype */
+{
       _processedExceptions: {},
 
     /**
@@ -27,6 +37,7 @@ myfaces._impl.core._Runtime.extendClass(
         this._onWarning = onWarning;
     },
 
+
     /**
      * determines fields to submit
      * @param {Object} request the xhr request object

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_BaseRequest.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_BaseRequest.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_BaseRequest.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_BaseRequest.js Thu Sep  1 15:30:53 2011
@@ -16,14 +16,33 @@
 
 /**
  *
- * Abstract base request encapuslating all methods and variables
- * shared over all different request objects
- *
  * Author: Werner Punz (latest modification by $Author: ganeshpuri $)
  * Version: $Revision: 1.4 $ $Date: 2009/05/31 09:16:44 $
  */
-/** @namespace myfaces._impl.xhrCore._AjaxRequest */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._BaseRequest", myfaces._impl.xhrCore._FinalizeableObj, {
+
+/**
+ * @memberOf myfaces._impl
+ * @namespace
+ * @name xhrCore
+ */
+
+/**
+ * @class
+ * @name _BaseRequest
+ * @memberOf myfaces._impl.xhrCore
+ * @extends myfaces._impl.xhrCore._FinalizeableObj
+ *
+ * @description
+ * Abstract base request encapuslating all methods and variables
+ * shared over all different request objects
+ * <p />
+ * Abstract methods which have to be implemented:<br />
+ * Since we do not have abstract methods we simulate them
+ * by using empty ones
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._BaseRequest", myfaces._impl.xhrCore._FinalizeableObj,
+/** @lends myfaces._impl.xhrCore._BaseRequest.prototype */
+{
 
     _Dom: null,
     _Lang: null,

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_FinalizeableObj.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_FinalizeableObj.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_FinalizeableObj.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_FinalizeableObj.js Thu Sep  1 15:30:53 2011
@@ -13,22 +13,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-/**
- *  A helper object which supports IE with its non working garbage collection.
- *
- * See also:
- *
- * http://msdn.microsoft.com/en-us/library/bb250448%28VS.85%29.aspx
- * http://weblogs.java.net/blog/driscoll/archive/2009/11/13/ie-memory-management-and-you
- * http://home.orange.nl/jsrosman/
- * http://www.quirksmode.org/blog/archives/2005/10/memory_leaks_li.html
- * http://www.josh-davis.org/node/7
- *
+/*
  * Author: Werner Punz (latest modification by $Author: werpu $)
  * Version: $Revision: 1.4 $ $Date: 2009/05/31 09:16:44 $
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._FinalizeableObj", Object, {
+
+/**
+ * @class
+ * @name _FinalizeableObj
+ * @memberOf myfaces._impl.xhrCore
+ * @description  A helper class which supports IE with its non working garbage collection.
+ * @see <a href="http://msdn.microsoft.com/en-us/library/bb250448%28VS.85%29.aspx">http://msdn.microsoft.com/en-us/library/bb250448%28VS.85%29.aspx</a>
+ * @see <a href="http://weblogs.java.net/blog/driscoll/archive/2009/11/13/ie-memory-management-and-you">http://weblogs.java.net/blog/driscoll/archive/2009/11/13/ie-memory-management-and-you</a>
+ * @see <a href="http://home.orange.nl/jsrosman/">http://home.orange.nl/jsrosman/</a>
+ * @see <a href="http://www.quirksmode.org/blog/archives/2005/10/memory_leaks_li.html">http://www.quirksmode.org/blog/archives/2005/10/memory_leaks_li.html</a>
+ * @see <a href="http://www.josh-davis.org/node/7">http://www.josh-davis.org/node/7</a>
+ */
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._FinalizeableObj", Object,
+/** @lends myfaces._impl.xhrCore._FinalizeableObj.prototype */
+{
 
     _resettableContent: null,
 
@@ -47,6 +50,9 @@ myfaces._impl.core._Runtime.extendClass(
 
     /**
      * ie6 cleanup
+     * This method disposes all properties manually in case of ie6
+     * hence reduces the chance of running into a gc problem tremendously
+     * on other browsers this method does nothing
      */
     _finalize: function() {
         if (!myfaces._impl.core._Runtime.browser.isIE || !this._resettableContent) {

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_IFrameRequest.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_IFrameRequest.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_IFrameRequest.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_IFrameRequest.js Thu Sep  1 15:30:53 2011
@@ -15,24 +15,45 @@
  */
 
 /**
- * iframe request for communications over iframe
+ * @class
+ * @name _IFrameRequest
+ * @memberOf myfaces._impl.xhrCore
+ * @extends myfaces._impl.xhrCore._BaseRequest
+ * @description
+ * iframe transport for an alternative way to do ajax communication
+ * <p />
+ * The idea to make a frame a protocol transport is, to make a form submit
+ * with the iframe as target, and once done use the result in the iframe
+ * as result for the request.
  *
+ * <p />
  * This method can be used by older browsers and if you have
  * a multipart request which includes
  * a fileupload element, fileuploads cannot be handled by
  * normal xhr requests. The standard html 4+ compliant way to do this
  * is to use an iframe as submit target for a form.
- *
+ * <p />
  * Note on almost all browsers this method induces a real asynchronity, the only
  * exception is firefox 3.6- which blocks the ui, this is resolved in Firefox 4
  */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._IFrameRequest", myfaces._impl.xhrCore._BaseRequest, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._IFrameRequest", myfaces._impl.xhrCore._BaseRequest,
+/** @lends  myfaces._impl.xhrCore._IFrameRequest */
+{
 
     _FRAME_ID: "_mf_comm_frm",
     _frame: null,
     _RT: myfaces._impl.core._Runtime,
     CLS_NAME: "myfaces._impl.xhrCore._IFrameRequest",
+
+    /**
+     * @constant
+     * @description request marker that the request is an iframe based request
+     */
     JX_PART_IFRAME: "javax.faces.partial.iframe",
+    /**
+     * @constant
+     * @description request marker that the request is an apache myfaces iframe request based request
+     */
     MF_PART_IFRAME: "org.apache.myfaces.partial.iframe",
 
     /**
@@ -187,6 +208,7 @@ myfaces._impl.core._Runtime.extendClass(
 
     },
 
+
     _removeAjaxParams: function(oldTarget) {
         var _Impl = this._getImpl();
         this._sourceForm.target = oldTarget;

Modified: myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_Transports.js
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_Transports.js?rev=1164112&r1=1164111&r2=1164112&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_Transports.js (original)
+++ myfaces/core/trunk/api/src/main/javascript/META-INF/resources/myfaces/_impl/xhrCore/_Transports.js Thu Sep  1 15:30:53 2011
@@ -13,31 +13,34 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 /**
+ * @class
+ * @name _Transports
+ * @memberOf myfaces._impl.xhrCore
+ * @description
+ *
  * The xhr core adapter
  * which provides the transport mechanisms to the calling
  * objects, and controls the queue behavior, the error handling
  * and partial page submit functionality among other things
- *
+ * <p />
  * The idea behind this is to make the ajax request object as barebones
  * as possible and shift the extra functionality like queuing
  * parameter handling etc... to this class so that our transports become more easily
  * pluggable. This should keep the path open to iframe submits and other transport layers
- *
+ * <p />
  * the call to the corresponding transport just should be a
- * transport.xhrQueuedPost
- *
+ * transport.xhrQueuedPost <br />
  * or transport.xhrPost,transport.xhrGet  etc... in the future
- *
+ * <p />
  * Note we have taken a pattern lesson or two from the dojo toolkit and its excellent handling
  * of transports by our patterns here (which is mainly a centralized transport singleton which routes
  * to different transport implementations and the auto passing of parameters into their
  * corresponding protected attributes on class level in the transports themselves)
- *
  */
-/** @namespace myfaces._impl.xhrCore._Transports */
-myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._Transports"
-        , Object, {
+myfaces._impl.core._Runtime.extendClass("myfaces._impl.xhrCore._Transports" , Object,
+     /** @lends myfaces._impl.xhrCore._Transports.prototype */ {
 
     _PAR_ERRORLEVEL:"errorlevel",
     _PAR_QUEUESIZE:"queuesize",
@@ -258,6 +261,7 @@ myfaces._impl.core._Runtime.extendClass(
      */
     _getArguments: function(source, sourceForm, context, passThrgh) {
         var _RT = myfaces._impl.core._Runtime;
+        /** @ignore */
         var _getConfig = _RT.getLocalOrGlobalConfig;
         var _Lang = myfaces._impl._util._Lang;
 
@@ -296,6 +300,7 @@ myfaces._impl.core._Runtime.extendClass(
      */
     _applyConfig: function(destination, context, destParm, srcParm) {
         var _RT = myfaces._impl.core._Runtime;
+        /** @ignore */
         var _getConfig = _RT.getLocalOrGlobalConfig;
         if (_getConfig(context, srcParm, null) != null) {
             destination[destParm] = _getConfig(context, srcParm, null);



Mime
View raw message