flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From erikdebr...@apache.org
Subject [04/17] git commit: [flex-asjs] [refs/heads/develop] - Fixed JSDoc annotations.
Date Thu, 07 Nov 2013 13:58:23 GMT
Fixed JSDoc annotations.

Signed-off-by: Erik de Bruin <erik@ixsoftware.nl>


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

Branch: refs/heads/develop
Commit: dca3287872f560dba3900c42b15d1c674f92bdf3
Parents: 0d5dc01
Author: Erik de Bruin <erik@ixsoftware.nl>
Authored: Thu Nov 7 13:32:43 2013 +0100
Committer: Erik de Bruin <erik@ixsoftware.nl>
Committed: Thu Nov 7 13:32:43 2013 +0100

----------------------------------------------------------------------
 frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js       | 2 ++
 .../FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js  | 1 +
 .../FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js   | 2 +-
 .../js/FlexJS/src/org/apache/flex/html/staticControls/List.js    | 4 ++--
 .../html/staticControls/accessories/NumericOnlyTextInputBead.js  | 4 ++++
 .../apache/flex/html/staticControls/beads/DataGridColumnView.js  | 4 ++--
 6 files changed, 12 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js b/frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js
index 98cad69..774cf3b 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/core/IBeadView.js
@@ -29,6 +29,8 @@ goog.inherits(
 
 /**
  * @expose
+ * @return {boolean} I guess this method is 'old' since we now
+ *                   support regular type checking?
  */
 org.apache.flex.core.IBeadView.prototype.isaView = function() {
   return true;

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js b/frameworks/js/FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js
index 3ac97cf..1e3bca2 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/core/ItemRendererClassFactory.js
@@ -57,6 +57,7 @@ prototype.createItemRenderer = function(parent) {
  * @expose
  * @this {org.apache.flex.core.ItemRendererClassFactory}
  * @param {object} parent The parent of the new item renderer.
+ * @return {object} The new item renderer.
  */
 org.apache.flex.core.ItemRendererClassFactory.
 prototype.createFromClass = function(parent) {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js
index 3db5e84..2b29775 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/DataGrid.js
@@ -99,6 +99,6 @@ function(value) {
  * @return {string} value The current selectedIndex.
  */
 org.apache.flex.html.staticControls.DataGrid.prototype.get_selectedIndex =
-function(value) {
+function() {
   return this.get_model().get_selectedIndex();
 };

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/List.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/List.js b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/List.js
index fa044ac..d154755 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/List.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/List.js
@@ -63,8 +63,8 @@ function() {
 /**
  * @expose
  * @this {org.apache.flex.html.staticControls.List}
- * Returns an array of objects that make up the actual list (most likely
- * itemRenderers).
+ * @return {Array.<Object>} An array of objects that make up the actual
+ *                          list (most likely itemRenderers).
  */
 org.apache.flex.html.staticControls.List.prototype.internalChildren =
 function() {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.js
b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.js
index bc96e09..a1a1e66 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/accessories/NumericOnlyTextInputBead.js
@@ -41,6 +41,10 @@ prototype.set_strand = function(value) {
   }
 };
 
+/**
+ * @expose
+ * @param {Object} event The input to validate?
+ */
 org.apache.flex.html.staticControls.accessories.NumericOnlyTextInputBead.
 prototype.validateInput = function(event) {
 

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/dca32878/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/beads/DataGridColumnView.js
----------------------------------------------------------------------
diff --git a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/beads/DataGridColumnView.js
b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/beads/DataGridColumnView.js
index 1c5b991..31ff3a5 100644
--- a/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/beads/DataGridColumnView.js
+++ b/frameworks/js/FlexJS/src/org/apache/flex/html/staticControls/beads/DataGridColumnView.js
@@ -56,7 +56,7 @@ org.apache.flex.html.staticControls.beads.DataGridColumnView.prototype.
 /**
  * @expose
  * @this {org.apache.flex.html.staticControls.beads.DataGridColumnView}
- * @param {number} The column index for this grid column.
+ * @param {number} value The column index for this grid column.
  */
 org.apache.flex.html.staticControls.beads.DataGridColumnView.prototype.
     set_columnIndex = function(value) {
@@ -78,7 +78,7 @@ org.apache.flex.html.staticControls.beads.DataGridColumnView.prototype.
 /**
  * @expose
  * @this {org.apache.flex.html.staticControls.beads.DataGridColumnView}
- * @param {string} The field in the data to use for the column's label.
+ * @param {string} value The field in the data to use for the column's label.
  */
 org.apache.flex.html.staticControls.beads.DataGridColumnView.prototype.
      set_labelField = function(value) {


Mime
View raw message