svn commit: r432332 - /incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js

[mt...@apache.org]

Author: mturyn
Date: Thu Aug 17 11:46:43 2006
New Revision: 432332

URL: http://svn.apache.org/viewvc?rev=432332&view=rev
Log:
Improved the jsdoc.

Modified:
    incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js

Modified: incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js?rev=432332&r1=432331&r2=432332&view=diff
==============================================================================
--- incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js (original)
+++ incubator/xap/trunk/src/xap/bridges/dojo/DojoWidgetBridge.js Thu Aug 17 11:46:43 2006
@@ -79,7 +79,8 @@
 
 /**
  * 
- * Is the property in the list of allowed ones?
+ * Is the named property in the list of allowed ones that will be passed into <code>createWidget</code>?
+ * @param prop{string} The name of the property for which to check our list.
  */
 xap.bridges.dojo.DojoWidgetBridge.prototype.allowsInitialProperty = function(prop){
 	return xap.util.ArrayHelper.indexOf(this.getAllowedInitialProperties(),prop)>-1 ;
@@ -90,7 +91,7 @@
  * Since the <code>dojo.widget.createWidget()</code> 
  * is good at creating a widget into the place in a DOM previously 
  * occupied by an HTML element, we first create a vanilla
- * <DIV/> to be swapped-out with the widget's containing DIV.
+ * <code>&lt;DIV/&gt;</code> to be swapped-out with the widget's containing DIV.
  */
 xap.bridges.dojo.DojoWidgetBridge.prototype.obtainPeer = function() {
         
@@ -156,7 +157,7 @@
 
 /**
  * This method is called whenever an attribute
- * on the XML element that maps to this bridge class
+ * on the XAPElement that maps to this bridge class
  * is changed. xap.bridges.dojo.DojoWidgetBridge handles the following attributes:
  * <ul>
  * <li>x - the x location</li>
@@ -179,11 +180,12 @@
  * <li>textDecoration- equivalent of CSS text-decoration</li>
  * <li>margin - equivalent of CSS margin</li>
  * <li>padding - equivalent of CSS padding</li>
- * <li>textAlign - equivalent of CSS ext-align</li>
+ * <li>textAlign - equivalent of CSS text-align</li>
  * </ul>
- * 
- * Attributes not handled here are not passed to the 
- * superclass attributeSet method, since this has an abstract superclass and its parent
+ * ...mostly with changes to the dojo widget peer's <code>style</code> member.
+ *<br/>
+ * Attributes not handled here are passed to the 
+ * superclass attributeSet method.
  * 
  */
 xap.bridges.dojo.DojoWidgetBridge.prototype.attributeSet = function( event ) {
@@ -279,9 +281,7 @@
 
 /**
  *  Create a valid widget creation object for the peer based on the XAL
- *  properties (names may be different); maybe there's a way of 
- *  combining this with setAttributes, or rather letting setAttributes
- *  use this:
+ *  properties (names may be different).
  *  @param propertyMap A JS object holding name/value pairs
  *  @param holder An object holding an array of attribute nodes (in an "attributes" member) 
  *                produced by the parser/handler.